cterror Class Reference

Parameter error calculation tool. More...

#include <cterror.hpp>

Inheritance diagram for cterror:

Public Member Functions
	cterror (void)
	Void constructor. More...
	cterror (const GObservations &obs)
	Observations constructor. More...
	cterror (int argc, char *argv[])
	Command line constructor. More...
	cterror (const cterror &app)
	Copy constructor. More...
virtual	~cterror (void)
	Destructor. More...
cterror &	operator= (const cterror &app)
	Assignment operator. More...
void	clear (void)
	Clear cterror tool. More...
void	process (void)
	Compute parameter errors using a likelihood profile method. More...
void	save (void)
	Save model. More...
Public Member Functions inherited from ctlikelihood
	ctlikelihood (const std::string &name, const std::string &version)
	Name constructor. More...
	ctlikelihood (const std::string &name, const std::string &version, const GApplicationPars &pars)
	Application parameters constructor. More...
	ctlikelihood (const std::string &name, const std::string &version, int argc, char *argv[])
	Command line constructor. More...
	ctlikelihood (const std::string &name, const std::string &version, const GObservations &obs)
	Observations constructor. More...
	ctlikelihood (const ctlikelihood &app)
	Copy constructor. More...
virtual	~ctlikelihood (void)
	Destructor. More...
ctlikelihood &	operator= (const ctlikelihood &app)
	Assignment operator. More...
void	opt (const GOptimizer *opt)
	Set optimizer. More...
const GOptimizer *	opt (void) const
	Return optimizer. More...
Public Member Functions inherited from ctobservation
	ctobservation (const std::string &name, const std::string &version)
	Name constructor. More...
	ctobservation (const std::string &name, const std::string &version, const GApplicationPars &pars)
	Application parameters constructor. More...
	ctobservation (const std::string &name, const std::string &version, int argc, char *argv[])
	Command line constructor. More...
	ctobservation (const std::string &name, const std::string &version, const GObservations &obs)
	Observations constructor. More...
	ctobservation (const ctobservation &app)
	Copy constructor. More...
virtual	~ctobservation (void)
	Destructor. More...
ctobservation &	operator= (const ctobservation &app)
	Assignment operator. More...
void	obs (const GObservations &obs)
	Set observation container. More...
const GObservations &	obs (void) const
	Return observation container. More...
Public Member Functions inherited from ctool
	ctool (const std::string &name, const std::string &version)
	Name constructor. More...
	ctool (const std::string &name, const std::string &version, const GApplicationPars &pars)
	Application parameter constructor. More...
	ctool (const std::string &name, const std::string &version, int argc, char *argv[])
	Command line constructor. More...
	ctool (const ctool &app)
	Copy constructor. More...
virtual	~ctool (void)
	Destructor. More...
ctool &	operator= (const ctool &app)
	Assignment operator. More...
virtual void	run (void)
	Run ctool. More...
virtual void	execute (void)
	Execute ctool. More...

Protected Member Functions
void	init_members (void)
	Initialise class members. More...
void	copy_members (const cterror &app)
	Copy class members. More...
void	free_members (void)
	Delete class members. More...
void	get_parameters (void)
	Get application parameters. More...
double	error_bisection (const double &min, const double &max)
	Calculate error using a bisection method. More...
Protected Member Functions inherited from ctlikelihood
double	evaluate (GModelPar &par, const double &value)
	Evaluates the log-likelihood function. More...
void	init_members (void)
	Initialise class members. More...
void	copy_members (const ctlikelihood &app)
	Copy class members. More...
void	free_members (void)
	Delete class members. More...
Protected Member Functions inherited from ctobservation
GCTAObservation *	first_unbinned_observation (void)
	Return first unbinned CTA observation. More...
GCTAObservation *	next_unbinned_observation (void)
	Return next unbinned CTA observation. More...
const GCTAObservation *	first_unbinned_observation (void) const
	Return first unbinned CTA observation (const version) More...
const GCTAObservation *	next_unbinned_observation (void) const
	Return next unbinned CTA observation (const version) More...
void	read_ogip_keywords (GFitsHDU *hdu) const
	Read OGIP keywords from FITS HDU. More...
