Define and modify Spatial Condition components and templates.
SpatialTool <ScenarioPath> <ParentObject> {Action} {Spatial Condition | Spatial ConditionTemplate} <Spatial ConditionName> [{Spatial ConditionType} <Spatial ConditionTypeParams>]
The SpatialTool Spatial Condition command is used to add, modify and delete Spatial Condition 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 Spatial ConditionTemplate keyword must be entered.
The following table provides a description of {Action} values and the applicable parameters:
{Action} | Parameters | Description |
---|---|---|
Create | {Spatial ConditionType} [<Spatial ConditionTypeParams>] | <Spatial ConditionTypeParams> are optional, except where noted below. If no <Spatial ConditionTypeParams> are specified, default values are used. |
Modify | {Spatial ConditionType} <Spatial ConditionTypeParams> | The values <Spatial ConditionName> {Spatial ConditionType} must define an existing Spatial Condition component or template. The {Spatial ConditionType} can not be modified. <Spatial ConditionTypeParams> are required. |
Delete | N/A | Delete the component or template identified by <Spatial ConditionName> |
The following table describes each Spatial Condition type and it's parameters.
{Spatial ConditionType} | <Spatial ConditionTypeParams> |
---|---|
"Access To Location" |
Any or all of the following keyword-value pairs can be specified:
Note: The GridObject parameter is required when Creating the "Access To Location" Spatial Condition. Note: The "Access To Location" Spatial Condition is not valid for Central Bodies. |
"Combined" |
Any or all of the following keyword-value pairs can be specified:
Note: The SpatialConditionA and SpatialConditionB parameters are required when Creating the "Combined" Spatial Condition. |
"Condition At Location" |
Any or all of the following keyword-value pairs can be specified:
Advanced options:
If SetTimeLimits is set to Local then the time interval or interval list specified by the TimeLimits parameter will be used. The "<IntervalOrIntervalList>" should include the time component type, e.g. "Satellite/Sat1 EphemerisTimeSpan Interval"
Parameters for SamplingType FixedStep:
Parameters for SamplingType RelativeTolerance:
Parameters for SamplingType CurvatureTolerance:
<TimeStep>, <StepBound>, <MinStep> and <MaxStep> are entered in Connect time units and must be between 1e-13 and 99999999999.0. <RelTol>, and <CurveTol> must be between 1e-13 and 1.0 <AbsTol> must be greater or equal to 1e-13 Parameters for Convergence: Parameters for Convergence:
<TimeTol> is entered in Connect time units, and must be between 1e-13 and 99999999999.0. <ConvergeAbsTol> must be greater or equal to 1e-13 <ConvergeRelTol> must be between 1e-13 and 1.0 Note: The Condition parameter is required when Creating the "Condition At Location" Spatial Condition. Note: The "Condition At Location" Spatial Condition is not valid for Central Bodies. |
"Over Time" |
Any or all of the following keyword-value pairs can be specified:
The StartOffset and StopOffset are used when DurationType is set to SlidingWindow. The <Value> is entered in Connect Time units and the StartOffset must be less than the StopOffset. The ReferenceIntervals "<IntervalOrIntervalList>" can be an Interval component or an Interval List component and should include the time component type, e.g. "Satellite/Sat1 EphemerisTimeSpan Interval" Note: The OriginalSpatialCondition and ReferenceIntervals parameters are required when Creating the "Over Time" Spatial Condition. |
"Spatial Calculation Bounds" |
Any or all of the following keyword-value pairs can be specified:
The <Value> for Minimum and Maximum should be entered in the units of the specified Spatial Calculation. |
"Valid Time At Location" |
The Intervals "<IntervalOrIntervalList>" can be an Interval component or an Interval List component and should include the time component type, e.g. "Satellite/Sat1 EphemerisTimeSpan Interval" Note: The "Valid Time At Location" Spatial Condition is not valid for Central Bodies. |
For details on the format of a reference component (e.g. "<IntervalList>", "<SpatialCondition>", etc) see Component Specification.
To create and modify a Spatial Calculation Bounds Spatial Condition:
SpatialTool * Satellite/ScenTestSat Create "Spatial Condition" SatCond6 "Spatial Calculation Bounds"
SpatialTool * Satellite/ScenTestSat Modify "Spatial Condition" SatCond6 "Spatial Calculation Bounds" SpatialCalculation "Satellite/ScenTestSat SatSCalc1 Spatial Calculation"
To create and modify a Condition At Location Spatial Condition:
SpatialTool * Satellite/ScenTestSat Create "Spatial Condition" SatCond5 "Condition At Location" Condition "Satellite/ScenTestSat AfterStart Condition"
SpatialTool * Satellite/ScenTestSat Modify "Spatial Condition" SatCond5 "Condition At Location" MinimumTimeStep 38.0 SamplingType RelativeTolerance MaximumTimeStep 1845.67 StepAtBoundaries 45.0
To create and then delete a Combined Spatial Condition:
SpatialTool * Facility/ScenTestFac Create "Spatial Condition" FacVol3 "Combined" SpatialConditionA "Satellite/ScenTestSat2/Sensor/Sensor1 SnVol1 Spatial Condition" SpatialConditionB "Facility/ScenTestFac FacVol1 Spatial Condition"
SpatialTool * Facility/ScenTestFac Delete "Spatial Condition" FacVol3 "Combined"
If activated, Connect returns an acknowledgement message.
This command belongs to the following group(s):
11
STK Programming Interface 11.0.1