The `analysis_workbench` module#

Summary#

Interfaces

`IAnalysisWorkbenchComponent`	A base interface implemented by all VGT components. The methods and properties of the interface provide type information about the VGT component.
`IAnalysisWorkbenchComponentContext`	The interface represents a context associated with a VGT component. All VGT components are associated with a valid context. A context can represent a VGT instance or a VGT template.
`IAnalysisWorkbenchComponentReference`	A base interface for all VGT component references.
`IAnalysisWorkbenchComponentTimeProperties`	Define methods to compute time properties such as availability and special times.
`IAnalysisWorkbenchConvergence`	Represents a base class for convergence definitions.
`IAnalysisWorkbenchDerivative`	Represents a base class for derivative definitions.
`IAnalysisWorkbenchIntegral`	Represents a base class for integral definitions.
`IAnalysisWorkbenchInterpolator`	Represents a base class for interpolation definitions.
`IAnalysisWorkbenchMethodCallResult`	Instances of the interface are used to return the result of a computation.
`IAnalysisWorkbenchSampling`	Base sampling interface.
`IAnalysisWorkbenchSignalDelay`	Signal delay definition determines how long it takes for a signal to propagate from one location to another.
`ICalculationToolCondition`	Condition returns a non-dimensional metric that is positive if satisfied, negative if not satisfied and 0 if on boundary; this provides computational methods needed for accurate detection of condition crossings.
`ICalculationToolConditionSet`	Condition set returns an array of non-dimensional metrics, one for each condition in the set; each metric is positive if corresponding condition is satisfied, negative if not satisfied and 0 if on boundary; this provides computational methods needed for…
`ICalculationToolParameterSet`	Parameter set contains various sets of scalar computations.
`ICalculationToolSamplingMethod`	A sampling method.
`ICalculationToolScalar`	Any scalar calculation that is not constant by construction.
`ISpatialAnalysisToolGridValuesMethod`	A grid values method.
`ISpatialAnalysisToolSpatialCalculation`	A volume calc interface. The methods and properties of the interface provide Volumetric calc functions.
`ISpatialAnalysisToolVolume`	A volume interface. The methods and properties of the interface provide Volume functions.
`ISpatialAnalysisToolVolumeGrid`	A volume grid interface. The methods and properties of the interface provide Volumetric Grid functions.
`ITimeToolInstant`	Define an event (time instant).
`ITimeToolPruneFilter`	A filter used with event interval list pruned class to prune interval lists…
`ITimeToolTimeArray`	An ordered array of times, which may or may not be evenly spaced.
`ITimeToolTimeInterval`	A single time interval.
`ITimeToolTimeIntervalCollection`	A collection of related interval lists.
`ITimeToolTimeIntervalList`	An ordered list of time intervals.
`IVectorGeometryToolAngle`	The interface defines methods and properties common to all angles.
`IVectorGeometryToolAxes`	The interface defines methods and properties common to all axes.
`IVectorGeometryToolPlane`	The interface defines methods and properties common to all VGT planes.
`IVectorGeometryToolPoint`	The interface defines methods and properties common to all points.
`IVectorGeometryToolSystem`	The interface contains methods and properties shared by all VGT systems.
`IVectorGeometryToolVector`	The interface defines methods and properties common to all vectors.

Classes

