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

Public Member Functions

 __init__ (self, *argv)
 
 __getstate__ (self)
 
 __setstate__ (self, state)
 
 process (self)
 
 save (self)
 
 publish (self, name='')
 
 lightcurve (self)
 
 models (self, models)
 
 exclusion_map (self, object=None)
 

Protected Member Functions

 _get_parameters (self)
 
 _create_tbounds (self)
 
 _get_free_par_names (self)
 
 _adjust_model_pars (self)
 
 _create_fits_table (self, results)
 
 _compute_ulimit (self, obs)
 
 _timebin (self, i)
 

Protected Attributes

 _srcname
 
 _tbins
 
 _onoff
 
 _stacked
 
 _fits
 
 _nthreads
 
 _excl_reg_map
 

Detailed Description

Generates a lightcurve

The cslightcrv class generates a light curve for Imaging Air Cherenkov
Telescope event data by performing a maximum likelihood fit using
ctlike in a series of time bins. The time bins can be either
specified in an ASCII file, as an interval divided into equally
sized time bins, or can be taken from the Good Time Intervals of the
observation(s).

The format of the ASCII file is one row per time bin, each specifying
the start of stop value of the bin, separated by a whitespace. The
times are given in Modified Julian Days (MJD). 

Examples:
        >>> lcrv = cslightcrv()
        >>> lcrv.run()
        >>> ... (querying for parameters) ...
        >>> fits = lcrv.lightcurve()
            Generates a light curve and retrieves the results in
            a FITS file.

        >>> lcrv = cslightcrv()
        >>> lcrv.execute()
        >>> ... (querying for parameters) ...
            Generates a light curve and saves results in a FITS file.

        >>> lcrv = cslightcrv(obs)
        >>> lcrv.execute()
        >>> ... (querying for parameters) ...
            Generates a light curve from the observations in an
            observation container and saves results in a FITS file.

Definition at line 33 of file cslightcrv.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 69 of file cslightcrv.py.

Member Function Documentation

◆ __getstate__()

◆ __setstate__()

◆ _adjust_model_pars()

◆ _compute_ulimit()

cscripts.cslightcrv.cslightcrv._compute_ulimit ( self,
obs )
protected
Computes upper limit

Parameters
----------
obs : `~gammalib.GObservations`
    Observation container

Returns
-------
ul_diff, ul_flux, ul_eflux : tuple of float
    Upper limits, -1.0 of not computed

Definition at line 359 of file cslightcrv.py.

References cscripts.cslightcrv.cslightcrv._srcname, cscripts.csphagen.csphagen._srcname, cscripts.csphasecrv.csphasecrv._srcname, cscripts.cssens.cssens._srcname, cscripts.cstsdist.cstsdist._srcname, and cscripts.cstsmapsplit.cstsmapsplit._srcname.

Referenced by cscripts.cslightcrv.cslightcrv._timebin().

◆ _create_fits_table()

cscripts.cslightcrv.cslightcrv._create_fits_table ( self,
results )
protected
Creates FITS binary table containing light curve results

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

Returns
-------
table : `~gammalib.GFitsBinTable`
    FITS binary table containing light curve

Definition at line 315 of file cslightcrv.py.

References cscripts.cslightcrv.cslightcrv._srcname, cscripts.csphagen.csphagen._srcname, cscripts.csphasecrv.csphasecrv._srcname, cscripts.cssens.cssens._srcname, cscripts.cstsdist.cstsdist._srcname, cscripts.cstsmapsplit.cstsmapsplit._srcname, cscripts.cslightcrv.cslightcrv.models(), cscripts.csiactobs.csiactobs.obs(), cscripts.csobsdef.csobsdef.obs(), ctobservation.obs(), and ctobservation.obs().

Referenced by cscripts.csphasecrv.csphasecrv._create_fits(), and cscripts.cslightcrv.cslightcrv.process().

◆ _create_tbounds()

cscripts.cslightcrv.cslightcrv._create_tbounds ( self)
protected
Creates light curve time bins

Returns
-------
gti : `~gammalib.GGti`
    Light curve bins in form of Good Time Intervals

Definition at line 182 of file cslightcrv.py.

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

Referenced by cscripts.cslightcrv.cslightcrv._get_parameters(), and cscripts.csphasecrv.csphasecrv._get_parameters().

◆ _get_free_par_names()

◆ _get_parameters()

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

Definition at line 133 of file cslightcrv.py.

