ostk.astrodynamics.trajectory.orbit.Pass¶

class Pass( self: ostk.astrodynamics.trajectory.orbit.Pass, revolution_number: ostk.core.type.Integer, instant_at_ascending_node: ostk.physics.time.Instant, instant_at_north_point: ostk.physics.time.Instant, instant_at_descending_node: ostk.physics.time.Instant, instant_at_south_point: ostk.physics.time.Instant, instant_at_pass_break: ostk.physics.time.Instant, )¶

Bases: pybind11_object

A revolution of an orbiting object.

Constructor.

Parameters:

revolution_number (int) -- The revolution number of the pass.
instant_at_ascending_node (Instant) -- The instant at the ascending node of the pass.
instant_at_north_point (Instant) -- The instant at the north point of the pass.
instant_at_descending_node (Instant) -- The instant at the descending node of the pass.
instant_at_south_point (Instant) -- The instant at the south point of the pass.
instant_at_pass_break (Instant) -- The instant at break of the pass.

Methods

`get_duration`	Get the duration of the pass.
`get_end_instant`	Get the end instant of the pass.
`get_instant_at_ascending_node`	Get the instant at the ascending node of the pass.
`get_instant_at_descending_node`	Get the instant at the descending node of the pass.
`get_instant_at_north_point`	Get the instant at the north point of the pass.
`get_instant_at_pass_break`	Get the instant at the break of the pass, i.e. the ascending node of the next pass.
`get_instant_at_south_point`	Get the instant at the south point of the pass.
`get_interval`	Get the interval of the pass.
`get_revolution_number`	Get the revolution number of the pass.
`get_start_instant`	Get the start instant of the pass.
`get_type`	Get the type of the pass.
`is_complete`	Check if the pass is complete.
`is_defined`	Check if the pass is defined.
`string_from_phase`	Get the string representation of a pass phase.
`string_from_type`	Get the string representation of a pass type.
`undefined`	Get an undefined pass.

class Phase(self: ostk.astrodynamics.trajectory.orbit.Pass.Phase, value: int)¶

Bases: pybind11_object

The phase of the Pass.

Members:

Undefined : Undefined

Ascending : Ascending

Descending : Descending

property name¶

class Type(self: ostk.astrodynamics.trajectory.orbit.Pass.Type, value: int)¶

Bases: pybind11_object

The type of Pass.

Members:

Undefined : Undefined

Complete : Complete

Partial : Partial

property name¶

get_duration( self: ostk.astrodynamics.trajectory.orbit.Pass, ) → ostk.physics.time.Duration¶

Get the duration of the pass. Undefined if the pass is not complete.

Returns:: The duration of the pass.
Return type:: Duration

get_end_instant( self: ostk.astrodynamics.trajectory.orbit.Pass, ) → ostk.physics.time.Instant¶

Get the end instant of the pass. For partial passes, this is the maximum defined instant.

Returns:: The end instant of the pass.
Return type:: Instant

get_instant_at_ascending_node( self: ostk.astrodynamics.trajectory.orbit.Pass, ) → ostk.physics.time.Instant¶

Get the instant at the ascending node of the pass. i.e. z = 0 & vz > 0 in an ECI frame.

Returns:: The instant at the ascending node of the pass.
Return type:: Instant

get_instant_at_descending_node( self: ostk.astrodynamics.trajectory.orbit.Pass, ) → ostk.physics.time.Instant¶

Get the instant at the descending node of the pass. i.e. z = 0 and vz < 0 in an ECI frame.

Returns:: The instant at the descending node of the pass.
Return type:: Instant

get_instant_at_north_point( self: ostk.astrodynamics.trajectory.orbit.Pass, ) → ostk.physics.time.Instant¶

Get the instant at the north point of the pass. i.e. z = maximum and vz = 0 in an ECI frame.

Returns:: The instant at the north point of the pass.
Return type:: Instant

get_instant_at_pass_break( self: ostk.astrodynamics.trajectory.orbit.Pass, ) → ostk.physics.time.Instant¶

Get the instant at the break of the pass, i.e. the ascending node of the next pass.

Returns:: The instant at the break of the pass.
Return type:: Instant

get_instant_at_south_point( self: ostk.astrodynamics.trajectory.orbit.Pass, ) → ostk.physics.time.Instant¶

Get the instant at the south point of the pass. i.e. z = minimum and vz = 0 in an ECI frame.

Returns:: The instant at the south point of the pass.
Return type:: Instant

get_interval( self: ostk.astrodynamics.trajectory.orbit.Pass, ) → ostk.physics.time.Interval¶

Get the interval of the pass. Undefined if the pass is not complete.

Returns:: The interval of the pass.
Return type:: Interval

get_revolution_number( self: ostk.astrodynamics.trajectory.orbit.Pass, ) → ostk.core.type.Integer¶

Get the revolution number of the pass.

Returns:: The revolution number of the pass.
Return type:: int

get_start_instant( self: ostk.astrodynamics.trajectory.orbit.Pass, ) → ostk.physics.time.Instant¶

Get the start instant of the pass. For partial passes, this is the minimum defined instant.

Returns:: The start instant of the pass.
Return type:: Instant

get_type( self: ostk.astrodynamics.trajectory.orbit.Pass, ) → ostk.astrodynamics.trajectory.orbit.Pass.Type¶

Get the type of the pass.

Returns:: The type of the pass.
Return type:: Pass.Type

is_complete(self: ostk.astrodynamics.trajectory.orbit.Pass) → bool¶

Check if the pass is complete.

Returns:: True if the pass is complete, False otherwise.
Return type:: bool

is_defined(self: ostk.astrodynamics.trajectory.orbit.Pass) → bool¶

Check if the pass is defined.

Returns:: True if the pass is defined, False otherwise.
Return type:: bool

static string_from_phase( phase: ostk.astrodynamics.trajectory.orbit.Pass.Phase, ) → ostk.core.type.String¶

Get the string representation of a pass phase.

Parameters:: phase (Pass.Phase) -- The pass phase.
Returns:: The string representation of the pass phase.
Return type:: str

static string_from_type( type: ostk.astrodynamics.trajectory.orbit.Pass.Type, ) → ostk.core.type.String¶

Get the string representation of a pass type.

Parameters:: type (Pass.Type) -- The pass type.
Returns:: The string representation of the pass type.
Return type:: str

static undefined() → ostk.astrodynamics.trajectory.orbit.Pass¶

Get an undefined pass.

Returns:: The undefined pass.
Return type:: Pass