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

Public Member Functions

 __init__ (self, *argv)
 
 __getstate__ (self)
 
 __setstate__ (self, state)
 
 process (self)
 
 models (self, models)
 
 save (self)
 
 pull_distribution (self)
 

Protected Member Functions

 _get_parameters (self)
 
 _obs_string (self, obs)
 
 _trial (self, seed)
 
 _create_fits (self, results)
 

Protected Attributes

 _fits
 
 _nthreads
 

Detailed Description

Generates pull distributions for a model

Definition at line 32 of file cspull.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 37 of file cspull.py.

Member Function Documentation

◆ __getstate__()

cscripts.cspull.cspull.__getstate__ ( self) 
Extend ctools.csobservation getstate method to include some members

Returns
-------
state : dict
    Pickled instance

Definition at line 52 of file cspull.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.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, and cscripts.cstsdist.cstsdist._nthreads.

◆ __setstate__()

cscripts.cspull.cspull.__setstate__ ( self,
state ) 
Extend ctools.csobservation setstate method to include some members

Parameters
----------
state : dict
    Pickled instance

Definition at line 69 of file cspull.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.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, and cscripts.cstsdist.cstsdist._nthreads.

◆ _create_fits()

cscripts.cspull.cspull._create_fits ( self,
results )
protected 
Create FITS file from results

Parameters
----------
results : list of dict
    List of result dictionaries

Definition at line 346 of file cspull.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.

Referenced by cscripts.csphasecrv.csphasecrv._save_fits(), cscripts.csphasecrv.csphasecrv.process(), cscripts.cspull.cspull.process(), cscripts.cssens.cssens.process(), cscripts.csspec.csspec.process(), and cscripts.cstsdist.cstsdist.process().

◆ _get_parameters()

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

Definition at line 87 of file cspull.py.

References 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.cspull.cspull.models(), 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().

◆ _obs_string()

cscripts.cspull.cspull._obs_string ( self,
obs )
protected 
Generate summary string for observation

Parameters
----------
obs : `~gammalib.GCTAObservation`
    Observation

Returns
-------
text : str
    Summary string

Definition at line 143 of file cspull.py.

Referenced by cscripts.cspull.cspull._trial().

◆ _trial()

cscripts.cspull.cspull._trial ( self,
seed )
protected 
Compute the pull for a single trial

Parameters
----------
seed : int
    Random number generator seed

Returns
-------
result : dict
    Dictionary of results

Definition at line 181 of file cspull.py.

References cscripts.cspull.cspull._obs_string(), cscripts.cspull.cspull.models(), cscripts.csiactobs.csiactobs.obs(), cscripts.csobsdef.csobsdef.obs(), ctobservation.obs(), and ctobservation.obs().

Referenced by cscripts.cspull.cspull.process(), and cscripts.cstsdist.cstsdist.process().

◆ models()

cscripts.cspull.cspull.models ( self,
models ) 
Set model

Parameters
----------
models : `~gammalib.GModels`
    Set model container

Definition at line 493 of file cspull.py.

References cscripts.cspull.cspull.models(), cscripts.csiactobs.csiactobs.obs(), cscripts.csobsdef.csobsdef.obs(), ctobservation.obs(), and ctobservation.obs().

Referenced by cscripts.cspull.cspull._get_parameters(), cscripts.cspull.cspull._trial(), cscripts.cspull.cspull.models(), and cscripts.cstsdist.cstsdist.process().

◆ process()

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

Definition at line 442 of file cspull.py.

References 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.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.cspull.cspull._trial(), cscripts.cstsdist.cstsdist._trial(), cscripts.csiactobs.csiactobs.obs(), cscripts.csobsdef.csobsdef.obs(), ctobservation.obs(), and ctobservation.obs().

◆ pull_distribution()

cscripts.cspull.cspull.pull_distribution ( self) 
Return pull distribution FITS file

Returns:
    FITS file containing pull distribution

Definition at line 530 of file cspull.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.cspull.cspull.save ( self) 
Save pull FITS file

Definition at line 508 of file cspull.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.cspull.cspull._fits
protected

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

◆ _nthreads

cscripts.cspull.cspull._nthreads
protected

Definition at line 46 of file cspull.py.

Referenced by cscripts.cslightcrv.cslightcrv.__getstate__(), cscripts.csphagen.csphagen.__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.csphagen.csphagen.__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.csspec.csspec._fit_energy_bins(), cscripts.cslightcrv.cslightcrv._get_parameters(), cscripts.csphagen.csphagen._get_parameters(), cscripts.csphasecrv.csphasecrv._get_parameters(), cscripts.cspull.cspull._get_parameters(), cscripts.csscs.csscs._get_parameters(), cscripts.cssens.cssens._get_parameters(), cscripts.csspec.csspec._get_parameters(), cscripts.cstsdist.cstsdist._get_parameters(), cscripts.cslightcrv.cslightcrv.process(), cscripts.csphagen.csphagen.process(), cscripts.csphasecrv.csphasecrv.process(), cscripts.cspull.cspull.process(), cscripts.csscs.csscs.process(), cscripts.cssens.cssens.process(), and cscripts.cstsdist.cstsdist.process().

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