TileRawChannelContByteStreamTool Class Reference

AlgTool class to provide conversion from TileRawChannelContainer to ByteStream, and fill it in RawEvent. More...

#include <TileRawChannelContByteStreamTool.h>

Inheritance diagram for TileRawChannelContByteStreamTool:

Collaboration diagram for TileRawChannelContByteStreamTool:

Public Types
typedef TileRawChannelContainer	CONTAINER

Public Member Functions
	TileRawChannelContByteStreamTool (const std::string &type, const std::string &name, const IInterface *parent)
	constructor
virtual	~TileRawChannelContByteStreamTool ()
	destructor
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
StatusCode	convert (CONTAINER *cont, FullEventAssembler< TileHid2RESrcID > *fea) const
	Provides conversion from TileRawChannelContainer to BS.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool InterfaceID.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< bool >	m_doFragType4 {this, "DoFragType4", true, "Do frag type 4"}
Gaudi::Property< bool >	m_doFragType5 {this, "DoFragType5", false, "Do frag type 5"}
Gaudi::Property< bool >	m_initializeForWriting {this, "InitializeForWriting", false, "Initialize for writing"}
SG::ReadCondHandleKey< TileHid2RESrcID >	m_hid2RESrcIDKey
const TileHWID *	m_tileHWID
bool	m_verbose
ToolHandle< TileCondToolEmscale >	m_tileToolEmscale
	Handle to Tile calibration tool.
ToolHandle< ITileBadChanTool >	m_tileBadChanTool
	Handle to Tile bad channel tool.
int	m_maxChannels
	maximum number of channels in a drawer
std::vector< int >	m_demoFragIDs
std::vector< int >	m_legacy2DemoChannelLB
std::vector< int >	m_legacy2DemoChannelEB
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

AlgTool class to provide conversion from TileRawChannelContainer to ByteStream, and fill it in RawEvent.

Author

Hong Ma

Version

Created, Sept 25, 2002

requirements: typedef for CONTAINER class method:

StatusCode convert(CONTAINER* cont, RawEvent* re);

Definition at line 34 of file TileRawChannelContByteStreamTool.h.

Member Typedef Documentation

CONTAINER

typedef TileRawChannelContainer TileRawChannelContByteStreamTool::CONTAINER

Definition at line 37 of file TileRawChannelContByteStreamTool.h.

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

TileRawChannelContByteStreamTool()

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

constructor

Definition at line 42 of file TileRawChannelContByteStreamTool.cxx.

    : AthAlgTool(type, name, parent)
    , m_tileHWID(0)
    , m_verbose(false)
    , m_maxChannels(TileCalibUtils::MAX_CHAN)
{
  declareInterface<TileRawChannelContByteStreamTool>(this);
}

~TileRawChannelContByteStreamTool()

TileRawChannelContByteStreamTool::~TileRawChannelContByteStreamTool ( )

virtual

destructor

Definition at line 54 of file TileRawChannelContByteStreamTool.cxx.

                                                                    {
}

Member Function Documentation

convert()

StatusCode TileRawChannelContByteStreamTool::convert	(	CONTAINER *	cont,
		FullEventAssembler< TileHid2RESrcID > *	fea ) const

Provides conversion from TileRawChannelContainer to BS.

Definition at line 131 of file TileRawChannelContByteStreamTool.cxx.

