VectorTool Point
Define and modify Point geometry components and templates.
Syntax
VectorTool <ScenarioPath> <ParentObject> {Action} {Point | PointTemplate} <PointName> [{PointType} <PointTypeParams>]
Related commands
Description
Use the VectorTool Point command to add, modify, and delete Point 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 PointTemplate keyword.
The Point component type is not valid for Star objects.
The following table provides a description of {Action} values and the applicable parameters:
| {Action} | Parameters | Description |
|---|---|---|
| Create | {PointType} [<PointTypeParams>] | <PointTypeParams> are optional, except where noted below. If you do not specify <PointTypeParams>, STK will use default values. |
| Modify | {PointType} <PointTypeParams> | The values <PointName> {PointType} must define an existing Point component or template. You cannot modify the {PointType}. <PointTypeParams> are required. |
| Delete | N/A | Deletes the component or template identified by <PointName>. |
The following table describes each Point type and its parameters.
| {PointType} | <PointTypeParams> |
|---|---|
| "B-Plane" | <CentralBodyName> "<TrajPoint>" {Incoming | Outgoing} {Asymptote | TwoBody}
The <ParentObject> for the "B-Plane" type must be a Satellite object. |
| "Central Body Grazing" | "<ReferencePoint>" "<DirectionVector>" <CentralBodyName> <Altitude>
Enter <Altitude> in Connect distance units. You can enter a negative value for Altitude, but ensure the value does not exceed the length of the smallest semi-axis of the shape. Prior to STK 10, this Point type was named "CB Grazing". |
| "Central Body Intersection" | You can specify any or all of the following keyword-value pairs:
Enter <Altitude> in Connect distance units. You can enter a negative value for Altitude, but ensure the value does not exceed the length of the smallest semi-axis of the shape. Enter <Range> in Connect distance units, greater than or equal to 0.0. UseRangeConstraint On is only valid if ReferencePoint is a center point of an object that supports a range constraint. If UseRangeConstraint is Off, then you can enter UseMinimumRange, MinimumRange, UseMaximumRange, and MaximumRange. Enter DiffTimeStep <Step> in Connect time units, greater than or equal to 0.000001 seconds. Enter AvailSampleStep <Step> in Connect time units, greater than or equal to 0.000001 seconds. |
| "Custom Inline Script" | You can specify any or all of the following keyword-value pairs can be specified:
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. Any errors must be fixed before using the component. The XDerivativeFunction, YDerivativeFunction, and ZDerivativeFunction must all be defined, or all must be undefined. These functions can be cleared 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. |
| "File" | {Filename "<FilePath>" | Reload} [StartTime {TimeInstant}] [OverrideStartTime {Yes | No}]
"<FilePath>" is an ephemeris (*.e) file. Reload is valid for the Modify command only. You must enter either Filename "<FilePath>" or Reload on each Point "File" command. For valid {TimeInstant} values, see Time Options. "<FilePath>" is the path to a file on your local drive. Sending StartTime {TimeInstant} will turn on the OverrideStartTime option. |
| "Fixed at Time Instant" | You can specify any or all of the following keyword-value pairs:
|
| "Fixed in System" | {Cartesian | Spherical} <OrientParameters> "<RefSystem>"
Valid values for <OrientParameters> are described below this table. |
| "Fixed on Central Body" | You can specify any or all of the following keyword-value pairs:
Valid values for <OrientParameters> are described below this table. SurfaceType MSL is only valid if CentralBody is Earth. |
| "Glint" | <CentralBodyName> "<SourcePoint>" "<ObserverPoint>" |
| "Intersection" | "<DirectionVector>" "<ReferencePlane>" "<OriginPoint>" |
| "Libration" | <CentralBodyName> {L1 | L2 | L3 | L4 | L5} <SecondaryBody> [<SecondaryBody>...]
You can enter as many <SecondaryBody> as needed on the command line. The <ParentObject> for the "Libration" type must be a CentralBody. |
| "Model Attachment" | "<MdlAttachPoint>" [{On | Off}]
A valid <MdlAttachPoint> is determined by the attach points specified in the parent object's model file. Use On or Off to specify whether or not to use the Model Scale."<MdlAttachPoint>" is a required parameter. The <ParentObject> for the "Model Attachment" type must be an object for which a model is valid, such as Satellite, Facility, etc. The "Model Attachment" Point type is not valid for Templates. |
| "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" Point. The "Plugin" Point type is not valid for Templates. |
| "Position Covariance Grazing" | "<ReferencePoint>" "<DirectionVector>" <TargetObjectPath> <Distance> {Scale | Probability} <ScaleProbValue>
<TargetObjectPath> is the truncated path of the target object. Enter <Distance> in Connect distance units. You can enter a negative value for Distance, but ensure the value does not exceed the length of the smallest semi-axis of the shape. <ScaleProbValue> is the Scale or Probability value. The parameters are required when creating the "Position Covariance Grazing" Point. The "Position Covariance Grazing" Point type is not valid for Templates. Prior to STK 10, this Point type was named "Cov Grazing". |
| "Projection" | "<SourcePoint>" "<ReferencePlane>" |
| "SatelliteCollection Entry" | This parameter "collectionEntryName" specifies an entry from the SatelliteCollection object. |
| "Surface" | <CentralBodyName> "<ReferencePoint>" [{Terrain | MSL | Ellipsoid} {Centric | Detic}] |
Description of {OrientMethod} <OrientParameters>
| {PointType} | {OrientMethod} | <OrientParameters> |
|---|---|---|
"Fixed in System" "Fixed on Central Body" | 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. | |
| "Fixed on Central Body" | Geodetic | <Latitude> <Longitude> <Altitude>
Enter <Latitude> and <Longitude> in degrees. <Latitude> should be between -90.0 and 90.0 degrees. <Longitude> should be between -360.0 and 360.0 degrees. Enter <Altitude> in Connect Distance units, greater than 0.0 meters. |
| Geocentric |
For details on the format of a reference component (e.g., "<TrajPoint>", "<RefSystem>", "<TimeInstant>", etc), see Component Specification.
When specifying a reference component or template in the Create or Modify commands, the {ComponentType} is implied based on the {PointType} being created or modified and the {ComponentType} need not be entered. In the example below, "Satellite/ScenTestSat Center Point" is entered as "Satellite/ScenTestSat Center", since the command is expecting a point.
Examples
To create and modify a point based on the Satellite's stop time:
To create a surface point, with the CentralBody Earth as the parent:
To create, modify and then delete an Intersection point template:
Examples
To create and modify a Custom Inline Script Point:
Return message
Group membership
This command belongs to the following group(s):
Version
12.10