Description | Example | Return Message | Group

VectorTool Vector

Define and modify Vector geometry components and templates.

Syntax

VectorTool <ScenarioPath> <ParentObject> {Action} {Vector | VectorTemplate} <VectorName> [{VectorType} <VectorTypeParams>]

Related Commands

Description

The VectorTool Vector command is used 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 the VectorTemplate keyword must be entered.

The following table provides a description of {Action} values and the applicable parameters. Labels for the X and Y axis can be optionally be entered for all Vector types.

{Action} Parameters Description
Create {VectorType} [<VectorTypeParams>] <VectorTypeParams> are optional, except where noted below. If no <VectorTypeParams> are specified, default values are used.
Modify {VectorType} <VectorTypeParams> The values <VectorName> {VectorType} must define an existing Vector component or template. The {VectorType} can not be modified. <VectorTypeParams> are required.
Delete N/A Delete the component or template identified by <VectorName>

The following table describes each Vector type and it's parameters.

{VectorType} <VectorTypeParams>
"Acceleration"

Any or all of the following keyword-value pairs can be specified:

  • Point "<Point>"
  • ReferenceSystem "<System>"
  • DiffTimeStep <Step>

DiffTimeStep <Step> is entered in Connect time units, and must be greater or equal to 0.000001 seconds.

"Angle Rate" "<Angle>" [<DiffTimeStep>]

<DiffTimeStep> is entered in Connect time units, and must be greater or equal to 0.000001 seconds.

"Angular Velocity" "<Axes>" "<ReferenceAxes>" [<DiffTimeStep>]

<DiffTimeStep> is entered in Connect time units, and must be greater or equal to 0.000001 seconds.

"Apoapsis" <CentralBodyName> "<ReferencePoint>" {Osculating | BrouwerLyddaneShort | BrouwerLyddaneLong | Kozai}

Note: The <ParentObject> for the "Apoapsis" type must be a Satellite.

"Coning"

Any or all of the following keyword-value pairs can be specified:

  • AboutVector "<Vector>"
  • ReferenceVector "<Vector>"
  • StartAngle <Value>
  • StopAngle <Value>
  • Epoch "<Epoch>"
  • Rate <Rate>
  • Direction {Uni | Bi}

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.

Epoch "<Epoch>" is entered in Connect Date units. The default value is the object's start time.

Rate <Rate> is entered in Degrees/ConnectTimeUnit. The default value is 3 degrees/second.

"Cross Product" "<VectorA>" "<VectorB>" [Normalize {On | Off}] [Dimension <DimensionName>]

The Dimension can only be set if Normalize is Off.

"Custom Script" {Reload | <CustomOption>}

<CustomOption> can be any or all of:

  • Filename "<FilePath>"
  • ReferenceAxes "<Axes>"
  • Dimension <DimensionName>

Reload is valid for the Modify command only.

Note: Filename <FilePath> option is required when Creating the "Custom Script" Vector

"<FilePath>" can be a .m, .pl, .vbs or .dll (PC only) file. The "<FilePath>" value should include a full path. Custom Script files must be located in a hierarchy of pre-determined directories.

For more information see Plugin Script Reference

The option {InvalidOnExec} was deprecated in STK10, it cannot be entered.

"Derivative" "<Vector>" "<ReferenceAxes>" [<DiffTimeStep>]

<DiffTimeStep> is entered in Connect time units, and must be greater 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"

Any or all of the following keyword-value pairs can be specified:

  • OriginPoint "<Point>"
  • DestinationPoint "<Point>"
  • SurfaceCB <CBName>
  • DiffTimeStep <Value>

Note: The <ParentObject> for the "Displacement on Surface" type cannot be a Star.

DiffTimeStep <Step> is entered in Connect time units, and must be greater or equal to 0.000001 seconds.

"Eccentricity" <CentralBodyName> "<ReferencePoint>" {Osculating | BrouwerLyddaneShort | BrouwerLyddaneLong | Kozai}

Note: The <ParentObject> for the "Eccentricity" type must be a Satellite.

"File" {"<FilePath>" | Reload} [StartTime {TimeInstant}] [OverrideStartTime {Yes | No}]

"<FilePath>" is a vector data (*.vd) file.

Reload is valid for the Modify command only.

Note: Either "<FilePath>" or Reload must be entered on each Vector "File" command.

For valid {TimeInstant} values see Time Options.

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>"]

"<EpochDate>" is entered in Connect date units.

"Fixed at Time Instant"

Any or all of the following keyword-value pairs can be specified:

  • Instant "<TimeInstant>"
  • SourceVector "<Vector>"
  • ReferenceAxes "<Axes>"
"Force Model"

Any or all of the following options can be specified:

Scale <Value> The default value is 1.0.
CentralBody <CBName> The default is the parent's central body.
Force {ForceModel} <ModelParameters> For valid {ForceModel} <ModelParameters> values see the HPOP Force command. The following additional {ForceModel} options are available for the Force Model Vector:
  • UseCBGravity {On | Off}
  • IgnoreTwoBody {On | Off}
Drag {Options} For valid {Options} see the parameters of the HPOP Drag command.
Options {ForceModelOption} <ModelParameters> For valid {ForceModelOption} <ModelParameters> values see the HPOP Options command. The following {ForceModelOption} are NOT valid for the Force Model Vector: AltitudeCutoff and PropPlugin.

Note: 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>"

Note: The <ParentObject> for the "Line of Nodes" type must be a Satellite.

"Linear Combination"

Any or all of the following keyword-value pairs can be specified:

  • VectorA "<Vector>"
  • ScaleFactorA <Factor>
  • NormalizeA {Yes | No}
  • VectorB "<Vector>"
  • ScaleFactorB <Factor>
  • NormalizeB {Yes | No}
  • InheritDimension {FromA | FromB | No}
  • Dimension <DimensionName>

