NEMO3 ANA event model. More...

#include <ana_event.h>

Classes
class	i_measurement
	Generic interface for a measurement, used by inheritance by tof_reflect for exemple: More...
class	i_predicate
	generic interface for a predicate: More...
class	timestamp
	event time stamp: More...
Public Types
typedef std::list< sim_vertex >	sim_vertex_col
	unused
typedef std::list< sim_particle >	sim_particle_col
	unused
typedef std::list< scin_hit >	scin_hit_col
	Collection of scin hits of the event in list<>
typedef std::list< gg_hit >	gg_hit_col
	Collection of geiger hits of the event in list<>
typedef std::map< std::string, tracking >	tracking_col
	Dictionary of the trackings. Default and others.
typedef datatools::serialization::safe_serial < ana_event >	safe_serial
Public Member Functions
bool	is_calib_ok ()
	check if calib were done
void	set_calib_ok ()
	used to validate calibration
void	revert_pm_time ()
	old TDC std calib debug. Unused for new calibrated files.
bool	is_debug () const
	check debug mode
void	set_debug (bool)
void	set_selected (bool)
	can use this bool for selection
bool	is_selected () const
bool	is_simulated () const
	check data or simulated format
void	set_simulated (bool)
	set data or simulated format
const datatools::event::event_id &	get_id () const
const datatools::event::event_id &	get_id_ro () const
	? same as get_id
int	get_run_number () const
int	get_event_number () const
	< get the event number
datatools::event::event_id &	get_id ()
datatools::event::event_id &	get_id_rw ()
void	set_id (const datatools::event::event_id &)
	set evt_id
const datatools::utils::properties &	properties () const
const datatools::utils::properties &	get_properties_ro () const
const datatools::utils::properties &	get_properties_const () const
datatools::utils::properties &	properties ()
datatools::utils::properties &	get_properties_rw ()
const timestamp &	get_timestamp () const
const timestamp &	get_timestamp_ro () const
void	set_timestamp (const timestamp &)
	set the timestamp
int	get_year () const
	timestamp::get_year
int	get_month () const
	timestamp::get_month
int	get_day () const
	timestamp::get_day
int	get_hours () const
	timestamp::get_hours
int	get_minutes () const
	timestamp::get_minutes
int	get_seconds () const
	timestamp::get_seconds
int	get_milliseconds () const
	timestamp::get_milliseconds
int	get_sec_epoch () const
	timestamp::get_sec_epoch
void	clear_scin_hits ()
	flush the ana_event::__scin_hits
void	clear_gg_hits ()
	flush the ana_event::__gg_hits
void	clear_trackings ()
	flush the ana_event::__trackings
void	clear_sim_data ()
	unused
void	set_sim_data (const sim_primary_event &)
	unused
const sim_primary_event &	get_sim_data () const
	unused
const sim_primary_event &	get_sim_data_ro () const
	unused
sim_primary_event &	get_sim_data ()
	unused
sim_primary_event &	get_sim_data_rw ()
	unused
scin_hit_col &	scin_hits ()
gg_hit_col &	gg_hits ()
const gg_hit_col &	gg_hits () const
int	get_number_of_gg_hits () const
	get size of ana_event::gg_hit_col
tracking_col &	trackings ()
const scin_hit_col &	scin_hits () const
int	get_number_of_scin_hits () const
const gg_hit &	get_gg_hit (int i_) const
gg_hit &	gg (int i_)
const scin_hit &	get_scin_hit (int i_) const
scin_hit &	scin (int i_)
const tracking_col &	trackings () const
void	set_default_tracking (const std::string &name_)
bool	has_default_tracking () const
bool	has_tracking () const
	check if some tracking data is available:
bool	has_tracking_with_name (const std::string &name_) const
const tracking &	get_tracking (const std::string &name_) const
const tracking &	get_tracking_const (const std::string &name_) const
const tracking &	get_tracking_ro (const std::string &name_) const
void	add_tracking (const std::string &name_, const tracking &tracking_, bool default_=true)
tracking &	get_tracking (const std::string &name_)
tracking &	get_tracking_rw (const std::string &name_)
const tracking &	get_default_tracking () const
const tracking &	get_default_tracking_const () const
const tracking &	get_default_tracking_ro () const
tracking &	get_default_tracking ()
tracking &	get_default_tracking_rw ()
gamma_tracking &	get_gamma_tracking ()
gamma_tracking	copy_gamma_tracking () const
const tof_col &	get_tof_col () const
tof_col &	get_tof_col_no_const ()
void	measure (i_measurement &measurement_)
	permit the i_measurement inheriters to analyse the current event.
	ana_event ()
	default constructor
	ana_event (const datatools::event::event_id &id_, bool simulated_=false)
	Constructor from an datatools::event::event_id.
