CaloRecoStatus Class Reference

reconstruction status indicator More...

#include <CaloRecoStatus.h>

Collaboration diagram for CaloRecoStatus:

Public Types
enum	StatusIndicator {   TAGGEDEM = 0x00000001, TAGGEDHAD = 0x00000002, TAGGEDMUON = 0x00000004, TAGGEDUNKNOWN = 0x00000008,   CALIBRATED = 0x10000000, CALIBRATEDLHC = 0x10000010, CALIBRATEDALT = 0x10000020, UNKNOWNSTATUS = 0x00000000 }
	reconstruction status word More...
typedef unsigned int	store_type
	Internal store type. More...

Public Member Functions
	CaloRecoStatus (StatusIndicator statusIndicator=UNKNOWNSTATUS)
	Default constructor. More...
	CaloRecoStatus (store_type store)
virtual	~CaloRecoStatus ()
	Destructor. More...
virtual void	setStatus (const StatusIndicator &statusIndicator)
	Set status. More...
virtual bool	checkStatus (const StatusIndicator &statusIndicator) const
	Check status. More...
virtual const store_type &	getStatusWord () const
	retrieve the entire status word More...
virtual bool	getStatus (std::vector< CaloRecoStatus::StatusIndicator > &pStatusList) const
	retrieve all status indicators More...
virtual void	resetStatus ()
	reset reconstruction status More...
virtual void	resetStatus (const StatusIndicator &statusIndicator)

Private Attributes
store_type	m_status
	Status store. More...

Detailed Description

reconstruction status indicator

Definition at line 11 of file CaloRecoStatus.h.

Member Typedef Documentation

store_type

typedef unsigned int CaloRecoStatus::store_type

Internal store type.

Definition at line 16 of file CaloRecoStatus.h.

Member Enumeration Documentation

StatusIndicator

enum CaloRecoStatus::StatusIndicator

reconstruction status word

Indicates cluster tag and calibration status. Note that tags may only be applied to (calibrated) topological clusters.

Parameters

TAGGEDEM	tagged as electromagnetic
TAGGEDHAD	tagged as hadronic
TAGGEDMUON	tagged as muon
TAGGEDUNKNOWN	no safe tags from any classification
CALIBRATED	calibrated begond em scale
CALIBRATEDLHC	calibrated by local hadronic approach
CALIBRATEDALT	calibrated by alternative calibration, typically with cell weights from jets

Note that several tags can be valid at the same time, especially CALIBRATED & CALIBRATEDLHC & CALIBRATEDALT and subsequent combinations of those.

Enumerator
TAGGEDEM
TAGGEDHAD
TAGGEDMUON
TAGGEDUNKNOWN
CALIBRATED
CALIBRATEDLHC
CALIBRATEDALT
UNKNOWNSTATUS

Definition at line 36 of file CaloRecoStatus.h.

  { 
    TAGGEDEM      = 0x00000001, /*< tagged as electromagnetic object */  
    TAGGEDHAD     = 0x00000002, /*< tagged as hadronic object        */
    TAGGEDMUON    = 0x00000004, /*< tagged as muonic cluster         */
    TAGGEDUNKNOWN = 0x00000008, /*< tagged as unknown                */
    CALIBRATED    = 0x10000000, /*< cluster calibrated (non-emscale) */
    CALIBRATEDLHC = 0x10000010, /*< cluster calibrated local had     */
    CALIBRATEDALT = 0x10000020, /*< cluster calibrated alternatively */
    UNKNOWNSTATUS = 0x00000000  /*< unknown status                   */
  };

Constructor & Destructor Documentation

CaloRecoStatus() [1/2]

CaloRecoStatus::CaloRecoStatus ( StatusIndicator  statusIndicator = UNKNOWNSTATUS )

inline

Default constructor.

Definition at line 96 of file CaloRecoStatus.h.

  : m_status((store_type)aStatus)
{ }

CaloRecoStatus() [2/2]

CaloRecoStatus::CaloRecoStatus ( store_type  store )

inline

Definition at line 100 of file CaloRecoStatus.h.

  : m_status(aStatus)
{ }

~CaloRecoStatus()

CaloRecoStatus::~CaloRecoStatus ( )

inlinevirtual

Destructor.

Definition at line 104 of file CaloRecoStatus.h.

{ }

Member Function Documentation

checkStatus()

bool CaloRecoStatus::checkStatus ( const StatusIndicator &  statusIndicator ) const

inlinevirtual

Check status.

Parameters

statusIndicator

status indicator

Note that the client can request a single status set, or a combination of status indicators set

Definition at line 117 of file CaloRecoStatus.h.

{
  return ( m_status & (store_type)aStatus ) == (store_type)aStatus;
}

getStatus()

bool CaloRecoStatus::getStatus ( std::vector< CaloRecoStatus::StatusIndicator > &  pStatusList ) const

virtual

retrieve all status indicators

Parameters

pStatusList

list of all status indicators

Returns true if one or more indicators are available

Definition at line 7 of file CaloRecoStatus.cxx.

{
  const size_t oldSize = pStatusList.size();
  for (const auto& s : {TAGGEDEM, TAGGEDHAD, TAGGEDMUON, TAGGEDUNKNOWN, CALIBRATED, CALIBRATEDLHC,CALIBRATEDALT, UNKNOWNSTATUS}) {
    if ((s & m_status) == s) pStatusList.push_back(s);
  }
  return oldSize < pStatusList.size();
}

getStatusWord()

const CaloRecoStatus::store_type & CaloRecoStatus::getStatusWord ( ) const

inlinevirtual

retrieve the entire status word

Definition at line 112 of file CaloRecoStatus.h.

{
  return m_status;
}

resetStatus() [1/2]

void CaloRecoStatus::resetStatus ( )

inlinevirtual

reset reconstruction status

Definition at line 122 of file CaloRecoStatus.h.

{
  m_status = (store_type)UNKNOWNSTATUS;
}

resetStatus() [2/2]

void CaloRecoStatus::resetStatus ( const StatusIndicator &  statusIndicator )

inlinevirtual

Definition at line 127 of file CaloRecoStatus.h.

{
  m_status = m_status & ~((store_type)aStatus);
}

setStatus()

void CaloRecoStatus::setStatus ( const StatusIndicator &  statusIndicator )

inlinevirtual

Set status.

Parameters

statusIndicator

status bit pattern

Definition at line 107 of file CaloRecoStatus.h.

{
  m_status = m_status | (store_type)aStatus;
}

Member Data Documentation

m_status

store_type CaloRecoStatus::m_status

private

Status store.

Definition at line 88 of file CaloRecoStatus.h.

---

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

• CaloRecoStatus.h
• CaloRecoStatus.cxx