L1GctJetLeafCard.h

Go to the documentation of this file.

#ifndef L1GCTJETLEAFCARD_H_
#define L1GCTJETLEAFCARD_H_

#include "DataFormats/L1GlobalCaloTrigger/interface/L1GctEtTotal.h"
#include "DataFormats/L1GlobalCaloTrigger/interface/L1GctEtHad.h"
#include "DataFormats/L1GlobalCaloTrigger/interface/L1GctEtMiss.h"

#include "L1Trigger/GlobalCaloTrigger/interface/L1GctProcessor.h"
#include "L1Trigger/GlobalCaloTrigger/interface/L1GctJetFinderBase.h"
#include "L1Trigger/GlobalCaloTrigger/src/L1GctTwosComplement.h"
#include "L1Trigger/GlobalCaloTrigger/src/L1GctUnsignedInt.h"

#include <vector>

/*
 * \class L1GctJetLeafCard
 * \brief Emulates a leaf card programmed for jetfinding
 *
 * Represents a GCT Leaf Card
 * programmed for jet finding
 * author: Jim Brooke
 * date: 20/2/2006
 * 
 */

class L1GctJetCand;

class L1GctJetLeafCard : public L1GctProcessor
{
public:
  //Type declaration
  enum jetFinderType { tdrJetFinder, hardwareJetFinder, nullJetFinder };

  //Statics
  static const int MAX_JET_FINDERS;  

  //Typedefs
  typedef L1GctUnsignedInt<L1GctInternEtSum::kTotEtOrHtNBits> etTotalType;
  typedef L1GctUnsignedInt<L1GctInternEtSum::kTotEtOrHtNBits> etHadType;

  typedef L1GctTwosComplement<  L1GctInternEtSum::kMissExOrEyNBits > etComponentType;
  typedef L1GctTwosComplement< L1GctInternHtMiss::kMissHxOrHyNBits > htComponentType;

  typedef L1GctJetFinderBase::hfTowerSumsType hfTowerSumsType;

  enum maxValues {
    etTotalMaxValue = L1GctInternEtSum::kTotEtOrHtMaxValue,
    htTotalMaxValue = L1GctInternEtSum::kTotEtOrHtMaxValue
  };

  //Construtors/destructor
  L1GctJetLeafCard(int id, int iphi, jetFinderType jfType = tdrJetFinder);
                   
  ~L1GctJetLeafCard() override;

  void setNeighbourLeafCards(const std::vector<L1GctJetLeafCard*>& neighbours);

  bool setupOk() const;

  friend std::ostream& operator << (std::ostream& os, const L1GctJetLeafCard& card);

  void reset();

  void fetchInput() override;
 
  void process() override;

  void setBxRange(const int firstBx, const int numberOfBx);

  void setNextBx(const int bx);

  L1GctJetFinderBase* getJetFinderA() const { return m_jetFinderA; }
  L1GctJetFinderBase* getJetFinderB() const { return m_jetFinderB; }
  L1GctJetFinderBase* getJetFinderC() const { return m_jetFinderC; }

  // get the jet output
  std::vector<L1GctJetCand> getOutputJetsA() const;  
  std::vector<L1GctJetCand> getOutputJetsB() const;  
  std::vector<L1GctJetCand> getOutputJetsC() const;  
    
  etComponentType getOutputEx() const { return m_exSum; }
   
  etComponentType getOutputEy() const { return m_eySum; }
    
  etComponentType getOutputHx() const { return m_hxSum; }
  etComponentType getOutputHy() const { return m_hySum; }
    
  etTotalType getOutputEt() const { return m_etSum; }
  etHadType   getOutputHt() const { return m_htSum; }

  hfTowerSumsType getOutputHfSums() const { return m_hfSums; }
   
  std::vector< etComponentType > getAllOutputEx() const { return m_exSumPipe.contents; }
   
  std::vector< etComponentType > getAllOutputEy() const { return m_eySumPipe.contents; }

  std::vector< htComponentType > getAllOutputHx() const { return m_hxSumPipe.contents; }
  std::vector< htComponentType > getAllOutputHy() const { return m_hySumPipe.contents; }
    
  std::vector< etTotalType > getAllOutputEt() const { return m_etSumPipe.contents; }
  std::vector< etHadType >   getAllOutputHt() const { return m_htSumPipe.contents; }

  std::vector< hfTowerSumsType > getAllOutputHfSums() const { return m_hfSumsPipe.contents; }
   
  std::vector< L1GctInternEtSum  > getInternalEtSums() const;
  std::vector< L1GctInternHtMiss > getInternalHtMiss() const;

 protected:

  void resetProcessor() override;
  void resetPipelines() override;

  void setupObjects() override {}

 private:

  // Leaf card ID
  int m_id;

  // Which jetFinder to use?
  jetFinderType m_whichJetFinder;

  // internal algorithms
  L1GctJetFinderBase* m_jetFinderA;  
  L1GctJetFinderBase* m_jetFinderB;  
  L1GctJetFinderBase* m_jetFinderC;  
  
  // internal data (other than jets)

  int phiPosition;

  etComponentType m_exSum;
  etComponentType m_eySum;
  htComponentType m_hxSum;
  htComponentType m_hySum;
  etTotalType m_etSum;
  etHadType   m_htSum;

  hfTowerSumsType m_hfSums;

  // stored copies of output data
  Pipeline<etComponentType> m_exSumPipe;
  Pipeline<etComponentType> m_eySumPipe;
  Pipeline<htComponentType> m_hxSumPipe;
  Pipeline<htComponentType> m_hySumPipe;
  Pipeline<etTotalType>     m_etSumPipe;
  Pipeline<etHadType>       m_htSumPipe;
  Pipeline<hfTowerSumsType> m_hfSumsPipe;

  bool m_ctorInputOk;

};

std::ostream& operator << (std::ostream& os, const L1GctJetLeafCard& card);

#endif /*L1GCTJETLEAFCARD_H_*/