virtual	~ana_event ()
	destructor
virtual void	clear ()
	interface i_clear
virtual void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
	interface i_tree_dumpable
void	dump () const
	Dump info of the event in tree form.
virtual const std::string &	get_serial_tag () const
	interface i_serializable
Static Public Attributes
static const std::string	SERIAL_TAG
	interface i_serializable
Private Member Functions
template<class Archive >
void	serialize (Archive &ar_, const unsigned int version_)
Private Attributes
bool	__debug
bool	__selected
bool	__calib_is_ok
	used to validate calibration
datatools::event::event_id	__id
bool	__simulated
timestamp	__timestamp
	timestamp of the event
datatools::utils::properties	__properties
sim_primary_event	__sim_data
scin_hit_col	__scin_hits
	scin col
gg_hit_col	__gg_hits
	geiger col
tracking_col	__trackings
	tracking dictionary
std::string	__default_tracking_name
	The default tracking name.
gamma_tracking	__gamma_tracks
	the nemo3::gamma_tracking of the event
tof_col	__tof_col
	the nemo3::tof_col of the event
Friends
class	boost::serialization::access
	what is saved and opened in data file

Detailed Description

NEMO3 ANA event model.

NEMO3 ANA event model NEMO3 ANA event model

Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
Creation date: 2008-12-17
Last modified: 2009-03-11

License: GPL

Description:
NEMO3 ANA event model

Contain reconstructed tracks, scintillators collection, timestamps...

History:

Member Function Documentation

void nemo3::ana_event::add_tracking	(	const std::string &	name_,
		const tracking &	tracking_,
		bool	default_ = `true`
	)

Add a const tracking with name name_, with a bool for "default" tracking

virtual void nemo3::ana_event::clear ( ) [virtual]

interface i_clear

clear everything

See also:: clear_trackings (); clear_gg_hits (); clear_scin_hits (); clear_sim_data (); timestamp::clear; properties::clear; id::clear

gamma_tracking nemo3::ana_event::copy_gamma_tracking ( ) const [inline]

Returns:: a copy of the nemo3::gamma_tracking of the event. Permit to keep this const.

References __gamma_tracks.

const tracking& nemo3::ana_event::get_default_tracking ( ) const

get the default tracking from the dictionary ana_event::tracking_col

Referenced by get_default_tracking_const(), get_default_tracking_ro(), and get_default_tracking_rw().

tracking& nemo3::ana_event::get_default_tracking ( )

get a no const default tracking from the dictionary ana_event::tracking_col

const tracking& nemo3::ana_event::get_default_tracking_const ( ) const [inline]

get the default tracking from the dictionary ana_event::tracking_col

References get_default_tracking().

const tracking& nemo3::ana_event::get_default_tracking_ro ( ) const [inline]

get the default tracking from the dictionary ana_event::tracking_col

References get_default_tracking().

tracking& nemo3::ana_event::get_default_tracking_rw ( ) [inline]

get a no const default tracking from the dictionary ana_event::tracking_col

References get_default_tracking().

gamma_tracking& nemo3::ana_event::get_gamma_tracking ( ) [inline]

Returns:: the nemo3::gamma_tracking of the event

References __gamma_tracks.

const gg_hit& nemo3::ana_event::get_gg_hit ( int i_ ) const

Returns:: const ana_event::gg_hit_col

const datatools::event::event_id& nemo3::ana_event::get_id ( ) const

Returns:: datatools::event::event_id()

Referenced by get_event_number(), get_id_ro(), get_id_rw(), and get_run_number().

datatools::event::event_id& nemo3::ana_event::get_id ( )

Returns:: datatools::event::event_id

datatools::event::event_id& nemo3::ana_event::get_id_rw ( ) [inline]

Returns:: datatools::event::event_id

References get_id().

int nemo3::ana_event::get_number_of_scin_hits ( ) const [inline]

Returns:: size of ana_event::scin_hit_col

References scin_hits().

