ostk.astrodynamics.trajectory.model.TargetScan

class TargetScan(
self: ostk.astrodynamics.trajectory.model.TargetScan,
start_lla: ostk.physics.coordinate.spherical.LLA,
end_lla: ostk.physics.coordinate.spherical.LLA,
start_instant: ostk.physics.time.Instant,
end_instant: ostk.physics.time.Instant,
celestial: ostk.physics.environment.object.Celestial = -- Object ------------------------------------------------------------------------------------------ Name: Earth ----------------------------------------------------------------------------------------------------,
step_size: ostk.physics.time.Duration = 00.010.000.000,
)

Bases: Model

TargetScan trajectory model.

This model represents a trajectory that scans between two target locations on a celestial body.

Construct a TargetScan object.

Parameters:
  • start_lla (LLA) -- The starting location.

  • end_lla (LLA) -- The ending location.

  • start_instant (Instant) -- The starting instant.

  • end_instant (Instant) -- The ending instant.

  • celestial (Celestial) -- The celestial body. Defaults to Earth.WGS84().

  • step_size (Duration) -- The step size for the trajectory. Defaults to 1e-2 seconds.

Returns:

The TargetScan object.

Return type:

TargetScan

Methods

calculate_state_at

Calculate the state at a given instant.

calculate_states_at

Calculate the states at given instants.

from_ground_speed

Construct a TargetScan object from ground speed.

get_celestial

Get the celestial object of the target scan.

get_end_instant

Get the ending instant of the target scan.

get_end_lla

Get the ending LLA of the target scan.

get_start_instant

Get the starting instant of the target scan.

get_start_lla

Get the starting LLA of the target scan.

get_step_size

Get the step size of the target scan.

is_defined

Check if the model is defined.

calculate_state_at(
self: ostk.astrodynamics.trajectory.model.TargetScan,
instant: ostk.physics.time.Instant,
) ostk.astrodynamics.trajectory.State

Calculate the state at a given instant.

Parameters:

instant (Instant) -- The instant.

Returns:

The state at the given instant.

Return type:

State

calculate_states_at(
self: ostk.astrodynamics.trajectory.Model,
instants: list[ostk.physics.time.Instant],
) list[ostk.astrodynamics.trajectory.State]

Calculate the states at given instants. It can be more performant than looping calculate_state_at for multiple instants.

@param instants The instants.

Returns:

The states at the given instants.

Return type:

Array<State>

static from_ground_speed(
start_lla: ostk.physics.coordinate.spherical.LLA,
end_lla: ostk.physics.coordinate.spherical.LLA,
ground_speed: ostk.physics.unit.Derived,
start_instant: ostk.physics.time.Instant,
celestial: ostk.physics.environment.object.Celestial = -- Object ------------------------------------------------------------------------------------------ Name: Earth ----------------------------------------------------------------------------------------------------,
step_size: ostk.physics.time.Duration = 00.010.000.000,
) ostk.astrodynamics.trajectory.model.TargetScan

Construct a TargetScan object from ground speed.

Parameters:
  • start_lla (LLA) -- The starting location.

  • end_lla (LLA) -- The ending location.

  • ground_speed (Derived) -- The ground speed.

  • start_instant (Instant) -- The starting instant.

  • celestial (Celestial) -- The celestial body.

  • step_size (Duration) -- The step size for the trajectory.

Returns:

The TargetScan object.

Return type:

TargetScan

get_celestial(
self: ostk.astrodynamics.trajectory.model.TargetScan,
) ostk.physics.environment.object.Celestial

Get the celestial object of the target scan.

Returns:

The celestial object.

Return type:

Celestial

get_end_instant(
self: ostk.astrodynamics.trajectory.model.TargetScan,
) ostk.physics.time.Instant

Get the ending instant of the target scan.

Returns:

The ending instant.

Return type:

Instant

get_end_lla(
self: ostk.astrodynamics.trajectory.model.TargetScan,
) ostk.physics.coordinate.spherical.LLA

Get the ending LLA of the target scan.

Returns:

The ending LLA.

Return type:

LLA

get_start_instant(
self: ostk.astrodynamics.trajectory.model.TargetScan,
) ostk.physics.time.Instant

Get the starting instant of the target scan.

Returns:

The starting instant.

Return type:

Instant

get_start_lla(
self: ostk.astrodynamics.trajectory.model.TargetScan,
) ostk.physics.coordinate.spherical.LLA

Get the starting LLA of the target scan.

Returns:

The starting LLA.

Return type:

LLA

get_step_size(
self: ostk.astrodynamics.trajectory.model.TargetScan,
) ostk.physics.time.Duration

Get the step size of the target scan.

Returns:

The step size.

Return type:

Duration

is_defined(self: ostk.astrodynamics.trajectory.model.TargetScan) bool

Check if the model is defined.

Returns:

True if the model is defined, False otherwise.

Return type:

bool