ctools 2.1.0.dev
Loading...
Searching...
No Matches
cscripts.csiactobs.csiactobs Class Reference
Inheritance diagram for cscripts.csiactobs.csiactobs:

Public Member Functions

 __init__ (self, *argv)
 
 process (self)
 
 save (self)
 
 runlist (self, runlist)
 
 ebounds (self)
 
 obs (self)
 

Protected Member Functions

 _get_parameters (self)
 
 _background_spectrum (self, prefactor, index, emin=0.01, emax=100.0)
 
 _iact_background (self, telescope, obs_id, bkg_scale, bkgtype, emin=0.01, emax=100)
 
 _append_inmodels (self)
 
 _write_summary (self)
 
 _get_filename (self, hdu, hierarchy, formats)
 
 _is_present (self, filename, obs_id, filetype)
 

Protected Attributes

 _obs
 
 _ebounds
 
 _datapath
 
 _prodname
 
 _xml
 
 _models
 
 _runlist
 
 _runlistfile
 
 _bkgpars
 
 _master_indx
 
 _use_bkg_scale
 
 _ev_hiera
 
 _aeff_hiera
 
 _psf_hiera
 
 _bkg_hiera
 
 _edisp_hiera
 
 _bkg_mod_hiera
 
 _bkg_gauss_norm
 
 _bkg_gauss_index
 
 _bkg_gauss_sigma
 
 _bkg_aeff_index
 
 _bkg_aeff_norm
 
 _bkg_range_factor
 
 _hdu_index
 
 _obs_index
 
 _subdir
 
 _debug
 
 _xml_obslist
 

Detailed Description

Generates an IACT observation definition XML file

This class implements the creation of a observation xml file for IACT
data analysis. This class is dedicated for use inside a IACT
Collaboration, i.e. it can only be used if you have access to IACT data
in FITS format. The FITS data has to be structured and in the format
described here:
http://gamma-astro-data-formats.readthedocs.org/en/latest/

Definition at line 31 of file csiactobs.py.

Constructor & Destructor Documentation

◆ __init__()

cscripts.csiactobs.csiactobs.__init__ ( self,
* argv )
Constructor

Definition at line 44 of file csiactobs.py.

Member Function Documentation

◆ _append_inmodels()

◆ _background_spectrum()

cscripts.csiactobs.csiactobs._background_spectrum ( self,
prefactor,
index,
emin = 0.01,
emax = 100.0 )
protected
Create a background spectrum model dependent on user parameters

Parameters
----------
prefactor : float
    Power law prefactor of spectral model
index : float
    Power law index of spectral model
emin : float
    Minimum energy (in case a spectral node function is required)
emax : float
    Maximum energy (in case a spectral node function is required)

Returns
-------
spec : `~gammalib.GModelSpectral()`
    Spectral model for the background shape     

Definition at line 245 of file csiactobs.py.

References cscripts.csiactobs.csiactobs._bkg_range_factor, and cscripts.csiactobs.csiactobs._bkgpars.

Referenced by cscripts.csiactobs.csiactobs._iact_background().

◆ _get_filename()

cscripts.csiactobs.csiactobs._get_filename ( self,
hdu,
hierarchy,
formats )
protected
Retrieves a filename from a hdu index

Parameters
----------
hdu : `~gammalib.GFitsTable`
    HDU FITS table
hierarchy : list of str
    List of strings containing the hierarchy how to look for files
formats : list of str
    File formats available for this observation

Returns
-------
filename : str
    Filename of requested file

Definition at line 476 of file csiactobs.py.

References cscripts.csiactobs.csiactobs._subdir.

Referenced by cscripts.csiactobs.csiactobs.process().

◆ _get_parameters()

cscripts.csiactobs.csiactobs._get_parameters ( self)
protected
Get parameters from parfile and setup the observation

Definition at line 93 of file csiactobs.py.