`AnalysisWorkbenchAngleFindAngleResult`	Contains the results returned with IVectorGeometryToolAngle.FindAngle method.
`AnalysisWorkbenchAngleFindAngleWithRateResult`	Contains the results returned with IVectorGeometryToolAngle.FindAngleWithRate method.
`AnalysisWorkbenchAngleFindResult`	Represents result returned with IVectorGeometryToolAngle.FindCoordinates method.
`AnalysisWorkbenchAngleFindWithRateResult`	Contains the results returned with IVectorGeometryToolAngle.FindCoordinatesWithRate method.
`AnalysisWorkbenchAxesFindInAxesResult`	Contains the results returned with IVectorGeometryToolAxes.FindInAxes method.
`AnalysisWorkbenchAxesFindInAxesWithRateResult`	Contains the results returned with IVectorGeometryToolAxes.FindInAxesWithRate method.
`AnalysisWorkbenchAxesTransformResult`	Contains the results returned with IVectorGeometryToolAxes.TransformFrom method.
`AnalysisWorkbenchAxesTransformWithRateResult`	Contains the results returned with IVectorGeometryToolAxes.TransformFromWithRate method.
`AnalysisWorkbenchCentralBody`	Represents an central body.
`AnalysisWorkbenchCentralBodyCollection`	A collection of central body names.
`AnalysisWorkbenchCentralBodyReference`	Represents a central body reference.
`AnalysisWorkbenchComponent`	Generic VGT component.
`AnalysisWorkbenchComponentCollection`	A collection of VGT objects.
`AnalysisWorkbenchComponentInstance`	Enable to obtain information about the parent object that owns the VGT component.
`AnalysisWorkbenchComponentProvider`	Allow accessing existing Vector Geometry Tool components.
`AnalysisWorkbenchComponentTemplate`	Enable to obtain information about the STK class that owns the VGT component.
`AnalysisWorkbenchComponentTypeInformation`	VGT component info.
`AnalysisWorkbenchConvergence`	Represents a base class for convergence definitions.
`AnalysisWorkbenchDerivative`	Represents a base class for derivative definitions.
`AnalysisWorkbenchIntegral`	Represents a base class for integral definitions.
`AnalysisWorkbenchInterpolator`	Represents a base class for interpolation definitions.
`AnalysisWorkbenchPlaneFindInAxesResult`	Contains the results returned with IVectorGeometryToolPlane.FindInAxes method.
`AnalysisWorkbenchPlaneFindInAxesWithRateResult`	Contains the results returned with IVectorGeometryToolPlane.FindInAxesWithRate method.
`AnalysisWorkbenchPlaneFindInSystemResult`	Contains the results returned with IVectorGeometryToolPlane.FindInSystem method.
`AnalysisWorkbenchPlaneFindInSystemWithRateResult`	Contains the results returned with IVectorGeometryToolPlane.FindInSystemWithRate method.
`AnalysisWorkbenchPointLocateInSystemResult`	Contains the results returned with IVectorGeometryToolPlane.FindInSystemWithRate method.
`AnalysisWorkbenchPointLocateInSystemWithRateResult`	Contains the results returned with IVectorGeometryToolPoint.LocateInSystemWithRate method.
`AnalysisWorkbenchPositionLLA`	A position represented by the Latitude, longtitude and Latitude.
`AnalysisWorkbenchRoot`	Represents a VGT root.
`AnalysisWorkbenchSampling`	Base sampling interface.
`AnalysisWorkbenchSignalDelay`	Signal delay definition determines how long it takes for a signal to propagate from one location to another.
`AnalysisWorkbenchSystemFindInSystemResult`	Contains the results returned with IVectorGeometryToolSystem.FindInSystem method.
`AnalysisWorkbenchSystemTransformResult`	Contains the results returned with IVectorGeometryToolSystem.TransformFrom and IVectorGeometryToolSystem.TransformTo methods.
`AnalysisWorkbenchSystemTransformWithRateResult`	Contains the results returned with IVectorGeometryToolSystem.TransformFromWithRate and IVectorGeometryToolSystem.TransformToWithRate methods.
`AnalysisWorkbenchVectorFindInAxesResult`	Contains the results returned with IVectorGeometryToolVector.FindInAxes method.
`AnalysisWorkbenchVectorFindInAxesWithRateResult`	Contains the results returned with IVectorGeometryToolVector.FindInAxesWithRate method.
`CalculationToolCondition`	Condition returns a non-dimensional metric that is positive if satisfied, negative if not satisfied and 0 if on boundary; this provides computational methods needed for accurate detection of condition crossings.
`CalculationToolConditionCombined`	Define a condition which combines multiple conditions.
`CalculationToolConditionFactory`	The factory creates condition components.
`CalculationToolConditionGroup`	Access or create VGT conditions associated with an object or a central body.
`CalculationToolConditionScalarBounds`	Defined by determining if input scalar is within specified bounds; returns +1 if satisfied, -1 if not satisfied and 0 if on boundary.
`CalculationToolConditionSet`	Condition set returns an array of non-dimensional metrics, one for each condition in the set; each metric is positive if corresponding condition is satisfied, negative if not satisfied and 0 if on boundary; this provides computational methods needed for…
`CalculationToolConditionSetEvaluateResult`	Represents the results returned by ConditionSet.Evaluate.
`CalculationToolConditionSetEvaluateWithRateResult`	Represents the results returned by ConditionSet.EvaluateWithRate.
`CalculationToolConditionSetFactory`	The factory creates condition set components.
`CalculationToolConditionSetGroup`	Allow accessing and creating condition set components.
`CalculationToolConditionSetScalarThresholds`	Condition set based on single scalar calculation compared to set of threshold values.
`CalculationToolConditionTrajectoryWithinVolume`	Defined by determining if input trajectory poiny is within extents of specified volume grid coordinate.
`CalculationToolConvergeBasic`	Convergence definition includes parameters that determine criteria for accurate detection of extrema or condition crossings for scalar calculations.
`CalculationToolDerivativeBasic`	Derivative definition determines how numerical differencing is used to compute derivatives.
`CalculationToolEvaluateResult`	Represents the results of evaluating a scalar component.
`CalculationToolEvaluateWithRateResult`	Represents the results of evaluating a scalar component.
`CalculationToolIntegralBasic`	Integral definition determines how scalar calculation is numerically integrated.
`CalculationToolInterpolatorBasic`	Interpolation definition determines how to obtain values in between tabulated samples. See STK help on interpolation for further details.
`CalculationToolParameterSet`	Parameter set contains various sets of scalar computations.
`CalculationToolParameterSetAttitude`	Attitude parameter set contains various representations of attitude of one set of axes relative to another.
`CalculationToolParameterSetFactory`	The factory is used to create instances of available parameter set types.
`CalculationToolParameterSetGroundTrajectory`	Ground trajectory parameter set contains various representations of trajectory of a point relative to central body reference shape.
`CalculationToolParameterSetGroup`	Access or create VGT parameter sets associated with an object or a central body.
`CalculationToolParameterSetOrbit`	Orbit parameter set contains various trajectory representations of an orbiting point.
`CalculationToolParameterSetTrajectory`	Trajectory parameter set contains various representations of trajectory of a point relative to a reference coordinate system.
`CalculationToolParameterSetVector`	Vector parameter set contains various representations of a vector in a reference set of axes.
`CalculationToolSamplingBasic`	Sampling definition determines how scalar data should be sampled in order to adequately capture trends in that data.
`CalculationToolSamplingCurvatureTolerance`	Curvature tolerance definition includes parameters that determine how scalar data should be sampled based on limits on slope changes between samples.
`CalculationToolSamplingFixedStep`	Fixed step definition includes parameters that determine how scalar data should be sampled based on fixed steps between samples.
`CalculationToolSamplingMethod`	A sampling method.
`CalculationToolSamplingMethodFactory`	The factory creates sampling method components.
`CalculationToolSamplingRelativeTolerance`	Relative tolerance definition includes parameters that determine how scalar data should be sampled based on limits on difference between actual changes between samples and changes predicted by dead reckoning.
`CalculationToolScalar`	Any scalar calculation that is not constant by construction.
`CalculationToolScalarAlongTrajectory`	Scalar value of spatial calculation evaluated along trajectory of point.
`CalculationToolScalarAngle`	Scalar equal to angular displacement obtained from any angle in VGT.
`CalculationToolScalarAverage`	Integral of input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.
`CalculationToolScalarConstant`	Constant scalar value of specified dimension.
`CalculationToolScalarCustom`	A calc scalar based on a scripted algorithm in MATLAB (.m or .dll), Perl or VBScript to define its value and rate.
`CalculationToolScalarCustomInlineScript`	A calc scalar based on using an inline scripted algorithm in MATLAB, Perl, VBScript or JScript to define its value and rate.
`CalculationToolScalarDataElement`	Any time-dependent data element from STK data providers available for parent STK object.
`CalculationToolScalarDerivative`	Derivative of an input scalar calculation.
`CalculationToolScalarDotProduct`	Dot product between two vectors.
`CalculationToolScalarElapsedTime`	Time elapsed since the reference time instant. Negative if in the past.
`CalculationToolScalarFactory`	The factory creates scalar calculation components.
`CalculationToolScalarFile`	Tabulated scalar calculation data loaded from specified file - a file with .csc extension.
`CalculationToolScalarFixedAtTimeInstant`	Constant scalar created by evaluating the input scalar calculation at the specified reference time instant. Undefined if original scalar is not available at specified time or if reference time instant is undefined.
`CalculationToolScalarFunction`	Defined by performing the specified function on the input scalar or time instant.
`CalculationToolScalarFunctionOf2Variables`	Defined by performing a function(x,y) on two scalar arguments.
`CalculationToolScalarGroup`	Access or create VGT calculation scalars associated with an object or a central body.
`CalculationToolScalarIntegral`	Integral of input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.
`CalculationToolScalarPlugin`	Use a scalar calculation plugin.
`CalculationToolScalarStandardDeviation`	Integral of input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.
`CalculationToolScalarSurfaceDistanceBetweenPoints`	Surface distance along the specified central body ellipsoid between two points (or their respective projections if specified at altitude).
`CalculationToolScalarVectorComponent`	The specified component of a vector when resolved in the specified axes.
`CalculationToolScalarVectorMagnitude`	Scalar equal to the magnitude of a specified vector.
`SpatialAnalysisToolAnalysisToolVolumeGridBearingAltitude`	A volume grid bearing alt (Surface Bearing) interface.
`SpatialAnalysisToolCalculationAltitude`	A volume calc altitude interface.
`SpatialAnalysisToolCalculationAngleToLocation`	A volume calc angle off vector interface.
`SpatialAnalysisToolCalculationConditionSatisfactionMetric`	A volume calc condition satisfaction interface.
`SpatialAnalysisToolCalculationDistanceToLocation`	A volume calc distance to location interface.
`SpatialAnalysisToolCalculationFactory`	The factory is used to create instances of volume calcs.
`SpatialAnalysisToolCalculationFile`	Volumetric data loaded from a specified file - A file with .h5 extension. See STK help.
`SpatialAnalysisToolCalculationFromCalculationScalar`	A volume calc scalar to location interface.
`SpatialAnalysisToolCalculationGroup`	Access or create VGT volume calc associated with an object or a central body.
`SpatialAnalysisToolCalculationPropagationDelayToLocation`	A volume calc propagation delay to location interface.
`SpatialAnalysisToolCalculationSolarIntensity`	A volume calc solar intensityn interface.
`SpatialAnalysisToolConditionAccessToLocation`	An Inview volume interface.
`SpatialAnalysisToolConditionCombined`	A combined volume interface.
`SpatialAnalysisToolConditionConditionAtLocation`	A volume from conditioninterface.
`SpatialAnalysisToolConditionFactory`	The factory is used to create instances of volumes.
`SpatialAnalysisToolConditionGridBoundingVolume`	An over time volume interface.
`SpatialAnalysisToolConditionGroup`	Access or create spatial conditions associated with a volume grid.
`SpatialAnalysisToolConditionLighting`	A lighting volume interface.
`SpatialAnalysisToolConditionOverTime`	An over time volume interface.
`SpatialAnalysisToolConditionSpatialCalculationBounds`	An volume from calc volume interface.
`SpatialAnalysisToolConditionValidTimeAtLocation`	An volume from time satisfaction volume interface.
`SpatialAnalysisToolGridCoordinateDefinition`	Define a set of coordinate values.
`SpatialAnalysisToolGridValuesCustom`	Fixed step grid values.
`SpatialAnalysisToolGridValuesFixedNumberOfSteps`	Fixed step grid values.
`SpatialAnalysisToolGridValuesFixedStep`	Fixed step grid values.
`SpatialAnalysisToolGridValuesMethod`	A grid values method.
`SpatialAnalysisToolSpatialCalculation`	A volume calc interface. The methods and properties of the interface provide Volumetric calc functions.
`SpatialAnalysisToolVolume`	A volume interface. The methods and properties of the interface provide Volume functions.
`SpatialAnalysisToolVolumeGrid`	A volume grid interface. The methods and properties of the interface provide Volumetric Grid functions.
`SpatialAnalysisToolVolumeGridCartesian`	A volume grid Cartesian interface.
`SpatialAnalysisToolVolumeGridConstrained`	A volume grid constrained interface.
`SpatialAnalysisToolVolumeGridCylindrical`	A volume grid cylindrical interface.
`SpatialAnalysisToolVolumeGridFactory`	The factory is used to create instances of volume grids.
`SpatialAnalysisToolVolumeGridGroup`	Access or create VGT volume grids associated with an object or a central body.
`SpatialAnalysisToolVolumeGridLatitudeLongitudeAltitude`	A volume grid lat lon alt (Cartogrographic) interface.
`SpatialAnalysisToolVolumeGridResult`	An interface that generates Volume Grid results.
`SpatialAnalysisToolVolumeGridSpherical`	A volume grid spherical interface.
`TimeToolAxesSamplingInterval`	The interface represents an interval with the time, orientation and velocity arrays.
`TimeToolAxesSamplingIntervalCollection`	A collection of intervals where each interval contains the time, orientation and velocity arrays.
`TimeToolAxesSamplingResult`	Contains tabulated orientations and angular velocities of axes created by Sample method.
`TimeToolInstant`	Define an event (time instant).
`TimeToolInstantEpoch`	Event set at specified date/time.
`TimeToolInstantExtremum`	Determine time of global minimum or maximum of specified scalar calculation. Determination is performed within interval list using Sampling and Convergence parameters.
`TimeToolInstantFactory`	The factory creates events.
`TimeToolInstantGroup`	Access or create VGT events associated with an object.
`TimeToolInstantOccurrenceResult`	Contains the results returned with ITimeToolInstant.FindOccurrence method.
`TimeToolInstantSignaled`	Event recorded on specified clock via signal transmission from original time instant recorded on different clock.
`TimeToolInstantSmartEpoch`	A smart epoch.
`TimeToolInstantStartStopTime`	Event is either start or stop time selected from a reference interval.
`TimeToolInstantTimeOffset`	Event at fixed offset from specified reference event.
`TimeToolInterval`	Represents an interval.
`TimeToolIntervalCollection`	Represents a collection of intervals.
`TimeToolIntervalListResult`	Contains the results returned with ITimeToolTimeIntervalList.FindIntervals method.
`TimeToolIntervalsFilter`	The filter selects intervals of at least/most certain duration.
`TimeToolIntervalsVectorResult`	Contains the results returned with ITimeToolTimeIntervalCollection.FindIntervalCollection method.
`TimeToolIntervalVectorCollection`	A collection of interval collections.
`TimeToolLightTimeDelay`	Manage Light Time Delay options..
`TimeToolPointSamplingInterval`	The interface represents an interval with the time, position and velocity arrays.
`TimeToolPointSamplingIntervalCollection`	A collection of intervals where each interval contains the time, position and velocity arrays.
`TimeToolPointSamplingResult`	Contains tabulated positions and velocities of a point created by Sample method.
`TimeToolPruneFilter`	A filter used with event interval list pruned class to prune interval lists…
`TimeToolPruneFilterFactory`	The factory creates pruning filters.
`TimeToolSignalDelayBasic`	Signal delay definition determines how long it takes for a signal to propagate from one location to another.
`TimeToolTimeArray`	An ordered array of times, which may or may not be evenly spaced.
`TimeToolTimeArrayConditionCrossings`	Time array containing times at which the specified condition will change its satisfaction status. Determination is performed within the interval list using Sampling and Convergence parameters.
`TimeToolTimeArrayExtrema`	Determine times of local minimum and/or maximum of specified scalar calculation. Determination is performed within interval list using Sampling and Convergence parameters.
`TimeToolTimeArrayFactory`	The factory creates event arrays.
`TimeToolTimeArrayFiltered`	Defined by filtering times from original time array according to specified filtering method.
`TimeToolTimeArrayFindTimesResult`	Return a collection of intervals and an array of times.
`TimeToolTimeArrayFixedStep`	Defined by taking fixed time steps from specified time reference and adding sampled times to array if they fall within specified bounding interval list.
`TimeToolTimeArrayFixedTimes`	Array defined by time ordered instants each explicitly specified.
`TimeToolTimeArrayGroup`	Access or create VGT event arrays associated with an object.
`TimeToolTimeArrayMerged`	Defined by merging times from two other arrays by creating a union of bounding intervals from two constituent arrays. If some intervals overlap, then within overlap times from both arrays are merged together.
`TimeToolTimeArraySignaled`	Determine what time array is recorded at target clock location by performing signal transmission of original time array between base and target clock locations…
`TimeToolTimeArrayStartStopTimes`	Defined by taking start and/or stop times of every interval in specified reference interval list and adding them to array. The array is then bounded by single interval spanning specified reference interval list…
`TimeToolTimeInterval`	A single time interval.
`TimeToolTimeIntervalBetweenTimeInstants`	Interval between specified start and stop time instants. If start instant occurs after stop, then interval is undefined.
`TimeToolTimeIntervalCollection`	A collection of related interval lists.
`TimeToolTimeIntervalCollectionCondition`	Interval list containing intervals during which specified condition is satisfied. Determination is performed within interval list using Sampling and Convergence parameters.
`TimeToolTimeIntervalCollectionFactory`	The factory creates collections of event interval lists.
`TimeToolTimeIntervalCollectionGroup`	Access or create VGT event interval collections associated with an object.
`TimeToolTimeIntervalCollectionLighting`	Defined by computing sunlight, penumbra and umbra intervals as seen at specified location using specified selection of eclipsing bodies.
`TimeToolTimeIntervalCollectionOccurredResult`	Contains the results returned with ITimeToolTimeIntervalCollection.Occurred method.
`TimeToolTimeIntervalCollectionSignaled`	Determine what interval list collection is recorded at target clock location by performing signal transmission of original interval list collection between base and target clock locations…
`TimeToolTimeIntervalFactory`	The factory creates event intervals.
`TimeToolTimeIntervalFirstIntervalsFilter`	The filter selects a portion of first intervals.
`TimeToolTimeIntervalFixed`	Interval defined between two explicitly specified start and stop times. Stop date/time is required to be at or after start.
`TimeToolTimeIntervalFixedDuration`	Interval of fixed duration specified using start and stop offsets relative to specified reference time instant.
`TimeToolTimeIntervalFromIntervalList`	Interval created from specified interval list by using one of several selection methods.
`TimeToolTimeIntervalGapsFilter`	The filter merges intervals unless they are separated by gaps of at least/most certain duration.
`TimeToolTimeIntervalGroup`	Access or create VGT event intervals associated with an object.
`TimeToolTimeIntervalLastIntervalsFilter`	The filter selects a portion of last intervals.
`TimeToolTimeIntervalList`	An ordered list of time intervals.
`TimeToolTimeIntervalListCondition`	Interval list containing intervals during which specified condition is satisfied. Determination is performed within interval list using Sampling and Convergence parameters.
`TimeToolTimeIntervalListFactory`	The factory creates event interval lists.
`TimeToolTimeIntervalListFile`	Interval list loaded from specified interval file - ASCII file with .int extension. See STK help.
`TimeToolTimeIntervalListFiltered`	Defined by filtering intervals from original interval list using specified filtering method.
`TimeToolTimeIntervalListFixed`	Interval list defined by time ordered non-overlapping intervals each explicitly specified by its start and stop times. Stop date/time is required to be at or after start for each interval.
`TimeToolTimeIntervalListGroup`	Access or create VGT event interval lists associated with an object.
`TimeToolTimeIntervalListMerged`	Interval list created by merging two constituent interval lists using specified logical operation. It is possible to select either interval list or interval types for either or both constituents.
`TimeToolTimeIntervalListScaled`	Interval List defined by scaling every interval in original interval list using either absolute or relative scale. If resulting interval’s start becomes after its stop, the interval is removed from scaled list…
`TimeToolTimeIntervalListSignaled`	Determine what interval list is recorded at target clock location by performing signal transmission of original interval list between base and target clock locations…
`TimeToolTimeIntervalListTimeOffset`	Interval List defined by shifting the specified reference interval list by a fixed time offset.
`TimeToolTimeIntervalRelativeSatisfactionConditionFilter`	The filter selects intervals if certain side condition is satisfied at least/most certain percentage of time.
`TimeToolTimeIntervalResult`	Contains the results returned with ITimeToolTimeIntervalList.FindIntervals method.
`TimeToolTimeIntervalSatisfactionConditionFilter`	The filter selects intervals if certain side condition is satisfied at least/most certain duration.
`TimeToolTimeIntervalScaled`	Interval defined by scaling original interval using either absolute or relative scale. If resulting interval’s start becomes after its stop, the interval becomes undefined.
`TimeToolTimeIntervalSignaled`	Determine what interval is recorded at target clock location by performing signal transmission of original interval between base and target clock locations.
`TimeToolTimeIntervalSmartInterval`	A smart interval.
`TimeToolTimeIntervalTimeOffset`	Interval defined by shifting specified reference interval by fixed time offset.
`VectorGeometryToolAngle`	Base class for VGT axes.
`VectorGeometryToolAngleBetweenPlanes`	An angle between two planes.
`VectorGeometryToolAngleBetweenVectors`	An angle between two vectors.
`VectorGeometryToolAngleDihedral`	An angle between two vectors about an axis.
`VectorGeometryToolAngleFactory`	A Factory object to create angles.
`VectorGeometryToolAngleGroup`	Access or create VGT angles associated with an object or a central body.
`VectorGeometryToolAngleReference`	Represents a reference to a VGT angle.
`VectorGeometryToolAngleRotation`	Angle of the shortest rotation between the specified FromAxes and ToAxes axes.
`VectorGeometryToolAngleToPlane`	An angle between a vector and a plane.
`VectorGeometryToolAxes`	A generic axes class.
`VectorGeometryToolAxesAlignedAndConstrained`	Axes aligned using two pairs of vectors. One vector in each pair is fixed in these axes and the other vector serves as an independent reference.
`VectorGeometryToolAxesAngularOffset`	Axes created by rotating the Reference axes about the Spin vector through the specified rotation angle plus the additional rotational offset.
`VectorGeometryToolAxesAtTimeInstant`	Axes orientation fixed relative to reference axes based on orientation of another set of axes evaluated at specified time instant.
`VectorGeometryToolAxesAttitudeFile`	Axes specified by data from a file.
`VectorGeometryToolAxesBPlane`	B-Plane axes using the selected target body and reference vector.
`VectorGeometryToolAxesCommonTasks`	Provide methods to create non-persistent VGT axes components. Non-persistent components do not have names, do not get saved/loaded and are not shown in the VGT browser.
`VectorGeometryToolAxesCustomScript`	Customized axes offset with respect to a set of reference Axes.
`VectorGeometryToolAxesFactory`	A Factory object to create axes.
`VectorGeometryToolAxesFixed`	Axes fixed in reference axes.
`VectorGeometryToolAxesFixedAtEpoch`	Axes based on another set fixed at a specified epoch.
`VectorGeometryToolAxesGroup`	Access or create VGT axes associated with an object or a central body.
`VectorGeometryToolAxesLabels`	Allow configuring the VGT axes labels.
`VectorGeometryToolAxesLagrangeLibration`	Libration point axes using one primary and multiple secondary central bodies. Set primary and secondary bodies, and point type.
`VectorGeometryToolAxesModelAttachment`	Axes aligned with the specified pointable element of the object’s 3D model. The axes follow the model as well as any articulations that affect the specified pointable element.
`VectorGeometryToolAxesOnSurface`	Topocentric axes located at the reference point’s projection on the central body.
`VectorGeometryToolAxesPlugin`	A VGT axes plugin.
`VectorGeometryToolAxesReference`	Represents a reference to a VGT axes.
`VectorGeometryToolAxesSpinning`	Axes created by spinning the Reference axes about the Spin vector with the specified rate. The axes are aligned with the Reference axes at the specified epoch plus the additional rotational offset.
`VectorGeometryToolAxesTrajectory`	Axes based on trajectory of the point relative to the reference coordinate system.
`VectorGeometryToolPlane`	Base class for VGT axes.
`VectorGeometryToolPlaneFactory`	A Factory object to create VGT planes.
`VectorGeometryToolPlaneGroup`	Represents a VGT Plane component.
`VectorGeometryToolPlaneLabels`	Allow configuring the X and Y axes labels.
`VectorGeometryToolPlaneNormal`	A plane normal to a vector at a given point.
`VectorGeometryToolPlaneQuadrant`	A plane based on a selected Quadrant of a reference system.
`VectorGeometryToolPlaneReference`	Represents a Plane reference.
`VectorGeometryToolPlaneTrajectory`	The plane is defined on the basis of a trajectory of a Point with respect to a ReferenceSystem.
`VectorGeometryToolPlaneTriad`	A Plane containing points PointA, PointB and ReferencePont with the first axis aligned with the direction from the ReferencePoint to PointA and the second axis toward the direction from the ReferencePoint to PointB.
`VectorGeometryToolPlaneTwoVector`	A plane normal to a vector at a given point.
`VectorGeometryToolPoint`	A generic VGT point class.
`VectorGeometryToolPointAtTimeInstant`	Point fixed relative to reference system based on another point evaluated at specified time instant.
`VectorGeometryToolPointBPlane`	B-Plane point using the selected target body.
`VectorGeometryToolPointCentralBodyFixedOffset`	Point specified by fixed components with respect to central body.
`VectorGeometryToolPointCentralBodyIntersect`	Point on central body surface along direction vector originating at source point.
`VectorGeometryToolPointCommonTasks`	Provide methods to create non-persistent VGT point components. Non-persistent components do not have names, do not get saved/loaded and are not shown in the VGT browser.
`VectorGeometryToolPointCovarianceGrazing`	The point of closest approach to the surface of the specified position covariance ellipsoid surface along a defined direction. Position covariance must be available for a vehicle object to be considered a possible target for this option.
`VectorGeometryToolPointFactory`	A Factory object to create points.
`VectorGeometryToolPointFile`	Point specified by data from a file.
`VectorGeometryToolPointFixedInSystem`	Point fixed in a reference coordinate system using the selected coordinate type.
`VectorGeometryToolPointGlint`	Point on central body surface that reflects from source to observer.
`VectorGeometryToolPointGrazing`	The grazing point is the point of closest approach to the surface of the selected central body along a defined direction.
`VectorGeometryToolPointGroup`	Access or create VGT points associated with an object or a central body.
`VectorGeometryToolPointLagrangeLibration`	Libration point using one primary and multiple secondary central bodies. Set the central body, secondary central bodies, and point type.
`VectorGeometryToolPointModelAttachment`	A point placed at the specified attachment point of the object’s 3D model. The point follows the model as well as any articulations that affect the specified attachment point.
`VectorGeometryToolPointOnSurface`	The detic subpoint of the reference point as projected onto the central body.
`VectorGeometryToolPointPlaneIntersection`	Point on a plane located along a given direction looking from a given origin.
`VectorGeometryToolPointPlaneProjection`	The projection of a point onto a reference plane. Specify the Source Point and Reference Plane.
`VectorGeometryToolPointPlugin`	A VGT point plugin.
`VectorGeometryToolPointReference`	Represents a reference to a VGT point.
`VectorGeometryToolPointSatelliteCollectionEntry`	A point placed at the center of mass of a specified satellite of the satellite collection.
`VectorGeometryToolSystem`	Base class for VGT axes.
`VectorGeometryToolSystemAssembled`	A system assembled from an origin point and a set of reference axes.
`VectorGeometryToolSystemCommonTasks`	Provide methods to create non-persistent VGT coordinate reference frames (systems). Non-persistent components do not have names, do not get saved/loaded and are not shown in the VGT browser.
`VectorGeometryToolSystemFactory`	A Factory class to create VGT systems.
`VectorGeometryToolSystemGroup`	Access or create VGT systems associated with an object or a central body.
`VectorGeometryToolSystemOnSurface`	A system with an origin on the surface of the central body with topocentric axes rotated on a clock angle. Specify the central body, angle, and the latitude, longitude, and altitude of the origin.
`VectorGeometryToolSystemReference`	Represents a System reference.
`VectorGeometryToolVector`	A generic vector class.
`VectorGeometryToolVectorAngleRate`	Angle rate vector perpendicular to the plane in which the angle is defined.
`VectorGeometryToolVectorAngularVelocity`	Angular velocity vector of one set of axes computed with respect to the reference set.
`VectorGeometryToolVectorApoapsis`	Vector from the center of the specified central body to the farthest point of an elliptical orbit created from the motion of the specified point.
`VectorGeometryToolVectorConing`	Vector created by revolving the Reference vector around the About vector with the specified rate.
`VectorGeometryToolVectorCross`	The vector cross product of two vectors.
`VectorGeometryToolVectorCustomScript`	Customized vector components defined with respect to reference axes.
`VectorGeometryToolVectorDerivative`	A vector derivative of a vector computed with respect to specified axes.
`VectorGeometryToolVectorDirectionToStar`	Defined with respect to a star object. For a star object to be available, you must first create one.
`VectorGeometryToolVectorDisplacement`	Vector defined by its start and end points.
`VectorGeometryToolVectorEccentricity`	A vector directed from the center of the specified central body toward the nearest point of an elliptical orbit created from the motion of the specified point.
`VectorGeometryToolVectorFactory`	A Factory object to create vectors.
`VectorGeometryToolVectorFile`	Vector interpolated from tabulated data from file.
`VectorGeometryToolVectorFixedAtEpoch`	Based on another vector fixed at a specified epoch.
`VectorGeometryToolVectorFixedAtTimeInstant`	Vector fixed relative to reference axes based on another vector evaluated at specified time instant.
`VectorGeometryToolVectorFixedInAxes`	Vector fixed in reference axes.
`VectorGeometryToolVectorGroup`	Access or create VGT vectors associated with an object or a central body.
`VectorGeometryToolVectorLinearCombination`	Linear combination of two input vectors.
`VectorGeometryToolVectorLineOfNodes`	Unit vector along the line of nodes - the line of intersection of the osculating orbit plane and the inertial equator of the specified central body.
`VectorGeometryToolVectorModelAttachment`	Unit vector along the specified pointable element of the object’s 3D model. The vector’s direction follows the model as well as any articulations that affect the specified pointable element.
`VectorGeometryToolVectorOrbitAngularMomentum`	Vector perpendicular to the plane of an elliptical orbit created from the motion of the specified point with respect to the center of the specified central body.
`VectorGeometryToolVectorOrbitNormal`	Unit vector perpendicular to the plane of an elliptical orbit created from the motion of the specified point with respect to the center of the specified central body.
`VectorGeometryToolVectorPeriapsis`	Vector from the center of the specified central body to the nearest point of an elliptical orbit created from the motion of the specified point.
`VectorGeometryToolVectorPlugin`	A VGT vector plugin.
`VectorGeometryToolVectorProjection`	A projection of a vector computed with respect to a reference plane.
`VectorGeometryToolVectorProjectionAlongVector`	A projection of a source vector in the direction of another vector.
`VectorGeometryToolVectorReference`	Represents a vector reference.
`VectorGeometryToolVectorReflection`	Incident vector reflected using a plane whose normal is the normal vector, scaled by a factor. The selected vector or its opposite can be reflected on just one or on both sides of the plane.
`VectorGeometryToolVectorRotationVector`	Rotation vector representing the rotation of one axes relative to reference axes, expressed as angle*rotationAxis.
`VectorGeometryToolVectorScalarLinearCombination`	Linear combination of two input vectors using scalars.
`VectorGeometryToolVectorScalarScaled`	Scaled version of the input vector using scalar.
`VectorGeometryToolVectorScaled`	Scaled version of the input vector. Set IsNormalized to convert the input vector to a unit vector before scaling it.
`VectorGeometryToolVectorSurfaceDisplacement`	Displacement between origin and destination points using surface distance and altitude difference.
`VectorGeometryToolVectorTwoPlanesIntersection`	Defined along the intersection of two planes.
`VectorGeometryToolVectorVelocityAcceleration`	Velocity vector of a point in a coordinate system.
`VectorGeometryToolWellKnownAxes`	Represents well-known VGT Axes.
`VectorGeometryToolWellKnownEarthAxes`	Well-known Earth’s axes.
`VectorGeometryToolWellKnownEarthSystems`	Well-known Earth’s coordinate systems.
`VectorGeometryToolWellKnownSunAxes`	Well-known Sun’s axes.
`VectorGeometryToolWellKnownSunSystems`	The Sun’s well-known coordinate reference systems.
`VectorGeometryToolWellKnownSystems`	Well-known coordinate reference systems.

