/* This file is part of MAUS: http://micewww.pp.rl.ac.uk/projects/maus * * MAUS is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * MAUS is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with MAUS. If not, see . */ #ifndef _SRC_COMMON_CPP_DATASTRUCTURE_GLOBALEVENT_ #define _SRC_COMMON_CPP_DATASTRUCTURE_GLOBALEVENT_ #include #include "src/common_cpp/Utils/VersionNumber.hh" #include "src/common_cpp/DataStructure/Global/PrimaryChain.hh" #include "src/common_cpp/DataStructure/Global/Track.hh" #include "src/common_cpp/DataStructure/Global/TrackPoint.hh" #include "src/common_cpp/DataStructure/Global/SpacePoint.hh" namespace MAUS { /** @class GlobalEvent comment * @author Ian Taylor, University of Warwick * @date 2013/03/01 - Expanded from original 'blank slate' * */ class GlobalEvent { public: /** Default constructor - initialises to 0/NULL */ GlobalEvent(); /** Copy constructor - any pointers are deep copied */ GlobalEvent(const GlobalEvent& globalevent); /** Equality operator - any pointers are deep copied */ GlobalEvent& operator=(const GlobalEvent& globalevent); /** Destructor - any member pointers are deleted */ virtual ~GlobalEvent(); /** Add a MAUS::DataStructure::Global::PrimaryChain object, daughter objects * are ignored. */ void add_primary_chain(MAUS::DataStructure::Global::PrimaryChain* pchain); /** Return the std::vector of MAUS::DataStructure::Global::PrimaryChain*, * #_primary_chains. */ std::vector* get_primary_chains() const; /** Set the std::vector. */ void set_primary_chains( std::vector *primary_chains); /** Add a MAUS::DataStructure::Global::Track object, daughter * objects are ignored. */ void add_track(MAUS::DataStructure::Global::Track* track); /** If a MAUS::DataStructure::Global::Track object is not already a * member of the GlobalEvent, add it in. Otherwise, return false, * to signify already added.*/ bool add_track_check(MAUS::DataStructure::Global::Track* track); /** Recursively add a MAUS::DataStructure::Global::Track object and * the associated daughter objects */ void add_track_recursive(MAUS::DataStructure::Global::Track* track); /** Return the std::vector of MAUS::DataStructure::Global::Track*, * #_tracks. */ std::vector* get_tracks() const; /** Set the std::vector. */ void set_tracks(std::vector *tracks); /** Add a MAUS::DataStructure::Global::TrackPoint object, daughter * objects are ignored. */ void add_track_point(MAUS::DataStructure::Global::TrackPoint* track_point); /** If a MAUS::DataStructure::Global::TrackPoint object is not * already a member of the GlobalEvent, add it in. Otherwise, * return false, to signify already added.*/ bool add_track_point_check( MAUS::DataStructure::Global::TrackPoint* track_point); /** Recursively add a MAUS::DataStructure::Global::TrackPoint object * and the associated daughter objects */ void add_track_point_recursive( MAUS::DataStructure::Global::TrackPoint* track_point); /** Return the std::vector of MAUS::DataStructure::Global::TrackPoint*, * #_track_points. */ std::vector* get_track_points() const; /** Set the std::vector. */ void set_track_points( std::vector *track_points); /** Add a MAUS::DataStructure::Global::SpacePoint object. */ void add_space_point(MAUS::DataStructure::Global::SpacePoint* space_point); /** If a MAUS::DataStructure::Global::SpacePoint object is not already a * member of the GlobalEvent, add it in. Otherwise, return false, * to signify already added.*/ bool add_space_point_check( MAUS::DataStructure::Global::SpacePoint* space_point); /** Return the std::vector of MAUS::DataStructure::Global::SpacePoint*, * #_space_points. */ std::vector* get_space_points() const; /** Set the std::vector, * #_space_points. */ void set_space_points( std::vector *space_points); /** Return a vector of all upstream primary chains that are not orphans */ std::vector GetUSPrimaryChains() const; /** Return a vector of all downstream primary chains that are not orphans */ std::vector GetDSPrimaryChains() const; /** Return a vector of all through primary chains */ std::vector GetThroughPrimaryChains() const; /** Return a vector of all primary chain orphans, i.e. chains whose tracks have * not been matched into a through track */ std::vector GetPrimaryChainOrphans() const; /** Return a vector of all upstream primary chain orphans, i.e. upstream chains whose tracks * have not been matched into a through track */ std::vector GetUSPrimaryChainOrphans() const; /** Return a vector of all downstream primary chain orphans, i.e. downstream chains whose tracks * have not been matched into a through track */ std::vector GetDSPrimaryChainOrphans() const; /** Return a vector of all non-through primary chains, i.e. all upstream and downstream * chains, whether they are orphans or not. */ std::vector GetNonThroughPrimaryChains() const; /** Return a vector of tracks from local reconstruction, i.e. tracker and EMR tracks */ std::vector GetLRTracks() const; /** Return a vector of tracks from local reconstruction, i.e. tracker and EMR tracks, if they * contain a hit in the selected detector. */ std::vector GetLRTracks(MAUS::DataStructure::Global::DetectorPoint detector) const; /** Return a vector of space points from local reconstruction, i.e. from the * TOFs, Chkovs, and KL */ std::vector GetLRSpacePoints() const; /** Return a vector of space points from local reconstruction corresponding to the chosen * DetectorPoint (corresponding to one of the TOFs or Chkovs or the KL */ std::vector GetLRSpacePoints(MAUS::DataStructure::Global::DetectorPoint detector) const; private: /** Return all primary chains corresponding to the given type. Is called by the respective * public functions */ std::vector GetPrimaryChains(MAUS::DataStructure::Global::ChainType chain_type) const; /** A vector of MAUS::DataStructure::Global::PrimaryChain pointers * associated with this event. Different reconstruction steps can * be distinguished by mapper_name. */ std::vector *_primary_chains; /** A vector of MAUS::DataStructure::Global::Track pointers associated with * this event. These should be accessed through the * MAUS::DataStructure::Global::PrimaryChain pointers stored in * #_primary_chains. */ std::vector *_tracks; /** A vector of MAUS::DataStructure::Global::TrackPoint pointers * associated with this event. These should be accessed through the * MAUS::DataStructure::Global::PrimaryChain pointers stored in * #_primary_chains. */ std::vector *_track_points; /** A vector of MAUS::DataStructure::Global::SpacePoint pointers * associated with this event. These should be accessed through the * MAUS::DataStructure::Global::PrimaryChain pointers stored in * #_primary_chains. */ std::vector *_space_points; MAUS_VERSIONED_CLASS_DEF(GlobalEvent); }; // ~GlobalEvent } // ~MAUS #endif // _SRC_COMMON_CPP_DATASTRUCTURE_GLOBALEVENT_