void	write_ogip_keywords (GFitsHDU *hdu) const
	Write OGIP keywords in FITS HDU. More...
void	set_obs_statistic (const std::string &statistic)
	Set fit statistic for CTA observations. More...
void	set_obs_bounds ()
	Set observation boundaries for CTA observations. More...
void	save_events_fits (void)
	Save event list in FITS format. More...
void	save_events_xml (void)
	Save event list(s) in XML format. More...
void	init_members (void)
	Initialise class members. More...
void	copy_members (const ctobservation &app)
	Copy class members. More...
void	free_members (void)
	Delete class members. More...
Protected Member Functions inherited from ctool
void	init_members (void)
	Initialise class members. More...
void	copy_members (const ctool &app)
	Copy class members. More...
void	free_members (void)
	Delete class members. More...
void	sync_pfiles (void)
	Synchronise parameter files. More...
const bool &	read_ahead (void) const
	Signal whether parameters should be read ahead. More...
void	setup_observations (GObservations &obs, const bool &response=true, const bool &list=true, const bool &cube=true)
	Setup observation container. More...
void	setup_models (GObservations &obs, const std::string &name="")
	Setup model container. More...
GEbounds	create_ebounds (void)
	Create energy boundaries from user parameters. More...
GEnergies	create_energies (void)
	Create energies from user parameters. More...
GSkyMap	create_map (const GObservations &obs)
	Create a skymap from user parameters. More...
GCTAEventCube	create_cube (const GObservations &obs)
	Create a CTA event cube from user parameters. More...
GCTAObservation	create_cta_obs (void)
	Create a CTA observation from User parameters. More...
void	require_inobs (const std::string &method)
	Throws exception if inobs parameter is not valid. More...
void	require_inobs_nolist (const std::string &method)
void	require_inobs_nocube (const std::string &method)
	Throws exception if inobs parameter is a counts cube. More...
GCTARoi	get_roi (const GCTAPointing &pnt=GCTAPointing())
	Return RoI from User parameters. More...
GEbounds	get_ebounds (void)
	Return energy boundaries from User parameters. More...
GGti	get_gti (const GTimeReference &ref)
	Return Good Time Intervals from User parameter. More...
GCTAPointing	get_pointing (void)
	Return CTA pointing from User parameters. More...
GSkyDir	get_skydir (void)
	Return sky direction from User parameters. More...
std::string	set_outfile_name (const std::string &filename)
	Set output file name. More...
bool	is_stacked (void)
	Query user parameters for stacked analysis. More...
bool	is_onoff (void)
	Query user parameters for On/Off analysis. More...
void	log_parameters (const GChatter &chatter)
	Log application parameters. More...
void	log_observations (const GChatter &chatter, const GObservations &obs, const std::string &what="Observation")
	Log observation container. More...
void	log_models (const GChatter &chatter, const GModels &models, const std::string &what="Model")
	Log model container. More...
void	set_response (GObservations &obs)
	Set response for all CTA observations in container. More...
std::vector< bool >	set_edisp (GObservations &obs, const bool &edisp) const
	Set energy dispersion to CTA observations. More...
void	restore_edisp (GObservations &obs, const std::vector< bool > &edisp) const
	Restore energy dispersion flags of CTA observations. More...
void	set_obs_response (GCTAObservation *obs)
	Set response for CTA observation. More...
GObservations	get_observations (const bool &get_response=true)
	Get observation container. More...
GSkyDir	get_mean_pointing (const GObservations &obs)
	Derives mean pointing from CTA observations. More...
size_t	get_current_rss (void)
	Get current resident set size (physical memory use) in Bytes. More...
std::string	get_obs_header (const GObservation *obs) const
	Return observation header string. More...
GEnergies	insert_energy_boundaries (const GEnergies &energies, const GCTAObservation &obs)
	Insert observation energy boundaries into list of energies. More...
std::vector< bool >	cube_layer_usage (const GEbounds &cube_ebounds, const GEbounds &list_ebounds) const
	Determine the counts cube layer usage. More...