References cscripts.cslightcrv.cslightcrv._create_tbounds(), cscripts.csphasecrv.csphasecrv._create_tbounds(), 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.cslightcrv.cslightcrv._onoff, cscripts.csphasecrv.csphasecrv._onoff, cscripts.cslightcrv.cslightcrv._srcname, cscripts.csphagen.csphagen._srcname, cscripts.csphasecrv.csphasecrv._srcname, cscripts.cssens.cssens._srcname, cscripts.cstsdist.cstsdist._srcname, cscripts.cstsmapsplit.cstsmapsplit._srcname, cscripts.cslightcrv.cslightcrv._stacked, cscripts.csphasecrv.csphasecrv._stacked, cscripts.cslightcrv.cslightcrv._tbins, cscripts.cslightcrv.cslightcrv.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().

◆ _timebin()

◆ exclusion_map()

cscripts.cslightcrv.cslightcrv.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 763 of file cslightcrv.py.

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

◆ lightcurve()

cscripts.cslightcrv.cslightcrv.lightcurve ( self)

◆ models()

◆ process()

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

Definition at line 608 of file cslightcrv.py.

References cscripts.cslightcrv.cslightcrv._adjust_model_pars(), cscripts.csscs.csscs._adjust_model_pars(), cscripts.csspec.csspec._adjust_model_pars(), cscripts.cslightcrv.cslightcrv._create_fits_table(), cscripts.csphasecrv.csphasecrv._create_fits_table(), 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.cslightcrv.cslightcrv._tbins, cscripts.cslightcrv.cslightcrv._timebin(), cscripts.csiactobs.csiactobs.obs(), cscripts.csobsdef.csobsdef.obs(), ctobservation.obs(), ctobservation.obs(), cscripts.cslightcrv.cslightcrv.publish(), cscripts.csphasecrv.csphasecrv.publish(), cscripts.csresmap.csresmap.publish(), cscripts.csspec.csspec.publish(), cscripts.csviscube.csviscube.publish(), ctbin.publish(), ctbkgcube.publish(), ctcubemask.publish(), ctexpcube.publish(), ctmapcube.publish(), ctmodel.publish(), ctobssim.publish(), ctphase.publish(), ctprob.publish(), ctselect.publish(), ctskymap.publish(), and cttsmap.publish().

◆ publish()

◆ save()

Member Data Documentation

◆ _excl_reg_map

◆ _fits

cscripts.cslightcrv.cslightcrv._fits
protected

Definition at line 81 of file cslightcrv.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

◆ _onoff

◆ _srcname

cscripts.cslightcrv.cslightcrv._srcname
protected

Definition at line 77 of file cslightcrv.py.

Referenced by cscripts.cslightcrv.cslightcrv.__getstate__(), cscripts.csphagen.csphagen.__getstate__(), cscripts.csphasecrv.csphasecrv.__getstate__(), cscripts.cssens.cssens.__getstate__(), cscripts.cstsdist.cstsdist.__getstate__(), cscripts.cslightcrv.cslightcrv.__setstate__(), cscripts.csphagen.csphagen.__setstate__(), cscripts.csphasecrv.csphasecrv.__setstate__(), cscripts.cssens.cssens.__setstate__(), cscripts.cstsdist.cstsdist.__setstate__(), cscripts.cslightcrv.cslightcrv._adjust_model_pars(), cscripts.cstsmapsplit.cstsmapsplit._compute_null_hypothesis(), cscripts.cslightcrv.cslightcrv._compute_ulimit(), cscripts.csphasecrv.csphasecrv._create_fits(), cscripts.cssens.cssens._create_fits(), cscripts.cslightcrv.cslightcrv._create_fits_table(), cscripts.csphasecrv.csphasecrv._create_fits_table(), cscripts.cslightcrv.cslightcrv._get_free_par_names(), cscripts.csphasecrv.csphasecrv._get_free_par_names(), cscripts.cslightcrv.cslightcrv._get_parameters(), cscripts.csphagen.csphagen._get_parameters(), cscripts.csphasecrv.csphasecrv._get_parameters(), cscripts.cstsdist.cstsdist._get_parameters(), cscripts.cstsmapsplit.cstsmapsplit._get_parameters(), cscripts.cssens.cssens._get_sensitivity(), cscripts.csphagen.csphagen._process_observation(), cscripts.cssens.cssens._set_source(), cscripts.cssens.cssens._set_src_prefactor(), cscripts.cssens.cssens._sim_evt_excess(), cscripts.cslightcrv.cslightcrv._timebin(), cscripts.cstsdist.cstsdist._trial(), cscripts.cssens.cssens.process(), cscripts.cstsdist.cstsdist.process(), and cscripts.cstsmapsplit.cstsmapsplit.process().

◆ _stacked

◆ _tbins


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