<Factor> is a unitless value.

"Linear Scalar Combination"

Any or all of the following keyword-value pairs can be specified:

  • VectorA "<Vector>"
  • ScaleFactorA <Factor>
  • NormalizeA {Yes | No}
  • UseScalarA {Yes | No}
  • ScalarA "<Scalar>"
  • VectorB "<Vector>"
  • ScaleFactorB <Factor>
  • NormalizeB {Yes | No}
  • UseScalarB {Yes | No}
  • ScalarB "<Scalar>"
  • InheritDimension {FromA | FromB | No}
  • Dimension <DimensionName>

<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.

Note: "<MdlAttachPoint>" is a required parameter.

Note: The <ParentObject> for the "Model Attachment" type must be an object for which a model is valid, Satellite, Facility, etc.

Note: The "Model Attachment" Vector type is not valid for Templates.

"Orbit Angular Momentum" <CentralBodyName> "<ReferencePoint>" {Osculating | BrouwerLyddaneShort | BrouwerLyddaneLong | Kozai}

Note: The <ParentObject> for the "Orbit Angular Momentum" type must be a Satellite.

"Orbit Normal" <CentralBodyName> "<ReferencePoint>" {Osculating | BrouwerLyddaneShort | BrouwerLyddaneLong | Kozai}

Note: The <ParentObject> for the "Orbit Normal" type must be a Satellite.

"Periapsis" <CentralBodyName> "<ReferencePoint>" {Osculating | BrouwerLyddaneShort | BrouwerLyddaneLong | Kozai}

Note: The <ParentObject> for the "Periapsis" type must be a Satellite.

"Plugin"
  • PluginName "<PluginName>"
  • Reset

The Reset parameter is valid for a Modify command only.

Note: The PluginName "<PluginName>" parameter is required when Creating the "Plugin" Vector

Note: 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.

"Scaled" "<ReferenceVector>" <Scale> {Normalize}

Valid values for {Normalize} are On and Off.

<Scale> is a real number.

"Scaled by Scalar"

Any or all of the following keyword-value pairs can be specified:

  • Vector "<Vector>"
  • ScaleFactor <Factor>
  • Normalize {Yes | No}
  • Scalar "<Scalar>"
  • UseScalar {Yes | No}
  • InheritDimension {Yes | No}
  • Dimension <DimensionName>

<Factor> is a unitless value.

"To Star" <StarObjPath>
"Velocity"

Any or all of the following keyword-value pairs can be specified:

  • Point "<Point>"
  • ReferenceSystem "<System>"
  • DiffTimeStep <Step>

<Step> is entered in Connect time units, and must be greater or equal to 0.000001 seconds.

Description of {OrientMethod} <OrientParams>

{VectorType} {OrientMethod} <OrientParams>
"Fixed in Axes" Spherical <RightAsc> <Declin> <Distance>

<RightAsc> and <Declin> are entered in Degrees, <Distance> is entered in Connect Distance units.

Cartesian <X> <Y> <Z>

<X> <Y> and <Z> are entered in Connect Distance units.

For details on the format of a reference component (e.g. "<ReferencePoint>", "<Vector>", "<ReferenceAxes>", etc) 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 and the {ComponentType} need not be entered. In the first example below, "CentralBody/Earth SunRA Angle" is entered as "CentralBody/Earth SunRA", since the command is expecting an angle.

Example

To create an Angle Rate Vector and then modify it:

VectorTool * Facility/ScenTestFac Create Vector FacVector2 "Angle Rate"

VectorTool * Facility/ScenTestFac Modify Vector FacVector2 "Angle Rate" "CentralBody/Earth SunRA" 0.25

To create and modify a Fixed at Time Instant Vector:

VectorTool * Satellite/ScenTestSat Create Vector TestVector14 "Fixed at Time Instant"

VectorTool * Satellite/ScenTestSat Modify Vector TestVector14 "Fixed at Time Instant" Instant "Aircraft/ScenTestAC AvailabilityIntervals.Span.Start" SourceVector "Satellite/ScenTestSat Position"

To create a Coning vector for Satellite1:

VectorTool * Satellite/Satellite1 Create Vector SatVec1 "Coning" AboutVector "Satellite/Satellite1 Velocity" StartAngle 45.0 StopAngle 120.0

Example

The following commands will create and modify a Force Model Vector:

VectorTool * Satellite/A_Satellite Create Vector FM7 "Force Model" Force RadiationPressure Albedo On Coefficient 56

VectorTool * Satellite/A_Satellite Modify Vector FM7 "Force Model" Drag On -6 1234 "Harris-Priester" Manual 255

VectorTool * Satellite/A_Satellite Modify Vector FM7 "Force Model" Scale 3.0 CentralBody Moon

VectorTool * Satellite/A_Satellite Modify Vector FM7 "Force Model" Options SunPositionMethod Apparent Mass 1234.5 FluxUpdate 3Hour

VectorTool * Satellite/A_Satellite Modify Vector FM7 "Force Model" Force SRP On ShadowModel None Model Spherical 0.123 221.1

To create, modify and then delete a Displacement Vector template:

VectorTool * Satellite Create VectorTemplate SatVectorT1 "Displacement"

VectorTool * Satellite Modify VectorTemplate SatVectorT1 "Displacement" "CentralBody/Earth L1" "Satellite Center"

VectorTool * Satellite Delete VectorTemplate SatVectorT1

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Area Targets

Attitude

Comm

Facilities, Places & Targets

Line Targets

Radar

Scenarios

Sensors

Stars & Planets

Object Tools

Vehicles

VO

VO Objects

Version

11

STK Programming Interface 11.0.1