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

Public Member Functions

 __init__ (self, *argv)
 
 process (self)
 
 save (self)
 
 mapcube (self)
 
 cubemodelname (self)
 
 models (self, models)
 

Protected Member Functions

 _get_parameters (self)
 
 _gen_cubemodel (self)
 

Protected Attributes

 _cubegen
 
 _models
 
 _cubemodels
 

Detailed Description

Puts subset of sources in diffuse model cube

The csmodelsois class puts a subset of sources in a model definition
XML file into a model cube and generates a new model definition XML file
in which the subset of sources is replaced by a model of type
DiffuseMapCube.

Definition at line 29 of file csmodelsois.py.

Constructor & Destructor Documentation

◆ __init__()

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

Parameters
----------
argv : list of parameters

Raises
------
TypeError
    An invalid number of command line arguments was provided.

Definition at line 40 of file csmodelsois.py.

Member Function Documentation

◆ _gen_cubemodel()

cscripts.csmodelsois.csmodelsois._gen_cubemodel ( self)
protected 
Generates a binned model from the model file using ctmapcube

Definition at line 114 of file csmodelsois.py.

References cscripts.csmodelsois.csmodelsois._cubemodels, cscripts.csbkgmodel.csbkgmodel._models, cscripts.csiactobs.csiactobs._models, cscripts.csmodelinfo.csmodelinfo._models, cscripts.csmodelmerge.csmodelmerge._models, cscripts.csmodelselect.csmodelselect._models, cscripts.csmodelsois.csmodelsois._models, cscripts.csphagen.csphagen._models, cscripts.cssens.cssens._models, and cscripts.cssrcdetect.cssrcdetect._models.

Referenced by cscripts.csmodelsois.csmodelsois.process().

◆ _get_parameters()

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

Definition at line 66 of file csmodelsois.py.

References cscripts.csmodelsois.csmodelsois._cubegen.

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

◆ cubemodelname()

cscripts.csmodelsois.csmodelsois.cubemodelname ( self) 
Return the name to be given to the cube model in the output XML file

Definition at line 227 of file csmodelsois.py.

Referenced by cscripts.csmodelsois.csmodelsois.save().

◆ mapcube()

cscripts.csmodelsois.csmodelsois.mapcube ( self) 
Return the mapcube generated by the underlying 'ctmapcube' object

Definition at line 220 of file csmodelsois.py.

References cscripts.csmodelsois.csmodelsois._cubegen, and cscripts.csmodelsois.csmodelsois.mapcube().

Referenced by cscripts.csmodelsois.csmodelsois.mapcube(), and cscripts.csmodelsois.csmodelsois.save().

◆ models()

cscripts.csmodelsois.csmodelsois.models ( self,
models ) 
Set the models

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

Definition at line 234 of file csmodelsois.py.

References cscripts.csbkgmodel.csbkgmodel._models, cscripts.csiactobs.csiactobs._models, cscripts.csmodelinfo.csmodelinfo._models, cscripts.csmodelmerge.csmodelmerge._models, cscripts.csmodelselect.csmodelselect._models, cscripts.csmodelsois.csmodelsois._models, cscripts.csphagen.csphagen._models, cscripts.cssens.cssens._models, and cscripts.cssrcdetect.cssrcdetect._models.

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

◆ process()

cscripts.csmodelsois.csmodelsois.process ( self) 
Implements the actual bulk of the script's tasks

Definition at line 149 of file csmodelsois.py.

References cscripts.csmodelsois.csmodelsois._cubegen, cscripts.csmodelsois.csmodelsois._cubemodels, cscripts.csmodelsois.csmodelsois._gen_cubemodel(), 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(), and cscripts.csmodelsois.csmodelsois.models().

◆ save()

cscripts.csmodelsois.csmodelsois.save ( self) 
Save the cube and optionally the updated XML model file

Definition at line 178 of file csmodelsois.py.

References cscripts.csmodelsois.csmodelsois._cubegen, cscripts.csmodelsois.csmodelsois._cubemodels, cscripts.csbkgmodel.csbkgmodel._models, cscripts.csiactobs.csiactobs._models, cscripts.csmodelinfo.csmodelinfo._models, cscripts.csmodelmerge.csmodelmerge._models, cscripts.csmodelselect.csmodelselect._models, cscripts.csmodelsois.csmodelsois._models, cscripts.csphagen.csphagen._models, cscripts.cssens.cssens._models, cscripts.cssrcdetect.cssrcdetect._models, cscripts.csmodelsois.csmodelsois.cubemodelname(), cscripts.csmodelsois.csmodelsois.mapcube(), and cscripts.csmodelsois.csmodelsois.save().

Referenced by cscripts.csmodelsois.csmodelsois.save().

Member Data Documentation

◆ _cubegen

cscripts.csmodelsois.csmodelsois._cubegen
protected

Definition at line 57 of file csmodelsois.py.

Referenced by cscripts.csmodelsois.csmodelsois._get_parameters(), cscripts.csmodelsois.csmodelsois.mapcube(), cscripts.csmodelsois.csmodelsois.process(), and cscripts.csmodelsois.csmodelsois.save().

◆ _cubemodels

cscripts.csmodelsois.csmodelsois._cubemodels
protected

Definition at line 59 of file csmodelsois.py.

Referenced by cscripts.csmodelsois.csmodelsois._gen_cubemodel(), cscripts.csmodelsois.csmodelsois.process(), and cscripts.csmodelsois.csmodelsois.save().

◆ _models

cscripts.csmodelsois.csmodelsois._models
protected

Definition at line 58 of file csmodelsois.py.

Referenced by cscripts.csbkgmodel.csbkgmodel.__getstate__(), cscripts.csphagen.csphagen.__getstate__(), cscripts.cssens.cssens.__getstate__(), cscripts.csbkgmodel.csbkgmodel.__setstate__(), cscripts.csphagen.csphagen.__setstate__(), cscripts.cssens.cssens.__setstate__(), cscripts.cssrcdetect.cssrcdetect._add_model(), cscripts.csiactobs.csiactobs._append_inmodels(), cscripts.cssens.cssens._e_bin(), cscripts.csmodelsois.csmodelsois._gen_cubemodel(), cscripts.csbkgmodel.csbkgmodel._generate_runwise_bkg(), cscripts.csmodelinfo.csmodelinfo._get_parameters(), cscripts.csmodelselect.csmodelselect._get_parameters(), cscripts.csphagen.csphagen._get_parameters(), cscripts.csphagen.csphagen._get_parameters_bkgmethod_custom(), cscripts.csphagen.csphagen._get_parameters_bkgmethod_off(), cscripts.csphagen.csphagen._process_observation(), cscripts.csphagen.csphagen._set_models(), cscripts.csbkgmodel.csbkgmodel.models(), cscripts.csmodelsois.csmodelsois.models(), cscripts.cssrcdetect.cssrcdetect.models(), cscripts.csiactobs.csiactobs.obs(), cscripts.csbkgmodel.csbkgmodel.process(), cscripts.csiactobs.csiactobs.process(), cscripts.csmodelinfo.csmodelinfo.process(), cscripts.csmodelmerge.csmodelmerge.process(), cscripts.csmodelselect.csmodelselect.process(), cscripts.cssens.cssens.process(), cscripts.cssrcdetect.cssrcdetect.process(), cscripts.csbkgmodel.csbkgmodel.save(), cscripts.csiactobs.csiactobs.save(), cscripts.csmodelinfo.csmodelinfo.save(), cscripts.csmodelmerge.csmodelmerge.save(), and cscripts.csmodelsois.csmodelsois.save().

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