References cscripts.csiactobs.csiactobs._aeff_hiera, cscripts.csiactobs.csiactobs._bkg_aeff_index, cscripts.csiactobs.csiactobs._bkg_aeff_norm, cscripts.csiactobs.csiactobs._bkg_gauss_index, cscripts.csiactobs.csiactobs._bkg_gauss_norm, cscripts.csiactobs.csiactobs._bkg_gauss_sigma, cscripts.csiactobs.csiactobs._bkg_hiera, cscripts.csiactobs.csiactobs._bkg_mod_hiera, cscripts.csiactobs.csiactobs._bkg_range_factor, cscripts.csiactobs.csiactobs._bkgpars, cscripts.csfindobs.csfindobs._datapath, cscripts.csiactcopy.csiactcopy._datapath, cscripts.csiactdata.csiactdata._datapath, cscripts.csiactobs.csiactobs._datapath, cscripts.csiactobs.csiactobs._debug, cscripts.csiactobs.csiactobs._edisp_hiera, cscripts.csiactobs.csiactobs._ev_hiera, cscripts.csiactobs.csiactobs._hdu_index, cscripts.csiactdata.csiactdata._master_indx, cscripts.csiactobs.csiactobs._master_indx, cscripts.csfindobs.csfindobs._obs_index, cscripts.csiactobs.csiactobs._obs_index, cscripts.csfindobs.csfindobs._prodname, cscripts.csiactcopy.csiactcopy._prodname, cscripts.csiactobs.csiactobs._prodname, cscripts.csiactobs.csiactobs._psf_hiera, cscripts.csiactcopy.csiactcopy._runlist, cscripts.csiactobs.csiactobs._runlist, cscripts.csiactobs.csiactobs._runlistfile, cscripts.csiactobs.csiactobs._subdir, and cscripts.csiactobs.csiactobs._use_bkg_scale.

Referenced by cscripts.csadd2caldb.csadd2caldb.process(), cscripts.csbkgmodel.csbkgmodel.process(), cscripts.cscaldb.cscaldb.process(), cscripts.csebins.csebins.process(), cscripts.csfindobs.csfindobs.process(), cscripts.csfootprint.csfootprint.process(), cscripts.csiactcopy.csiactcopy.process(), cscripts.csiactdata.csiactdata.process(), cscripts.csiactobs.csiactobs.process(), cscripts.cslightcrv.cslightcrv.process(), cscripts.csmodelinfo.csmodelinfo.process(), cscripts.csmodelmerge.csmodelmerge.process(), cscripts.csmodelselect.csmodelselect.process(), cscripts.csmodelsois.csmodelsois.process(), cscripts.csobs2caldb.csobs2caldb.process(), cscripts.csobsdef.csobsdef.process(), cscripts.csobsinfo.csobsinfo.process(), cscripts.csobsselect.csobsselect.process(), cscripts.csphagen.csphagen.process(), cscripts.csphasecrv.csphasecrv.process(), cscripts.cspull.cspull.process(), cscripts.csresmap.csresmap.process(), cscripts.csresspec.csresspec.process(), cscripts.csroot2caldb.csroot2caldb.process(), cscripts.csscs.csscs.process(), cscripts.cssens.cssens.process(), cscripts.csspec.csspec.process(), cscripts.cssrcdetect.cssrcdetect.process(), cscripts.cstsdist.cstsdist.process(), cscripts.cstsmapmerge.cstsmapmerge.process(), cscripts.cstsmapsplit.cstsmapsplit.process(), cscripts.csviscube.csviscube.process(), and cscripts.csworkflow.csworkflow.process().

◆ _iact_background()

cscripts.csiactobs.csiactobs._iact_background ( self,
telescope,
obs_id,
bkg_scale,
bkgtype,
emin = 0.01,
emax = 100 )
protected
Create an IACT background model

Parameters
----------
telescope : str
    Name of telescope
obs_id : str
    Observation ID
bkg_scale : float
    Background scaling factor
bkgtype : str
    Type of background (irf,aeff, or gauss)

Returns
-------
model : `~gammalib.GModelData()`
    Background model for IACT observation

Definition at line 346 of file csiactobs.py.

References cscripts.csiactobs.csiactobs._background_spectrum(), cscripts.csiactobs.csiactobs._bkg_aeff_index, cscripts.csiactobs.csiactobs._bkg_aeff_norm, cscripts.csiactobs.csiactobs._bkg_gauss_index, cscripts.csiactobs.csiactobs._bkg_gauss_norm, and cscripts.csiactobs.csiactobs._bkg_gauss_sigma.

Referenced by cscripts.csiactobs.csiactobs.process().

◆ _is_present()

cscripts.csiactobs.csiactobs._is_present ( self,
filename,
obs_id,
filetype )
protected
Checks if a filename is present

Parameters
----------
filename : str
    Filename
obs_id : int
    Observation ID
filetype : str
    Type of file

Returns
-------
present : bool
    True if filename is present, False otherwise

Definition at line 523 of file csiactobs.py.

Referenced by cscripts.csiactobs.csiactobs.process().

◆ _write_summary()

◆ ebounds()

◆ obs()

cscripts.csiactobs.csiactobs.obs ( self)
Return observations container

Definition at line 847 of file csiactobs.py.

