#include <AFP_Raw2DigiTool.h>

Inheritance diagram for AFP_Raw2DigiTool:

Collaboration diagram for AFP_Raw2DigiTool:

Public Member Functions
	AFP_Raw2DigiTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~AFP_Raw2DigiTool () override
	Does nothing.
virtual StatusCode	initialize () override
	Does nothing.
StatusCode	recoSiHits (const EventContext &ctx) const override
	Creates xAOD for silicon detector.
StatusCode	recoToFHits (const EventContext &ctx) const override
	Creates xAOD for time-of-flight detector.
StatusCode	recoAll (const EventContext &ctx) const override
virtual StatusCode	finalize () override
	Does nothing.
unsigned int	decodeTimeOverThresholdSi (const unsigned int input, const unsigned int discConfig) const
	Method that decodes raw information about time-over-threshold to number of clock ticks.

Protected Member Functions
void	newXAODHitToF (xAOD::AFPToFHitContainer *tofHitContainer, const AFP_ToFRawCollection &collection, const AFP_ToFRawData &data, const EventContext &ctx) const
	Method that creates a new AFPToFHit and sets it valus according to data.
void	newXAODHitSi (xAOD::AFPSiHitContainer *xAODSiHit, const AFP_SiRawCollection &collection, const AFP_SiRawData &data) const
	Method that creates a new AFPSiHit and sets it valus according to data.
void	setBarAndTrainID (xAOD::AFPToFHit *tofHit, const EventContext &ctx) const
	Method mapping hptdcID and hptdcChannel to train ID and bar in train ID.

Protected Attributes
SG::ReadHandleKey< AFP_RawContainer >	m_rawDataContainerName {this, "rawDataContainerName", "AFP_RawData"}
SG::WriteHandleKey< xAOD::AFPSiHitContainer >	m_AFPSiHitsContainerName {this, "AFPSiHitsContainerName", "AFPSiHitContainer"}
SG::WriteHandleKey< xAOD::AFPToFHitContainer >	m_AFPHitsContainerNameToF {this, "AFPHitsContainerNameToF", "AFPToFHitContainer"}
Gaudi::Property< std::string >	m_totToChargeTransfExpr {this, "TotToChargeTransfExpr", "1909 + x363 + xx*141", "Function that transforms time-over-threshold to charge"}
	Function that transforms time-over-threshold to charge.
Gaudi::Property< std::string >	m_totToChargeTransfName {this, "TotToChargeTransfName", "TotToChargeTransfFunction", "Name of the function that transforms time-over-threshold to charge"}
TF1	m_totToChargeTransformation

Static Protected Attributes
static constexpr double	s_timeConversionFactor = 25./1024.
	Factor converting signal to time.
static constexpr double	s_pulseLengthFactor = 0.521
	Factor converting pulse length to time.

Private Attributes
const int	m_channel2train [3][2][12]
const int	m_channel2bar [3][2][12]

Detailed Description

Definition at line 17 of file AFP_Raw2DigiTool.h.

Constructor & Destructor Documentation

◆ AFP_Raw2DigiTool()

AFP_Raw2DigiTool::AFP_Raw2DigiTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 20 of file AFP_Raw2DigiTool.cxx.

  : base_class(type, name, parent),
    m_totToChargeTransformation ("totToChargeTransformation", "1909 + x*363 + x*x*141")
{}      

◆ ~AFP_Raw2DigiTool()

AFP_Raw2DigiTool::~AFP_Raw2DigiTool ( )

overridevirtual

Does nothing.

Definition at line 27 of file AFP_Raw2DigiTool.cxx.

27{}

Member Function Documentation

◆ decodeTimeOverThresholdSi()

unsigned int AFP_Raw2DigiTool::decodeTimeOverThresholdSi	(	const unsigned int	input,
		const unsigned int	discConfig ) const

Method that decodes raw information about time-over-threshold to number of clock ticks.

Definition at line 231 of file AFP_Raw2DigiTool.cxx.

{
  if (input <= 13)
    return input + discConfig + 1;
  else if (input == 14) 
    return discConfig;
  else
    return 0;
}

◆ finalize()

StatusCode AFP_Raw2DigiTool::finalize ( )

overridevirtual

Does nothing.