const datatools::utils::properties& nemo3::ana_event::get_properties_const ( ) const [inline]

Returns:: datatools::utils::properties

References properties().

const datatools::utils::properties& nemo3::ana_event::get_properties_ro ( ) const [inline]

Returns:: datatools::utils::properties

References properties().

datatools::utils::properties& nemo3::ana_event::get_properties_rw ( ) [inline]

Returns:: datatools::utils::properties

References properties().

int nemo3::ana_event::get_run_number ( ) const [inline]

< get the run number

References get_id().

const scin_hit& nemo3::ana_event::get_scin_hit ( int i_ ) const

Returns:: const scin_hit number i_ (0 to (number of scin-1))

const timestamp& nemo3::ana_event::get_timestamp ( ) const

Returns:: a const ana_event::timestamp

Referenced by get_timestamp_ro().

const timestamp& nemo3::ana_event::get_timestamp_ro ( ) const [inline]

Returns:: a const ana_event::timestamp

References get_timestamp().

const tof_col& nemo3::ana_event::get_tof_col ( ) const [inline]

return the const Time of Flight collection object.

References __tof_col.

tof_col& nemo3::ana_event::get_tof_col_no_const ( ) [inline]

return the no const Time of Flight collection object.

References __tof_col.

const tracking& nemo3::ana_event::get_tracking ( const std::string & name_ ) const

Returns:: const tracking with name name_

Referenced by get_tracking_const(), get_tracking_ro(), and get_tracking_rw().

tracking& nemo3::ana_event::get_tracking ( const std::string & name_ )

return custom tracking with the std::string name name_

const tracking& nemo3::ana_event::get_tracking_const ( const std::string & name_ ) const [inline]

Returns:: const tracking with name name_

References get_tracking().

const tracking& nemo3::ana_event::get_tracking_ro ( const std::string & name_ ) const [inline]

Returns:: const tracking with name name_

References get_tracking().

tracking& nemo3::ana_event::get_tracking_rw ( const std::string & name_ ) [inline]

Parameters:

name_ return custom tracking with the std::string name name_

References get_tracking().

gg_hit& nemo3::ana_event::gg ( int i_ )

Returns:: gg_hit number i_ (0 to (number of gg-1))

gg_hit_col& nemo3::ana_event::gg_hits ( )

Returns:: ana_event::gg_hit_col

Referenced by get_number_of_gg_hits().

const gg_hit_col& nemo3::ana_event::gg_hits ( ) const

Returns:: const ana_event::gg_hit_col

bool nemo3::ana_event::has_default_tracking ( ) const

check if the default tracking has been initializated

bool nemo3::ana_event::has_tracking_with_name ( const std::string & name_ ) const

check if some tracking data from algorithm 'name' is available:

bool nemo3::ana_event::is_selected ( ) const

See also:: set_selected (bool)

const datatools::utils::properties& nemo3::ana_event::properties ( ) const

Returns:: datatools::utils::properties

Referenced by get_properties_const(), get_properties_ro(), and get_properties_rw().

datatools::utils::properties& nemo3::ana_event::properties ( )

Returns:: datatools::utils::properties

scin_hit& nemo3::ana_event::scin ( int i_ )

Returns:: scin_hit number i_ (0 to (number of scin-1))

scin_hit_col& nemo3::ana_event::scin_hits ( )

Returns:: ana_event::scin_hit_col

Referenced by get_number_of_scin_hits().

const scin_hit_col& nemo3::ana_event::scin_hits ( ) const

Returns:: const ana_event::scin_hit_col

void nemo3::ana_event::set_debug ( bool )

set debug mode

void nemo3::ana_event::set_default_tracking ( const std::string & name_ )

set the name of the default tracking

void nemo3::ana_event::set_selected ( bool )

can use this bool for selection

usefull for set of ana_event, for instance in thread_mgr

See also:: is_selected ()

tracking_col& nemo3::ana_event::trackings ( )

Returns:: const ana_event::tracking_col

const tracking_col& nemo3::ana_event::trackings ( ) const

Returns:: const tracking_col

Friends And Related Function Documentation

friend class boost::serialization::access [friend]

what is saved and opened in data file

Using boost format, to add a new element, use versionning like in done for gamma tracking and tof_col.

Member Data Documentation

bool nemo3::ana_event::__selected [private]

See also:: set_selected ()

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

include/N3AnaBase/event/ana_event.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation