Closest Approach#

class SpaceCenter.ClosestApproach#

A close approach between an orbit and a target orbit. Obtained by calling SpaceCenter.Orbit.next_closest_approach() or SpaceCenter.Orbit.closest_approaches().

Note

A close approach is a snapshot: the time of closest approach is estimated once when the object is created, and every member describes the state at that time. Relative quantities are the target relative to the orbiting object (target minus self).

ut: number#

The universal time of the closest approach, in seconds.

Attribute:

Read-only, cannot be set

Return type:

number

time_to: number#

The time until the closest approach, in seconds.

Attribute:

Read-only, cannot be set

Return type:

number

distance: number#

The distance between the objects at the closest approach, in meters.

Attribute:

Read-only, cannot be set

Return type:

number

relative_speed: number#

The relative speed of the objects at the closest approach, in meters per second. This is the magnitude of SpaceCenter.ClosestApproach.relative_velocity(), and does not depend on the choice of reference frame.

Attribute:

Read-only, cannot be set

Return type:

number

vessel: SpaceCenter.Vessel#

The vessel doing the approaching, or nil if it is not a vessel.

Attribute:

Read-only, cannot be set

Return type:

SpaceCenter.Vessel

body: SpaceCenter.CelestialBody#

The celestial body doing the approaching, or nil if it is not a celestial body.

Attribute:

Read-only, cannot be set

Return type:

SpaceCenter.CelestialBody

target_vessel: SpaceCenter.Vessel#

The vessel being approached, or nil if the target is not a vessel.

Attribute:

Read-only, cannot be set

Return type:

SpaceCenter.Vessel

target_body: SpaceCenter.CelestialBody#

The celestial body being approached, or nil if the target is not a celestial body.

Attribute:

Read-only, cannot be set

Return type:

SpaceCenter.CelestialBody

position([reference_frame = None])#

The position of the orbiting object at the closest approach.

Parameters:

reference_frame (SpaceCenter.ReferenceFrame) – The reference frame that the returned position vector is in. Defaults to the orbital reference frame of the object the orbit belongs to.

Returns:

The position as a vector.

Return type:

Tuple

target_position([reference_frame = None])#

The position of the target object at the closest approach.

Parameters:

reference_frame (SpaceCenter.ReferenceFrame) – The reference frame that the returned position vector is in. Defaults to the orbital reference frame of the object the orbit belongs to.

Returns:

The position as a vector.

Return type:

Tuple

velocity([reference_frame = None])#

The velocity of the orbiting object at the closest approach.

Parameters:

reference_frame (SpaceCenter.ReferenceFrame) – The reference frame that the returned velocity vector is in. Defaults to the orbital reference frame of the object the orbit belongs to.

Returns:

The velocity as a vector.

Return type:

Tuple

target_velocity([reference_frame = None])#

The velocity of the target object at the closest approach.

Parameters:

reference_frame (SpaceCenter.ReferenceFrame) – The reference frame that the returned velocity vector is in. Defaults to the orbital reference frame of the object the orbit belongs to.

Returns:

The velocity as a vector.

Return type:

Tuple

relative_position([reference_frame = None])#

The position of the target relative to the orbiting object at the closest approach.

Parameters:

reference_frame (SpaceCenter.ReferenceFrame) – The reference frame whose axes the returned vector is expressed in. Defaults to the orbital reference frame of the object the orbit belongs to.

Returns:

The relative position as a vector.

Return type:

Tuple

relative_velocity([reference_frame = None])#

The velocity of the target relative to the orbiting object at the closest approach.

Parameters:

reference_frame (SpaceCenter.ReferenceFrame) – The reference frame whose axes the returned vector is expressed in. Defaults to the orbital reference frame of the object the orbit belongs to.

Returns:

The relative velocity as a vector.

Return type:

Tuple