RAT::PruneProc Class Reference

Inheritance diagram for RAT::PruneProc:

Public Member Functions
	PruneProc ()
virtual	~PruneProc ()
virtual Processor::Result	DSEvent (DS::Root *ds)
virtual void	SetS (std::string param, std::string value)
void	SetPruneState (std::string item, bool state)
bool	GetPruneState (std::string item)
Public Member Functions inherited from RAT::Processor
	Processor (std::string _name)
virtual	~Processor ()
std::string	GetName () const
virtual void	SetI (std::string param, int value)
virtual void	SetF (std::string param, float value)
virtual void	SetD (std::string param, double value)
virtual void	BeginOfRun (DS::Run *run)
virtual void	EndOfRun (DS::Run *run)
virtual Processor::Result	Event (DS::Root *ds, DS::EV *ev)

Protected Attributes
bool	mc
bool	mc_particle
bool	mc_track
bool	mc_pmt
bool	mc_pmt_photon
bool	ev
bool	ev_pmt
std::vector< std::string >	track_cut
Protected Attributes inherited from RAT::Processor
std::string	name

Additional Inherited Members
Public Types inherited from RAT::Processor
enum	Result { OK = 0 , FAIL = 1 , ABORT = 2 }

Constructor & Destructor Documentation

PruneProc()

PruneProc::PruneProc

(

)

Create a new prune processor which prunes nothing by default.

~PruneProc()

PruneProc::~PruneProc ( )

virtual

Destroy the processor

Member Function Documentation

DSEvent()

Processor::Result PruneProc::DSEvent ( DS::Root *  ds )

virtual

Eliminate branches from ds as specified in SetS().

Reimplemented from RAT::Processor.

GetPruneState()

bool PruneProc::GetPruneState

(

std::string

item

)

Returns true if the branch name item will be cut.

Valid branch names listed in SetS().

SetPruneState()

void PruneProc::SetPruneState	(	std::string	item,
		bool	state
	)

Set the pruning state of a branch.

Parameters

item	Name of branch. Valid names listed in SetS().
state	if true, that branch will be deleted.

SetS()

void PruneProc::SetS ( std::string  param, std::string  value  )

virtual

Set string parameter.

• "prune" : Adds a branch to the list to prune. Allowed values include "mc.particle", "mc.track", "mc.hit", "mc.pmt", "mc.pmt.photon", "ev", "ev.pmt". If you wish to remove only a specific kind of particle, like optical photons, you can use the for "mc.track:opticalphoton".

Reimplemented from RAT::Processor.

Member Data Documentation

ev

bool RAT::PruneProc::ev

protected

Cut triggered events?

ev_pmt

bool RAT::PruneProc::ev_pmt

protected

Cut list of hit PMTs from triggered events?

mc

bool RAT::PruneProc::mc

protected

Cut Monte Carlo information entirely

mc_particle

bool RAT::PruneProc::mc_particle

protected

Cut Monte Carlo particles?

mc_pmt

bool RAT::PruneProc::mc_pmt

protected

Cut Monte Carlo list of hit PMTs?

mc_pmt_photon

bool RAT::PruneProc::mc_pmt_photon

protected

Cut Monte Carlo list of photoelectrons?

mc_track

bool RAT::PruneProc::mc_track

protected

Cut Monte Carlo tracks? True even if only certain particle types will be cut.

track_cut

std::vector<std::string> RAT::PruneProc::track_cut

protected

Names of particles to eliminate from tracks.

If this vector is empty and mc_track is true, cut all tracks.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/ratpac/checkouts/latest/src/core/include/RAT/PruneProc.hh
• /home/docs/checkouts/readthedocs.org/user_builds/ratpac/checkouts/latest/src/core/src/PruneProc.cc