std::string	get_gtiname (const std::string &filename, const std::string &evtname) const
	Get Good Time Intervals extension name. More...
void	save_event_list (const GCTAObservation *obs, const std::string &infile, const std::string &evtname, const std::string &gtiname, const std::string &outfile) const
	Save event list into FITS file. More...
std::string	warn_too_few_energies (const GEnergies &energies) const
	Set warning string if there are too few energies. More...
std::string	warn_xml_suffix (const GFilename &filename) const
	Set warning string if file has no .xml suffix. More...
void	provide_help (void) const
	Dump help text in the console. More...

Protected Attributes
std::string	m_srcname
	Name of source. More...
GFilename	m_outmodel
	Output model XML file. More...
double	m_confidence
	Confidence level. More...
double	m_tol
	Tolerance for limit determination. More...
int	m_max_iter
	Maximum number of iterations. More...
bool	m_apply_edisp
	Apply energy dispersion? More...
GChatter	m_chatter
	Chattiness. More...
double	m_value
	Parameter value. More...
double	m_dlogL
	Likelihood difference for upper limit computation. More...
GModelPar *	m_model_par
	Pointer to model parameter. More...
double	m_best_logL
	Best fit log likelihood of given model. More...
Protected Attributes inherited from ctlikelihood
GOptimizerLM	m_opt
	Optimizer. More...
Protected Attributes inherited from ctobservation
GObservations	m_obs
	Observation container. More...
Protected Attributes inherited from ctool
bool	m_read_ahead
	Read ahead output parameters. More...
bool	m_use_xml
	Use XML file instead of FITS file for observations. More...

Detailed Description

Parameter error calculation tool.

Definition at line 42 of file cterror.hpp.

Constructor & Destructor Documentation

cterror::cterror

(

void

)

Void constructor.

Constructs an empty cterror tool.

Definition at line 60 of file cterror.cpp.

References init_members().

cterror::cterror ( const GObservations &  obs )

explicit

Observations constructor.

param[in] obs Observation container.

Constructs cterror tool from an observations container.

Definition at line 77 of file cterror.cpp.

References init_members().

cterror::cterror	(	int	argc,
		char *	argv[]
	)

Command line constructor.

Parameters

[in]	argc	Number of arguments in command line.
[in]	argv	Array of command line arguments.

Constructs an instance of the cterror tool that will parse user parameters that are provided as command line arguments.

Definition at line 97 of file cterror.cpp.

References init_members().

cterror::cterror

(

const cterror &

app

)

Copy constructor.

Parameters

[in]

app

Application.

Constructs an instance of the cterror tool by copying information from another ctulimit tool.

Definition at line 116 of file cterror.cpp.

References copy_members(), and init_members().

cterror::~cterror ( void  )

virtual

Destructor.

Destructs the cterror tool.

Definition at line 134 of file cterror.cpp.

References free_members().

Member Function Documentation

void cterror::clear ( void  )

virtual

Clear cterror tool.

Clears cterror tool.

Implements ctlikelihood.

Definition at line 193 of file cterror.cpp.

References free_members(), ctlikelihood::free_members(), ctool::free_members(), ctobservation::free_members(), init_members(), ctlikelihood::init_members(), ctool::init_members(), and ctobservation::init_members().

void cterror::copy_members ( const cterror &  app )

protected

Copy class members.

Parameters

[in]

app

Application.

Definition at line 407 of file cterror.cpp.

References m_apply_edisp, m_best_logL, m_chatter, m_confidence, m_dlogL, m_max_iter, m_model_par, m_outmodel, m_srcname, m_tol, and m_value.

Referenced by cterror(), and operator=().

double cterror::error_bisection ( const double &  min, const double &  max  )

protected

Calculate error using a bisection method.

Parameters

[in]	min	Minimum parameter value
[in]	max	Maximum parameter value

Calculates the error using a bisection method.

Definition at line 504 of file cterror.cpp.

References ctlikelihood::evaluate(), G_ERR_BISECTION, m_best_logL, m_dlogL, m_max_iter, m_model_par, m_tol, and m_value.

Referenced by process().

void cterror::free_members ( void  )

protected

Delete class members.

Definition at line 432 of file cterror.cpp.

Referenced by clear(), operator=(), and ~cterror().

void cterror::get_parameters ( void  )

protected

Get application parameters.

Get all task parameters from parameter file.

Definition at line 444 of file cterror.cpp.

References ctool::log_parameters(), m_apply_edisp, m_chatter, m_confidence, m_dlogL, m_max_iter, ctobservation::m_obs, ctlikelihood::m_opt, m_srcname, m_tol, cscripts.mputils::nthreads(), ctool::read_ahead(), ctobservation::set_obs_statistic(), ctool::setup_models(), and ctool::setup_observations().

Referenced by process().

void cterror::init_members ( void  )

protected

Initialise class members.

Definition at line 380 of file cterror.cpp.

References m_apply_edisp, m_best_logL, m_chatter, m_confidence, m_dlogL, m_max_iter, m_model_par, m_outmodel, m_srcname, m_tol, and m_value.

Referenced by clear(), cterror(), and operator=().

cterror & cterror::operator=

(

const cterror &

app

)

Assignment operator.

Parameters

[in]

app

Application.

Returns

Application.

Assigns a cterror tool.

Definition at line 158 of file cterror.cpp.

References copy_members(), free_members(), init_members(), and ctlikelihood::operator=().

void cterror::process ( void  )

virtual

Compute parameter errors using a likelihood profile method.

Computes the parameter errors using a likelihood profile method.

Implements ctlikelihood.

Definition at line 223 of file cterror.cpp.

References error_bisection(), get_parameters(), ctool::log_observations(), m_apply_edisp, m_best_logL, m_chatter, m_confidence, m_dlogL, m_model_par, ctobservation::m_obs, ctlikelihood::m_opt, m_srcname, m_value, ctool::restore_edisp(), and ctool::set_edisp().

void cterror::save ( void  )

virtual

Save model.

Saves the model into an XML file.

Implements ctlikelihood.

Definition at line 342 of file cterror.cpp.

References ctobservation::m_obs, and m_outmodel.

Member Data Documentation

bool cterror::m_apply_edisp

protected

Apply energy dispersion?

Definition at line 74 of file cterror.hpp.

Referenced by copy_members(), get_parameters(), init_members(), and process().

double cterror::m_best_logL

protected

Best fit log likelihood of given model.

Definition at line 81 of file cterror.hpp.

Referenced by copy_members(), error_bisection(), init_members(), and process().

GChatter cterror::m_chatter

protected

Chattiness.

Definition at line 75 of file cterror.hpp.

Referenced by copy_members(), get_parameters(), init_members(), and process().

double cterror::m_confidence

protected

Confidence level.

Definition at line 71 of file cterror.hpp.

Referenced by copy_members(), get_parameters(), init_members(), and process().

double cterror::m_dlogL

protected

Likelihood difference for upper limit computation.

Definition at line 79 of file cterror.hpp.

Referenced by copy_members(), error_bisection(), get_parameters(), init_members(), and process().

int cterror::m_max_iter

protected

Maximum number of iterations.

Definition at line 73 of file cterror.hpp.

Referenced by copy_members(), error_bisection(), get_parameters(), and init_members().

GModelPar* cterror::m_model_par

protected

Pointer to model parameter.

Definition at line 80 of file cterror.hpp.

Referenced by copy_members(), error_bisection(), init_members(), and process().

GFilename cterror::m_outmodel

protected

Output model XML file.

Definition at line 70 of file cterror.hpp.

Referenced by copy_members(), init_members(), and save().

std::string cterror::m_srcname

protected

Name of source.

Definition at line 69 of file cterror.hpp.

Referenced by copy_members(), get_parameters(), init_members(), and process().

double cterror::m_tol

protected

Tolerance for limit determination.

Definition at line 72 of file cterror.hpp.

Referenced by copy_members(), error_bisection(), get_parameters(), and init_members().

double cterror::m_value

protected

Parameter value.

Definition at line 78 of file cterror.hpp.

Referenced by copy_members(), error_bisection(), init_members(), and process().

---

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

• src/cterror/cterror.hpp
• src/cterror/cterror.cpp