Description
The OrbitPerigee method is a conditional property that can be used with the Step command to advance the Spacecraft to perigee, the point in the orbit where the Spacecraft is at its closest approach to a celestial body. FreeFlyer determines this condition by monitoring the dot product between the position and velocity vectors and identifying when this value passes from negative to positive. The celestial body to be used in the periapsis calculation can be specified using a Variable, String, or CelestialObject. If a celestial body is not specified, the current Spacecraft Central Body will be used.
Note that as a general rule this method should only be used as a propagation stopping condition and should not be used as a means monitor whether or not a Spacecraft is at perigee at a particular epoch.
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond timing precision mode.
Overload List
Signatures

Return Value

Description

Spacecraft.OrbitPerigee()

Variable

Returns the point in the orbit where the Spacecraft is at its closest approach to its central body. FreeFlyer determines this condition by monitoring the dot product between the position and velocity vectors and identifying when this value passes from negative to positive.

Spacecraft.OrbitPerigee(CelestialObject celestialObject)

Variable

Returns the point in the orbit where the Spacecraft is at its closest approach to the specified celestialObject. FreeFlyer determines this condition by monitoring the dot product between the position and velocity vectors and identifying when this value passes from negative to positive.

Spacecraft.OrbitPerigee(String referenceBodyName)

Variable

Returns the point in the orbit where the Spacecraft is at its closest approach to the celestial body represented by referenceBodyName. FreeFlyer determines this condition by monitoring the dot product between the position and velocity vectors and identifying when this value passes from negative to positive.

Spacecraft.OrbitPerigee(Variable referenceBodyIDVariable)

Variable

Returns the point in the orbit where the Spacecraft is at its closest approach to the celestial body represented by referenceBodyIDVariable. FreeFlyer determines this condition by monitoring the dot product between the position and velocity vectors and identifying when this value passes from negative to positive.

See also
Spacecraft Object
StopPropagation Properties and Methods
Spacecraft Propagation Guide
Coverage and Contact Analysis Guide
