Event probability computation tool. More...

#include <ctprob.hpp>

Inheritance diagram for ctprob:

Public Member Functions
	ctprob (void)
	Void constructor. More...

	ctprob (const GObservations &obs)
	Observations constructor. More...

	ctprob (int argc, char *argv[])
	Command line constructor. More...

	ctprob (const ctprob &app)
	Copy constructor. More...

virtual	~ctprob (void)
	Destructor. More...

ctprob &	operator= (const ctprob &app)
	Assignment operator. More...

void	clear (void)
	Clear ctprob tool. More...

void	process (void)
	Process the ctprob tool. More...

void	save (void)
	Save the selected event list(s) More...

void	publish (const std::string &name="")
	Publish event lists. 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 ctprob &app)
	Copy class members. More...

void	free_members (void)
	Delete class members. More...

void	get_parameters (void)
	Get application parameters. More...

void	evaluate_probability (GCTAObservation *obs)
	Evaluate probability for events. 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
bool	m_apply_edisp
	Apply energy dispersion? More...

bool	m_publish
	Publish event list? More...

GChatter	m_chatter
	Chattiness. 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

Event probability computation tool.

Definition at line 46 of file ctprob.hpp.

Constructor & Destructor Documentation

ctprob::ctprob ( void )

Void constructor.

Definition at line 52 of file ctprob.cpp.

References init_members().

ctprob::ctprob ( const GObservations & obs )

explicit

Observations constructor.

param[in] obs Observation container.

Creates an instance of the class that is initialised using the information provided in an observation container.

Definition at line 70 of file ctprob.cpp.

References init_members().

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

Command line constructor.

Parameters

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

Definition at line 89 of file ctprob.cpp.

References init_members().

ctprob::ctprob ( const ctprob & app )

Copy constructor.

Parameters

[in] app Application.

Definition at line 105 of file ctprob.cpp.

References copy_members(), and init_members().

ctprob::~ctprob ( void )

virtual

Destructor.

Definition at line 121 of file ctprob.cpp.

References free_members().

Member Function Documentation

void ctprob::clear ( void )

virtual

Clear ctprob tool.

Clears ctprob tool.

Implements ctobservation.

Definition at line 178 of file ctprob.cpp.

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

void ctprob::copy_members ( const ctprob & app )

protected

Copy class members.

Parameters

[in] app Application.

Definition at line 379 of file ctprob.cpp.

References m_apply_edisp, m_chatter, and m_publish.

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

void ctprob::evaluate_probability ( GCTAObservation * obs )

protected

Evaluate probability for events.

Parameters

[in,out] obs CTA observation.

Exceptions

GException::invalid_value Observation does not contain an event list.

Computes for all events the probability that an event arises from a specific model component. The computation is done by by evaluating the differential event probability for a given model and normalizing these probabilities so that the sum of the probabilities for all model components is unity for each event.

The method appends for each model component a single precision column to the event list that contains the event probabilities. The name of the column is build from the model name prefixed with PROB_.

Definition at line 463 of file ctprob.cpp.

References G_EVALUATE_PROB, and ctobservation::m_obs.

Referenced by process().

void ctprob::free_members ( void )

protected

Delete class members.

Definition at line 394 of file ctprob.cpp.

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

void ctprob::get_parameters ( void )

protected

Get application parameters.

Get all application parameters by either querying the parameters or by retrieving the parameters for the parameter file.

Definition at line 407 of file ctprob.cpp.

References ctool::log_parameters(), m_apply_edisp, m_chatter, ctobservation::m_obs, m_publish, ctool::read_ahead(), and ctool::setup_observations().

Referenced by process().

void ctprob::init_members ( void )

protected

Initialise class members.

Definition at line 362 of file ctprob.cpp.

References m_apply_edisp, m_chatter, and m_publish.

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

ctprob & ctprob::operator= ( const ctprob & app )

Assignment operator.

Parameters

[in] app Application.

Returns: Application.

Definition at line 143 of file ctprob.cpp.

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

void ctprob::process ( void )

virtual

Process the ctprob tool.

This method reads in the application parameters and loops over all unbinned observations to compute the probability for each event that it comes from one of the model components.

Implements ctobservation.

Definition at line 208 of file ctprob.cpp.

References evaluate_probability(), ctobservation::first_unbinned_observation(), get_parameters(), ctool::log_observations(), m_apply_edisp, ctobservation::m_obs, ctool::m_use_xml, ctobservation::next_unbinned_observation(), ctobservation::obs(), publish(), ctool::restore_edisp(), and ctool::set_edisp().

void ctprob::publish ( const std::string & name = "" )

Publish event lists.

Parameters

[in] name Event list name.

Definition at line 304 of file ctprob.cpp.

References CTPROB_NAME, ctobservation::m_obs, ctool::m_use_xml, and ctobservation::obs().

Referenced by process().

void ctprob::save ( void )

virtual

Save the selected event list(s)

This method saves the selected event list(s) into FITS file(s). There are two modes, depending on the m_use_xml flag.

If m_use_xml is true, all selected event list(s) will be saved into FITS files, where the output filenames are constructued from the input filenames by prepending the m_prefix string to name. Any path information will be stripped form the input name, hence event files will be written into the local working directory (unless some path information is present in the prefix). In addition, an XML file will be created that gathers the filename information for the selected event list(s). If an XML file was present on input, all metadata information will be copied from this input file.

If m_use_xml is false, the selected event list will be saved into a FITS file.

Implements ctobservation.

Definition at line 279 of file ctprob.cpp.

References ctobservation::m_obs, ctool::m_use_xml, ctobservation::save_events_fits(), and ctobservation::save_events_xml().