ModelSrcInterface

class ModelSrcInterface[source]

Bases: object

Base object for the creation of the shadowgram model of different sources

Attributes Summary

attitude
duration
e_max
e_min
idx_chan
mdl_effect
name
position
sim_geom
snr
time
velocity

Methods Summary

get_model([obs_time]) should return the shadowgram model
get_noisy_model([obs_time]) Return the shadowgram model with poisson noise
set_energy_band(e_min, e_max) set the energy lower and upper limit for sources models classes
set_idx_channel(idx_chan)
set_satellite_context(attitude, position, …) set the satellite information: attitude, position, velocity and time
set_sim_dpix(dpix)
use_always_noisy_model()

Attributes Documentation

attitude = [0, 0, 0]
duration = 10
e_max = 0
e_min = 0
idx_chan = 0
mdl_effect = <common.instru.model_effect.ECLAIRsDetectorEffectDefault object>
name
position = [0, 0, 0]
sim_geom = <simu.lib.InstruX.SimuECLAIRsMaskProjection object>
snr
time = None
velocity = [0, 0, 0]

Methods Documentation

get_model(obs_time=None)[source]

should return the shadowgram model

get_noisy_model(obs_time=None)[source]

Return the shadowgram model with poisson noise

classmethod set_energy_band(e_min, e_max)[source]

set the energy lower and upper limit for sources models classes :param e_min: energy lower limit in keV :type e_min: float :param e_max: energy upper limit in keV :type e_max: float

classmethod set_idx_channel(idx_chan)[source]
classmethod set_satellite_context(attitude, position, velocity, time)[source]

set the satellite information: attitude, position, velocity and time

Parameters:
  • attitude ([float, float, float]) – [ra, dec, ori] in degrees
  • position ([float, float, float]) – [X, Y, Z] in km in J2000
  • velocity ([float, float, float]) – [Vx, Vy, Vz] in km/s
  • time (float) – PPS time in s from mjdref
classmethod set_sim_dpix(dpix)[source]
use_always_noisy_model()[source]