{
  bool isTMDB = evtStore()->proxy(rawChannelContainer)->name() == "MuRcvRawChCnt";
 
  TileFragHash::TYPE contType = rawChannelContainer->get_type();
  TileRawChannelUnit::UNIT inputUnit = rawChannelContainer->get_unit();
  TileRawChannelUnit::UNIT outputUnit = inputUnit; 
 
  bool oflCont = (inputUnit < TileRawChannelUnit::OnlineOffset);
 
  FullEventAssembler<TileHid2RESrcID>::RODDATA* theROD;
  SG::ReadCondHandle<TileHid2RESrcID> hid2re{m_hid2RESrcIDKey};
 
  ATH_MSG_DEBUG( " Number of raw channel collections... " << rawChannelContainer->size() << " " << evtStore()->proxy(rawChannelContainer)->name());
 
  std::map<uint32_t, TileROD_Encoder> mapEncoder;
  std::vector<TileFastRawChannel> channels;
  channels.reserve (m_tileHWID->channel_hash_max());
 
  uint32_t reid = 0x0;
 
  for (const TileRawChannelCollection* rawChannelCollection : *rawChannelContainer) {
 
    TileRawChannelCollection::ID frag_id = rawChannelCollection->identify();
 
    if (isTMDB) reid = hid2re->getRodTileMuRcvID(frag_id);
    else reid = hid2re->getRodID(frag_id);
 
    TileROD_Encoder& encoder = mapEncoder[reid];
 
    encoder.setTileHWID(m_tileHWID, m_verbose, 4);
    encoder.setTypeAndUnit(contType, outputUnit);
    encoder.setMaxChannels(m_maxChannels);
 
    HWIdentifier drawer_id = m_tileHWID->drawer_id(frag_id);
 
    int ros = m_tileHWID->ros(drawer_id);
    int drawer = m_tileHWID->drawer(drawer_id);
    int drawerIdx = TileCalibUtils::getDrawerIdx(ros, drawer);
 
    const std::vector<uint32_t> & drawer_info = hid2re->getDrawerInfo(frag_id);
    int drawer_type = drawer_info.size() > 2 ? static_cast<int>(drawer_info[2]) : -1;
    bool remap = (drawer_type > 0) || std::binary_search(m_demoFragIDs.begin(), m_demoFragIDs.end(), frag_id);
    const std::vector<int>& legacy2DemoChannel = (ros < 3) ? m_legacy2DemoChannelLB : m_legacy2DemoChannelEB;
 
    int nChannels = 0;
    std::vector<std::reference_wrapper<TileFastRawChannel>> drawerChannels;
    drawerChannels.reserve(rawChannelCollection->size());
 
    for (const TileRawChannel* rawChannel : *rawChannelCollection) {
 
      HWIdentifier adc_id = rawChannel->adc_HWID();
      int channel = m_tileHWID->channel(adc_id);
      int adc = m_tileHWID->adc(adc_id);
      float amplitude = rawChannel->amplitude();
      float time = rawChannel->time();
      float quality = rawChannel->quality();
      if (isTMDB) {
        channels.emplace_back (frag_id, channel, adc, amplitude, 0., 0.);
      } else {
        if (oflCont) {
          if (quality > 15.0) quality = 15.0;
          if (m_tileBadChanTool->getAdcStatus(drawerIdx, channel, adc).isBad()) quality += 16.;
        }
        //amplitude = m_tileToolEmscale->channelCalib(drawerIdx, channel, adc, amplitude, inputUnit, outputUnit);
 
        if (remap && (channel >= 0) && (channel < m_maxChannels)) {
          ATH_MSG_VERBOSE("Change channel [" << TileCalibUtils::getDrawerString(ros, drawer) << "]: "
                          << channel << " -> " << legacy2DemoChannel[channel]);
          channel = legacy2DemoChannel[channel];
        }
 
        channels.emplace_back (frag_id, channel, adc, amplitude, time, quality);
        drawerChannels.push_back(channels.back());
      }
 
      ++nChannels;
    }
 
    if (remap) {
      std::sort(drawerChannels.begin(), drawerChannels.end(),
                [] (const TileFastRawChannel& a, const TileFastRawChannel& b ) {
                  return a.channel() < b.channel();
                });
 
      }
 
    for (const TileFastRawChannel& channel : drawerChannels){
      // Don't need to worry about these moving due to the reserve() above.
      encoder.add(&channel);
    }
 
    ATH_MSG_DEBUG( " Collection " << MSG::hex << "0x" << frag_id
                  << " ROD " << "0x" << reid
                  << " number of channels " << MSG::dec << nChannels );
  }
 
  // TileROD_Encoder has collected all the channels, now can fill the
  // ROD block data.
 
  for (std::pair<const uint32_t, TileROD_Encoder>& reidAndEncoder: mapEncoder) {
 
    theROD = fea->getRodData(reidAndEncoder.first);
    TileROD_Encoder& theEncoder = reidAndEncoder.second;
 
    if ((reidAndEncoder.first & 0xf00)) {
       theEncoder.fillRODTileMuRcvRawChannel(*theROD);
    } else {
      if (m_doFragType4) theEncoder.fillROD4(*theROD);
      if (m_doFragType5) theEncoder.fillROD5(*theROD);
    }
    ATH_MSG_DEBUG( " Number of TileRawChannel words in ROD " << MSG::hex << " 0x" << reidAndEncoder.first << MSG::dec << " : " << theROD->size() );
  }
 
  return StatusCode::SUCCESS;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

finalize()

StatusCode TileRawChannelContByteStreamTool::finalize ( )

overridevirtual

Definition at line 126 of file TileRawChannelContByteStreamTool.cxx.

                                                      {
  ATH_MSG_INFO ("Finalizing TileRawChannelContByteStreamTool successfuly");
  return StatusCode::SUCCESS;
}

initialize()

StatusCode TileRawChannelContByteStreamTool::initialize ( )

overridevirtual

Definition at line 57 of file TileRawChannelContByteStreamTool.cxx.

                                                        {
 
  ATH_MSG_INFO ("Initializing TileRawChannelContByteStreamTool");
 
  ATH_CHECK( detStore()->retrieve(m_tileHWID, "TileHWID") );
 
  ToolHandle<TileROD_Decoder> dec("TileROD_Decoder");
  ATH_CHECK( dec.retrieve() );
 
  const Gaudi::Details::PropertyBase& demoFragIDsProperty = SmartIF<IProperty>(dec.get())->getProperty("DemoFragIDs");
  const IntegerArrayProperty& demoFragIDs = dynamic_cast<const IntegerArrayProperty&>(demoFragIDsProperty);
 
  m_demoFragIDs.reserve(demoFragIDs.size());
  for (const auto fragID : demoFragIDs.value()) {
    m_demoFragIDs.push_back(fragID);
  }
 
  if ( !m_demoFragIDs.empty() ) {
    std::ostringstream os;
    std::sort(m_demoFragIDs.begin(),m_demoFragIDs.end());
    os << " (frag IDs):";
    for (int fragID : m_demoFragIDs) {
      if (fragID > 0)
        os << " 0x" << std::hex << fragID << std::dec;
      else
        os << " " << fragID;
    }
    ATH_MSG_INFO("Enable channel remapping for demonstrator modules" << os.str());
  }
 
 
  // Prepare legacy to Demonstrator channel mapping for LB and EB
  // (vice versa to the one in the Tile ROD Decoder)
  std::vector<std::pair<std::reference_wrapper<std::vector<int>>,
                        std::reference_wrapper<const std::vector<int>>>>
    legacyAndDemoChanMaps{{m_legacy2DemoChannelLB, dec->getDemoChannelMapLB()},
                          {m_legacy2DemoChannelEB, dec->getDemoChannelMapEB()}};
 
  for (std::pair<std::reference_wrapper<std::vector<int>>,
         std::reference_wrapper<const std::vector<int>>>
         legacyAndDemoChanMap : legacyAndDemoChanMaps) {
 
    std::vector<int>& legacy2DemoChannel = legacyAndDemoChanMap.first;
    const std::vector<int>& demoChanMap = legacyAndDemoChanMap.second;
    if (!demoChanMap.empty()) {
      legacy2DemoChannel.resize(m_maxChannels);
      for (unsigned int demoChannel = 0; demoChannel < demoChanMap.size(); ++demoChannel) {
        int legacyChannel = demoChanMap[demoChannel];
        if ((legacyChannel >= 0) && (legacyChannel < m_maxChannels)) {
          legacy2DemoChannel[legacyChannel] = demoChannel;
        }
      }
    }
  }
 
 
  // get TileCondToolEmscale
  ATH_CHECK( m_tileToolEmscale.retrieve() );
 
  // get TileBadChanTool
  ATH_CHECK( m_tileBadChanTool.retrieve() );
 
  ATH_CHECK( m_hid2RESrcIDKey.initialize(m_initializeForWriting) );
 
  m_maxChannels = TileCablingService::getInstance()->getMaxChannels();
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

const InterfaceID & TileRawChannelContByteStreamTool::interfaceID ( )

static

AlgTool InterfaceID.

Definition at line 36 of file TileRawChannelContByteStreamTool.cxx.

                                                                 {
  return IID_ITileRawChannelContByteStreamTool;
}

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_demoFragIDs

std::vector<int> TileRawChannelContByteStreamTool::m_demoFragIDs

private

Definition at line 82 of file TileRawChannelContByteStreamTool.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_doFragType4

Gaudi::Property<bool> TileRawChannelContByteStreamTool::m_doFragType4 {this, "DoFragType4", true, "Do frag type 4"}

private

Definition at line 61 of file TileRawChannelContByteStreamTool.h.

{this, "DoFragType4", true, "Do frag type 4"};

m_doFragType5

Gaudi::Property<bool> TileRawChannelContByteStreamTool::m_doFragType5 {this, "DoFragType5", false, "Do frag type 5"}

private

Definition at line 62 of file TileRawChannelContByteStreamTool.h.

{this, "DoFragType5", false, "Do frag type 5"};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_hid2RESrcIDKey

SG::ReadCondHandleKey<TileHid2RESrcID> TileRawChannelContByteStreamTool::m_hid2RESrcIDKey

private

Initial value:

{this,
        "TileHid2RESrcID", "TileHid2RESrcIDHLT", "TileHid2RESrcID key"}

Definition at line 65 of file TileRawChannelContByteStreamTool.h.

                                                         {this,
        "TileHid2RESrcID", "TileHid2RESrcIDHLT", "TileHid2RESrcID key"};

m_initializeForWriting

Gaudi::Property<bool> TileRawChannelContByteStreamTool::m_initializeForWriting {this, "InitializeForWriting", false, "Initialize for writing"}

private

Definition at line 63 of file TileRawChannelContByteStreamTool.h.

{this, "InitializeForWriting", false, "Initialize for writing"};

m_legacy2DemoChannelEB

std::vector<int> TileRawChannelContByteStreamTool::m_legacy2DemoChannelEB

private

Definition at line 84 of file TileRawChannelContByteStreamTool.h.

m_legacy2DemoChannelLB

std::vector<int> TileRawChannelContByteStreamTool::m_legacy2DemoChannelLB

private

Definition at line 83 of file TileRawChannelContByteStreamTool.h.

m_maxChannels

int TileRawChannelContByteStreamTool::m_maxChannels

private

maximum number of channels in a drawer

Definition at line 80 of file TileRawChannelContByteStreamTool.h.

m_tileBadChanTool

ToolHandle<ITileBadChanTool> TileRawChannelContByteStreamTool::m_tileBadChanTool

private

Initial value:

{this,
        "TileBadChanTool", "TileBadChanTool", "Tile bad channel tool"}

Handle to Tile bad channel tool.

Definition at line 76 of file TileRawChannelContByteStreamTool.h.

                                                  {this,
        "TileBadChanTool", "TileBadChanTool", "Tile bad channel tool"};

m_tileHWID

const TileHWID* TileRawChannelContByteStreamTool::m_tileHWID

private

Definition at line 68 of file TileRawChannelContByteStreamTool.h.

m_tileToolEmscale

ToolHandle<TileCondToolEmscale> TileRawChannelContByteStreamTool::m_tileToolEmscale

private

Initial value:

{this,
        "TileCondToolEmscale", "TileCondToolEmscale", "Tile EM scale conditions tool"}

Handle to Tile calibration tool.

Definition at line 72 of file TileRawChannelContByteStreamTool.h.

                                                     {this,
        "TileCondToolEmscale", "TileCondToolEmscale", "Tile EM scale conditions tool"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_verbose

bool TileRawChannelContByteStreamTool::m_verbose

private

Definition at line 69 of file TileRawChannelContByteStreamTool.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• TileRawChannelContByteStreamTool.h
• TileRawChannelContByteStreamTool.cxx