Definition at line 108 of file AFP_Raw2DigiTool.cxx.

                                     {
  ATH_MSG_INFO("Finalizing " << name() << "...");
 
 
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode AFP_Raw2DigiTool::initialize ( )

overridevirtual

Does nothing.

Definition at line 29 of file AFP_Raw2DigiTool.cxx.

{
  ATH_MSG_DEBUG("Initializing " << name() << "...");
 
  ATH_CHECK( m_rawDataContainerName.initialize() );
  ATH_CHECK( m_AFPSiHitsContainerName.initialize() );
  ATH_CHECK( m_AFPHitsContainerNameToF.initialize() );
  
  m_totToChargeTransformation=TF1(m_totToChargeTransfName.toString().c_str(), m_totToChargeTransfExpr.toString().c_str());
 
  return StatusCode::SUCCESS;
}

◆ newXAODHitSi()

void AFP_Raw2DigiTool::newXAODHitSi	(	xAOD::AFPSiHitContainer *	xAODSiHit,
		const AFP_SiRawCollection &	collection,
		const AFP_SiRawData &	data ) const

protected

Method that creates a new AFPSiHit and sets it valus according to data.

Definition at line 147 of file AFP_Raw2DigiTool.cxx.

{
  xAOD::AFPSiHit* xAODSiHit = new xAOD::AFPSiHit();
  siHitContainer->push_back(xAODSiHit);
 
  const unsigned int hitLink = data.link();
  const unsigned int robID = collection.robId();
  // decoding according to Outlink numbers in: https://twiki.cern.ch/twiki/bin/view/Atlas/AFPRunning#Tracker
  if (hitLink <=3 ) {   // not checking if larger or equal 0, because this is uint, which is always positive
    // set near station ID selecting side based on ROB
    if (robID == AFP_ROBID::sideA)
      xAODSiHit->setStationID(xAOD::AFPStationID::nearA);
    else if (robID == AFP_ROBID::sideC || robID == AFP_ROBID::sideC_2016)
      xAODSiHit->setStationID(xAOD::AFPStationID::nearC);
    else  {
      ATH_MSG_WARNING("Unrecognised robID: in dec="<<std::dec<<robID<<",  in hex=0x"<<std::hex<<robID<<std::dec);
      xAODSiHit->setStationID(-1);
    }
  } else if (hitLink >= 8 && hitLink <= 11) {
    // set far station ID selecting side based on ROB
    if (robID == AFP_ROBID::sideA)
      xAODSiHit->setStationID(xAOD::AFPStationID::farA);
    else if (robID == AFP_ROBID::sideC || robID == AFP_ROBID::sideC_2016)
      xAODSiHit->setStationID(xAOD::AFPStationID::farC);
    else  {
      ATH_MSG_WARNING("Unrecognised robID: in dec="<<std::dec<<robID<<",  in hex=0x"<<std::hex<<robID<<std::dec);
      xAODSiHit->setStationID(-1);
    }
  } else {
    ATH_MSG_WARNING("Unrecognised value in hitLink = " << hitLink);
    xAODSiHit->setStationID(-1);
  } // end of switch
  
  xAODSiHit->setPixelLayerID( hitLink%4 );
  xAODSiHit->setPixelColIDChip( data.column() );
  xAODSiHit->setPixelRowIDChip( data.row() );
 
  const unsigned int ToT_value = decodeTimeOverThresholdSi( data.timeOverThreshold(), data.hitDiscConfig() );
  xAODSiHit->setTimeOverThreshold(ToT_value);
  xAODSiHit->setDepositedCharge( m_totToChargeTransformation(ToT_value) );
 
  ATH_MSG_DEBUG("have AFPSiHit: pixelLayerID "<<xAODSiHit->pixelLayerID()<<", pixelColIDChip "<<xAODSiHit->pixelColIDChip()<<", pixelRowIDChip "<<xAODSiHit->pixelRowIDChip()<<", timeOverThreshold "<<xAODSiHit->timeOverThreshold()<<", depositedCharge "<<xAODSiHit->depositedCharge());
}

◆ newXAODHitToF()

void AFP_Raw2DigiTool::newXAODHitToF	(	xAOD::AFPToFHitContainer *	tofHitContainer,
		const AFP_ToFRawCollection &	collection,
		const AFP_ToFRawData &	data,
		const EventContext &	ctx ) const

protected

Method that creates a new AFPToFHit and sets it valus according to data.

Definition at line 116 of file AFP_Raw2DigiTool.cxx.

{
  xAOD::AFPToFHit* xAODToFHit = new xAOD::AFPToFHit();
  tofHitContainer->push_back(xAODToFHit);
 
  const uint32_t hitLink = data.link();
  const unsigned int robID = collection.robId();
  xAODToFHit->setTime(data.time()*s_timeConversionFactor);
  xAODToFHit->setPulseLength(data.pulseLength()*s_pulseLengthFactor); 
  xAODToFHit->setHptdcChannel(data.channel());
 
  // set station ID
  if (robID == AFP_ROBID::sideC) // no AFP_ROBID::sideC_2016 because there was no ToF in 2016
    xAODToFHit->setStationID(xAOD::AFPStationID::farC);
  else if (robID == AFP_ROBID::sideA)
    xAODToFHit->setStationID(xAOD::AFPStationID::farA);
  else
    xAODToFHit->setStationID(-1);
 
  // set hptdcID
  if (hitLink == 12)
    xAODToFHit->setHptdcID(2);
  else if (hitLink == 13)
    xAODToFHit->setHptdcID(1);
  else
    xAODToFHit->setHptdcID(-1);
 
  // set barID
  setBarAndTrainID(xAODToFHit, ctx);
}

◆ recoAll()

StatusCode AFP_Raw2DigiTool::recoAll ( const EventContext & ctx ) const

override

Definition at line 42 of file AFP_Raw2DigiTool.cxx.

{
  ATH_CHECK( recoSiHits(ctx) );
  ATH_CHECK( recoToFHits(ctx) );
 
  return StatusCode::SUCCESS;
}

◆ recoSiHits()

StatusCode AFP_Raw2DigiTool::recoSiHits ( const EventContext & ctx ) const

override

Creates xAOD for silicon detector.

Definition at line 50 of file AFP_Raw2DigiTool.cxx.

{
  ATH_MSG_DEBUG("AFP_Raw2DigiTool recoSiHits ");
 
  // create output containers
  auto siHitContainer = std::make_unique<xAOD::AFPSiHitContainer>();
  auto siHitAuxContainer = std::make_unique<xAOD::AFPSiHitAuxContainer>();
  siHitContainer->setStore(siHitAuxContainer.get());
 
  // retrieve raw data
  SG::ReadHandle<AFP_RawContainer> container{m_rawDataContainerName, ctx};
  if (!container.isValid()) {
    ATH_MSG_WARNING("AFP_Raw2DigiTool: Could not find raw data container");
    return StatusCode::SUCCESS;
  }
  else
    ATH_MSG_DEBUG("AFP_Raw2DigiTool: Raw data container retrieved");
 
  for (const AFP_SiRawCollection& collection: container->collectionsSi())
    for (const AFP_SiRawData& data : collection.dataRecords())
      newXAODHitSi (siHitContainer.get(), collection, data);
 
  SG::WriteHandle<xAOD::AFPSiHitContainer> writeHandle{m_AFPSiHitsContainerName, ctx};
  ATH_CHECK( writeHandle.record(std::move(siHitContainer), std::move(siHitAuxContainer)) );
 
  return StatusCode::SUCCESS;
}

◆ recoToFHits()

StatusCode AFP_Raw2DigiTool::recoToFHits ( const EventContext & ctx ) const

override

Creates xAOD for time-of-flight detector.

Definition at line 78 of file AFP_Raw2DigiTool.cxx.

{
  ATH_MSG_DEBUG("AFP_Raw2DigiTool recoToFHits ");
 
  // create output containers
  auto tofHitContainer = std::make_unique<xAOD::AFPToFHitContainer>();
  auto tofHitAuxContainer = std::make_unique<xAOD::AFPToFHitAuxContainer>();
  tofHitContainer->setStore(tofHitAuxContainer.get());
 
  // retrieve raw data
  SG::ReadHandle<AFP_RawContainer> container{m_rawDataContainerName, ctx};
  if (!container.isValid()) {
    ATH_MSG_WARNING("AFP_Raw2DigiTool: Could not find raw data container");
    return StatusCode::SUCCESS;
  }
  else
    ATH_MSG_DEBUG("AFP_Raw2DigiTool: Raw data container retrieved");
  
  for (const AFP_ToFRawCollection& collection: container->collectionsToF())
    for (const AFP_ToFRawData& data : collection.dataRecords())
      if (data.hitDiscConfig() == 3 && (data.header() == 2 || (data.header() == 1 && !data.isTrigger()))) 
    newXAODHitToF (tofHitContainer.get(), collection, data, ctx); // is_ToF && (is_HPTDC || (is_picoTDC && !is_trigger_word))
 
  SG::WriteHandle<xAOD::AFPToFHitContainer> writeHandle{m_AFPHitsContainerNameToF, ctx};
  ATH_CHECK( writeHandle.record(std::move(tofHitContainer), std::move(tofHitAuxContainer)) );
 
  return StatusCode::SUCCESS;
}

◆ setBarAndTrainID()

void AFP_Raw2DigiTool::setBarAndTrainID	(	xAOD::AFPToFHit *	tofHit,
		const EventContext &	ctx ) const

protected

Method mapping hptdcID and hptdcChannel to train ID and bar in train ID.

The method requires that hptdcID and hptdcChannel are set in the tofHit passed as argument. Mapping is implemented according to https://twiki.cern.ch/twiki/bin/view/Atlas/AFPHPTDC#Channel_Mapping

Definition at line 191 of file AFP_Raw2DigiTool.cxx.

{
  // mapping is implemented according to https://twiki.cern.ch/twiki/bin/view/Atlas/AFPHPTDC#Channel_Mapping
 
  const int hptdcChannel = tofHit->hptdcChannel();
  const int hptdcID = tofHit->hptdcID();
  
  if((hptdcChannel<0 || hptdcChannel>=12) || (hptdcID<=0 || hptdcID>=3))
  {
    ATH_MSG_WARNING("Invalid hptdcID "<<hptdcID<<", or hptdcChannel "<<hptdcChannel);
    return;
  }
  
  int RunID = (ctx.eventID().run_number() > 370000 ? (ctx.eventID().run_number() > 436657 ? 2 : 1) : 0);
  
  int trainID=m_channel2train[RunID][hptdcID-1][hptdcChannel];
  int barID=m_channel2bar[RunID][hptdcID-1][hptdcChannel];
  
  if(trainID>=0 && barID>=0)
  {
    tofHit->setTrainID(trainID);
    tofHit->setBarInTrainID(barID);
  }
  else if(trainID==-2 && barID==-2)
  {
    // this is known problem for Run2, channels 1 and 4
    ATH_MSG_DEBUG("Unrecognised hptdcChannel "<<hptdcChannel<<", hptdcID "<<hptdcID);
  }
  else if(trainID==-1 && barID==-1)
  {
    // this is not known
    ATH_MSG_WARNING("Unrecognised hptdcChannel "<<hptdcChannel<<", hptdcID "<<hptdcID);
  }
  else
  {
    // this shouldn't happen
    ATH_MSG_WARNING("Unrecognised trainID "<<trainID<<" or barID "<<barID<<"; run "<<ctx.eventID().run_number()<<", hptdcChannel "<<hptdcChannel<<", hptdcID "<<hptdcID);
  }
}

Member Data Documentation

◆ m_AFPHitsContainerNameToF

SG::WriteHandleKey<xAOD::AFPToFHitContainer> AFP_Raw2DigiTool::m_AFPHitsContainerNameToF {this, "AFPHitsContainerNameToF", "AFPToFHitContainer"}

protected

Definition at line 47 of file AFP_Raw2DigiTool.h.

47{this, "AFPHitsContainerNameToF", "AFPToFHitContainer"};

◆ m_AFPSiHitsContainerName

SG::WriteHandleKey<xAOD::AFPSiHitContainer> AFP_Raw2DigiTool::m_AFPSiHitsContainerName {this, "AFPSiHitsContainerName", "AFPSiHitContainer"}

protected

Definition at line 46 of file AFP_Raw2DigiTool.h.

46{this, "AFPSiHitsContainerName", "AFPSiHitContainer"};

◆ m_channel2bar

const int AFP_Raw2DigiTool::m_channel2bar[3][2][12]

private

Initial value:

= {{{0,-2,2,3,-2,1, 2,-1,0,1,-1,3}, {0,-2,2,3,-2,1, 2,-1,0,1,-1,3}},
                                       {{0,-1,2,3,-1,1, 2,-1,0,1,-1,3}, {0,-1,2,3,-1,1, 2,-1,0,1,-1,3}},
                                       {{0,-1,2,3,-1,1, 2,-1,0,1,-1,3}, {0,-1,2,3,-1,1, 2,-1,0,1,-1,3}}}

Definition at line 89 of file AFP_Raw2DigiTool.h.

                                      {{{0,-2,2,3,-2,1, 2,-1,0,1,-1,3}, {0,-2,2,3,-2,1, 2,-1,0,1,-1,3}},
                                       {{0,-1,2,3,-1,1, 2,-1,0,1,-1,3}, {0,-1,2,3,-1,1, 2,-1,0,1,-1,3}},
                                       {{0,-1,2,3,-1,1, 2,-1,0,1,-1,3}, {0,-1,2,3,-1,1, 2,-1,0,1,-1,3}}};

◆ m_channel2train

const int AFP_Raw2DigiTool::m_channel2train[3][2][12]

private

Initial value:

={{{0,-2,1,0,-2,1, 0,-1,1,0,-1,1}, {2,-2,3,2,-2,3, 2,-1,3,2,-1,3}},
                                       {{1,-1,0,1,-1,0, 1,-1,0,1,-1,0}, {3,-1,2,3,-1,2, 3,-1,2,3,-1,2}},
                                       {{1,-1,3,1,-1,3, 1,-1,3,1,-1,3}, {0,-1,2,0,-1,2, 0,-1,2,0,-1,2}}}

Definition at line 86 of file AFP_Raw2DigiTool.h.

                                      {{{0,-2,1,0,-2,1, 0,-1,1,0,-1,1}, {2,-2,3,2,-2,3, 2,-1,3,2,-1,3}},
                                       {{1,-1,0,1,-1,0, 1,-1,0,1,-1,0}, {3,-1,2,3,-1,2, 3,-1,2,3,-1,2}},
                                       {{1,-1,3,1,-1,3, 1,-1,3,1,-1,3}, {0,-1,2,0,-1,2, 0,-1,2,0,-1,2}}};

◆ m_rawDataContainerName

SG::ReadHandleKey<AFP_RawContainer> AFP_Raw2DigiTool::m_rawDataContainerName {this, "rawDataContainerName", "AFP_RawData"}

protected

Definition at line 45 of file AFP_Raw2DigiTool.h.

45{this, "rawDataContainerName", "AFP_RawData"};

◆ m_totToChargeTransfExpr

Gaudi::Property<std::string> AFP_Raw2DigiTool::m_totToChargeTransfExpr {this, "TotToChargeTransfExpr", "1909 + x*363 + x*x*141", "Function that transforms time-over-threshold to charge"}

protected

Function that transforms time-over-threshold to charge.

Transformation function can be set in steering cards

Definition at line 62 of file AFP_Raw2DigiTool.h.

62{this, "TotToChargeTransfExpr", "1909 + x*363 + x*x*141", "Function that transforms time-over-threshold to charge"};

◆ m_totToChargeTransfName

Gaudi::Property<std::string> AFP_Raw2DigiTool::m_totToChargeTransfName {this, "TotToChargeTransfName", "TotToChargeTransfFunction", "Name of the function that transforms time-over-threshold to charge"}

protected

Definition at line 63 of file AFP_Raw2DigiTool.h.

63{this, "TotToChargeTransfName", "TotToChargeTransfFunction", "Name of the function that transforms time-over-threshold to charge"};

◆ m_totToChargeTransformation

TF1 AFP_Raw2DigiTool::m_totToChargeTransformation

protected

Definition at line 64 of file AFP_Raw2DigiTool.h.

◆ s_pulseLengthFactor

double AFP_Raw2DigiTool::s_pulseLengthFactor = 0.521

staticconstexprprotected

Factor converting pulse length to time.

The value of the factor is 0.521 nanoseconds

Definition at line 57 of file AFP_Raw2DigiTool.h.

◆ s_timeConversionFactor

double AFP_Raw2DigiTool::s_timeConversionFactor = 25./1024.

staticconstexprprotected

Factor converting signal to time.

The value of the factor is 25/1024 nanoseconds

Definition at line 52 of file AFP_Raw2DigiTool.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AFP_Raw2DigiTool()

◆ ~AFP_Raw2DigiTool()

Member Function Documentation

◆ decodeTimeOverThresholdSi()

◆ finalize()

◆ initialize()

◆ newXAODHitSi()

◆ newXAODHitToF()

◆ recoAll()

◆ recoSiHits()

◆ recoToFHits()

◆ setBarAndTrainID()

Member Data Documentation

◆ m_AFPHitsContainerNameToF

◆ m_AFPSiHitsContainerName

◆ m_channel2bar

◆ m_channel2train

◆ m_rawDataContainerName

◆ m_totToChargeTransfExpr

◆ m_totToChargeTransfName

◆ m_totToChargeTransformation

◆ s_pulseLengthFactor

◆ s_timeConversionFactor