Documentation for PandoraSpacecraft

Bases: pandoraspacecraft.spacecraft.Spacecraft

A class representing the Pandora spacecraft.

This class extends the Spacecraft base class and includes spacecraft-specific configurations, such as the unique SPICE NAIF ID code for the Pandora mission.

Attributes:

Name	Type	Description
spacecraft_code	int	The SPICE NAIF ID code for the Pandora spacecraft.
time_offset	int	The JD value for the launch date of Pandora

Initializes the Spacecraft object and loads SPICE kernels.

This method clears any previously loaded SPICE kernels, loads the kernels specified in the Meta.txt file, and determines the start and end times of the kernel data.

Parameters:

Name	Type	Description	Default
test_mode		Whether to use the test kernels. Test kernels are small, truncated kernels for each spacecraft valid over a short time range. If you use this mode, pandoraspacecraft will not connect to the internet, download new kernels, or used cached kernels. Use this mode if you want to test pandoraspacecraft as a dependency in your package.	required

Raises:

Type	Description
Exception	If there is an issue loading the SPICE kernels or retrieving the kernel time coverage.

get_altitude(time)

Returns the altitude of Pandora at each time in km.

Parameters:

Name	Type	Description	Default
time	Time	Time array at which to estimate position.	required

Returns:

Name	Type	Description
altitude	Quantity	Altitude of the spacecraft at the given time in km

get_period(time)

Returns the orbital period of Pandora at each time in minutes.

Parameters:

Name	Type	Description	Default
time		Time array at which to estimate position.	required

Returns:

Name	Type	Description
period	Quantity	Period of the spacecraft at the given time in minutes

get_spacecraft_position(time, observer='SOLAR SYSTEM BARYCENTER')

Returns the position vector (x, y, z) in [km] for all time w.r.t the observer.

Parameters:

Name	Type	Description	Default
time	Time	Time array at which to estimate position. Time must be in BJD.	required
observer	string	Observer body. Common options include "SOLAR SYSTEM BARYCENTER", "EARTH BARYCENTER", "MOON BARYCENTER"	'SOLAR SYSTEM BARYCENTER'

get_spacecraft_velocity(time, observer='SOLAR SYSTEM BARYCENTER')

Returns the position vector (vx, vy, vz) in [km/s] for all time w.r.t the observer.

Parameters:

Name	Type	Description	Default
time	Time	Time array at which to estimate velocity. Time must be in BJD.	required
observer	string	Observer body. Common options include "SOLAR SYSTEM BARYCENTER", "EARTH BARYCENTER", "MOON BARYCENTER"	'SOLAR SYSTEM BARYCENTER'

get_spacecraft_light_travel_time(time, observer='SOLAR SYSTEM BARYCENTER')

Returns the one-way light travel time in seconds for all time w.r.t the observer.

Parameters:

Name	Type	Description	Default
time	Time	Time array at which to estimate position. Time must be in BJD.	required
observer	string	Observer body. Common options include "SOLAR SYSTEM BARYCENTER", "EARTH BARYCENTER", "MOON BARYCENTER"	'SOLAR SYSTEM BARYCENTER'

get_earth_subpoint(time)

Returns the lattitude and longitude of the point underneath Pandora, accounting for light travel time and aberations.

Parameters:

Name	Type	Description	Default
time	Time	Time array at which to estimate position.	required

Returns:

Name	Type	Description
lon	Quantity	Longitude of the point on earth below the spacecraft in degrees
lat	Quantity	Latitude of the point on earth below the spacecraft in degrees

get_earth_illumination(time)

Returns the angle of incidence of sunlight on the earth directly under Pandora

Parameters:

Name	Type	Description	Default
time	Time	Time array at which to estimate position.	required

Returns:

Name	Type	Description
incidence	Quantity	Incidence of sunlight on the point on earth below the spacecraft in degrees.