Enums

`AberrationModelType`	Define the model of aberration to use.
`AngleToLocationType`	Define volume calc angle off vector reference types.
`AngleType`	Represents angle types.
`AsymptoteDirectionType`	Direction options.
`AxesType`	Represents vector types.
`CalculationScalarType`	Define available calculation scalar types.
`ClockHostType`	Define whether base or target of an Access instance holds the clock for Access times.
`ConditionCombinedOperationType`	Define scalar condition combined operation types.
`ConditionSetType`	Define available condition set types.
`ConditionThresholdType`	Operations for Scalar Bounds Condition.
`ConditionType`	Define available condition types.
`DistanceToLocationType`	Define volume calc range distance types.
`EventArrayFilterType`	Event array filter types.
`EventArrayType`	Define available time array types.
`EventIntervalCollectionType`	Define available interval collection types.
`EventIntervalListType`	Define available interval list types.
`EventIntervalType`	Define available interval types.
`EventListMergeOperation`	Define merge operations for interval lists.
`ExtremumType`	These constants are utilized when finding a local or global minimum or maximum, or the threshold crossing.
`FileInterpolatorType`	Interpolator types.
`GridValuesMethodType`	Define volumetric grid values method types.
`InheritDimensionType`	Define how dimension is inherited.
`IntegrationWindowType`	Define the interval of times during which an integral is evaluated.
`InterpolationMethodType`	Interpolator types.
`IntersectionSurfaceType`	Intersection surface flags.
`IntervalDurationType`	Duration for filtering intervals or gaps from interval lists or time arrays.
`IntervalFromIntervalListSelectionType`	Select the method to choose an interval from an interval list.
`IntervalPruneFilterType`	Specify the filter for filtering interval lists or time arrays.
`LagrangeLibrationPointType`	Types of the Lagrange points, also known as libration points. Lagrange points are points in space where gravitational forces and the orbital motion of a body balance each other.
`LightingConditionsType`	Define spatial condition lighting conditions types.
`MeanElementTheory`	Mean element theory types for approximating motion.
`ParameterSetType`	Define parameter set types.
`PlaneQuadrantType`	Quadrants from a reference system (e.g., XY, XZ, YZ, YX, ZX, ZY).
`PlaneType`	Represents plane types.
`PointBPlaneType`	B-Plane point types.
`PointType`	Represents point types.
`PrincipalAxisOfRotationType`	Rotation directions.
`QuadratureType`	Integral types.
`RangeSpeedType`	Define volume calc range distance types.
`ResultVectorRequestType`	Define volume result vector request types.
`RotationSweepModeType`	The rotation sweeping modes.
`SampleReferenceTimeType`	Event array reference type.
`SatisfactionCrossing`	Direction crossing flags.
`SaveDataType`	Method for saving computed data.
`SignalDirectionType`	Signal sense transmission options.
`SignalPathReferenceSystem`	Signal path reference system types.
`SignedAngleType`	Define options for computing an angle.
`SmartEpochState`	Smart epoch states.
`SmartIntervalState`	Smart interval states.
`SpatialCalculationAltitudeReferenceType`	Define volume calc altitude reference types.
`SpatialCalculationType`	Define volume calc types.
`SpatialConditionOverTypeDurationType`	Define spatial condition over time duration type.
`SpeedType`	Define various speed options.
`StartStopType`	Start/stop options.
`SurfaceReferenceShapeType`	Surface shape types.
`SurfaceShapeType`	Surface types.
`SystemType`	Represents system types.
`ThresholdConvergenceSenseType`	Specify the desired sense of the results from threshold crossing computations.
`TimeEventType`	Define available time instant types.
`TimeSenseType`	Define whether object1 or object2 of an Access instance holds the clock for Access times.
`TrajectoryAxesCoordinatesType`	Trajectory axes coordinate types.
`VectorComponentType`	Define component directions for a vector.
`VectorGeometryToolComponentType`	Represents kinds of vectory geometry components.
`VectorGeometryToolSamplingMethod`	Define the Sampling Method.
`VectorGeometryToolScaledVectorDimensionInheritanceOptionType`	Dimension inheritance constants used to configure the dimension inheritance of a vector scaled by a scalar.
`VectorType`	Represents vector types.
`VolumeCombinedOperationType`	Define spatial condition combined operation types.
`VolumeFromGridEdgeType`	Define spatial condition from grid edge type.
`VolumeGridType`	Define volume grid types.
`VolumeSatisfactionAccumulationType`	Define volume calc spatial condition accumulation types.
`VolumeSatisfactionDurationType`	Define volume calc spatial condition duration types.
`VolumeSatisfactionFilterType`	Define volume calc spatial condition filter types.
`VolumeSatisfactionMetricType`	Define volume calc spatial condition satisfaction metric types.
`VolumeType`	Define volume grid types.

Description#

The Vector Geometry (VGT) API enables users define new or utilize existing geometric constructs such as coordinate systems, vectors, points, angles, axes and planes.

The geometric elements can be used to transform between coordinate systems, compute first and second derivatives, or perform other types of analysis.