---

ReconHeader Class Reference

Root object containing flags for a concerning reconstruction data. More...

#include <ReconHeader.h>

Inheritance diagram for ReconHeader:

List of all members.

Public Types
enum	tkrFlags { TKRRECON = UInt_t(1 << tkrOffset), NOTRACKS = UInt_t(1 << (tkrOffset+1)), GAMMA = UInt_t(1 << (tkrOffset+2)), MANYTRACKS = UInt_t(1 << (tkrOffset+3)) }
	Defines the possible values for the tkrRecon bits. More...
enum	calFlags { GOOD = UInt_t(1 << calOffset), FAIR = UInt_t(1 << (calOffset+1)), POOR = UInt_t(1 << (calOffset+2)), NOENERGY = UInt_t(1 << (calOffset+3)) }
	Defines the possible values for the calRecon bits. More...
enum	{ tkrTestWord = UInt_t(TKRRECON | NOTRACKS | GAMMA | MANYTRACKS), calTestWord = UInt_t(GOOD | FAIR | POOR | NOENERGY) }
Public Methods
	ReconHeader ()
	default constructor - initialize all flags to false.
	~ReconHeader ()
	destructor. More...
int	Clear ()
	Reset all flags to false. More...
UInt_t	getFlags ()
	get the word containing the flags. More...
UInt_t	getTkrFlags ()
	Returns the integer value of the TKR flags. More...
UInt_t	getCalFlags ()
Bool_t	HasRecon ()
	denotes whether there is ANY recon data available. More...
Bool_t	HasTkrRecon ()
	is there any TKR recon data available? More...
Bool_t	HasGamma ()
	Is there a reconstructed gamma? More...
Bool_t	HasManyTracks ()
	Did the TKR recon find more than 1 track? More...
Bool_t	HasCalRecon ()
	Is there CAL reconstruction data? Just checks that NOENERGY bit is not set. More...
Bool_t	HasCalGood ()
	Was the energy reconstruction good? More...
Bool_t	HasCalFair ()
	Was energy reconstruction fair? More...
Bool_t	HasCalPoor ()
	Was the energy reconstruction poor? More...
Bool_t	HasCalNoEnergyRecon ()
	True when NOENERGY bit is set - meaning NO Energy reconstruction. More...
Bool_t	setTkrFlag (UInt_t val)
	set the TKR flags. More...
Bool_t	setCalFlag (UInt_t val)
	set the CAL flags. More...
Bool_t	isValidTkrFlag (UInt_t val)
	Checks to be sure flag falls within bounds for TKR bits. More...
Bool_t	isValidCalFlag (UInt_t val)
	Checks to be sure flag falls within bounds for CAL bits. More...
UInt_t	getEventId ()
	retrieve the event ID for this event. More...
void	setEventId (UInt_t id)
	set the event ID for this event - should match the event ID in the raw data!!! More...
UInt_t	getRunId ()
void	setRunId (UInt_t id)
Private Types
enum	{ calOffset = 8, tkrOffset = 0 }
Private Attributes
UInt_t	m_flags
	Packed word that contains all of the flags for this event. More...
UInt_t	m_eventId
	Event Id. More...
UInt_t	m_runId
	Run number. More...

---

Detailed Description

Root object containing flags for a concerning reconstruction data.

Currently contains flags denoting whether or not: TKR reconstruction data is available CAL reconstruction data is available

Definition at line 11 of file ReconHeader.h.

---

Member Enumeration Documentation

anonymous enum [private]

Enumeration values: calOffset   offset to the beginning of the CAL flags. tkrOffset   offset to the beginning of the TKR flags. Definition at line 33 of file ReconHeader.h.

anonymous enum

Enumeration values: tkrTestWord   extract TKR data. calTestWord   extract CAL data. Definition at line 67 of file ReconHeader.h.

enum ReconHeader::calFlags

Defines the possible values for the calRecon bits. Enumeration values: GOOD   set to 1 when the energy recon is "Good". FAIR   set to 1 when energy recon is "Fair". POOR   set to 1 when the energy recon is "Poor". NOENERGY   set to 1 when NO energy recon is available. Definition at line 56 of file ReconHeader.h.

enum ReconHeader::tkrFlags

Defines the possible values for the tkrRecon bits. Enumeration values: TKRRECON   NOTRACKS   GAMMA   MANYTRACKS   Definition at line 48 of file ReconHeader.h.

---

Constructor & Destructor Documentation

ReconHeader::ReconHeader ( )

default constructor - initialize all flags to false.

ReconHeader::~ReconHeader ( ) [inline]

