Falaise  4.0.1
SuperNEMO Software Toolkit
Public Types | Public Member Functions | List of all members
snemo::datamodel::particle_track_data Class Reference

SuperNEMO particle track model. More...

#include <falaise/snemo/datamodels/particle_track_data.h>

Inheritance diagram for snemo::datamodel::particle_track_data:
datatools::i_serializable datatools::i_tree_dumpable datatools::i_clear

Public Types

typedef std::vector< particle_track::handle_typeparticle_collection_type
 Collection of handles on particle tracks. More...
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type
 

Public Member Functions

 particle_track_data ()
 Default constructor. More...
 
virtual ~particle_track_data ()
 Destructor: More...
 
bool has_particles () const
 Check if there are some particles. More...
 
size_t get_number_of_particles () const
 Returns the number of particle. More...
 
void add_particle (const particle_track::handle_type &handle_)
 Add a particle track. More...
 
const particle_trackget_particle (size_t index_) const
 Return a non mutable reference to a particle by index. More...
 
particle_collection_typegrab_particles ()
 Return a mutable reference to particles. More...
 
const particle_collection_typeget_particles () const
 Return a non mutable reference to particles. More...
 
void remove_particle (size_t index_)
 Remove a particle given its index. More...
 
void remove_particles (std::vector< size_t > &indexes_)
 Remove particles given a list of indexes. More...
 
void invalidate_particles ()
 Reset the particle tracks. More...
 
size_t fetch_particles (particle_collection_type &particles_, const uint32_t flags_, const bool clear_=false) const
 Retrieve particles given their charge. More...
 
bool has_non_associated_calorimeters () const
 Check if there are some non associated calorimeters. More...
 
const calibrated_calorimeter_hit::collection_typeget_non_associated_calorimeters () const
 Return a non mutable reference to non associated calorimeters. More...
 
calibrated_calorimeter_hit::collection_typegrab_non_associated_calorimeters ()
 Return a mutable reference to non associated calorimeters. More...
 
void reset_non_associated_calorimeters ()
 Reset the non associated calorimeters. More...
 
void reset ()
 Reset the internals. More...
 
bool is_valid () const
 Check if the object has a valid internal structure. More...
 
const datatools::propertiesget_auxiliaries () const
 Return a mutable reference on the container of auxiliary properties. More...
 
datatools::propertiesgrab_auxiliaries ()
 Return a non mutable reference on the container of auxiliary properties. More...
 
virtual void clear ()
 Clear the object. More...
 
virtual void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 Smart print. More...
 
- Public Member Functions inherited from datatools::i_serializable
 i_serializable ()
 
virtual ~i_serializable ()
 
virtual const std::string & get_serial_tag () const=0
 
- Public Member Functions inherited from datatools::i_tree_dumpable
 i_tree_dumpable ()
 
virtual ~i_tree_dumpable ()
 
virtual void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
 
void print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
 
void print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
 
void tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const
 
void tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const
 
void smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const
 
- Public Member Functions inherited from datatools::i_clear
virtual ~i_clear ()
 

Additional Inherited Members

- Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree & empty_options ()
 
static boost::property_tree::ptree make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)
 
static std::ostream & last_skip_tag (std::ostream &out_)
 
static std::ostream & skip_tag (std::ostream &out_)
 
static std::ostream & last_tag (std::ostream &out_)
 
static std::ostream & tag (std::ostream &out_)
 
- Public Attributes inherited from datatools::i_tree_dumpable
 OSTREAM_COUT
 
 OSTREAM_CERR
 
 OSTREAM_CLOG
 

Detailed Description

SuperNEMO particle track model.

Member Typedef Documentation

◆ particle_collection_type

Collection of handles on particle tracks.

Constructor & Destructor Documentation

◆ particle_track_data()

snemo::datamodel::particle_track_data::particle_track_data ( )

Default constructor.

◆ ~particle_track_data()

virtual snemo::datamodel::particle_track_data::~particle_track_data ( )
virtual

Destructor:

Member Function Documentation

◆ add_particle()

void snemo::datamodel::particle_track_data::add_particle ( const particle_track::handle_type handle_)

Add a particle track.

◆ clear()

virtual void snemo::datamodel::particle_track_data::clear ( )
virtual

Clear the object.

Implements datatools::i_clear.

◆ fetch_particles()

size_t snemo::datamodel::particle_track_data::fetch_particles ( particle_collection_type particles_,
const uint32_t  flags_,
const bool  clear_ = false 
) const

Retrieve particles given their charge.

◆ get_auxiliaries()

const datatools::properties& snemo::datamodel::particle_track_data::get_auxiliaries ( ) const

Return a mutable reference on the container of auxiliary properties.

◆ get_non_associated_calorimeters()

const calibrated_calorimeter_hit::collection_type& snemo::datamodel::particle_track_data::get_non_associated_calorimeters ( ) const

Return a non mutable reference to non associated calorimeters.

◆ get_number_of_particles()

size_t snemo::datamodel::particle_track_data::get_number_of_particles ( ) const

Returns the number of particle.

◆ get_particle()

const particle_track& snemo::datamodel::particle_track_data::get_particle ( size_t  index_) const

Return a non mutable reference to a particle by index.

◆ get_particles()

const particle_collection_type& snemo::datamodel::particle_track_data::get_particles ( ) const

Return a non mutable reference to particles.

◆ grab_auxiliaries()

datatools::properties& snemo::datamodel::particle_track_data::grab_auxiliaries ( )

Return a non mutable reference on the container of auxiliary properties.

◆ grab_non_associated_calorimeters()

calibrated_calorimeter_hit::collection_type& snemo::datamodel::particle_track_data::grab_non_associated_calorimeters ( )

Return a mutable reference to non associated calorimeters.

◆ grab_particles()

particle_collection_type& snemo::datamodel::particle_track_data::grab_particles ( )

Return a mutable reference to particles.

◆ has_non_associated_calorimeters()

bool snemo::datamodel::particle_track_data::has_non_associated_calorimeters ( ) const

Check if there are some non associated calorimeters.

◆ has_particles()

bool snemo::datamodel::particle_track_data::has_particles ( ) const

Check if there are some particles.

◆ invalidate_particles()

void snemo::datamodel::particle_track_data::invalidate_particles ( )

Reset the particle tracks.

◆ is_valid()

bool snemo::datamodel::particle_track_data::is_valid ( ) const

Check if the object has a valid internal structure.

◆ remove_particle()

void snemo::datamodel::particle_track_data::remove_particle ( size_t  index_)

Remove a particle given its index.

◆ remove_particles()

void snemo::datamodel::particle_track_data::remove_particles ( std::vector< size_t > &  indexes_)

Remove particles given a list of indexes.

◆ reset()

void snemo::datamodel::particle_track_data::reset ( )

Reset the internals.

◆ reset_non_associated_calorimeters()

void snemo::datamodel::particle_track_data::reset_non_associated_calorimeters ( )

Reset the non associated calorimeters.

◆ tree_dump()

virtual void snemo::datamodel::particle_track_data::tree_dump ( std::ostream &  out_ = std::clog,
const std::string &  title_ = "",
const std::string &  indent_ = "",
bool  inherit_ = false 
) const
virtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.


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