ctools  2.0.0
 All Classes Namespaces Files Functions Variables Macros Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
cscripts.cstsdist.cstsdist Class Reference
Inheritance diagram for cscripts.cstsdist.cstsdist:

Public Member Functions

def __init__
 
def __getstate__
 
def __setstate__
 
def process
 
def models
 
def save
 
def ts_distribution
 

Private Member Functions

def _get_parameters
 
def _sim
 
def _trial
 
def _create_fits
 

Private Attributes

 _srcname
 
 _fits
 
 _log_clients
 
 _model
 
 _nthreads
 

Detailed Description

Generates Test Statistic distribution for a model

Definition at line 33 of file cstsdist.py.

Constructor & Destructor Documentation

def cscripts.cstsdist.cstsdist.__init__ (   self,
  argv 
) 
Constructor

Definition at line 39 of file cstsdist.py.

Member Function Documentation

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

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

Definition at line 57 of file cstsdist.py.

References cscripts.cspull.cspull._fits, cscripts.csresspec.csresspec._fits, cscripts.cstsdist.cstsdist._fits, cscripts.csspec.csspec._fits, cscripts.csscs.csscs._fits, cscripts.cssens.cssens._fits, cscripts.csphasecrv.csphasecrv._fits, cscripts.cslightcrv.cslightcrv._fits, cscripts.cstsdist.cstsdist._log_clients, cscripts.cssens.cssens._log_clients, cscripts.cstsdist.cstsdist._model, cscripts.cspull.cspull._nthreads, cscripts.cstsdist.cstsdist._nthreads, cscripts.csscs.csscs._nthreads, cscripts.csspec.csspec._nthreads, cscripts.csphagen.csphagen._nthreads, cscripts.cssens.cssens._nthreads, cscripts.csphasecrv.csphasecrv._nthreads, cscripts.cslightcrv.cslightcrv._nthreads, cscripts.cstsdist.cstsdist._srcname, cscripts.csphagen.csphagen._srcname, cscripts.cssens.cssens._srcname, cscripts.csphasecrv.csphasecrv._srcname, and cscripts.cslightcrv.cslightcrv._srcname.

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

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

Definition at line 77 of file cstsdist.py.

References cscripts.cspull.cspull._fits, cscripts.csresspec.csresspec._fits, cscripts.cstsdist.cstsdist._fits, cscripts.csspec.csspec._fits, cscripts.csscs.csscs._fits, cscripts.cssens.cssens._fits, cscripts.csphasecrv.csphasecrv._fits, cscripts.cslightcrv.cslightcrv._fits, cscripts.cstsdist.cstsdist._log_clients, cscripts.cssens.cssens._log_clients, cscripts.cstsdist.cstsdist._model, cscripts.cspull.cspull._nthreads, cscripts.cstsdist.cstsdist._nthreads, cscripts.csscs.csscs._nthreads, cscripts.csspec.csspec._nthreads, cscripts.csphagen.csphagen._nthreads, cscripts.cssens.cssens._nthreads, cscripts.csphasecrv.csphasecrv._nthreads, cscripts.cslightcrv.cslightcrv._nthreads, cscripts.cstsdist.cstsdist._srcname, cscripts.csphagen.csphagen._srcname, cscripts.cssens.cssens._srcname, cscripts.csphasecrv.csphasecrv._srcname, and cscripts.cslightcrv.cslightcrv._srcname.

def cscripts.cstsdist.cstsdist._create_fits (   self,
  results 
)
private 
Create FITS file from results

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

Definition at line 287 of file cstsdist.py.

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

Referenced by cscripts.cstsdist.cstsdist.process().

def cscripts.cstsdist.cstsdist._get_parameters (   self)
private 
Get parameters from parfile and setup the observation

Definition at line 97 of file cstsdist.py.

References cscripts.cspull.cspull._nthreads, cscripts.cstsdist.cstsdist._nthreads, cscripts.csscs.csscs._nthreads, cscripts.csspec.csspec._nthreads, cscripts.csphagen.csphagen._nthreads, cscripts.cssens.cssens._nthreads, cscripts.csphasecrv.csphasecrv._nthreads, cscripts.cslightcrv.cslightcrv._nthreads, cscripts.cstsdist.cstsdist._srcname, cscripts.csphagen.csphagen._srcname, cscripts.cssens.cssens._srcname, cscripts.csphasecrv.csphasecrv._srcname, cscripts.cslightcrv.cslightcrv._srcname, cscripts.cstsdist.cstsdist.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.cstsmapmerge.cstsmapmerge.process(), cscripts.csworkflow.csworkflow.process(), cscripts.cstsdist.cstsdist.process(), and cscripts.csviscube.csviscube.process().

def cscripts.cstsdist.cstsdist._sim (   self,
  seed 
)
private 
Return a simulated observation container

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

Returns
-------
sim : `~gammalib.GObservations`
    Simulated observation container

Definition at line 133 of file cstsdist.py.

References cscripts.cstsdist.cstsdist._log_clients, cscripts.cssens.cssens._log_clients, cscripts.cstsdist.cstsdist._model, ctobservation.obs(), cscripts.csobsdef.csobsdef.obs(), and cscripts.csiactobs.csiactobs.obs().

Referenced by cscripts.cstsdist.cstsdist._trial().

def cscripts.cstsdist.cstsdist._trial (   self,
  seed 
)
private 
Create the TS for a single trial

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

Returns
-------
result : dict
    Result dictionary

Definition at line 187 of file cstsdist.py.