References cscripts.csbkgmodel.csbkgmodel._models, cscripts.csiactobs.csiactobs._models, cscripts.csmodelinfo.csmodelinfo._models, cscripts.csmodelmerge.csmodelmerge._models, cscripts.csmodelselect.csmodelselect._models, cscripts.csmodelsois.csmodelsois._models, cscripts.csphagen.csphagen._models, cscripts.cssens.cssens._models, cscripts.cssrcdetect.cssrcdetect._models, cscripts.csiactobs.csiactobs._obs, cscripts.csobsdef.csobsdef._obs, and cscripts.csiactobs.csiactobs._xml.

Referenced by cscripts.cslightcrv.cslightcrv._adjust_model_pars(), cscripts.csscs.csscs._adjust_model_pars(), cscripts.csspec.csspec._adjust_model_pars(), cscripts.cstsmapsplit.cstsmapsplit._compute_null_hypothesis(), cscripts.cslightcrv.cslightcrv._create_fits_table(), cscripts.csphasecrv.csphasecrv._create_fits_table(), cscripts.cslightcrv.cslightcrv._create_tbounds(), cscripts.csspec.csspec._fit_model(), cscripts.csbkgmodel.csbkgmodel._generate_runwise_bkg(), cscripts.cslightcrv.cslightcrv._get_free_par_names(), cscripts.csphasecrv.csphasecrv._get_free_par_names(), cscripts.csbkgmodel.csbkgmodel._get_instrument(), cscripts.csbkgmodel.csbkgmodel._get_parameters(), cscripts.csebins.csebins._get_parameters(), cscripts.cslightcrv.cslightcrv._get_parameters(), cscripts.csmodelselect.csmodelselect._get_parameters(), cscripts.csobs2caldb.csobs2caldb._get_parameters(), cscripts.csobsinfo.csobsinfo._get_parameters(), cscripts.csobsselect.csobsselect._get_parameters(), cscripts.csphagen.csphagen._get_parameters(), cscripts.csphasecrv.csphasecrv._get_parameters(), cscripts.cspull.cspull._get_parameters(), cscripts.csresmap.csresmap._get_parameters(), cscripts.csresspec.csresspec._get_parameters(), cscripts.csscs.csscs._get_parameters(), cscripts.cssens.cssens._get_parameters(), cscripts.csspec.csspec._get_parameters(), cscripts.cstsdist.cstsdist._get_parameters(), cscripts.cstsmapsplit.cstsmapsplit._get_parameters(), cscripts.csphagen.csphagen._get_parameters_bkgmethod_custom(), cscripts.csphagen.csphagen._get_parameters_bkgmethod_off(), cscripts.cssens.cssens._get_sensitivity(), cscripts.csspec.csspec._log_spectral_binning(), cscripts.csscs.csscs._mask_observations(), cscripts.csphasecrv.csphasecrv._phase_bin(), cscripts.csphagen.csphagen._process_observation(), cscripts.csspec.csspec._select_obs(), cscripts.csspec.csspec._set_ebounds(), cscripts.cssens.cssens._set_obs_ebounds(), cscripts.csspec.csspec._set_replace_src_spectrum_by_bins(), cscripts.csspec.csspec._set_replace_src_spectrum_by_nodes(), cscripts.cssens.cssens._set_source(), cscripts.cssens.cssens._set_src_prefactor(), cscripts.cstsdist.cstsdist._sim(), cscripts.cssens.cssens._sim_evt_excess(), cscripts.cslightcrv.cslightcrv._timebin(), cscripts.cspull.cspull._trial(), cscripts.cslightcrv.cslightcrv.models(), cscripts.cspull.cspull.models(), cscripts.csresmap.csresmap.models(), cscripts.csspec.csspec.models(), cscripts.cstsdist.cstsdist.models(), cscripts.csbkgmodel.csbkgmodel.process(), cscripts.csebins.csebins.process(), cscripts.cslightcrv.cslightcrv.process(), cscripts.csmodelselect.csmodelselect.process(), cscripts.csobsinfo.csobsinfo.process(), cscripts.csobsselect.csobsselect.process(), cscripts.csphagen.csphagen.process(), cscripts.csphasecrv.csphasecrv.process(), cscripts.cspull.cspull.process(), cscripts.csresmap.csresmap.process(), cscripts.csresspec.csresspec.process(), cscripts.csscs.csscs.process(), cscripts.cssens.cssens.process(), cscripts.csspec.csspec.process(), cscripts.cstsdist.cstsdist.process(), cscripts.cstsmapsplit.cstsmapsplit.process(), and cscripts.csphagen.csphagen.save().

◆ process()

cscripts.csiactobs.csiactobs.process ( self)
Process the script

