L1GctElectronFinalSort Class Reference

#include <L1GctElectronFinalSort.h>

Inheritance diagram for L1GctElectronFinalSort:

Public Types
typedef L1GctElectronSorter::prioritisedEmCand	prioritisedEmCand
	Use some definitions from the ElectronSorter in the leaf cards. More...

Public Member Functions
void	fetchInput () override
	get input data from sources More...
std::vector< L1GctEmCand >	getInputCands () const
	return input data More...
std::vector< L1GctEmCand >	getOutputCands () const
	return output data More...
	L1GctElectronFinalSort (bool iso, L1GctEmLeafCard *posEtaCard, L1GctEmLeafCard *negEtaCard)
	constructor More...
void	process () override
	process the data, fill output buffers More...
void	setInputEmCand (unsigned i, const L1GctEmCand &cand)
	set input data More...
bool	setupOk () const
	check setup More...
	~L1GctElectronFinalSort () override
	destructor More...
Public Member Functions inherited from L1GctProcessor
	L1GctProcessor ()
void	reset ()
	complete reset of processor More...
void	setBxRange (const int firstBx, const int numberOfBx)
	define the bunch crossing range to process More...
void	setNextBx (const int bxnum)
	clear input data buffers and process a new bunch crossing More...
void	setTerse ()
bool	setupOk () const
	Method to check the setup for this processor. Returns true by default. More...
void	setVerbose ()
	control output messages More...
virtual	~L1GctProcessor ()

Protected Member Functions
void	resetPipelines () override
void	resetProcessor () override
	Separate reset methods for the processor itself and any data stored in pipelines. More...
void	setupObjects () override
	Initialise inputs with null objects for the correct bunch crossing if required. More...
Protected Member Functions inherited from L1GctProcessor
int	bxAbs () const
int	bxMax () const
int	bxMin () const
	Support for multiple beam crossing operation. More...
int	bxRel () const
int	numOfBx () const

Private Attributes
bool	m_emCandsType
	type of electron candidate (iso(0) or non-iso(1)) More...
std::vector< L1GctEmCand >	m_inputCands
	input data More...
Pipeline< L1GctEmCand >	m_outputCands
	output data More...
bool	m_setupOk
	Check the setup. More...
L1GctEmLeafCard *	m_theNegEtaLeafCard
L1GctEmLeafCard *	m_thePosEtaLeafCard
	the 1st stage electron sorters More...

Friends
std::ostream &	operator<< (std::ostream &s, const L1GctElectronFinalSort &cand)
	overload of cout operator More...

Additional Inherited Members
Protected Attributes inherited from L1GctProcessor
bool	m_verbose
	Flag to control output messages. More...

Detailed Description

Definition at line 28 of file L1GctElectronFinalSort.h.

Member Typedef Documentation

prioritisedEmCand

typedef L1GctElectronSorter::prioritisedEmCand L1GctElectronFinalSort::prioritisedEmCand

Use some definitions from the ElectronSorter in the leaf cards.

Definition at line 31 of file L1GctElectronFinalSort.h.

Constructor & Destructor Documentation

L1GctElectronFinalSort()

L1GctElectronFinalSort::L1GctElectronFinalSort	(	bool	iso,
		L1GctEmLeafCard *	posEtaCard,
		L1GctEmLeafCard *	negEtaCard
	)

constructor

Definition at line 8 of file L1GctElectronFinalSort.cc.

References m_setupOk, m_theNegEtaLeafCard, m_thePosEtaLeafCard, and L1GctProcessor::m_verbose.

    : L1GctProcessor(),
      m_emCandsType(iso),
      m_thePosEtaLeafCard(nullptr),
      m_theNegEtaLeafCard(nullptr),
      m_inputCands(16),
      m_outputCands(4),
      m_setupOk(true) {
  if (posEtaCard != nullptr) {
    m_thePosEtaLeafCard = posEtaCard;
  } else {
    m_setupOk = false;
    if (m_verbose) {
      edm::LogWarning("L1GctSetupError") << "L1GctElectronFinalSort::Constructor() : 1st EmLeafCard passed is zero";
    }
  }
  if (negEtaCard != nullptr) {
    m_theNegEtaLeafCard = negEtaCard;
  } else {
    m_setupOk = false;
    if (m_verbose) {
      edm::LogWarning("L1GctSetupError") << "L1GctElectronFinalSort::Constructor() : 2nd EmLeafCard passed is zero";
    }
  }
  if (!m_setupOk && m_verbose) {
    edm::LogError("L1GctSetupError") << "L1GctElectronFinalSort has been incorrectly constructed";
  }
}

~L1GctElectronFinalSort()

L1GctElectronFinalSort::~L1GctElectronFinalSort ( )

override

destructor

Definition at line 37 of file L1GctElectronFinalSort.cc.

References m_inputCands, and m_outputCands.

                                                {
  m_inputCands.clear();
  m_outputCands.contents.clear();
}

Member Function Documentation

fetchInput()

void L1GctElectronFinalSort::fetchInput ( )

overridevirtual

get input data from sources

loop over candidates from four electron sorter FPGAs

Implements L1GctProcessor.

Definition at line 49 of file L1GctElectronFinalSort.cc.

References L1GctEmLeafCard::getIsoElectronSorterU1(), L1GctEmLeafCard::getIsoElectronSorterU2(), L1GctEmLeafCard::getNonIsoElectronSorterU1(), L1GctEmLeafCard::getNonIsoElectronSorterU2(), L1GctElectronSorter::getOutputCands(), dqmdumpme::k, m_emCandsType, m_setupOk, m_theNegEtaLeafCard, m_thePosEtaLeafCard, and setInputEmCand().

Referenced by L1GlobalCaloTrigger::bxProcess().

                                        {
  if (m_setupOk) {
    for (int k = 0; k < 4; k++) {  
      if (m_emCandsType) {
        setInputEmCand(k, m_thePosEtaLeafCard->getIsoElectronSorterU1()->getOutputCands().at(k));
        setInputEmCand(k + 4, m_thePosEtaLeafCard->getIsoElectronSorterU2()->getOutputCands().at(k));
        setInputEmCand(k + 8, m_theNegEtaLeafCard->getIsoElectronSorterU1()->getOutputCands().at(k));
        setInputEmCand(k + 12, m_theNegEtaLeafCard->getIsoElectronSorterU2()->getOutputCands().at(k));
      } else {
        setInputEmCand(k, m_thePosEtaLeafCard->getNonIsoElectronSorterU1()->getOutputCands().at(k));
        setInputEmCand(k + 4, m_thePosEtaLeafCard->getNonIsoElectronSorterU2()->getOutputCands().at(k));
        setInputEmCand(k + 8, m_theNegEtaLeafCard->getNonIsoElectronSorterU1()->getOutputCands().at(k));
        setInputEmCand(k + 12, m_theNegEtaLeafCard->getNonIsoElectronSorterU2()->getOutputCands().at(k));
      }
    }
  }
}

getInputCands()

std::vector<L1GctEmCand> L1GctElectronFinalSort::getInputCands ( ) const

inline

return input data

Definition at line 49 of file L1GctElectronFinalSort.h.

References m_inputCands.

{ return m_inputCands; }

getOutputCands()

std::vector<L1GctEmCand> L1GctElectronFinalSort::getOutputCands ( ) const

inline

return output data

Definition at line 52 of file L1GctElectronFinalSort.h.

References m_outputCands.

Referenced by L1GlobalCaloTrigger::getIsoElectrons(), and L1GlobalCaloTrigger::getNonIsoElectrons().

{ return m_outputCands.contents; }

process()

void L1GctElectronFinalSort::process ( )

overridevirtual

process the data, fill output buffers

Implements L1GctProcessor.

Definition at line 67 of file L1GctElectronFinalSort.cc.

References L1GctProcessor::bxRel(), c, data, mps_fire::i, m_inputCands, m_outputCands, m_setupOk, L1GctElectronSorter::rankByGt(), jetUpdater_cfi::sort, and groupFilesInBlocks::temp.

Referenced by L1GlobalCaloTrigger::bxProcess().

                                     {
  if (m_setupOk) {
    std::vector<prioritisedEmCand> data(m_inputCands.size());
    // Assign a "priority" for sorting - this assumes the candidates
    // have already been filled in "priority order"
    for (unsigned i = 0; i < m_inputCands.size(); i++) {
      prioritisedEmCand c(m_inputCands.at(i), i);
      data.at(i) = c;
    }

    //Then sort it
    sort(data.begin(), data.end(), L1GctElectronSorter::rankByGt);

    //Copy data to output buffer
    std::vector<L1GctEmCand> temp(4);
    for (int i = 0; i < 4; i++) {
      temp.at(i) = data.at(i).emCand;
    }
    m_outputCands.store(temp, bxRel());
  }
}

