Prints the content of all the ParticleFlow particles on screen. More...

Inheritance diagram for recob::DumpPFParticles:

Classes
struct	Config

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >

using	ModuleType = EDAnalyzer

Public Member Functions
	DumpPFParticles (Parameters const &config)
	Default constructor. More...

virtual void	analyze (const art::Event &evt) override
	Does the printing. More...

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Private Member Functions
void	MakePFParticleGraph (art::Event const &event, art::ValidHandle< std::vector< recob::PFParticle >> const &handle) const

Static Private Member Functions
static std::string	DotFileName (art::EventID const &evtID, art::Provenance const &prodInfo)

Private Attributes
art::InputTag	fInputTag
	input tag of the PFParticle product More...

std::string	fOutputCategory
	category for LogInfo output More...

bool	fPrintHexFloats
	whether to print floats in base 16 More...

unsigned int	fMaxDepth
	maximum generation to print (0: only primaries) More...

bool	fMakeEventGraphs
	whether to create one DOT file per event More...

Detailed Description

Prints the content of all the ParticleFlow particles on screen.

This analyser prints the content of all the ParticleFlow particles into the LogInfo/LogVerbatim stream.

Configuration parameters

PFModuleLabel (art::InputTag, required): label of the producer used to create the recob::PFParticle collection to be dumped
OutputCategory (string, default: "DumpPFParticles"): the category used for the output (useful for filtering)
PrintHexFloats (boolean, default: false): print all the floating point numbers in base 16
MaxDepth (unsigned int, optional): if specified, at most this number of particle generations will be printed; 1 means printing only primaries and their daughters, 0 only primaries. If not specified, no limit will be applied. This is useful for buggy PFParticles with circular references.
MakeParticleGraphs (boolean, default: false): creates a DOT file for each event, with a graph of PFParticle relations; each file is named as: ProcessName_ModuleLabel_InstanceName_Run::_Subrun::_Event::_particles.dot, where the the input label elements refer to the data product being plotted.

Particle connection graphs

When MakeParticleGraphs configuration option is activated, a file is created for each event, that contains the particle flow tree in GraphViz format. The GraphViz dot command can be used to render it into a PDF, SVG, EPS or one of the many supported bitmap formats. The typical command to use is:

dot -Tpdf -oPMTrk.pdf PMTrk.dot

A bash command to convert all files into a OutputFormat format:

OutputFormat='pdf'
for DotFile in *.dot ; do
  OutputFile="${DotFile%.dot}.${OutputFormat}"
  [[ "$OutputFile" -ot "$DotFile" ]] || continue # up to date already
  echo "${DotFile} => ${OutputFile} ..."
  dot -T"$OutputFormat" -o"$OutputFile" "$DotFile" || break
done

which will also skip files already converted.

The output shows one cell ("node") per particle. The format of the node follows these prescriptions:

