SunInFov

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.

Constructor

Methods Summary

compute_earth_frac(open_fov_map[, size_fov_map]) Compute earth fraction in FOV;
get_fov_direlev()
get_fov_xyz()
is_in_fov() Return whether Earth appears in ECALIRs field of view
limb_angle()
return:limb angle in degrees
open_fov_map([n_size]) Create the open field of view map, ie.
set_eclairs_attitude(ecl_att) Set ECLAIRs attitude object
set_pos_sat_time(c_pos[, c_time]) Set satellite position at considered time.
set_quater_svom(quater) Set SVOM quaternion

Methods Documentation

compute_earth_frac(open_fov_map, size_fov_map=199)

Compute earth fraction in FOV;

Parameters:
  • open_fov_map (int) – sky map with directions occulted by Earth
  • size_fov_map – siwe of sky map. Default is 199.
Returns:

earth fraction
Return type:

float
get_fov_direlev()
get_fov_xyz()
is_in_fov()

Return whether Earth appears in ECALIRs field of view

Returns:if Earth is in FOV
Return type:bool
limb_angle()
Returns:limb angle in degrees
Return type:float
open_fov_map(n_size=199)

Create the open field of view map, ie. a detector size array (199x199) filled with 0 and 1. Each pixel value is 0 if Earth is present in the LoS and 1 otherwise.

Parameters:idx_row (int) – row index in astropy table
Returns:open fov 199x199 map
Return type:2D array(bool)
set_eclairs_attitude(ecl_att)

Set ECLAIRs attitude object ..warning: set position satellite before :param ecl_att: ECLAIRs instrument attitude object :type ecl_att: array(float) of length 3

set_pos_sat_time(c_pos, c_time=None)

Set satellite position at considered time.

Parameters:
  • c_pos (array(float) of length 3) – satellite position [X, Y, Z] in km
  • c_time (float) – considered time in s. Default is None.
set_quater_svom(quater)

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