L1GctElectronSorter Class Reference

Class that sorts electron candidates. More...

#include <L1GctElectronSorter.h>

Inheritance diagram for L1GctElectronSorter:

Classes
struct	prioritisedEmCand

Public Member Functions
void	fetchInput () override
	get input data from sources More...
std::vector< L1CaloEmCand >	getInputCands ()
	get input candidates More...
std::vector< L1GctEmCand >	getOutputCands ()
	get output candidates More...
	L1GctElectronSorter (int nInputs, bool iso)
	constructor; set type (isolated or non-isolated) More...
void	process () override
	process the data, fill output buffers More...
void	setInputEmCand (const L1CaloEmCand &cand)
	set input candidate More...
	~L1GctElectronSorter () override
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 ()

Static Public Member Functions
static bool	rankByGt (const prioritisedEmCand &x, const prioritisedEmCand &y)

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
int	m_id
	algo ID (is it FPGA 1 or 2 processing) More...
std::vector< L1CaloEmCand >	m_inputCands
	input data More...
bool	m_isolation
	type of electron to sort (isolated = 0 or non isolated = 1) More...
std::vector< L1GctEmCand >	m_outputCands
	output data More...

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

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

Detailed Description

Class that sorts electron candidates.

L1GctElectronSorter This class can be constructed to sort iso or non-iso electron candidates. The electrons are sorted in ascending order and the 4 highest in rank will be returned. It represents the 1st stage sorter FPGA's on the electron leaf cards.

Author

Maria Hansen

Date

21/04/06

Definition at line 26 of file L1GctElectronSorter.h.

Constructor & Destructor Documentation

L1GctElectronSorter::L1GctElectronSorter	(	int	nInputs,
		bool	iso
	)

constructor; set type (isolated or non-isolated)

Definition at line 4 of file L1GctElectronSorter.cc.

    : L1GctProcessor(), m_id(nInputs), m_isolation(iso), m_inputCands(nInputs * 4), m_outputCands(4) {}

L1GctElectronSorter::~L1GctElectronSorter ( )

override

Definition at line 7 of file L1GctElectronSorter.cc.

{}

Member Function Documentation

void L1GctElectronSorter::fetchInput ( )

overridevirtual

get input data from sources

Implements L1GctProcessor.

Definition at line 30 of file L1GctElectronSorter.cc.

                                     {
  // This does nothing, assume the input candidates get pushed in
}

std::vector<L1CaloEmCand> L1GctElectronSorter::getInputCands ( )

inline

get input candidates

Definition at line 67 of file L1GctElectronSorter.h.

References m_inputCands.

{ return m_inputCands; }

std::vector<L1GctEmCand> L1GctElectronSorter::getOutputCands ( )

inline

get output candidates

Definition at line 70 of file L1GctElectronSorter.h.

References m_outputCands.

Referenced by L1GctElectronFinalSort::fetchInput().

{ return m_outputCands; }

void L1GctElectronSorter::process ( )

overridevirtual

process the data, fill output buffers

Implements L1GctProcessor.

Definition at line 35 of file L1GctElectronSorter.cc.

References c, data, mps_fire::i, m_inputCands, m_outputCands, and rankByGt().

                                  {
  //Convert from caloEmCand to gctEmCand and make temporary copy of data
  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(), rankByGt);

  //Copy data to output buffer
  for (int i = 0; i < 4; i++) {
    m_outputCands.at(i) = data.at(i).emCand;
  }
}

static bool L1GctElectronSorter::rankByGt ( const prioritisedEmCand &  x, const prioritisedEmCand &  y  )

inlinestatic

comparison operator for sort, used here and in the ElectronFinalSort Candidates of equal rank are sorted by priority, with the lower value given precedence

Definition at line 48 of file L1GctElectronSorter.h.

References L1GctElectronSorter::prioritisedEmCand::priority, and L1GctElectronSorter::prioritisedEmCand::rank().

Referenced by L1GctElectronFinalSort::process(), and process().

                                                                               {
    return (x.rank() > y.rank() || ((x.rank() == y.rank()) && (x.priority < y.priority)));
  }

void L1GctElectronSorter::resetPipelines ( )

inlineoverrideprotectedvirtual

Implements L1GctProcessor.

Definition at line 78 of file L1GctElectronSorter.h.

{}

void L1GctElectronSorter::resetProcessor ( )

overrideprotectedvirtual

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

Implements L1GctProcessor.

Definition at line 10 of file L1GctElectronSorter.cc.

References m_id, m_inputCands, and m_outputCands.

                                         {
  m_inputCands.clear();
  m_inputCands.resize(m_id * 4);

  m_outputCands.clear();
  m_outputCands.resize(4);
}

void L1GctElectronSorter::setInputEmCand

(

const L1CaloEmCand &

cand

)

set input candidate

Definition at line 54 of file L1GctElectronSorter.cc.

References mps_fire::i, L1CaloEmCand::index(), input, m_id, m_inputCands, and L1CaloEmCand::rctCrate().

                                                                 {
  // Fills the candidates in "priority order"
  // The lowest numbered RCT crate in each FPGA has highest priority.
  // We distinguish the two FPGAs on a leaf card by the number of inputs.
  // FPGA U1 has 5 inputs (crates 4-8) and FPGA U2 has 4 inputs (crates 0-3).
  // Within a crate the four input candidates are arranged in the order
  // that they arrive on the cable, using the index() method.
  unsigned crate = cand.rctCrate();
  unsigned input = ((m_id == 4) ? (crate % 9) : (crate % 9 - 4));
  unsigned i = input * 4 + (3 - cand.index());
  if (m_inputCands.at(i).rank() == 0) {
    m_inputCands.at(i) = cand;
  }
}

void L1GctElectronSorter::setupObjects ( )

overrideprotectedvirtual

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

Initialise inputs with null objects for the correct bunch crossing If no other input candidates "arrive", we have the correct bunch crossing to propagate through the processing.

Create a null input electron with the right bunch crossing, and fill the input candidates with copies of this.

Implements L1GctProcessor.

Definition at line 21 of file L1GctElectronSorter.cc.

References L1GctProcessor::bxAbs(), m_id, m_inputCands, L1CaloEmCand::setBx(), and groupFilesInBlocks::temp.

                                       {
  L1CaloEmCand temp;
  temp.setBx(bxAbs());
  m_inputCands.assign(m_id * 4, temp);
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  s, const L1GctElectronSorter &  card  )

friend

overload of cout operator

Definition at line 69 of file L1GctElectronSorter.cc.

                                                                      {
  s << "===L1GctElectronSorter===" << std::endl;
  s << "Algo type = " << ems.m_isolation << std::endl;
  s << "No of Electron Input Candidates = " << ems.m_inputCands.size() << std::endl;
  s << "No of Electron Output Candidates = " << ems.m_outputCands.size() << std::endl;
  return s;
}

Member Data Documentation

int L1GctElectronSorter::m_id

private

algo ID (is it FPGA 1 or 2 processing)

Definition at line 86 of file L1GctElectronSorter.h.

Referenced by resetProcessor(), setInputEmCand(), and setupObjects().

std::vector<L1CaloEmCand> L1GctElectronSorter::m_inputCands

private

input data

Definition at line 92 of file L1GctElectronSorter.h.

Referenced by getInputCands(), operator<<(), process(), resetProcessor(), setInputEmCand(), and setupObjects().

bool L1GctElectronSorter::m_isolation

private

type of electron to sort (isolated = 0 or non isolated = 1)

Definition at line 89 of file L1GctElectronSorter.h.

Referenced by operator<<().

std::vector<L1GctEmCand> L1GctElectronSorter::m_outputCands

private

output data

Definition at line 95 of file L1GctElectronSorter.h.

Referenced by getOutputCands(), operator<<(), process(), and resetProcessor().