VectorGeometryToolPointCovarianceGrazing#

class ansys.stk.core.analysis_workbench.VectorGeometryToolPointCovarianceGrazing#

Bases: IVectorGeometryToolPoint, IAnalysisWorkbenchComponentTimeProperties, IAnalysisWorkbenchComponent

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.

Overview#

Properties

`reference_point`	Specify a reference point which will serve as the starting location for the line along which the grazing point will be computed.
`direction_vector`	Specify a direction vector to be used in conjunction with the displacement vector from the selected target object to the reference point to define a plane in which the line will lie.
`target_name`	Specify a target object about which the covariance ellipsoid is centered.
`distance`	The point of closest approach to the covariance ellipsoid surface occurs at the specified distance.
`probability`	Specify a probability that the true position is inside the ellipsoid boundary.
`scale`	Specify a scale factor which is applied to the one sigma ellipsoid.
`use_probability`	A flag controlling whether to use probability or scale factor.

Import detail#

from ansys.stk.core.analysis_workbench import VectorGeometryToolPointCovarianceGrazing

Property detail#

property VectorGeometryToolPointCovarianceGrazing.reference_point: VectorGeometryToolPointReference#: Specify a reference point which will serve as the starting location for the line along which the grazing point will be computed.

property VectorGeometryToolPointCovarianceGrazing.direction_vector: VectorGeometryToolVectorReference#: Specify a direction vector to be used in conjunction with the displacement vector from the selected target object to the reference point to define a plane in which the line will lie.

property VectorGeometryToolPointCovarianceGrazing.target_name: str#: Specify a target object about which the covariance ellipsoid is centered.

property VectorGeometryToolPointCovarianceGrazing.distance: float#: The point of closest approach to the covariance ellipsoid surface occurs at the specified distance.

property VectorGeometryToolPointCovarianceGrazing.probability: float#: Specify a probability that the true position is inside the ellipsoid boundary.

property VectorGeometryToolPointCovarianceGrazing.scale: float#: Specify a scale factor which is applied to the one sigma ellipsoid.

property VectorGeometryToolPointCovarianceGrazing.use_probability: bool#: A flag controlling whether to use probability or scale factor.