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

Public Member Functions

 __init__ (self, *argv)
 
 __getstate__ (self)
 
 __setstate__ (self, state)
 
 process (self)
 
 save (self)
 
 exclusion_map (self, object=None)
 
 fits (self)
 
 flux (self, name)
 
 flux_error (self, name)
 
 ts (self, name)
 
 ulimit (self, name)
 

Protected Member Functions

 _get_onoff_parameters (self)
 
 _get_parameters (self)
 
 _create_map (self)
 
 _adjust_model_pars (self)
 
 _mask_cube (self, obs, ra, dec, rad)
 
 _mask_evlist (self, obs, ra, dec, rad)
 
 _mask_observations (self, ra, dec, rad)
 
 _pixel_analysis (self, inx)
 
 _write_hdu_keywords (self, hdu, is_flux=False)
 
 _fill_fits (self, results)
 
 _get_skymap (self, name, quantity)
 

Protected Attributes

 _nthreads
 
 _srcnames
 
 _method
 
 _fits
 
 _excl_reg_map
 
 _excl_reg_name
 

Detailed Description

Spectral component separation script

Definition at line 32 of file csscs.py.

Constructor & Destructor Documentation

◆ __init__()

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

Parameters
----------
argv : list of str
    List of IRAF command line parameter strings of the form
    ``parameter=3``.

Definition at line 38 of file csscs.py.

Member Function Documentation

◆ __getstate__()

◆ __setstate__()

◆ _adjust_model_pars()

◆ _create_map()

cscripts.csscs.csscs._create_map ( self)
protected
Create a gammalib.GSkyMap object to store the output

Returns
-------
skymap : `~gammalib.GSkyMap`
    Sky map

Definition at line 270 of file csscs.py.

Referenced by cscripts.csscs.csscs._fill_fits(), cscripts.cstsmapsplit.cstsmapsplit._get_parameters(), cscripts.csscs.csscs._pixel_analysis(), and cscripts.csscs.csscs.process().

◆ _fill_fits()

cscripts.csscs.csscs._fill_fits ( self,
results )
protected
Fill FITS object to store the results

Parameters
----------
result : `dict`
    Results

Returns
-------
fits : `~gammalib.GFits`
    FITS object

Definition at line 679 of file csscs.py.

References cscripts.csscs.csscs._create_map(), cscripts.csscs.csscs._srcnames, and cscripts.csscs.csscs._write_hdu_keywords().

Referenced by cscripts.csscs.csscs.process().

◆ _get_onoff_parameters()

cscripts.csscs.csscs._get_onoff_parameters ( self)
protected
Get On/Off analysis parameters.

This is done here rather than in ctools.is_onoff because the exclusion
map needs to be handled differently as an automatic parameter but
queried only if not already set and we need to verify is not empty.
Also many parameters are already queried for all methods

TODO: verify if this can be made more uniform with other scripts

Definition at line 106 of file csscs.py.

References cscripts.cslightcrv.cslightcrv._excl_reg_map, cscripts.csphasecrv.csphasecrv._excl_reg_map, cscripts.csscs.csscs._excl_reg_map, and cscripts.csscs.csscs._excl_reg_name.

Referenced by cscripts.csscs.csscs._get_parameters().

◆ _get_parameters()

cscripts.csscs.csscs._get_parameters ( self)
protected
Get parameters from parfile

Definition at line 141 of file csscs.py.

References cscripts.csscs.csscs._get_onoff_parameters(), cscripts.csscs.csscs._method, cscripts.csspec.csspec._method, cscripts.cslightcrv.cslightcrv._nthreads, cscripts.csphagen.csphagen._nthreads, cscripts.csphasecrv.csphasecrv._nthreads, cscripts.cspull.cspull._nthreads, cscripts.csscs.csscs._nthreads, cscripts.cssens.cssens._nthreads, cscripts.csspec.csspec._nthreads, cscripts.cstsdist.cstsdist._nthreads, cscripts.csscs.csscs._srcnames, 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().

◆ _get_skymap()

cscripts.csscs.csscs._get_skymap ( self,
name,
quantity )
protected
Fetches skymap from FITS container

Parameters
----------
name : str
    Source name
quantity : str
    Quantity

Returns
-------
skymap : `~gammalib.GSkyMap`
    Skymap

Raises
------
NameError

Definition at line 739 of file csscs.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, and cscripts.csscs.csscs._srcnames.

Referenced by cscripts.csscs.csscs.flux(), cscripts.csscs.csscs.flux_error(), cscripts.csscs.csscs.ts(), and cscripts.csscs.csscs.ulimit().

◆ _mask_cube()

cscripts.csscs.csscs._mask_cube ( self,
obs,
ra,
dec,
rad )
protected
Mask cube observation

Parameters
----------
obs : `gammalib.GCTAObservation`
    Input observation of type cube
ra : float
    Right Ascension (deg)
dec : float
    Declination (deg)
rad : float
    Radius (deg)

Returns
-------
new_obs : `gammalib.GCTAObservations`
    Output observations with masked cubes

Definition at line 367 of file csscs.py.

Referenced by cscripts.csscs.csscs._mask_observations().

◆ _mask_evlist()

cscripts.csscs.csscs._mask_evlist ( self,
obs,
ra,
dec,
rad )
protected
Mask event list

Parameters
----------
obs : `gammalib.GCTAObservations`
    Input observations of type event list
ra : float
    Right Ascension (deg)
dec : float
    Declination (deg)
