ctools 2.1.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cscripts.csresspec.csresspec Class Reference
Inheritance diagram for cscripts.csresspec.csresspec:

Public Member Functions

 __init__ (self, *argv)
 
 process (self)
 
 save (self)
 
 resspec (self)
 

Protected Member Functions

 _get_parameters (self)
 
 _bin_evlist (self, obs)
 
 _masked_cube (self, cube, ra, dec, rad, emin='INDEF', emax='INDEF', regfile='NONE')
 
 _cube_to_spectrum (self, cube, evlist_info)
 
 _residuals_table (self, obs_id, ebounds, counts, model, residuals)
 
 _append_column (self, table, name, data)
 
 _results2table (self, result)
 
 _stack_results (self, results)
 
 _residuals_3D (self, obs, models, obs_id, ccube=None)
 
 _residuals_OnOff (self, obs, models, obs_id)
 

Protected Attributes

 _use_maps
 
 _stack
 
 _mask
 
 _fits
 

Detailed Description

Generates a residual spectrum

Definition at line 30 of file csresspec.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 35 of file csresspec.py.

Member Function Documentation

◆ _append_column()

cscripts.csresspec.csresspec._append_column ( self,
table,
name,
data )
protected 
Append optional column to residual table

Parameters
----------
table : `~gammalib.GFitsBinTable'
    FITS binary table
name : str
    Column name
data : float
    Data to be filled into new column

Returns
-------
table : `~gammalib.GFitsBinTable'
    FITS binary table

Definition at line 413 of file csresspec.py.

Referenced by cscripts.csresspec.csresspec._results2table().

◆ _bin_evlist()

cscripts.csresspec.csresspec._bin_evlist ( self,
obs )
protected 
Turn single event list into counts cube

Parameters
----------
obs : `~gammalib.GObservations`
    Observation container with single event list

Returns
-------
obs, info : `~gammalib.GObservations`, dict
    Binned observation container and dictionary with event list ROI
    and energy range information

Definition at line 183 of file csresspec.py.

Referenced by cscripts.csresspec.csresspec._residuals_3D().

◆ _cube_to_spectrum()

cscripts.csresspec.csresspec._cube_to_spectrum ( self,
cube,
evlist_info )
protected 
Derive from event cube a count spectrum

If data come from event list use only the ROI and energy range of
the original data. Apply user defined mask if requested.

Parameters
----------
cube : `~gammalib.GCTAEventCube`
    Event cube
evlist_info : dict
    Dictionary with information on original event list

Returns
-------
array : `~gammalib.GNdarray'
    Counts spectrum

Definition at line 303 of file csresspec.py.

References cscripts.csresspec.csresspec._mask, and cscripts.csresspec.csresspec._masked_cube().

Referenced by cscripts.csresspec.csresspec._residuals_3D().

◆ _get_parameters()

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

Definition at line 53 of file csresspec.py.

References cscripts.csresspec.csresspec._mask, cscripts.csresspec.csresspec._stack, cscripts.csresmap.csresmap._use_maps, cscripts.csresspec.csresspec._use_maps, cscripts.csiactobs.csiactobs.obs(), cscripts.csobsdef.csobsdef.obs(), ctobservation.obs(), and ctobservation.obs().

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().

◆ _masked_cube()

cscripts.csresspec.csresspec._masked_cube ( self,
cube,
ra,
dec,
rad,
emin = 'INDEF',
emax = 'INDEF',
regfile = 'NONE' )
protected 
Mask an event cube and returns the masked cube

Parameters
----------
cube : `~gammalib.GCTAEventCube`
    Event cube
ra : float (str 'INDEF' for no selection on direction)
    Right Ascension (deg)
dec : float (str 'INDEF' for no selection on direction)
    Declination (deg)
rad : float (str 'INDEF' for no selection on direction)
    Radius (deg)
emin : float (str 'INDEF' for no selection on energy)
    Minimum energy (TeV)
emax : float (str 'INDEF' for no selection on energy)
    Maximum energy (TeV)

Returns
-------
cube : `~gammalib.GCTAEventCube`
    Event cube

Definition at line 255 of file csresspec.py.

Referenced by cscripts.csresspec.csresspec._cube_to_spectrum().

◆ _residuals_3D()

cscripts.csresspec.csresspec._residuals_3D ( self,
obs,
models,
obs_id,
ccube = None )
protected 
Calculate residuals for 3D observation

Parameters
----------
obs : `~gammalib.GCTAObservation`
    CTA observation
models : `~gammalib.GModels`
    Models
obs_id : str
    Observation ID
ccube : `~gammalib.GCTAEventCube', optional
    Count cube with stacked events lists

