RawSecMapRootInterface Class Reference

To be used as an interface to root-stuff. More...

#include <RawSecMapRootInterface.h>

Public Member Functions
	RawSecMapRootInterface (const std::string &mapName, const std::string &tag, const std::string &outputdir="./")
	Constructor - prepares TTree.
	~RawSecMapRootInterface ()
	destructor deleting the rootFile.
	RawSecMapRootInterface (const RawSecMapRootInterface &rawSecMapInterFace)=delete
	That class shall not be copied.
	RawSecMapRootInterface (RawSecMapRootInterface &&other)
	but it may be moved
RawSecMapRootInterface &	operator= (const RawSecMapRootInterface &rawSecMapInterFace)=delete
	That class shall not be copied.
void	initialize2Hit (std::vector< std::string > filterNames)
	initialize the RawSecMapRootInterface for two-hit-combinations (to be called in Module::initialize().
void	initialize3Hit (std::vector< std::string > filterNames)
	initialize the RawSecMapRootInterface for three-hit-combinations (to be called in Module::initialize().
FilterValueDataSet< SecIDPair > &	get2HitDataSet ()
	returns a reference to the 2-hit-dataset so one can set the relevant values.
FilterValueDataSet< SecIDTriplet > &	get3HitDataSet ()
	returns a reference to the 3-hit-dataset so one can set the relevant values.
void	fill2Hit ()
	fill two-hit-combinations in tree, triggers an Error if values not set yet.
void	fill3Hit ()
	fill three-hit-combinations in tree, triggers an Error if values not set yet.
void	write ()
	write all trees to file at end of processing.

Protected Attributes
TFile *	m_file
	a pointer to the file where the Tree shall be stored.
std::string	m_name
	name of the StoreObjPtr.
StoreObjPtr< RootMergeable< TTree > >	m_tree2Hit
	interface to the TTree storing two-hit-variables.
FilterValueDataSet< SecIDPair >	m_data2Hit
	Mask for storing dataSets to be piped into 2hit-tree.
StoreObjPtr< RootMergeable< TTree > >	m_tree3Hit
	interface to the TTree storing three-hit-variables.
FilterValueDataSet< SecIDTriplet >	m_data3Hit
	Mask for storing dataSets to be piped into 3hit-tree.

Detailed Description

To be used as an interface to root-stuff.

Definition at line 32 of file RawSecMapRootInterface.h.

Constructor & Destructor Documentation

RawSecMapRootInterface() [1/2]

RawSecMapRootInterface ( const std::string &  mapName, const std::string &  tag, const std::string &  outputdir = "./"  )

inline

Constructor - prepares TTree.

Without calling the initializer-functions this Object is still not working!

Definition at line 58 of file RawSecMapRootInterface.h.

                                                                                                               :
      m_name(mapName),
      m_tree2Hit((m_name + std::string("2Hit")), DataStore::c_Persistent),
      m_data2Hit({}),
               m_tree3Hit((m_name + std::string("3Hit")), DataStore::c_Persistent),
               m_data3Hit({})
 
    {
      // the "create" option results in the file not being opened if already existing
      std::string fileName = outputdir + "/" + mapName + "_" + tag +  ".root";
      m_file = new TFile((fileName).c_str(), "CREATE");
      if (!m_file->IsOpen()) {
        B2FATAL("File was not opened! File name: " << fileName << " (maybe it already exists!?)");
      }
      m_file->cd();
    }

~RawSecMapRootInterface()

~RawSecMapRootInterface ( )

inline

destructor deleting the rootFile.

Definition at line 76 of file RawSecMapRootInterface.h.

{ if (m_file) delete m_file; }

RawSecMapRootInterface() [2/2]

RawSecMapRootInterface ( RawSecMapRootInterface &&  other )

inline

but it may be moved

Definition at line 82 of file RawSecMapRootInterface.h.

                                                           :
      m_file(nullptr),
      m_name(std::move(other.m_name)),
      m_tree2Hit(std::move(other.m_tree2Hit)),
      m_data2Hit(std::move(other.m_data2Hit)),
      m_tree3Hit(std::move(other.m_tree3Hit)),
      m_data3Hit(std::move(other.m_data3Hit))
    {
      // the new object takes ownership of the file
      m_file = other.m_file;
      other.m_file = nullptr;
    }

Member Function Documentation

fill2Hit()

void fill2Hit ( )

inline

fill two-hit-combinations in tree, triggers an Error if values not set yet.

(data is reset during each fill2Hit-call).

Definition at line 191 of file RawSecMapRootInterface.h.

    {
      if (!m_data2Hit.isValid()) {
        B2ERROR("RawSecMapRootInterface::fill2Hit: attempt to fill invalid data in the tree! -> unintended behavior, data will not be filled.");
        m_data2Hit.reset();
        return;
      }
      m_tree2Hit->get().Fill();
      m_data2Hit.reset();
    }

fill3Hit()

void fill3Hit ( )

inline

fill three-hit-combinations in tree, triggers an Error if values not set yet.

(data is reset during each fill3Hit-call).

Definition at line 205 of file RawSecMapRootInterface.h.

    {
      if (!m_data3Hit.isValid()) {
        B2ERROR("RawSecMapRootInterface::fill3Hit: attempt to fill invalid data in the tree! -> unintended behavior, data will not be filled.");
        m_data3Hit.reset();
        return;
      }
      m_tree3Hit->get().Fill();
      m_data3Hit.reset();
    }

get2HitDataSet()

FilterValueDataSet< SecIDPair > & get2HitDataSet ( )

inline

returns a reference to the 2-hit-dataset so one can set the relevant values.

Definition at line 181 of file RawSecMapRootInterface.h.

{ return m_data2Hit; }

get3HitDataSet()

FilterValueDataSet< SecIDTriplet > & get3HitDataSet ( )

inline

returns a reference to the 3-hit-dataset so one can set the relevant values.

Definition at line 185 of file RawSecMapRootInterface.h.

{ return m_data3Hit; }

initialize2Hit()

void initialize2Hit ( std::vector< std::string >  filterNames )

inline

initialize the RawSecMapRootInterface for two-hit-combinations (to be called in Module::initialize().

Definition at line 100 of file RawSecMapRootInterface.h.

    {
      B2DEBUG(20, "RawSecMapRootInterface::initialize2Hit: start - got " << filterNames.size() << " filters");
      B2DEBUG(20, "and root file got size of: " << m_file->GetSize());
      m_file->cd();
 
      // preparing StoreObjPtr:
      bool registered = m_tree2Hit.registerInDataStore((m_name + std::string("2Hit")), DataStore::c_ErrorIfAlreadyRegistered);
      bool constructed = m_tree2Hit.construct((m_name + std::string("2Hit")).c_str(), "Raw data of two-hit-combinations for a sectorMap");
      B2DEBUG(20, "RawSecMapRootInterface::initialize2Hit: isRegistered/isConstructed: " << registered << "/" << constructed);
 
      // preparing data-mask for 2-hit-combinations:
      m_data2Hit = FilterValueDataSet<SecIDPair>(filterNames);
 
      m_tree2Hit->get().Branch("expNo", &(m_data2Hit.expNo));
      m_tree2Hit->get().Branch("runNo", &(m_data2Hit.runNo));
      m_tree2Hit->get().Branch("evtNo", &(m_data2Hit.evtNo));
      m_tree2Hit->get().Branch("trackNo", &(m_data2Hit.trackNo));
      m_tree2Hit->get().Branch("pdg", &(m_data2Hit.pdg));
      m_tree2Hit->get().Branch("outerSecID", &(m_data2Hit.secIDs.outer));
      m_tree2Hit->get().Branch("innerSecID", &(m_data2Hit.secIDs.inner));
 
      B2DEBUG(20, "RawSecMapRootInterface::initialize2Hit: adding " << filterNames.size() << " filters as branches to ttree ");
      for (auto& name : filterNames) {
        double* valuePtr = m_data2Hit.getValuePtr(name);
        if (valuePtr != nullptr) {
          B2DEBUG(20, "RawSecMapRootInterface::initialize2Hit: adding now branch with name " << name);
          m_tree2Hit->get().Branch(name.c_str(), valuePtr);
        } else {
          B2ERROR("RawSecMapRootInterface::initialize2Hit: filterName " << name <<
                  " not known! this is unintended behavior - skipping filter");
        }
 
      }
      B2DEBUG(20, "RawSecMapRootInterface::initialize2Hit: nBranches/nEntries: " << m_tree2Hit->get().GetNbranches() << "/" <<
              m_tree2Hit->get().GetEntries());
    }

initialize3Hit()

void initialize3Hit ( std::vector< std::string >  filterNames )

inline

initialize the RawSecMapRootInterface for three-hit-combinations (to be called in Module::initialize().

Definition at line 141 of file RawSecMapRootInterface.h.

    {
      B2DEBUG(20, "RawSecMapRootInterface::initialize3Hit: start");
      m_file->cd();
 
      // preparing StoreObjPtr:
      bool registered = m_tree3Hit.registerInDataStore((m_name + std::string("3Hit")), DataStore::c_ErrorIfAlreadyRegistered);
      bool constructed = m_tree3Hit.construct((m_name + std::string("3Hit")).c_str(),
                                              "Raw data of three-hit-combinations for a sectorMap");
      B2DEBUG(20, "RawSecMapRootInterface::initialize3Hit: isRegistered/isConstructed: " << registered << "/" << constructed);
 
      // preparing data-mask for 2-hit-combinations:
      m_data3Hit = FilterValueDataSet<SecIDTriplet>(filterNames);
 
      m_tree3Hit->get().Branch("expNo", &(m_data3Hit.expNo));
      m_tree3Hit->get().Branch("runNo", &(m_data3Hit.runNo));
      m_tree3Hit->get().Branch("evtNo", &(m_data3Hit.evtNo));
      m_tree3Hit->get().Branch("trackNo", &(m_data3Hit.trackNo));
      m_tree3Hit->get().Branch("pdg", &(m_data3Hit.pdg));
      m_tree3Hit->get().Branch("outerSecID", &(m_data3Hit.secIDs.outer));
      m_tree3Hit->get().Branch("centerSecID", &(m_data3Hit.secIDs.center));
      m_tree3Hit->get().Branch("innerSecID", &(m_data3Hit.secIDs.inner));
 
      B2DEBUG(20, "RawSecMapRootInterface::initialize3Hit: adding " << filterNames.size() << " filters as branches to ttree ");
      for (auto& name : filterNames) {
        double* valuePtr = m_data3Hit.getValuePtr(name);
        if (valuePtr != nullptr) {
          B2DEBUG(20, "RawSecMapRootInterface::initialize3Hit: adding now branch with name " << name);
          m_tree3Hit->get().Branch(name.c_str(), valuePtr);
        } else {
          B2ERROR("RawSecMapRootInterface::initialize3Hit: filterName " << name <<
                  " not known! this is unintended behavior - skipping filter");
        }
 
      }
      B2DEBUG(20, "RawSecMapRootInterface::initialize3Hit: nBranches/nEntries: " << m_tree3Hit->get().GetNbranches() << "/" <<
              m_tree3Hit->get().GetEntries());
    }

write()

void write ( )

inline

write all trees to file at end of processing.

Definition at line 218 of file RawSecMapRootInterface.h.

    {
      B2DEBUG(20, "RawSecMapRootInterface::write: start");
      m_file->cd();
 
      if (!ProcHandler::parallelProcessingUsed() or ProcHandler::isOutputProcess()) {
        //use TFile you created in initialize()
        m_tree2Hit->write(m_file);
        m_tree3Hit->write(m_file);
 
      }
    }

Member Data Documentation

m_data2Hit

FilterValueDataSet<SecIDPair> m_data2Hit

protected

Mask for storing dataSets to be piped into 2hit-tree.

Definition at line 45 of file RawSecMapRootInterface.h.

m_data3Hit

FilterValueDataSet<SecIDTriplet> m_data3Hit

protected

Mask for storing dataSets to be piped into 3hit-tree.

Definition at line 51 of file RawSecMapRootInterface.h.

m_file

TFile* m_file

protected

a pointer to the file where the Tree shall be stored.

Definition at line 36 of file RawSecMapRootInterface.h.

m_name

std::string m_name

protected

name of the StoreObjPtr.

Definition at line 39 of file RawSecMapRootInterface.h.

m_tree2Hit

StoreObjPtr<RootMergeable<TTree> > m_tree2Hit

protected

interface to the TTree storing two-hit-variables.

Definition at line 42 of file RawSecMapRootInterface.h.

m_tree3Hit

StoreObjPtr<RootMergeable<TTree> > m_tree3Hit

protected

interface to the TTree storing three-hit-variables.

Definition at line 48 of file RawSecMapRootInterface.h.

---

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

• tracking/trackFindingVXD/sectorMapTools/include/RawSecMapRootInterface.h