the label has the particle ID number prepended by a hash character (#)
if the particle has a PDG ID, that also appears in the label (either the name of the corresponding particle, or, if unknown, just the PDG ID number)
if the particle is primary, it is rendered in bold font
if the particle is referred by other particles, but it is not present ("ghost particle"), its border is red and dashed

The relations between particles in the flow are represented by connecting lines ("edges"). Connection information is redundant: the parent particle should have the daughter in the daughter list, and the daughter should have the parent particle referenced as such. Since the connection is usually from two sources, there are usually two arrow heads, each one close to the particle that provides information on that connection; all arrow heads point from parent to daughter.

when the information of daughter and parent is consistent, a black line with two arrow heads both pointing to the daughter is shown
when the parent is ghost, the arrow head close to the daughter is hollow; ghost particles have no arrow heads close to them
when the daughter is ghost, the arrow head close to the parent is hollow; ghost particles have no arrow heads close to them

If you are trying to interpret an existing diagram, the following list is more direct to the point. Nodes: represent particles (see above for the label content)

bold label: primary particle
red, dashed border: "ghost particle" (missing but referenced by others)
other: just a particle

Connecting lines ("edges"):

all arrow heads point from parent to daughter
black with two full arrow heads: regular parent to daughter
black with a single inward empty arrow head: the particle close to the arrow claims the particle pointed by the arrow as a daughter, but there is no information on that daughter (ghost daughter)
black with a single outward empty arrow head: the particle at the tip of the arrow claims to be daughter of the other particle, but there is no information on that parent (ghost parent)
red, outward arrow: the daughter (at the tip of the only arrow) claims the other particle as parent, but that parent does not recognise it as daughter
orange, inward arrow: the parent (close to the only arrow head) claims the other particle as daughter, but that daighter does not recognise it as parent

Definition at line 131 of file DumpPFParticles_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

using recob::DumpPFParticles::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 161 of file DumpPFParticles_module.cc.

Constructor & Destructor Documentation

recob::DumpPFParticles::DumpPFParticles ( Parameters const & config )

explicit

Default constructor.

Definition at line 993 of file DumpPFParticles_module.cc.

References fMaxDepth.

     : EDAnalyzer(config)
     , fInputTag(config().PFModuleLabel())
     , fOutputCategory(config().OutputCategory())
     , fPrintHexFloats(config().PrintHexFloats())
     , fMaxDepth(std::numeric_limits<unsigned int>::max())
     , fMakeEventGraphs(config().MakeParticleGraphs())
   {
     // here we are handling the optional configuration key as it had just a
     // default value
     if (!config().MaxDepth(fMaxDepth)) fMaxDepth = std::numeric_limits<unsigned int>::max();
   }

Member Function Documentation

void recob::DumpPFParticles::analyze ( const art::Event & evt )

overridevirtual

Does the printing.

Definition at line 1037 of file DumpPFParticles_module.cc.

References DEFINE_ART_MODULE, art::InputTag::encode(), fInputTag, fMakeEventGraphs, fMaxDepth, fOutputCategory, fPrintHexFloats, art::ProductRetriever::getValidHandle(), art::Event::id(), and MakePFParticleGraph().

   {
 
     //
     // collect all the available information
     //
     // fetch the data to be dumped on screen
     art::ValidHandle<std::vector<recob::PFParticle>> PFParticles =
       evt.getValidHandle<std::vector<recob::PFParticle>>(fInputTag);
 
     if (fMakeEventGraphs) MakePFParticleGraph(evt, PFParticles);
 
     art::FindOne<recob::Vertex> const ParticleVertices(PFParticles, evt, fInputTag);
     art::FindMany<recob::Track> const ParticleTracks(PFParticles, evt, fInputTag);
     art::FindMany<recob::Cluster> const ParticleClusters(PFParticles, evt, fInputTag);
     art::FindMany<recob::Seed> const ParticleSeeds(PFParticles, evt, fInputTag);
     art::FindMany<recob::SpacePoint> const ParticleSpacePoints(PFParticles, evt, fInputTag);
     art::FindMany<recob::PCAxis> const ParticlePCAxes(PFParticles, evt, fInputTag);
 
     size_t const nParticles = PFParticles->size();
     mf::LogVerbatim(fOutputCategory) << "Event " << evt.id() << " contains " << nParticles
                                      << " particles from '" << fInputTag.encode() << "'";
 
     // prepare the dumper
     ParticleDumper::PrintOptions_t options;
     options.hexFloats = fPrintHexFloats;
     options.maxDepth = fMaxDepth;
     options.streamName = fOutputCategory;
     ParticleDumper dumper(*PFParticles, options);
     if (ParticleVertices.isValid())
       dumper.SetVertices(&ParticleVertices);
     else
       mf::LogPrint("DumpPFParticles") << "WARNING: vertex information not available";
     if (ParticleTracks.isValid())
       dumper.SetTracks(&ParticleTracks);
     else
       mf::LogPrint("DumpPFParticles") << "WARNING: track information not available";
     if (ParticleClusters.isValid())
       dumper.SetClusters(&ParticleClusters);
     else
       mf::LogPrint("DumpPFParticles") << "WARNING: cluster information not available";
     if (ParticleSeeds.isValid())
       dumper.SetSeeds(&ParticleSeeds);
     else
       mf::LogPrint("DumpPFParticles") << "WARNING: seed information not avaialble";
     if (ParticleSpacePoints.isValid())
       dumper.SetSpacePoints(&ParticleSpacePoints);
     else {
       mf::LogPrint("DumpPFParticles") << "WARNING: space point information not available";
     }
     if (ParticlePCAxes.isValid())
       dumper.SetPCAxes(&ParticlePCAxes);
     else {
       mf::LogPrint("DumpPFParticles") << "WARNING: principal component axis not available";
     }
     dumper.DumpAllParticles("  ");
 
     mf::LogVerbatim(fOutputCategory) << "\n"; // two empty lines
 
   } // DumpPFParticles::analyze()

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Analyzer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 25 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Analyzer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 68 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 84 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

void art::detail::Analyzer::doEndJob ( )

inherited

Definition at line 33 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Analyzer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 76 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 92 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEvent	(	EventPrincipal &	ep,
		ModuleContext const &	mc,
		std::atomic< std::size_t > &	counts_run,
		std::atomic< std::size_t > &	counts_passed,
		std::atomic< std::size_t > &	counts_failed
	)

inherited

Definition at line 100 of file Analyzer.cc.

References e, and art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     auto const e = std::as_const(ep).makeEvent(mc);
     if (wantEvent(mc.scheduleID(), e)) {
       ++counts_run;
       ProcessingFrame const frame{mc.scheduleID()};
       analyzeWithFrame(e, frame);
       ++counts_passed;
     }
     return true;
   }