References cscripts.cstsdist.cstsdist._sim(), cscripts.cstsdist.cstsdist._srcname, cscripts.csphagen.csphagen._srcname, cscripts.cssens.cssens._srcname, cscripts.csphasecrv.csphasecrv._srcname, cscripts.cslightcrv.cslightcrv._srcname, and cscripts.cstsdist.cstsdist.models().

Referenced by cscripts.cstsdist.cstsdist.process().

def cscripts.cstsdist.cstsdist.models (   self,
  models 
) 
Set model

Parameters
----------
models : `~gammalib.GModels`
    Model container

Definition at line 412 of file cstsdist.py.

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

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

def cscripts.cstsdist.cstsdist.process (   self) 
Process the script

Definition at line 358 of file cstsdist.py.

References cscripts.csphasecrv.csphasecrv._create_fits(), cscripts.cstsdist.cstsdist._create_fits(), cscripts.cspull.cspull._create_fits(), cscripts.cssens.cssens._create_fits(), cscripts.csspec.csspec._create_fits(), cscripts.csobsselect.csobsselect._get_parameters(), cscripts.csadd2caldb.csadd2caldb._get_parameters(), cscripts.csebins.csebins._get_parameters(), cscripts.csmodelselect.csmodelselect._get_parameters(), cscripts.csroot2caldb.csroot2caldb._get_parameters(), cscripts.csresmap.csresmap._get_parameters(), cscripts.csresspec.csresspec._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.cssrcdetect.cssrcdetect._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.cstsdist.cstsdist._get_parameters(), cscripts.csobsdef.csobsdef._get_parameters(), cscripts.csspec.csspec._get_parameters(), cscripts.cssens.cssens._get_parameters(), cscripts.csphasecrv.csphasecrv._get_parameters(), cscripts.cslightcrv.cslightcrv._get_parameters(), cscripts.csscs.csscs._get_parameters(), cscripts.csphagen.csphagen._get_parameters(), cscripts.cspull.cspull._nthreads, cscripts.cstsdist.cstsdist._nthreads, cscripts.csscs.csscs._nthreads, cscripts.csspec.csspec._nthreads, cscripts.csphagen.csphagen._nthreads, cscripts.cssens.cssens._nthreads, cscripts.csphasecrv.csphasecrv._nthreads, cscripts.cslightcrv.cslightcrv._nthreads, cscripts.cstsdist.cstsdist._srcname, cscripts.csphagen.csphagen._srcname, cscripts.cssens.cssens._srcname, cscripts.csphasecrv.csphasecrv._srcname, cscripts.cslightcrv.cslightcrv._srcname, cscripts.cspull.cspull._trial(), cscripts.cstsdist.cstsdist._trial(), cscripts.csmodelsois.csmodelsois.models(), cscripts.csresmap.csresmap.models(), cscripts.cstsdist.cstsdist.models(), cscripts.cspull.cspull.models(), cscripts.cssrcdetect.cssrcdetect.models(), cscripts.csbkgmodel.csbkgmodel.models(), cscripts.cslightcrv.cslightcrv.models(), cscripts.csspec.csspec.models(), ctobservation.obs(), cscripts.csobsdef.csobsdef.obs(), and cscripts.csiactobs.csiactobs.obs().

def cscripts.cstsdist.cstsdist.save (   self) 
Save TS distribution FITS file

Definition at line 427 of file cstsdist.py.

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

def cscripts.cstsdist.cstsdist.ts_distribution (   self) 
Return TS distribution FITS file

Returns:
    FITS file containing TS distribution

Definition at line 449 of file cstsdist.py.

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

Member Data Documentation

cscripts.cstsdist.cstsdist._fits
private

Definition at line 48 of file cstsdist.py.

Referenced by cscripts.cstsdist.cstsdist.__getstate__(), cscripts.cstsdist.cstsdist.__setstate__(), cscripts.cstsdist.cstsdist._create_fits(), cscripts.cstsdist.cstsdist.save(), and cscripts.cstsdist.cstsdist.ts_distribution().

cscripts.cstsdist.cstsdist._log_clients
private

Definition at line 49 of file cstsdist.py.

Referenced by cscripts.cstsdist.cstsdist.__getstate__(), cscripts.cstsdist.cstsdist.__setstate__(), and cscripts.cstsdist.cstsdist._sim().

cscripts.cstsdist.cstsdist._model
private

Definition at line 50 of file cstsdist.py.

Referenced by cscripts.cstsdist.cstsdist.__getstate__(), cscripts.cstsdist.cstsdist.__setstate__(), and cscripts.cstsdist.cstsdist._sim().

cscripts.cstsdist.cstsdist._nthreads
private

Definition at line 51 of file cstsdist.py.

Referenced by cscripts.cstsdist.cstsdist.__getstate__(), cscripts.cstsdist.cstsdist.__setstate__(), cscripts.cstsdist.cstsdist._get_parameters(), and cscripts.cstsdist.cstsdist.process().

cscripts.cstsdist.cstsdist._srcname
private

Definition at line 47 of file cstsdist.py.

Referenced by cscripts.cstsdist.cstsdist.__getstate__(), cscripts.cstsdist.cstsdist.__setstate__(), cscripts.cstsmapsplit.cstsmapsplit._compute_null_hypothesis(), cscripts.cstsmapsplit.cstsmapsplit._get_parameters(), cscripts.cstsdist.cstsdist._get_parameters(), cscripts.cstsdist.cstsdist._trial(), cscripts.cstsmapsplit.cstsmapsplit.process(), and cscripts.cstsdist.cstsdist.process().

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