IntegralOrbit

class gdt.missions.integral.orbit.IntegralOrbit

Bases: SpacecraftFrameModelMixin, SpacecraftStatesModelMixin, FitsFileContextManager

Class for reading a INTEGRAL ORBIT file.

Attributes Summary

bcppid	Broadcast packet pointing ID at ScW start
date	The Creation or modification date
dec_scx	Declination of s/c viewing direction
dec_scz	Declination of the s/c Z-axis
distance	The Spacecraft distance from the Earth centre
ertfirst	Earth received time of the first packet
ertlast	Earth received time of the last packet
filename	The filename
hdulist	The list of Header Data Units
headers	The headers
num_hdus	The number of HDUs
obtend	OBT of the end of the Science Window
obtime	The Central on-board time
obtstart	OBT of the start of the Science Window
posangle	Position angle in degrees
preswid	Identifier of the previous Science Window
ra_scx	Right ascension of s/c viewing direction
ra_scz	Right ascension of the s/c Z-axis
revol	The Revolution Number
revol_frac	The Fractional revolution number
revol_header	Revolution number
revol_phase	The Phase of the revolution
sw_type	Type of the Science Window
swbound	Reason for Science Window ending
swid	Science Window identifier
xpos	The X component of the s/c position vector
xvel	The X component of the s/c velocity vector
ypos	The Y component of the s/c position vector
yvel	The Y component of the s/c velocity vector
zpos	The Z component of the s/c position vector
zvel	The Z component of the s/c velocity vector

Methods Summary

close()	Close the file
column(hdu_num, col_name)	Return a column from an HDU as an array.
columns_as_array(hdu_num, col_names[, dtype])	Return a list of columns from an HDU as an array.
get_column_names(hdu_num)	Get the column names in a HDU.
get_spacecraft_frame()	Retrieves the spacecraft frame from the model.
get_spacecraft_states()	Retrieves the spacecraft state information from the model.
open(file_path, **kwargs)	Open a INTEGRAL Orbithist FITS file.
set_spacecraft_frame(frame)	Saves the spacecraft frame to the model.
set_spacecraft_states(series)	Saves the spacecraft state to the model.
write(directory[, filename])	Write the file to disk.

Attributes Documentation

bcppid

Broadcast packet pointing ID at ScW start

Type:

(integer)

date

The Creation or modification date

Type:

(str)

dec_scx

Declination of s/c viewing direction

Type:

(float)

dec_scz

Declination of the s/c Z-axis

Type:

(float)

distance

The Spacecraft distance from the Earth centre

Type:

(float)

ertfirst

Earth received time of the first packet

Type:

(str)

ertlast

Earth received time of the last packet

Type:

(str)

filename

The filename

Type:

(str)

hdulist

The list of Header Data Units

Type:

(astropy.io.fits.hdu.HDUList)

headers

The headers

Type:

(FileHeaders)

num_hdus

The number of HDUs

Type:

(int)

obtend

OBT of the end of the Science Window

Type:

(integer)

obtime

The Central on-board time

Type:

(float)

obtstart

OBT of the start of the Science Window

Type:

(integer)

posangle

Position angle in degrees

Type:

(float)

preswid

Identifier of the previous Science Window

Type:

(integer)

ra_scx

Right ascension of s/c viewing direction

Type:

(float)

ra_scz

Right ascension of the s/c Z-axis

Type:

(float)

revol

The Revolution Number

Type:

(float)

revol_frac

The Fractional revolution number

Type:

(float)

revol_header

Revolution number

Type:

(str)

revol_phase

The Phase of the revolution

Type:

(float)

sw_type

Type of the Science Window

Type:

(integer)

swbound

Reason for Science Window ending

Type:

(integer)

swid

Science Window identifier

Type:

(integer)

xpos

The X component of the s/c position vector

Type:

(float)

xvel

The X component of the s/c velocity vector

Type:

(float)

ypos

The Y component of the s/c position vector

Type:

(float)

yvel

The Y component of the s/c velocity vector

Type:

(float)

zpos

The Z component of the s/c position vector

Type:

(float)

zvel

The Z component of the s/c velocity vector

Type:

(float)

Methods Documentation

close()

Close the file

column(hdu_num: int, col_name: str) → array

Return a column from an HDU as an array.

Parameters:

• hdu_num (int) – The HDU number

• col_name (str) – The name of the column

Returns:

(np.array)

columns_as_array(hdu_num: int, col_names: List[str], dtype: dtype = None) → array

Return a list of columns from an HDU as an array.

Parameters:

• hdu_num (int) – The HDU number

• col_names (list of str) – The names of the columns

• dtype (np.dtype, optional) – The custom dtype of the output array

Returns:

(np.array)

get_column_names(hdu_num: int)

Get the column names in a HDU. Returns empty if there is no data extension in the HDU.

Parameters:

hdu_num (int) – The HDU number

Returns:

(tuple)

get_spacecraft_frame() → SpacecraftFrame

Retrieves the spacecraft frame from the model.

Returns:

(SpacecraftFrame)

get_spacecraft_states() → TimeSeries

Retrieves the spacecraft state information from the model.

Returns:

(astropy.timeseries.TimeSeries)

classmethod open(file_path, **kwargs)

Open a INTEGRAL Orbithist FITS file.

Parameters:

file_path (str) – The file path of the FITS file

Returns:

(IntegralOrbitHist)

set_spacecraft_frame(frame: SpacecraftFrame)

Saves the spacecraft frame to the model.

Parameters:

frame (SpacecraftFrame) – The object to be saved to the model.

set_spacecraft_states(series: TimeSeries)

Saves the spacecraft state to the model.

Parameters:

series (astropy.timeseries.TimeSeries) – Object containing spacecraft states to be saved to model.

write(directory: str | Path, filename: str = None, **kwargs)

Write the file to disk.

Parameters:

• directory (str) – The directory to write the file.

• filename (str, optional) – The filename. If omitted, attempts to use the filename if set.