void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 47 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 61 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 40 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 54 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

std::string recob::DumpPFParticles::DotFileName	(	art::EventID const &	evtID,
		art::Provenance const &	prodInfo
	)

staticprivate

Definition at line 1007 of file DumpPFParticles_module.cc.

References art::EventID::event(), art::Provenance::moduleLabel(), art::Provenance::processName(), art::Provenance::productInstanceName(), art::EventID::run(), art::EventID::subRun(), and util::to_string().

Referenced by MakePFParticleGraph().

   {
     return prodInfo.processName() + '_' + prodInfo.moduleLabel() + '_' +
            prodInfo.productInstanceName() + "_Run" + std::to_string(evtID.run()) + "_Subrun" +
            std::to_string(evtID.subRun()) + "_Event" + std::to_string(evtID.event()) +
            "_particles.dot";
   } // DumpPFParticles::DotFileName()

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

Handle< TriggerResults > art::Observer::getTriggerResults ( Event const & e ) const

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

void recob::DumpPFParticles::MakePFParticleGraph	(	art::Event const &	event,
		art::ValidHandle< std::vector< recob::PFParticle >> const &	handle
	)		const

private

Definition at line 1017 of file DumpPFParticles_module.cc.

References DotFileName(), art::EventID::event(), art::EventID::run(), and art::EventID::subRun().

Referenced by analyze().

   {
     art::EventID const eventID = event.id();
     std::string fileName = DotFileName(eventID, *(handle.provenance()));
     std::ofstream outFile(fileName); // overwrite by default
 
     outFile << "// " << fileName << "\n// "
             << "\n// Created for run " << eventID.run() << " subrun " << eventID.subRun()
             << " event " << eventID.event() << "\n// "
             << "\n// dump of " << handle->size() << " particles"
             << "\n// " << std::endl;
 
     PFParticleGraphMaker graphMaker;
     graphMaker.MakeGraph(outFile, *handle);
 
   } // DumpPFParticles::MakePFParticleGraph()

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

   {
     return process_name_;
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

Referenced by art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }

Member Data Documentation

art::InputTag recob::DumpPFParticles::fInputTag

private

input tag of the PFParticle product

Definition at line 170 of file DumpPFParticles_module.cc.

Referenced by analyze().

bool recob::DumpPFParticles::fMakeEventGraphs

private

whether to create one DOT file per event

Definition at line 174 of file DumpPFParticles_module.cc.

Referenced by analyze().

unsigned int recob::DumpPFParticles::fMaxDepth

private

maximum generation to print (0: only primaries)

Definition at line 173 of file DumpPFParticles_module.cc.

Referenced by analyze(), and DumpPFParticles().

std::string recob::DumpPFParticles::fOutputCategory

private

category for LogInfo output

Definition at line 171 of file DumpPFParticles_module.cc.

Referenced by analyze().

bool recob::DumpPFParticles::fPrintHexFloats

private

whether to print floats in base 16

Definition at line 172 of file DumpPFParticles_module.cc.

Referenced by analyze().

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

lardata/v09_16_03/source/lardata/ArtDataHelper/Dumpers/DumpPFParticles_module.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Configuration parameters

Particle connection graphs

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation