VectorTool Vector
Define and modify Vector geometry components and templates.
Syntax
VectorTool <ScenarioPath> <ParentObject> {Action} {Vector | VectorTemplate} <VectorName> [{VectorType} <VectorTypeParams>]
Related commands
Description
Use the VectorTool Vector command to add, modify, and delete Vector geometry components and templates.
For a component object, the <ParentObject> is a truncated object path or a central body path.
For a template, the <ParentObject> is an STK class name, and you must enter the VectorTemplate keyword.
The following table provides a description of {Action} values and the applicable parameters. You can enter labels for the X and Y axes for all Vector types.
| {Action} | Parameters | Description |
|---|---|---|
| Create | {VectorType} [<VectorTypeParams>] | <VectorTypeParams> are optional, except where noted below. If you do not specify <VectorTypeParams>, STK will apply default values. |
| Modify | {VectorType} <VectorTypeParams> | The values <VectorName> {VectorType} must define an existing Vector component or template. You cannot modify the {VectorType}. <VectorTypeParams> are required. |
| Delete | N/A | Deletes the component or template identified by <VectorName> |
The following table describes each Vector type and its parameters.
| {VectorType} | <VectorTypeParams> | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| "Acceleration" | You can specify any or all of the following keyword-value pairs:
Enter DiffTimeStep <Step> in Connect time units. The value must be greater than or equal to 0.000001 seconds. | ||||||||||
| "Angle Rate" | "<Angle>" [<DiffTimeStep>]
Enter <DiffTimeStep> in Connect time units. The value must be greater than or equal to 0.000001 seconds. | ||||||||||
| "Angular Velocity" | "<Axes>" "<ReferenceAxes>" [<DiffTimeStep>]
Enter <DiffTimeStep> in Connect time units. The value must be greater than or equal to 0.000001 seconds. | ||||||||||
| "Apoapsis" | <CentralBodyName> "<ReferencePoint>" {Osculating | BrouwerLyddaneShort | BrouwerLyddaneLong | Kozai}
The <ParentObject> for the "Apoapsis" type must be a Satellite. | ||||||||||
| "Coning" | You can specify any or all of the following keyword-value pairs:
StartAngle <Value> is entered in degrees. The default value is 0.0 degrees. StopAngle <Value> is entered in degrees. The default value is 360.0 degrees. Enter Epoch "<Epoch>" in Connect Date units. The default value is the object's start time. Enter Rate <Rate> in Degrees/ConnectTimeUnit. The default value is 3 degrees/second. | ||||||||||
| "Cross Product" | "<VectorA>" "<VectorB>" [Normalize {On | Off}] [Dimension <DimensionName>]
You can only set the Dimension set if Normalize is Off. | ||||||||||
| ComputeVelocity | "<DerivativeOfInterpolatingPolynomial>" "<ForwardDifference>" "<BackwardDifference>" "<CentralDifference>"
By default, the velocity is computed as the derivative of the interpolating polynomial for position, consistent with previous behavior, unless you set ComputeVelocity to one of the other values. This is provided to generate nonzero velocity when the interpolation order in the file is set to zero. | ||||||||||
| "Custom Inline Script" | You can specify any or all of the following keyword-value pairs:
XFunction, YFunction, ZFunction and at least one Argument are required on the Create command. There must be at least as many arguments defined as are specified in the functions. For example, if a function is defined as "x1+(t*x2)", there must be at least two arguments defined, x1 and x2. When using Inline Script components, you may see error pop-ups from the scripts when there are errors in the functions that have been defined. Most of these errors will be caught when a Custom Inline Script component is created. You must fix all errors before using the component. The XDerivativeFunction, YDerivativeFunction, and ZDerivativeFunction must all be defined, or all must be undefined. You can clear these functions by setting the value to an empty string, for example, XDerivativeFunction "". Enter "Arguments Add" to add the specified Scalar Calculations to the arguments list, and enter "Arguments Replace" to replace the Scalar Calculations in the argument list. <NumberOfScalars> indicates the number of Scalar Calculations entered. For the RemoveArgument option, enter the index number of the component to be removed. The first component in the list has an index of 1. Use the VectorTool_R with the Details option to see the list of components. | ||||||||||
| "Custom Script" | {Reload | <CustomOption>}
<CustomOption> can be any or all of:
Reload is valid for the Modify command only. Filename <FilePath> option is required when Creating the "Custom Script" Vector "<FilePath>" can be a file with the following extensions: .m, .vbs, or .dll (PC only). The "<FilePath>" value should include a full path. Custom Script files must be located in a hierarchy of predetermined directories. For more information, see Plugin Script Reference. The option {InvalidOnExec} was deprecated in STK 10. You must not enter it. | ||||||||||
| "Derivative" | "<Vector>" "<ReferenceAxes>" [<DiffTimeStep>] [<ForceUseOfNumericalDifferences> {Yes | No}]
Enter <DiffTimeStep> in Connect time units. The value must be greater than or equal to 0.000001 seconds. | ||||||||||
| "Displacement" | "<OriginPoint>" "<DestinationPoint>" [{Apparent} [{IgnoreAberration} {Receive | Transmit} "<ReferenceSystem>"]]
Valid values for {Apparent} and {IgnoreAberration} are On and Off. | ||||||||||
| "Displacement on Surface" | You can specify any or all of the following keyword-value pairs:
The <ParentObject> for the "Displacement on Surface" type cannot be a Star. Enter DiffTimeStep <Step> in Connect time units. The value must be greater than or equal to 0.000001 seconds. | ||||||||||
| "Eccentricity" | <CentralBodyName> "<ReferencePoint>" {Osculating | BrouwerLyddaneShort | BrouwerLyddaneLong | Kozai}
The <ParentObject> for the "Eccentricity" type must be a Satellite. | ||||||||||
| "File" | {Filename "<FilePath>" | Reload} [StartTime {TimeInstant}] [OverrideStartTime {Yes | No}]
"<FilePath>" is a vector data (*.vd) file. Reload is valid for the Modify command only. You must enter either Filename "<FilePath>" or Reload on each Vector "File" command. For valid {TimeInstant} values, see Time Options. "<FilePath>" can be the path to a file on your local drive or the path to a file on an SDF server. See Specifying Paths for "<SDFFilePath>" syntax information. Sending StartTime {TimeInstant} will turn on the OverrideStartTime option. | ||||||||||
| "Fixed in Axes" | {OrientMethod} <OrientParameters> "<ReferenceAxes>"
Valid values for {OrientMethod} <OrientParameters> are described below this table. | ||||||||||
| "Fixed at Epoch" | "<EpochDate>" "<SourceVector>" ["<ReferenceAxes>"]
Enter "<EpochDate>" in Connect date units. | ||||||||||
| "Fixed at Time Instant" | You can specify any or all of the following keyword-value pairs:
| ||||||||||
| "Force Model" | You can specify any or all of the following options:
The <ParentObject> for the "Force Model" type must be a Satellite. This type of vector is used to visualize individual force model components. The parent Satellite need not be defined using the HPOP propagator. | ||||||||||
| "Intersection" | "<PlaneA>" "<PlaneB>" | ||||||||||
| "Line of Nodes" | <CentralBodyName> "<ReferencePoint>"
The <ParentObject> for the "Line of Nodes" type must be a Satellite. | ||||||||||
| "Linear Combination" | You can specify any or all of the following keyword-value pairs:
<Factor> is a unitless value. | ||||||||||
| "Linear Scalar Combination" | You can specify any or all of the following keyword-value pairs:
<Factor> is a unitless value. | ||||||||||
| "Model Attachment" | "<MdlAttachPoint>"
A valid <MdlAttachPoint> is determined by the attach points specified in the parent object's model file. "<MdlAttachPoint>" is a required parameter. The <ParentObject> for the "Model Attachment" type must be an object for which a model is valid: Satellite, Facility, etc. The "Model Attachment" Vector type is not valid for Templates. | ||||||||||
| "Orbit Angular Momentum" | <CentralBodyName> "<ReferencePoint>" {Osculating | BrouwerLyddaneShort | BrouwerLyddaneLong | Kozai}
The <ParentObject> for the "Orbit Angular Momentum" type must be a Satellite. | ||||||||||
| "Orbit Normal" | <CentralBodyName> "<ReferencePoint>" {Osculating | BrouwerLyddaneShort | BrouwerLyddaneLong | Kozai}
The <ParentObject> for the "Orbit Normal" type must be a Satellite. | ||||||||||
| "Periapsis" | <CentralBodyName> "<ReferencePoint>" {Osculating | BrouwerLyddaneShort | BrouwerLyddaneLong | Kozai}
The <ParentObject> for the "Periapsis" type must be a Satellite. | ||||||||||
| "Plugin" |
The Reset parameter is valid for a Modify command only. The "<ProgID>" value is the ProgID that was used to register the plugin. The PluginName "<ProgID>" parameter is required when creating the "Plugin" Vector. The "Plugin" Vector type is not valid for Templates. | ||||||||||
| "Projection" | "<Vector>" "<Plane>" | ||||||||||
| "Projection Along Vector" | "<SourceVector>" "<DestinationVector>" | ||||||||||
| "Reflection" | "<IncomingVector>" {UseOpposite} "<NormalVector>" <Scale> {AllowBackside}
Valid values for {UseOpposite} and {AllowBackside} are On and Off. <Scale> is a real number. | ||||||||||
| "Rotation Vector" | "<Axes>" "<Reference Axes>" [<ForceUseMinimumRotation>]
You can set ForceUseMinimumRotation to Yes/True/No/False. | ||||||||||
| "Scaled" | "<ReferenceVector>" <Scale> {Normalize}
Valid values for {Normalize} are On and Off. <Scale> is a real number. | ||||||||||
| "Scaled by Scalar" | You can specify any or all of the following keyword-value pairs:
<Factor> is a unitless value. | ||||||||||
| "Scheduled" | You can specify any or all of the following keyword-value pairs:
The ReferenceIntervals "<Interval or List>" and Schedule "<Interval or List>" can be an Interval component or Interval List component and should include the time component type, e.g., "Satellite/Sat1 EphemerisInterval Interval List". The Normalize keyword controls whether the resulting vector will be normalized or not. If not normalized, the value being returned will be the value from the On or Off vector or an interpolated value during slewing. During slewing, the magnitude of the vector will be interpolated from the magnitudes at the beginning and end of the slew. The Dimension of the vector will be taken as that of the OnSchedule vector, even when the value from the OffSchedule vector is being used. Slew Options:
Enter SlewWindowDuration <value> and SlewMinOffSchedule <value> in Connect time units. Enter the SlewMaxRate <value> in degrees/Connect time. This constraint is on by default, and you can't turn it off. Enter the SlewMaxAcceleration <value> in degrees/Connect time^2. Entering <value> turns on the constraint. Advanced options:
Parameters for SamplingType FixedStep:
Parameters for SamplingType RelativeTolerance:
Parameters for SamplingType CurvatureTolerance:
Enter <TimeStep>, <StepBound>, <MinStep>, and <MaxStep> in Connect time units. Their values must be between 1e-13 and 99999999999.0. <RelTol>, and <CurveTol> must be between 1e-13 and 1.0. <AbsTol> must be greater than or equal to 1e-13. Parameters for Convergence:
Enter <TimeTol> in Connect time units. The value must be between 1e-13 and 99999999999.0. <ConvergeAbsTol> must be greater than or equal to 1e-13. <ConvergeRelTol> must be between 1e-13 and 1.0. | ||||||||||
| "To Star" | <StarObjPath> | ||||||||||
| "Velocity" | You can specify any or all of the following keyword-value pairs:
Enter <Step> in Connect time units. The value must be greater than or equal to 0.000001 seconds. |
Description of {OrientMethod} <OrientParams>
| {VectorType} | {OrientMethod} | <OrientParams> |
|---|---|---|
| "Fixed in Axes" | Spherical | <RightAsc> <Declin> <Distance>
Enter <RightAsc> and <Declin> in degrees. Enter <Distance> in Connect Distance units. |
| Cartesian | <X> <Y> <Z>
Enter <X>, <Y>, and <Z> in Connect Distance units. |
For details on the format of a reference component, such as "<ReferencePoint>", "<Vector>", or "<ReferenceAxes>", see Component Specification.
When specifying a reference component or template in the Create or Modify commands, the {ComponentType} is implied based on the {VectorType} being created or modified, so you need not enter {ComponentType}. In the first example below, "CentralBody/Earth SunRA Angle" is entered as "CentralBody/Earth SunRA", since the command is expecting an angle.
Examples
To create an Angle Rate Vector and then modify it:
To create and modify a Fixed at Time Instant Vector:
To create a Coning vector for Satellite1:
Examples
The following commands will create and modify a Force Model Vector:
Examples
To create a Cross Product Vector made up of two "To Vectors":
Examples
To create and modify a Custom Inline Script Vector:
Return message
Group membership
This command belongs to the following group(s):
Version
12.8