rad : float
    Radius (deg)

Returns
-------
new_obs : `gammalib.GCTAObservations`
    Output observations with masked event lists

Definition at line 410 of file csscs.py.

Referenced by cscripts.csscs.csscs._mask_observations().

◆ _mask_observations()

cscripts.csscs.csscs._mask_observations ( self,
ra,
dec,
rad )
protected
Create observations restricted to circular ROI

Parameters
----------
ra : float
    Right Ascension (deg)
dec : float
    Declination (deg)
rad : float
    Radius (deg)

Returns
-------
new_obs : `~gammalib.GObservations`
    Observations in circular ROI

Definition at line 455 of file csscs.py.

References cscripts.csscs.csscs._mask_cube(), cscripts.csscs.csscs._mask_evlist(), cscripts.csscs.csscs._method, cscripts.csspec.csspec._method, cscripts.csscs.csscs._srcnames, cscripts.csiactobs.csiactobs.obs(), cscripts.csobsdef.csobsdef.obs(), ctobservation.obs(), and ctobservation.obs().

Referenced by cscripts.csscs.csscs._pixel_analysis().

◆ _pixel_analysis()

cscripts.csscs.csscs._pixel_analysis ( self,
inx )
protected
Performs analysis over the region of interest corresponding to a
single pixel of output map

Parameters
----------
inx : int
    Pixel index

Returns
-------
result : dict
    Results

Definition at line 487 of file csscs.py.

References cscripts.csscs.csscs._create_map(), cscripts.csscs.csscs._mask_observations(), cscripts.csscs.csscs._srcnames, and cscripts.csscs.csscs.flux().

Referenced by cscripts.csscs.csscs.process().

◆ _write_hdu_keywords()

cscripts.csscs.csscs._write_hdu_keywords ( self,
hdu,
is_flux = False )
protected
Append cards to HDU

Parameters
----------
hdu : `~gammalib.GFitsHDU`
    HDU

Definition at line 638 of file csscs.py.

References cscripts.csscs.csscs._excl_reg_name, cscripts.csscs.csscs._method, and cscripts.csspec.csspec._method.

Referenced by cscripts.csscs.csscs._fill_fits().

◆ exclusion_map()

cscripts.csscs.csscs.exclusion_map ( self,
object = None )
Return and optionally set the exclusion regions map

Parameters
----------
object : `~gammalib.GSkyRegion` or `~gammalib.GSkyMap` or `~gammalib.GFilename`
    Exclusion regions object

Returns
-------
region : `~gammalib.GSkyRegionMap`
    Exclusion regions map

Definition at line 860 of file csscs.py.

References cscripts.cslightcrv.cslightcrv._excl_reg_map, cscripts.csphasecrv.csphasecrv._excl_reg_map, and cscripts.csscs.csscs._excl_reg_map.

◆ fits()

cscripts.csscs.csscs.fits ( self)

◆ flux()

cscripts.csscs.csscs.flux ( self,
name )
Return flux skymap

Parameters
----------
name : str
    Source name

Returns
-------
skymap : `~gammalib.GSkyMap`
    Flux skymap

Definition at line 893 of file csscs.py.

References cscripts.csscs.csscs._get_skymap().

Referenced by cscripts.csscs.csscs._pixel_analysis().

◆ flux_error()

cscripts.csscs.csscs.flux_error ( self,
name )
Return flux error skymap

Parameters
----------
name : str
    Source name

Returns
-------
skymap : `~gammalib.GSkyMap`
    Flux error skymap

Definition at line 913 of file csscs.py.

References cscripts.csscs.csscs._get_skymap().

◆ process()

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

Definition at line 794 of file csscs.py.

References cscripts.cslightcrv.cslightcrv._adjust_model_pars(), cscripts.csscs.csscs._adjust_model_pars(), cscripts.csspec.csspec._adjust_model_pars(), cscripts.csscs.csscs._create_map(), cscripts.csscs.csscs._fill_fits(), 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.cslightcrv.cslightcrv._nthreads, cscripts.csphagen.csphagen._nthreads, cscripts.csphasecrv.csphasecrv._nthreads, cscripts.cspull.cspull._nthreads, cscripts.csscs.csscs._nthreads, cscripts.cssens.cssens._nthreads, cscripts.csspec.csspec._nthreads, cscripts.cstsdist.cstsdist._nthreads, cscripts.csscs.csscs._pixel_analysis(), cscripts.csiactobs.csiactobs.obs(), cscripts.csobsdef.csobsdef.obs(), ctobservation.obs(), and ctobservation.obs().

◆ save()

◆ ts()

cscripts.csscs.csscs.ts ( self,
name )
Return TS skymap

Parameters
----------
name : str
    Source name

Returns
-------
skymap : `~gammalib.GSkyMap`
    TS skymap

Definition at line 933 of file csscs.py.

References cscripts.csscs.csscs._get_skymap().

◆ ulimit()

cscripts.csscs.csscs.ulimit ( self,
name )
Return flux upper limit skymap

Parameters
----------
name : str
    Source name

Returns
-------
skymap : `~gammalib.GSkyMap`
    Flux upper limit skymap

Definition at line 960 of file csscs.py.

References cscripts.csscs.csscs._get_skymap().

Member Data Documentation

◆ _excl_reg_map

◆ _excl_reg_name

◆ _fits

cscripts.csscs.csscs._fits
protected

Definition at line 55 of file csscs.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().

◆ _method

◆ _nthreads

◆ _srcnames


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