InstruXbase

class InstruXbase(p_mask: ecpi.common.num.array_square_cell.ArraySquareCell, p_detec: ecpi.common.num.array_square_cell.ArraySquareCell, p_dist_mask_detec)[source]

Bases: object

mask convention : 1 for hole, 0 stop photon

Methods Summary

elevdir_to_skypix(elev, direction) convert elevation/direction coordinates into sky pixels coordinates
get_elevation_limit_fov_corner() for special case where mask and detector are square and with the same center
get_elevation_limit_fov_side() for special case where mask and detector are square and with the same center
get_full_surface_mask() in cm2
get_open_surface_mask() in cm2
get_percent_open_mask()
get_surface_rect_proj() compute intersection detector and shadow mask then compute its surface
get_total_photon()
set_pos_source_fov(elevation, direction) set definition of the translation vector linked to the source
skypix_to_elevdir(pix_y, pix_z) convert pixel coordinates into elevation and direction

Methods Documentation

elevdir_to_skypix(elev, direction)[source]

convert elevation/direction coordinates into sky pixels coordinates

(0,0) is at the center of the sky array

Parameters:
  • elev (float or array(float)) – elevation in degrees
  • direction (float or array(float)) – direction in degrees
Returns:

pixels y,z coordinates

Return type:

float, float or array2D(float)

get_elevation_limit_fov_corner()[source]

for special case where mask and detector are square and with the same center return deg

get_elevation_limit_fov_side()[source]

for special case where mask and detector are square and with the same center return deg

get_full_surface_mask()[source]

in cm2

get_open_surface_mask()[source]

in cm2

get_percent_open_mask()[source]
get_surface_rect_proj()[source]

compute intersection detector and shadow mask then compute its surface

Returns:intersection surface in cm2
Return type:float
get_total_photon()[source]
set_pos_source_fov(elevation, direction)[source]

set definition of the translation vector linked to the source vec_trans_source is also position on mask where photon passed to go on origin

skypix_to_elevdir(pix_y, pix_z)[source]

convert pixel coordinates into elevation and direction

(0,0) is at the center of the sky array

elevation from 0 to 90

direction from -pi to +pi

Parameters:
  • pix_y (float) – y coordinate of the source, in pixels.
  • pix_z (float) – z coordinates of the source, in pixels.
Returns:

elevation and direction of the source

Return type:

float, float