TE_Graph
Create, modify, or remove a graph.
Syntax
TE_Graph <ObjectPath> {Add | Save | Delete | Modify | Refresh} Name "<Name>" AnalysisObject "<Name>" {GraphXY | Multigraph | ColorLine | BoxWhiskerVert | BoxWhiskerHoriz | Histogram} <Parameters> {Stat} <Parameters> {Show "<On | Off>"}
Related commands
Description
TETK must be installed in order to use this command.
This command generates a graph in TETK.
Name "<Name>" specifies the name of the graph. This parameter is required.
AnalysisObject "<Name>" is the name of the analysis object. This parameter is required.
The following table describes the keywords for the Name parameter.
| <Keyword> | Description |
|---|---|
| GraphXY | A cartesian coordinate graph that plots a single graph in the window. GraphXY graphs may have multiple lines but the dimensions must be the same. |
| Multigraph | Plots multlple graphs in a single window. Each line has its own Y-axis and X-axis. Multigraph graphs may have multiple lines with different dimensions. |
| ColorLine | Displays a line showing the span of the time contraint. There is no Y value and the X value is fixed as time. |
| BoxWhiskerVert | Plots three data points — the min and max of the data set, as well as the median in the center of the plot. |
| BoxWhiskerHoriz | Plots three data points — the min and max of the data set, as well as the median in the center of the plot. |
| Histogram | Displays frequency distribution of multiple data points for a single metric or variable. Data points are classified into bins, which cover a range of numeric values. The following attributes are supported:
|
The following table describes the Segment parameters which are used for the Add option.
For the Add option, either Segment Color or Segment Gradient must be entered.
| <Parameters> | Description |
|---|---|
| DrawLine "<On | Off>" | Enables you to draw a line segment. Accepted values are On and Off. By default, the value is set to Off. |
| ShowLine "<Yes | No>" | Enables you to show or hide a graph line segment. Accepted values are Yes and No. Note that this keyword performs the same function as ShowItem. |
| ShowItem "<Yes | No>" | Enables you to show or hide a graph line segment. Accepted values are Yes and No. Note that this keyword performs the same function as ShowLine. |
| Segment Color "<Color>" | Enter a color. |
| Segment Gradient "<DataElement>,<Value1>,<Color1>,<Value2>,<Color2>,..." | Enter the data element, followed by a comma separated list of value, color. See below for format of <DataElement>. |
| BelowColor "<value>" | Enter a color value (named color, RGB, or hue). If you do not specify a color, the BelowColor will be turned off. This keyword only is used in conjunction with the Segment Gradient keyword. |
| Above "<ON | OFF>" | Define if the segment displays a color for values above the highest specified value. This keyword only is used in conjunction with the Segment Gradient keyword. |
| DrawPoints "<On | Off>" | Enables you to draw a point. Accepted values are On and Off. By default, the value is set to On. |
| Point Size "{Small | Large | Medium | Micro}" | Enter the size. |
| BackImage "<filename>,<style> " | Enables you to add a .BMP image to the background of the graph. The filename parameter refers to the name of the .BMP image that is added to the graph background. The style parameter accepts the values Center and Stretch. To center the image within the graph, use Center. To span the image across the graph, use Stretch. To remove the image from the graph background, specify the keyword with a value of ",". |
| BackOutsideColor "<Color>" | Enter the background color of the region outside of the graph axes. |
| BackInsideColor "<Color>" | Enter the background color of the region inside of the graph axes. |
| LimitPointSize "<ON | OFF>" | Limits the point size to the value defined in the Point Size parameter. This ensures that the point size will not increase when enlarging the graph. Default value is off. |
| Point "{1.0 | 1.5 | 2.0 | 2.5 | 3.0}" | Enter the point. This parameter accepts the keyword PixelSize, which enables you to define the pixel size of a track point. Accepted values are 0-30. |
| Seg Line Style "{Points, PointsPlusLine, ThinLine, MediumThinLine, MediumLine, DashLine, MediumThinDashLine, MediumDashLine, DotLine, MediumThinDotLine, MediumDotLine, DotDashLine, MediumThinDotDashLine, MediumDotDashLine}" | Enter the desired style. Note the first two plot the data points. |
| Stat "<RMS | StdDev>, <XStepValue>, <XStepUnit>, <Color>" | Display RMS or standard deviation on the graph with error bars. Specify RMS or StdDev followed by the value for the X step, the unit for the X step, and the color to draw the statistic in. This keyword only is used when XIsTIme is false. |
| Overlap < ON | OFF > | MultiGraph only. When Overlap is On, MultiGraph axes will appear in the same chart. When Overlap is Off, MultiGraph charts will be stacked. |
When using the Modify option, you must specify which Segment you are modifying. The following table describes the Segment parameters which are used for the Modify option.
| <Parameters> | Description |
|---|---|
| Segment "<Value>" Color "<Color>" | Enter the segment number, then the color to modify. |
| Segment "<Value>" Gradient "<DataElement>,<Value1>,<Color1>,<Value2>,<Color2>,..." | Enter the segment number, then the data element to modify, followed by a comma separated list of values and colors. See below for format of <DataElement>. |
| Segment "<Value>" BelowColor "<value>" | Enter a color value (named color, RGB, or hue). To turn off the BelowColor, enter Off. This keyword only is used in conjunction with the Segment Gradient keyword. |
| Segment "<Value>" Above "<ON | OFF>" | Define if the segment displays a color for values above the highest specified value. This keyword only is used in conjunction with the Segment Gradient keyword. |
| Segment "<Value>" Point Size "{Small | Large | Medium | Micro}" | Enter the segment number, then the size of the segment point. |
| Segment "<Value>" Point "{1.0 | 1.5 | 2.0 | 2.5 | 3.0}" | Enter the segment number, then the the point. |
The following table describes the parameters which are used for the Add or Modify option.
| <Parameters> | Description |
|---|---|
| DataElement "<DataElement1>,<DataElement2>,..." | A comma separated list of names of the data elements to be plotted.
See below for format of <DataElement>. If only one data element is defined, you must include the XIsTime parameter. |
| XIsTime | Enter to specify that the x-axis will show time. |
| Labels "<Name1>,<Name2>,..." | A comma separated list of Y-axis labels. If graph is of type MultiGraph and X-axis is not time, then the user can specify the X-axis label after all the Y-axis labels. |
| Units "<Unit1>,<Unit2>,..." | A comma separated list of unit names to use for Y-axis. If graph is of type MultiGraph and X-axis is not time, then the user can specify the X-axis unit after all the Y-axis units. |
| TimeConstraint "<Value>" . | Specify the name of a time constraint. This parameter supports fully qualified names as well as just the middle word of the name. |
| HorizontalLine "<value>,<label text>,<color>" | Enter horizontal line information. If using the Modify option, you also have an {On | Off} toggle option. |
| Step "<value>" | Enter the name of an STK object to use its time step to "thin" the data. Additionally, this keyword accepts a double value which enables you to use a manual time step value. If using the Modify option, you have the option to set this parameter to None. |
| Overlay "<value>" | List of file, color, line thickness {thin, medium, thick}, line type {line solid, line dash, line dot, square, triangle, dot}, transparency value, fill color, fill transparency (Only the file value is required; the rest are optional).
Each of these values have a default value. These values can be overwritten by the header values in the file. Lastly, values defined on this command line override both of these values. If using the Modify option, the file name entered determines the overlay you want to modify. If this file name is not recognized, then a new overlay is created. Header values in the file are ignored when using the Modify command. Also, you have the option to set this parameter to None. |
| Annotation "<Type>,<Subtype>,<Location>,<Color>,<Thickness>,<Label>,<Placement>,<Font Size>,<Specification>,<Span Type>,<Span End Bar Length>, <Span Arrow Tail>" | The Annotation keyword and its definition must come after the Segment keyword and its definition. The attributes Type, SubType, and Location are required. Type: Span, Line, Shape, BoundaryLine, Region. All annotation types support the attribute Translucency: 0-100, with 0 as the default value. Subtype:
Location:
The amount of Location points required for each Subtype varies as follows:
AnnotationName: The unique name of the annotation. Color: The color of the annotation and label. You can define a color using its name, RGB, and numerical value. The default value is Blue. Thickness: Small, Medium, Large. Note that this does not apply to Shape Text annotations. The default is Medium. Label: any random text. Note that the Shape Text supports multiline labels. Specifying "\n" separates the lines. Span supports a label at each end. The default value is "". Placement:
Font Size: Value range is 8–18. Specification: Applies to Line Annotations only. See Graph Annotations for how these are shown in the graph statistic summary. The default value is None. Single Line: None, Min, Max. Two Lines: None, Inside, Outside. Span type: Line, LineWithArrows, ArrowsInside, ArrowsOutside. Default is Line. Span End Bar Length: The length in pixels of the end bars of the span. Value range is 2–200. Default value is 10. Span Arrow Tail: The length in pixels of the arrow tails. Value range is 2–200. Default value is 30. A MultiGraph can have multiple graph segments each in its own section. You can specify which section the annotation belongs in by specifying the Annotation after that Segment keyword. Modify adds an index as the value of the Annotation keyword to designate which annotation is being modified. The index starts at 1. Modify also adds a special Type value of "Delete". If you specify just the index and "Delete", then that annotation will be removed from the graph. Note that to modify an attribute at the end of the list, you must specify the first three required attributes. |
| Regression"<Name>,<AnalysisObject>,<Segment>,<Color>,<Thickness>,<Label>,<FontSize>,<LineStyle>,<Label>,<ShowR>,<ShowEq>" | Enables you to create a regression line. The attributes Name, AnalysisObject, and Segment are required.
The ShowR attribute enables you to display a text annotation with the value of the regression. Values are On and Off. The default value is On. The ShowEq attribute enables you to display the equation as a separate text annotation for the straight line. Values are On and Off. The default value is Off. |
| AnimationLine "<Color>" | Enter a color.
If using the Modify option, you also have an {On | Off} toggle option. |
| ConnectDots "{On | Off}" | |
| ExtentY "<Value>" | Define a specific Y axis limit. This value is in the current units. |
| ExtentX "<Value>" | Define a specific X axis limit. This value is in the current units. |
| SlideTrail "<Value>" | Define the trail minutes in the slide window of the graph. |
| SlideLead "<Value>" | Define the lead minutes in the slide window of the graph. If the trail and lead values are 0, slide mode is disabled. |
| SlideDynamic "<On | Off>" | When enabled, the graph displays only dynamic data points and hides the other data points. This option is only available when "X" is not the time and Slide Mode is enabled. |
| FastAnimation "<On | Off>" | Toggle if using fast animations. |
| Position "<Value>,<Value>,<Value>,<Value>" | Enter two (x,y) positive integers to define the position of the graph, or enter four (x,y,w,h) positive integers to define the position and size of the graph. |
| Stat "< On | Off >" | Show / Hide graph statistics |
| Show "<On | Off>" | Show/Hide the graphic element. |
| XAxisScale "<Standard | Logarithmic>" | Set scale used for X-axis. Default is Standard. Logarithmic scale is only available when "X" is not the time and when all X values are greater than 0. |
| YAxisScale "<Standard | Logarithmic>" | Set scale used for Y-axis. Default is Standard. Logarithmic scale is only available when all Y values are greater than 0. |
| ShowLegend "<On | Off>" | Show/Hide the graph legend. |
| LegendStyle "<OneLine>,<TwoLine><OneLineInside>" | Change the location of the graph legend. Note that for a Multigraph, OneLineInside displays a legend in each axis. |
| ShowBoxLegend "<On | Off> | Show/Hide the graph box legend. |
| BoxLegendLocation | The legend can be shown at: OutsideTop, OutsideLeft, OutsideRight, OutsideBottom, InsideTop, InsideLeft, InsideRight, InsideBottom |
| ShowContourLegend "<On | Off>" | Show/Hide the Contour Graph legend. |
| ContourLegendSize "<Value>" | Define the size of the contour legend. Acceptable values are 30-300, with 100 being the default value. For reference, a value of 30 will make the legend 1/3 smaller, whereas a value of 300 will make the legend 3x larger. |
| ContourLegendPosition "<Value>" | Define the position of the contour legend. This parameter accepts three integers. The first integer is the index of the graph sgement, and the second and third integers are the x,y position of the segment's contour legend. The index starts at one and the coordinates must be positive. The default position of the legend is 10 index of the graph segment. Therefore, if the index of the segment is 1, the default position will be (10,10). |
| ShowStatisticsTable "<On | Off>" | Show/Hide the Box and Whisker Statistics table. This table displays the Mean, Variance, Median, IQR (Interquartile Range), Min, and Max for the data element(s). |
| ShowStatisticsAnnot "<On | Off>" | Show/Hide Box and Whisker annotations. |
Color may be entered using name, value or %rgb.
The format for specifying <DataElement> is: "[<SourceName> |] <ShortName>". If the <ShortName> is enough to identify the element then just enter that. Otherwise, include the <SourceName> followed by the | (bar), before the <ShortName>. Refer to examples of each below.
The Overlay will the line properties that are defined in the head of the file if not defined in the command. Values entered using the Overlay command will override values in the head of the file.
The following table describes the parameters for the Save and Delete options.
| <Parameters> | Description |
|---|---|
| File "<Filepath>" | Enter the filepath for a graph to be saved to. |
| OverlaySummary "<Files>" | Save individual overlay file names, or save all overlay file names. |
The Refresh option is used to re-request the graph data and display it. It does not require any parameters other than Name and AnalysisObject.
Examples
A simple graph Latitude vs time
A graph with two lines of the same dimension limited to a certain time constraint
Defining the pixel size of a track point.
A simple multigraph of three lines vs time
Creating a box and whisker graph plot
Creating a box and whisker graph plot with multiple segments
Creating a single element Box and Whisker plot graph with the Statistics Table and Annotations Displayed
Creating a histogram graph
A graph using a color gradient, line style, and time step
A graph using scalar value, line style, and horizontal line
A graph using an overlay
A graph with Legend
A graph with Box Legend
Adding and editing Annotations
Creating a regression line with annotations.
A multigraph with labels, units, animation line and connecting dots
A multigraph with labels, units when X is not time
Saving a graph previously generated. (T&E 1.5)
Creating a graph specifying SourceName and ShortName for various data elements:
Creating a graph specifying the Below Color while also disabling the Above option:
Modifying a graph's segment color:
Adding a .BMP image as a graph's background:
Defining a graph's background color:
Creating a graph with RMS statistics
Creating a graph with standard deviation
Show a Contour Legend and define its size
Define the position of a Contour Legend
Return message
Group membership
This command belongs to the following group(s):
You can use TETK Connect commands in TETK scenarios for pre-flight planning, post-flight analysis, and to support analysis workflows.
You should not use TETK Connect commands when real-time propagators are creating STK vehicles and using STK features instantaneously. The use of Connect commands in a real-time application requires more computational power than STK can support.
TETK functionality that is commonly referred to as "real-time" is actually an offline analysis mode. In this mode, an STK/TETK scenario is prepared with data that is streamed to a particular time in a mission. The post-flight analysis can be prepared again on demand throughout the mission for the data for each time of request. You can use TETK Connect commands in these scenarios.
Version
12.2