destructor. Definition at line 78 of file ReconHeader.h.

---

Member Function Documentation

int ReconHeader::Clear ( )

Reset all flags to false. Definition at line 11 of file ReconHeader.cxx. Referenced by ~ReconHeader().

Bool_t ReconHeader::HasCalFair ( ) [inline]

Was energy reconstruction fair? Definition at line 112 of file ReconHeader.h.

Bool_t ReconHeader::HasCalGood ( ) [inline]

Was the energy reconstruction good? Definition at line 109 of file ReconHeader.h.

Bool_t ReconHeader::HasCalNoEnergyRecon ( ) [inline]

True when NOENERGY bit is set - meaning NO Energy reconstruction. Definition at line 118 of file ReconHeader.h.

Bool_t ReconHeader::HasCalPoor ( ) [inline]

Was the energy reconstruction poor? Definition at line 115 of file ReconHeader.h.

Bool_t ReconHeader::HasCalRecon ( ) [inline]

Is there CAL reconstruction data? Just checks that NOENERGY bit is not set. Definition at line 106 of file ReconHeader.h.

Bool_t ReconHeader::HasGamma ( ) [inline]

Is there a reconstructed gamma? Definition at line 100 of file ReconHeader.h.

Bool_t ReconHeader::HasManyTracks ( ) [inline]

Did the TKR recon find more than 1 track? Definition at line 103 of file ReconHeader.h.

Bool_t ReconHeader::HasRecon ( ) [inline]

denotes whether there is ANY recon data available. depends on whether there is any TKR or CAL recon data Definition at line 94 of file ReconHeader.h.

Bool_t ReconHeader::HasTkrRecon ( ) [inline]

is there any TKR recon data available? Definition at line 97 of file ReconHeader.h.

UInt_t ReconHeader::getCalFlags ( ) [inline]

Definition at line 90 of file ReconHeader.h.

UInt_t ReconHeader::getEventId ( ) [inline]

retrieve the event ID for this event. Definition at line 137 of file ReconHeader.h.

UInt_t ReconHeader::getFlags ( ) [inline]

get the word containing the flags. Definition at line 84 of file ReconHeader.h.

UInt_t ReconHeader::getRunId ( ) [inline]

Definition at line 142 of file ReconHeader.h.

UInt_t ReconHeader::getTkrFlags ( ) [inline]

Returns the integer value of the TKR flags. Definition at line 87 of file ReconHeader.h.

Bool_t ReconHeader::isValidCalFlag ( UInt_t val )

Checks to be sure flag falls within bounds for CAL bits. Definition at line 33 of file ReconHeader.cxx. Referenced by setCalFlag().

Bool_t ReconHeader::isValidTkrFlag ( UInt_t val )

Checks to be sure flag falls within bounds for TKR bits. Definition at line 18 of file ReconHeader.cxx. Referenced by setTkrFlag().

Bool_t ReconHeader::setCalFlag ( UInt_t val )

set the CAL flags. returns kFALSE if the routine determines the val provided is out of bounds...if successful kTRUE is returned Definition at line 39 of file ReconHeader.cxx.

void ReconHeader::setEventId ( UInt_t id ) [inline]

set the event ID for this event - should match the event ID in the raw data!!! Definition at line 140 of file ReconHeader.h.

void ReconHeader::setRunId ( UInt_t id ) [inline]

Definition at line 144 of file ReconHeader.h.

Bool_t ReconHeader::setTkrFlag ( UInt_t val )

set the TKR flags. returns kFALSE if the routine determines the val provided is out of bounds...if successful kTRUE is returned Definition at line 24 of file ReconHeader.cxx.

---

Member Data Documentation

UInt_t ReconHeader::m_eventId [private]

Event Id. Definition at line 41 of file ReconHeader.h.

UInt_t ReconHeader::m_flags [private]

Packed word that contains all of the flags for this event. ||RESERVED || ||For Future|| || 31....16 || || CAL FLAGS || || 15 | 14 | 13 | 12 | 11 | 10 | 09 | 08 || || UNUSED |NO ENERGY|POOR |FAIR |GOOD || || |RECON | | | || || TKR FLAGS || || 07 | 06 | 05 | 04 | 03 | 02 | 01 | 00 || || UNUSED |MANYTracks|GAMMA|NOTRACKS|TKRRECON|| Definition at line 31 of file ReconHeader.h.

UInt_t ReconHeader::m_runId [private]

Run number. Definition at line 44 of file ReconHeader.h.

---

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

• ReconHeader.h
• ReconHeader.cxx

---