Returns
-------
result : dict
    Residual result dictionary

Definition at line 539 of file csresspec.py.

References cscripts.csresspec.csresspec._bin_evlist(), cscripts.csresspec.csresspec._cube_to_spectrum(), cscripts.csresmap.csresmap._use_maps, and cscripts.csresspec.csresspec._use_maps.

Referenced by cscripts.csresspec.csresspec.process().

◆ _residuals_OnOff()

cscripts.csresspec.csresspec._residuals_OnOff ( self,
obs,
models,
obs_id )
protected 
Calculate residual for OnOff observation

Parameters
----------
obs : `~gammalib.GOnOffObservation`
    OnOff observation
models : `~gammalib.GModels`
    Models
obs_id : str
    Observation ID

Returns
-------
result : dict
    Residual result dictionary

Definition at line 651 of file csresspec.py.

Referenced by cscripts.csresspec.csresspec.process().

◆ _residuals_table()

cscripts.csresspec.csresspec._residuals_table ( self,
obs_id,
ebounds,
counts,
model,
residuals )
protected 
Create a Fits Table and store counts, model, and residuals

Parameters
----------
obs_id : str
    Observation id
ebounds : `~gammalib.GEbounds'
    Energy boundaries
counts : `~gammalib.GNdarray'
    Counts spectrum
model : `~gammalib.GNdarray'
    Model spectrum
residuals : `~gammalib.GNdarray'
    Residual spectrum

Returns
-------
table : `~gammalib.GFitsBinTable'
    Residual spectrum as FITS binary table

Definition at line 355 of file csresspec.py.

Referenced by cscripts.csresspec.csresspec._results2table().

◆ _results2table()

cscripts.csresspec.csresspec._results2table ( self,
result )
protected 
Turn results into FITS table

Parameters
----------
result : dict
    Result dictionary

Returns
-------
table : `~gammalib.GFitsBinTable`
    FITS binary table

Definition at line 450 of file csresspec.py.

References cscripts.csresspec.csresspec._append_column(), and cscripts.csresspec.csresspec._residuals_table().

Referenced by cscripts.csresspec.csresspec.process().

◆ _stack_results()

cscripts.csresspec.csresspec._stack_results ( self,
results )
protected 
Stack results

Parameters
----------
results : list of dict
    Residual spectra results

Returns
-------
results : list of dict
    Stacked result

Definition at line 496 of file csresspec.py.

Referenced by cscripts.csresspec.csresspec.process().

◆ process()

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

Definition at line 750 of file csresspec.py.

References cscripts.cslightcrv.cslightcrv._fits, cscripts.csphasecrv.csphasecrv._fits, cscripts.cspull.cspull._fits, cscripts.csresspec.csresspec._fits, cscripts.csscs.csscs._fits, cscripts.cssens.cssens._fits, cscripts.csspec.csspec._fits, cscripts.cstsdist.cstsdist._fits, 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.csresspec.csresspec._residuals_3D(), cscripts.csresspec.csresspec._residuals_OnOff(), cscripts.csresspec.csresspec._results2table(), cscripts.csresspec.csresspec._stack, cscripts.csresspec.csresspec._stack_results(), cscripts.csiactobs.csiactobs.obs(), cscripts.csobsdef.csobsdef.obs(), ctobservation.obs(), and ctobservation.obs().

◆ resspec()

cscripts.csresspec.csresspec.resspec ( self) 
Return residual FITS file

Returns
-------
fits : `~gammalib.GFits'
    FITS file containing residuals

Definition at line 830 of file csresspec.py.

References cscripts.cslightcrv.cslightcrv._fits, cscripts.csphasecrv.csphasecrv._fits, cscripts.cspull.cspull._fits, cscripts.csresspec.csresspec._fits, cscripts.csscs.csscs._fits, cscripts.cssens.cssens._fits, cscripts.csspec.csspec._fits, and cscripts.cstsdist.cstsdist._fits.

◆ save()

cscripts.csresspec.csresspec.save ( self) 
Save residuals

Definition at line 811 of file csresspec.py.

References cscripts.cslightcrv.cslightcrv._fits, cscripts.csphasecrv.csphasecrv._fits, cscripts.cspull.cspull._fits, cscripts.csresspec.csresspec._fits, cscripts.csscs.csscs._fits, cscripts.cssens.cssens._fits, cscripts.csspec.csspec._fits, and cscripts.cstsdist.cstsdist._fits.

Member Data Documentation

◆ _fits

cscripts.csresspec.csresspec._fits
protected

Definition at line 47 of file csresspec.py.

Referenced by cscripts.cslightcrv.cslightcrv.__getstate__(), cscripts.csphasecrv.csphasecrv.__getstate__(), cscripts.cspull.cspull.__getstate__(), cscripts.csscs.csscs.__getstate__(), cscripts.cssens.cssens.__getstate__(), cscripts.csspec.csspec.__getstate__(), cscripts.cstsdist.cstsdist.__getstate__(), cscripts.cslightcrv.cslightcrv.__setstate__(), cscripts.csphasecrv.csphasecrv.__setstate__(), cscripts.cspull.cspull.__setstate__(), cscripts.csscs.csscs.__setstate__(), cscripts.cssens.cssens.__setstate__(), cscripts.csspec.csspec.__setstate__(), cscripts.cstsdist.cstsdist.__setstate__(), cscripts.csphasecrv.csphasecrv._create_fits(), cscripts.cspull.cspull._create_fits(), cscripts.cssens.cssens._create_fits(), cscripts.csspec.csspec._create_fits(), cscripts.cstsdist.cstsdist._create_fits(), cscripts.csscs.csscs._get_skymap(), cscripts.csphasecrv.csphasecrv._save_fits(), cscripts.csscs.csscs.fits(), cscripts.cslightcrv.cslightcrv.lightcurve(), cscripts.cslightcrv.cslightcrv.process(), cscripts.csresspec.csresspec.process(), cscripts.csscs.csscs.process(), cscripts.cslightcrv.cslightcrv.publish(), cscripts.csphasecrv.csphasecrv.publish(), cscripts.csspec.csspec.publish(), cscripts.cspull.cspull.pull_distribution(), cscripts.csresspec.csresspec.resspec(), cscripts.cslightcrv.cslightcrv.save(), cscripts.cspull.cspull.save(), cscripts.csresspec.csresspec.save(), cscripts.csscs.csscs.save(), cscripts.cssens.cssens.save(), cscripts.csspec.csspec.save(), cscripts.cstsdist.cstsdist.save(), cscripts.cssens.cssens.sensitivity(), cscripts.csspec.csspec.spectrum(), and cscripts.cstsdist.cstsdist.ts_distribution().

◆ _mask

cscripts.csresspec.csresspec._mask
protected

Definition at line 46 of file csresspec.py.

Referenced by cscripts.csresspec.csresspec._cube_to_spectrum(), and cscripts.csresspec.csresspec._get_parameters().

◆ _stack

cscripts.csresspec.csresspec._stack
protected

Definition at line 45 of file csresspec.py.

Referenced by cscripts.csresspec.csresspec._get_parameters(), and cscripts.csresspec.csresspec.process().

◆ _use_maps

cscripts.csresspec.csresspec._use_maps
protected

Definition at line 44 of file csresspec.py.

Referenced by cscripts.csresmap.csresmap._get_parameters(), cscripts.csresspec.csresspec._get_parameters(), cscripts.csresspec.csresspec._residuals_3D(), and cscripts.csresmap.csresmap.process().

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