resetPipelines()

void L1GctElectronFinalSort::resetPipelines ( )

overrideprotectedvirtual

Implements L1GctProcessor.

Definition at line 47 of file L1GctElectronFinalSort.cc.

References m_outputCands, and L1GctProcessor::numOfBx().

{ m_outputCands.reset(numOfBx()); }

resetProcessor()

void L1GctElectronFinalSort::resetProcessor ( )

overrideprotectedvirtual

Separate reset methods for the processor itself and any data stored in pipelines.

Implements L1GctProcessor.

Definition at line 42 of file L1GctElectronFinalSort.cc.

References m_inputCands.

                                            {
  m_inputCands.clear();
  m_inputCands.resize(16);
}

setInputEmCand()

void L1GctElectronFinalSort::setInputEmCand	(	unsigned	i,
		const L1GctEmCand &	cand
	)

set input data

Definition at line 89 of file L1GctElectronFinalSort.cc.

References L1GctProcessor::bxAbs(), mps_fire::i, and m_inputCands.

Referenced by fetchInput().

                                                                               {
  if ((i < m_inputCands.size()) && (cand.bx() == bxAbs())) {
    m_inputCands.at(i) = cand;
  }
}

setupObjects()

void L1GctElectronFinalSort::setupObjects ( )

inlineoverrideprotectedvirtual

Initialise inputs with null objects for the correct bunch crossing if required.

Implements L1GctProcessor.

Definition at line 66 of file L1GctElectronFinalSort.h.

{}

setupOk()

bool L1GctElectronFinalSort::setupOk ( ) const

inline

check setup

Definition at line 58 of file L1GctElectronFinalSort.h.

References m_setupOk.

Referenced by L1GlobalCaloTrigger::setupOk().

{ return m_setupOk; }

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  s, const L1GctElectronFinalSort &  cand  )

friend

overload of cout operator

Definition at line 95 of file L1GctElectronFinalSort.cc.

                                                                          {
  s << "===ElectronFinalSort===" << std::endl;
  s << "Card type = " << (cand.m_emCandsType ? "isolated" : "non-isolated") << std::endl;
  s << "Pointers to the Electron Leaf cards are: " << std::endl;
  s << "   Pos. eta: " << cand.m_thePosEtaLeafCard;
  s << "   Neg. eta: " << cand.m_theNegEtaLeafCard;
  s << std::endl;
  s << "No of Electron Input Candidates " << cand.m_inputCands.size() << std::endl;
  s << "No of Electron Output Candidates " << cand.m_outputCands.contents.size() << std::endl;

  return s;
}

Member Data Documentation

m_emCandsType

bool L1GctElectronFinalSort::m_emCandsType

private

type of electron candidate (iso(0) or non-iso(1))

Definition at line 71 of file L1GctElectronFinalSort.h.

Referenced by fetchInput().

m_inputCands

std::vector<L1GctEmCand> L1GctElectronFinalSort::m_inputCands

private

input data

Definition at line 78 of file L1GctElectronFinalSort.h.

Referenced by getInputCands(), process(), resetProcessor(), setInputEmCand(), and ~L1GctElectronFinalSort().

m_outputCands

Pipeline<L1GctEmCand> L1GctElectronFinalSort::m_outputCands

private

output data

Definition at line 81 of file L1GctElectronFinalSort.h.

Referenced by getOutputCands(), process(), resetPipelines(), and ~L1GctElectronFinalSort().

m_setupOk

bool L1GctElectronFinalSort::m_setupOk

private

Check the setup.

Definition at line 84 of file L1GctElectronFinalSort.h.

Referenced by fetchInput(), L1GctElectronFinalSort(), process(), and setupOk().

m_theNegEtaLeafCard

L1GctEmLeafCard* L1GctElectronFinalSort::m_theNegEtaLeafCard

private

Definition at line 75 of file L1GctElectronFinalSort.h.

Referenced by fetchInput(), and L1GctElectronFinalSort().

m_thePosEtaLeafCard

L1GctEmLeafCard* L1GctElectronFinalSort::m_thePosEtaLeafCard

private

the 1st stage electron sorters

Definition at line 74 of file L1GctElectronFinalSort.h.

Referenced by fetchInput(), and L1GctElectronFinalSort().