cscripts.cspull.cspull Class Reference

Inheritance diagram for cscripts.cspull.cspull:

Public Member Functions
def	__init__
def	__getstate__
def	__setstate__
def	process
def	models
def	save
def	pull_distribution

Private Member Functions
def	_get_parameters
def	_obs_string
def	_trial
def	_create_fits

Private Attributes
	_fits
	_nthreads

Detailed Description

Generates pull distributions for a model

Definition at line 32 of file cspull.py.

Constructor & Destructor Documentation

def cscripts.cspull.cspull.__init__	(		self,
			argv
	)

Constructor

Definition at line 37 of file cspull.py.

Member Function Documentation

def 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.cspull.cspull._fits, cscripts.csphasecrv.csphasecrv._fits, cscripts.cslightcrv.cslightcrv._fits, cscripts.cspull.cspull._nthreads, cscripts.csphagen.csphagen._nthreads, cscripts.csphasecrv.csphasecrv._nthreads, and cscripts.cslightcrv.cslightcrv._nthreads.

def 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.cspull.cspull._fits, cscripts.csphasecrv.csphasecrv._fits, cscripts.cslightcrv.cslightcrv._fits, cscripts.cspull.cspull._nthreads, cscripts.csphagen.csphagen._nthreads, cscripts.csphasecrv.csphasecrv._nthreads, and cscripts.cslightcrv.cslightcrv._nthreads.

def cscripts.cspull.cspull._create_fits (   self,   results  )

private

Create FITS file from results

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

Definition at line 346 of file cspull.py.

References cscripts.cspull.cspull._fits, cscripts.csphasecrv.csphasecrv._fits, and cscripts.cslightcrv.cslightcrv._fits.

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

def cscripts.cspull.cspull._get_parameters (   self )

private

Get parameters from parfile

Definition at line 87 of file cspull.py.

References cscripts.cspull.cspull._nthreads, cscripts.csphagen.csphagen._nthreads, cscripts.csphasecrv.csphasecrv._nthreads, cscripts.cslightcrv.cslightcrv._nthreads, cscripts.cspull.cspull.models(), ctobservation.obs(), cscripts.csobsdef.csobsdef.obs(), and cscripts.csiactobs.csiactobs.obs().

Referenced by cscript_base.cscript_base.process(), cscript_obs.cscript_obs.process(), cscript_like.cscript_like.process(), cscripts.cstsmapsplit.cstsmapsplit.process(), cscripts.csresmap.csresmap.process(), cscripts.cstsmapmerge.cstsmapmerge.process(), cscripts.csworkflow.csworkflow.process(), cscripts.cstsdist.cstsdist.process(), cscripts.cssrcdetect.cssrcdetect.process(), cscripts.cspull.cspull.process(), cscripts.csviscube.csviscube.process(), cscripts.csresspec.csresspec.process(), cscripts.csscs.csscs.process(), cscripts.cssens.cssens.process(), cscripts.csspec.csspec.process(), and cscripts.csroot2caldb.csroot2caldb.process().

def cscripts.cspull.cspull._obs_string (   self,   obs  )

private

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

def cscripts.cspull.cspull._trial (   self,   seed  )

private

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

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

def cscripts.cspull.cspull.models	(		self,
			models
	)

Set model

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

Definition at line 493 of file cspull.py.

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

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

def 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.csobsselect.csobsselect._get_parameters(), cscripts.csadd2caldb.csadd2caldb._get_parameters(), cscripts.csebins.csebins._get_parameters(), cscripts.csmodelselect.csmodelselect._get_parameters(), cscripts.csmodelinfo.csmodelinfo._get_parameters(), cscripts.csmodelmerge.csmodelmerge._get_parameters(), cscripts.csobsinfo.csobsinfo._get_parameters(), cscripts.csfindobs.csfindobs._get_parameters(), cscripts.csiactdata.csiactdata._get_parameters(), cscripts.csiactcopy.csiactcopy._get_parameters(), cscripts.csmodelsois.csmodelsois._get_parameters(), cscripts.cscaldb.cscaldb._get_parameters(), cscripts.csobs2caldb.csobs2caldb._get_parameters(), cscripts.csbkgmodel.csbkgmodel._get_parameters(), cscripts.cspull.cspull._get_parameters(), cscripts.csfootprint.csfootprint._get_parameters(), cscripts.csiactobs.csiactobs._get_parameters(), cscripts.csobsdef.csobsdef._get_parameters(), cscripts.csphasecrv.csphasecrv._get_parameters(), cscripts.cslightcrv.cslightcrv._get_parameters(), cscripts.csphagen.csphagen._get_parameters(), cscripts.cspull.cspull._nthreads, cscripts.csphagen.csphagen._nthreads, cscripts.csphasecrv.csphasecrv._nthreads, cscripts.cslightcrv.cslightcrv._nthreads, cscripts.cspull.cspull._trial(), ctobservation.obs(), cscripts.csobsdef.csobsdef.obs(), and cscripts.csiactobs.csiactobs.obs().

def 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.cspull.cspull._fits, cscripts.csphasecrv.csphasecrv._fits, and cscripts.cslightcrv.cslightcrv._fits.

def cscripts.cspull.cspull.save

(

self

)

Save pull FITS file

Definition at line 508 of file cspull.py.

References cscripts.cspull.cspull._fits, cscripts.csphasecrv.csphasecrv._fits, and cscripts.cslightcrv.cslightcrv._fits.

Member Data Documentation

cscripts.cspull.cspull._fits

private

Definition at line 45 of file cspull.py.

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

cscripts.cspull.cspull._nthreads

private

Definition at line 46 of file cspull.py.

Referenced by cscripts.cspull.cspull.__getstate__(), cscripts.cstsdist.cstsdist.__getstate__(), cscripts.csscs.csscs.__getstate__(), cscripts.csspec.csspec.__getstate__(), cscripts.cssens.cssens.__getstate__(), cscripts.cspull.cspull.__setstate__(), cscripts.cstsdist.cstsdist.__setstate__(), cscripts.csscs.csscs.__setstate__(), cscripts.csspec.csspec.__setstate__(), cscripts.cssens.cssens.__setstate__(), cscripts.csspec.csspec._fit_energy_bins(), cscripts.cspull.cspull._get_parameters(), cscripts.cstsdist.cstsdist._get_parameters(), cscripts.csspec.csspec._get_parameters(), cscripts.cssens.cssens._get_parameters(), cscripts.csscs.csscs._get_parameters(), cscripts.cstsdist.cstsdist.process(), cscripts.cspull.cspull.process(), cscripts.csscs.csscs.process(), and cscripts.cssens.cssens.process().

---

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

• cscripts/cspull.py