2. GroundStation#

class GroundStation(name: str, spice_id: int | str = None)#

Bases: Body

Represents a ground station in Scarabaeus. Contains values and methods necessary for modeling spacecraft communication.

Parameters:

  • name (str) – The name of the ground station.

  • spice_id (int or float, optional) – The SPICE ID of the ground station, defaults to None.

See also

scarabaeus.CelestialBody

GroundStation objects are placed on planetary bodies, defined by CelestialBody.

Attributes

mass

The mass of the Body object.

name

The name of the Body object.

spice_id

The SPICE ID of the Body object.

Methods

get_state(epoch_0[, reference_frame, origin])

Retrieves the state of the body relative to a given origin in a specified reference frame.

station_visibility(observer, target[, ...])

Determines if a ground station can see a spacecraft with some elevation mask (defined by vis_angle).
get_state(epoch_0, reference_frame: str = 'J2000', origin: str = 'EARTH')#

Retrieves the state of the body relative to a given origin in a specified reference frame.

Parameters:

  • epoch_0 (EpochArray) – The epoch times for which the state is to be computed.

  • reference_frame (str) – The reference frame in which the state is desired. Defaults to ‘J2000’.

  • origin (str) – The origin body relative to which the state is computed. Defaults to 'EARTH'.

Returns:

state_vector – The state vector of the body relative to the origin.

Return type:

ArrayWUnits

station_visibility(observer, target, elevation_mask: float = 10.0)#

Determines if a ground station can see a spacecraft with some elevation mask (defined by vis_angle). The elevation mask is defined as degrees above the horizon.

Parameters:

  • observer (Instrument) – Ground station sensor.

  • target (Spacecraft) – Spacecraft for measurements to be taken of.

  • elevation_mask (float, optional) – Elevation mask defined in degrees above the horizon, defaults to 10.0.

Returns:

visibility_tag – True if the station can see the spacecraft. False` if the station cannot see the spacecraft.

Return type:

bool

property mass: ArrayWUnits#

The mass of the Body object.

property name: str#

The name of the Body object.

property spice_id: int | str#

The SPICE ID of the Body object.