Definition at line 566 of file csiactobs.py.

References cscripts.csiactobs.csiactobs._aeff_hiera, cscripts.csiactobs.csiactobs._append_inmodels(), cscripts.csiactobs.csiactobs._bkg_hiera, cscripts.csiactobs.csiactobs._bkg_mod_hiera, cscripts.csebins.csebins._ebounds, cscripts.csiactobs.csiactobs._ebounds, cscripts.csobsinfo.csobsinfo._ebounds, cscripts.csphagen.csphagen._ebounds, cscripts.cssens.cssens._ebounds, cscripts.csspec.csspec._ebounds, cscripts.csiactobs.csiactobs._edisp_hiera, cscripts.csiactobs.csiactobs._ev_hiera, cscripts.csiactobs.csiactobs._get_filename(), cscripts.csadd2caldb.csadd2caldb._get_parameters(), cscripts.csbkgmodel.csbkgmodel._get_parameters(), cscripts.cscaldb.cscaldb._get_parameters(), cscripts.csebins.csebins._get_parameters(), cscripts.csfindobs.csfindobs._get_parameters(), cscripts.csfootprint.csfootprint._get_parameters(), cscripts.csiactcopy.csiactcopy._get_parameters(), cscripts.csiactdata.csiactdata._get_parameters(), cscripts.csiactobs.csiactobs._get_parameters(), cscripts.cslightcrv.cslightcrv._get_parameters(), cscripts.csmodelinfo.csmodelinfo._get_parameters(), cscripts.csmodelmerge.csmodelmerge._get_parameters(), cscripts.csmodelselect.csmodelselect._get_parameters(), cscripts.csmodelsois.csmodelsois._get_parameters(), cscripts.csobs2caldb.csobs2caldb._get_parameters(), cscripts.csobsdef.csobsdef._get_parameters(), cscripts.csobsinfo.csobsinfo._get_parameters(), cscripts.csobsselect.csobsselect._get_parameters(), cscripts.csphagen.csphagen._get_parameters(), cscripts.csphasecrv.csphasecrv._get_parameters(), cscripts.cspull.cspull._get_parameters(), cscripts.csresmap.csresmap._get_parameters(), cscripts.csresspec.csresspec._get_parameters(), cscripts.csroot2caldb.csroot2caldb._get_parameters(), cscripts.csscs.csscs._get_parameters(), cscripts.cssens.cssens._get_parameters(), cscripts.csspec.csspec._get_parameters(), cscripts.cssrcdetect.cssrcdetect._get_parameters(), cscripts.cstsdist.cstsdist._get_parameters(), cscripts.cstsmapmerge.cstsmapmerge._get_parameters(), cscripts.cstsmapsplit.cstsmapsplit._get_parameters(), cscripts.csviscube.csviscube._get_parameters(), cscripts.csworkflow.csworkflow._get_parameters(), cscripts.csiactobs.csiactobs._hdu_index, cscripts.csiactobs.csiactobs._iact_background(), cscripts.csiactobs.csiactobs._is_present(), cscripts.csbkgmodel.csbkgmodel._models, cscripts.csiactobs.csiactobs._models, cscripts.csmodelinfo.csmodelinfo._models, cscripts.csmodelmerge.csmodelmerge._models, cscripts.csmodelselect.csmodelselect._models, cscripts.csmodelsois.csmodelsois._models, cscripts.csphagen.csphagen._models, cscripts.cssens.cssens._models, cscripts.cssrcdetect.cssrcdetect._models, cscripts.csfindobs.csfindobs._obs_index, cscripts.csiactobs.csiactobs._obs_index, cscripts.csiactobs.csiactobs._psf_hiera, cscripts.csiactcopy.csiactcopy._runlist, cscripts.csiactobs.csiactobs._runlist, cscripts.csiactobs.csiactobs._use_bkg_scale, cscripts.csiactobs.csiactobs._write_summary(), and cscripts.csiactobs.csiactobs._xml_obslist.

◆ runlist()

cscripts.csiactobs.csiactobs.runlist ( self,
runlist )
Set runlist

Parameters
----------
runlist : list
    List of observation IDs

Raises
------
RuntimeError
    Input runlist is not a Python list

Definition at line 814 of file csiactobs.py.

References cscripts.csiactcopy.csiactcopy._runlist, and cscripts.csiactobs.csiactobs._runlist.

◆ save()

Member Data Documentation

◆ _aeff_hiera

cscripts.csiactobs.csiactobs._aeff_hiera
protected

◆ _bkg_aeff_index

cscripts.csiactobs.csiactobs._bkg_aeff_index
protected

