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

Public Member Functions

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

Protected Member Functions

 _get_parameters (self)
 
 _create_tbounds (self)
 
 _get_free_par_names (self)
 
 _create_fits_table (self, results)
 
 _create_fits (self)
 
 _save_fits (self)
 
 _save_xml (self)
 
 _phase_bin (self, phbin)
 

Protected Attributes

 _srcname
 
 _phbins
 
 _onoff
 
 _stacked
 
 _fits
 
 _fitmodels
 
 _nthreads
 
 _excl_reg_map
 

Detailed Description

Generates spectra in phase bins

This script computes spectra by performing a maximum likelihood fit
using :doc:`ctlike` in a series of phase bins for pulsars. The phase bins
can be either specified in an ASCII file or as an interval divided into
equally sized phase bins.

Examples:
        >>> phcrv = csphasecrv()
        >>> phcrv.run()
        >>> ... (querying for parameters) ...
        >>> phcrv = phrv.phasecrv()
            Generates phase fits and retrieves dictionary with best fit models.

        >>> phcrv = csphasecrv(obs)
        >>> phcrv.execute()
        >>> ... (querying for parameters) ...
            Generates phase fits from the observations 
            and saves results in XML files.

Definition at line 32 of file csphasecrv.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 56 of file csphasecrv.py.

Member Function Documentation

◆ __getstate__()

◆ __setstate__()

◆ _create_fits()

◆ _create_fits_table()

cscripts.csphasecrv.csphasecrv._create_fits_table ( self,
results )
protected
Creates FITS binary table containing phase curve results

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

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

Definition at line 240 of file csphasecrv.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.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.csphasecrv.csphasecrv._create_tbounds ( self)
protected
Creates phase bins

Returns
-------
phbins : `[]`
    List of phase bins

Definition at line 169 of file csphasecrv.py.

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

◆ _get_free_par_names()

◆ _get_parameters()

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

Definition at line 124 of file csphasecrv.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.csphasecrv.csphasecrv._phbins, 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.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().

◆ _phase_bin()

cscripts.csphasecrv.csphasecrv._phase_bin ( self,
phbin )
protected

◆ _save_fits()

◆ _save_xml()

cscripts.csphasecrv.csphasecrv._save_xml ( self)
protected
Save phase fit results into one XML model each bin

Definition at line 349 of file csphasecrv.py.

References cscripts.csphasecrv.csphasecrv._fitmodels, cscripts.csphasecrv.csphasecrv._phbins, and cscripts.csphasecrv.csphasecrv.save().

Referenced by cscripts.csphasecrv.csphasecrv.save().

◆ exclusion_map()

cscripts.csphasecrv.csphasecrv.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 558 of file csphasecrv.py.

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

◆ phasecurve()

cscripts.csphasecrv.csphasecrv.phasecurve ( self)
Return dictionary with best fit models

Definition at line 551 of file csphasecrv.py.

References cscripts.csphasecrv.csphasecrv._fitmodels.

◆ process()

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

Definition at line 464 of file csphasecrv.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.csphasecrv.csphasecrv._fitmodels, 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.csphasecrv.csphasecrv._phase_bin(), cscripts.csphasecrv.csphasecrv._phbins, 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()

cscripts.csphasecrv.csphasecrv.save ( self)
Saves results to fits and XML

Definition at line 508 of file csphasecrv.py.

References cscripts.csphasecrv.csphasecrv._save_fits(), and cscripts.csphasecrv.csphasecrv._save_xml().

Referenced by cscripts.csphasecrv.csphasecrv._save_xml().

Member Data Documentation

◆ _excl_reg_map

◆ _fitmodels

◆ _fits

cscripts.csphasecrv.csphasecrv._fits
protected

Definition at line 69 of file csphasecrv.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

◆ _phbins

◆ _srcname

cscripts.csphasecrv.csphasecrv._srcname
protected

Definition at line 65 of file csphasecrv.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


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