ecpi.common.sky.extented_body module

Section author: ECLAIRs GP team

To manage extended body in field of view, like: Earth, moon, sun

Summary

Classes:

EarthInFov

Informs if Earth is in the filed of view of the ECLAIRs instrument.

ExtentedBodyInFov

Informs if an arbitrary astronomical body is in the filed of view of the ECLAIRs instrument.

MoonInFov

Informs if Moon is in the filed of view of the ECLAIRs instrument.

SunInFov

Informs if Sun is in the filed of view of the ECLAIRs instrument.

Class diagram:

Reference

class EarthInFov[source]

Bases: ecpi.common.sky.extented_body.ExtentedBodyInFov

Informs if Earth is in the filed of view of the ECLAIRs instrument. Inherits from ExtendedBodyinFov class.

class ExtentedBodyInFov[source]

Bases: object

Informs if an arbitrary astronomical body is in the filed of view of the ECLAIRs instrument.

body_direlev()[source]

Spherical position in FOV of body in direction and elevation convention

body_xyz()[source]

Cartesian position in FOV of body

compute_occultation_frac()[source]

Compute occultation fraction in FOV, call open_fov_map() method before

Parameters

side_fov – integer, number of side pixels

Returns

earth fraction [0..1]

Return type

float

compute_openfov_map(side_fov=199)[source]

Create the open field of view map

Note

Definition

OpenFOV map is square boolean array (side_fovxside_fov), True is open (no extended body)

Parameters

side_fov – integer, number of side pixels

Returns

True if extended body is NOT present

Return type

numpy array (side_fov, side_fov) of bool

is_in_fov()[source]

Return whether Earth appears in ECALIRs field of view

Returns

if Earth is in FOV

Return type

bool

limb_angle()[source]
Returns

limb angle in degrees

Return type

float

set_eclairs_attitude(ecl_att)[source]

Set ECLAIRs attitude object

Parameters

ecl_att (array(float) of length 3) – ECLAIRs instrument attitude object

set_pos_sat_time(pos_sat, cur_time=None)[source]

Set satellite position at considered time.

Parameters

  • pos_sat (array(float) of length 3) – satellite position [X, Y, Z] in km

  • cur_time (float) – considered time in s. Default is None.

set_quater_svom(quater)[source]

Set SVOM quaternion ..warning: set position satellite before :param quater: unit quaternion :type quater: array(float) of length 4

class MoonInFov[source]

Bases: ecpi.common.sky.extented_body.ExtentedBodyInFov

Informs if Moon is in the filed of view of the ECLAIRs instrument. Inherits from ExtendedBodyinFov class.

class SunInFov[source]

Bases: ecpi.common.sky.extented_body.ExtentedBodyInFov

Informs if Sun is in the filed of view of the ECLAIRs instrument. Inherits from ExtendedBodyinFov class.