◆ _bkg_aeff_norm

cscripts.csiactobs.csiactobs._bkg_aeff_norm
protected

◆ _bkg_gauss_index

cscripts.csiactobs.csiactobs._bkg_gauss_index
protected

◆ _bkg_gauss_norm

cscripts.csiactobs.csiactobs._bkg_gauss_norm
protected

◆ _bkg_gauss_sigma

cscripts.csiactobs.csiactobs._bkg_gauss_sigma
protected

◆ _bkg_hiera

cscripts.csiactobs.csiactobs._bkg_hiera
protected

◆ _bkg_mod_hiera

cscripts.csiactobs.csiactobs._bkg_mod_hiera
protected

◆ _bkg_range_factor

cscripts.csiactobs.csiactobs._bkg_range_factor
protected

◆ _bkgpars

cscripts.csiactobs.csiactobs._bkgpars
protected

◆ _datapath

◆ _debug

cscripts.csiactobs.csiactobs._debug
protected

Definition at line 78 of file csiactobs.py.

Referenced by cscripts.csiactobs.csiactobs._get_parameters().

◆ _ebounds

◆ _edisp_hiera

cscripts.csiactobs.csiactobs._edisp_hiera
protected

◆ _ev_hiera

cscripts.csiactobs.csiactobs._ev_hiera
protected

◆ _hdu_index

cscripts.csiactobs.csiactobs._hdu_index
protected

◆ _master_indx

cscripts.csiactobs.csiactobs._master_indx
protected

◆ _models

cscripts.csiactobs.csiactobs._models
protected

Definition at line 57 of file csiactobs.py.

Referenced by cscripts.csbkgmodel.csbkgmodel.__getstate__(), cscripts.csphagen.csphagen.__getstate__(), cscripts.cssens.cssens.__getstate__(), cscripts.csbkgmodel.csbkgmodel.__setstate__(), cscripts.csphagen.csphagen.__setstate__(), cscripts.cssens.cssens.__setstate__(), cscripts.cssrcdetect.cssrcdetect._add_model(), cscripts.csiactobs.csiactobs._append_inmodels(), cscripts.cssens.cssens._e_bin(), cscripts.csmodelsois.csmodelsois._gen_cubemodel(), cscripts.csbkgmodel.csbkgmodel._generate_runwise_bkg(), cscripts.csmodelinfo.csmodelinfo._get_parameters(), cscripts.csmodelselect.csmodelselect._get_parameters(), cscripts.csphagen.csphagen._get_parameters(), cscripts.csphagen.csphagen._get_parameters_bkgmethod_custom(), cscripts.csphagen.csphagen._get_parameters_bkgmethod_off(), cscripts.csphagen.csphagen._process_observation(), cscripts.csphagen.csphagen._set_models(), cscripts.csbkgmodel.csbkgmodel.models(), cscripts.csmodelsois.csmodelsois.models(), cscripts.cssrcdetect.cssrcdetect.models(), cscripts.csiactobs.csiactobs.obs(), cscripts.csbkgmodel.csbkgmodel.process(), cscripts.csiactobs.csiactobs.process(), cscripts.csmodelinfo.csmodelinfo.process(), cscripts.csmodelmerge.csmodelmerge.process(), cscripts.csmodelselect.csmodelselect.process(), cscripts.cssens.cssens.process(), cscripts.cssrcdetect.cssrcdetect.process(), cscripts.csbkgmodel.csbkgmodel.save(), cscripts.csiactobs.csiactobs.save(), cscripts.csmodelinfo.csmodelinfo.save(), cscripts.csmodelmerge.csmodelmerge.save(), and cscripts.csmodelsois.csmodelsois.save().

◆ _obs

cscripts.csiactobs.csiactobs._obs
protected

◆ _obs_index

◆ _prodname

◆ _psf_hiera

cscripts.csiactobs.csiactobs._psf_hiera
protected

◆ _runlist

◆ _runlistfile

cscripts.csiactobs.csiactobs._runlistfile
protected

Definition at line 59 of file csiactobs.py.

Referenced by cscripts.csiactobs.csiactobs._get_parameters().

◆ _subdir

cscripts.csiactobs.csiactobs._subdir
protected

◆ _use_bkg_scale

cscripts.csiactobs.csiactobs._use_bkg_scale
protected

◆ _xml

cscripts.csiactobs.csiactobs._xml
protected

◆ _xml_obslist

cscripts.csiactobs.csiactobs._xml_obslist
protected

Definition at line 86 of file csiactobs.py.

Referenced by cscripts.csiactobs.csiactobs.process().


The documentation for this class was generated from the following file: