This algorithm allows to read wave forms from ntuples and builds a LArPhysWaveContainer conating the corresponding PhysWave. More...

#include <LArPhysWaveFromTuple.h>

Inheritance diagram for LArPhysWaveFromTuple:

Collaboration diagram for LArPhysWaveFromTuple:

Public Member Functions
	LArPhysWaveFromTuple (const std::string &name, ISvcLocator *pSvcLocator)
	~LArPhysWaveFromTuple ()
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
StatusCode	stop ()
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	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

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< unsigned int >	m_NPoints {this, "NPoints", 800, "Max number of points in ntuple"}
	max number of points of the waveform in the ntuple
Gaudi::Property< unsigned int >	m_skipPoints {this, "SkipPoints", 0, "How many points to skip"}
	the first m_skipPoints points of the waveform in the ntuple are skipped
Gaudi::Property< unsigned int >	m_prefixPoints {this, "PrefixPoints", 0, "How many points to add on front"}
	make a PhysWave with the first m_prefixPoints as zeros
Gaudi::Property< unsigned int >	m_flag {this, "LArWaveFlag", 20, "Flag to store with PhysWave"}
	flag for the PhysWave container
Gaudi::Property< std::string >	m_root_file_name {this, "FileName", "", "which file to open"}
	input file name
Gaudi::Property< std::string >	m_ntuple_name {this, "NtupleName", "PHYSWAVE", "which ntuple to read"}
	ntuple name
Gaudi::Property< std::string >	m_store_key {this, "StoreKey", "FROMTUPLE", "SG key of created container"}
	key of the PhysWave collection in Storegate
Gaudi::Property< std::string >	m_groupingType {this, "GroupingType", "ExtendedFeedThrough", "container grouping type"}
	Grouping type. Default is Feedthrough.
Gaudi::Property< bool >	m_isSC {this, "isSC", false, "Running for SuperCells ?"}
Gaudi::Property< int >	m_gain {this, "Gain", 0, "which gain to use ?"}
DataObjIDColl	m_extendedExtraObjects
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

This algorithm allows to read wave forms from ntuples and builds a LArPhysWaveContainer conating the corresponding PhysWave.

The root tree should contain the following branches :

channelId online ID
timeIndex : number of samples
Time[timeIndex] : double array of times
Amplitude[timeIndex] : double array of amplitudes

Definition at line 25 of file LArPhysWaveFromTuple.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ LArPhysWaveFromTuple()

LArPhysWaveFromTuple::LArPhysWaveFromTuple	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 23 of file LArPhysWaveFromTuple.cxx.

                                                                                           : AthAlgorithm(name, pSvcLocator)
{  
}

◆ ~LArPhysWaveFromTuple()

LArPhysWaveFromTuple::~LArPhysWaveFromTuple ( )

default

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::detStore ( ) const

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode LArPhysWaveFromTuple::execute ( )

inline

Definition at line 35 of file LArPhysWaveFromTuple.h.

35{return StatusCode::SUCCESS;}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode LArPhysWaveFromTuple::finalize ( )

inline

Definition at line 37 of file LArPhysWaveFromTuple.h.

37{return StatusCode::SUCCESS;}

◆ initialize()

StatusCode LArPhysWaveFromTuple::initialize ( )

Definition at line 30 of file LArPhysWaveFromTuple.cxx.

{
  return StatusCode::SUCCESS ;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ stop()

StatusCode LArPhysWaveFromTuple::stop ( )

Definition at line 36 of file LArPhysWaveFromTuple.cxx.

{
  ATH_MSG_INFO ( "... in stop()" );
  
  // get LArOnlineID helper
  const LArOnlineID* onlineHelper = nullptr;
  ATH_CHECK( detStore()->retrieve(onlineHelper, "LArOnlineID") );
 
  TChain* outfit = new TChain(m_ntuple_name.value().c_str());
  outfit->Add(m_root_file_name.value().c_str());
 
  // This algorithm assumes the input NTuple in contains less than 2000 
  // points.  If the NTuple contains less than 2000 points, the 
  // remaining points are automatically initialized to 0.
  // Catch potential array index out of range error.
  if ( m_NPoints > 2000 ) {
    ATH_MSG_WARNING ( " Too many points specified vs the expected content of the ntuple ! " );
    ATH_MSG_WARNING ( " Only 2000 will be used !");
    m_NPoints = 2000;
  }
 
  // variable names as in the Ntuple
  Int_t           channelId; 
  UInt_t           tIndex; 
  std::vector<Double_t>        Amplitude(2000);
  std::vector<Double_t>        Time(2000);
  outfit->SetBranchAddress("channelId", &channelId);
  outfit->SetBranchAddress("timeIndex", &tIndex);
  outfit->SetBranchAddress("Amplitude", Amplitude.data());
  outfit->SetBranchAddress("Time", Time.data());
 
  // Create new LArPhysWaveContainer
  auto larPhysWaveContainerNew = std::make_unique<LArPhysWaveContainer>();
  ATH_CHECK ( larPhysWaveContainerNew->setGroupingType(m_groupingType, msg()) );
  ATH_CHECK ( larPhysWaveContainerNew->initialize() );
 
  // loop over entries in the Tuple, one entry = one channel
  Long64_t nentries = outfit->GetEntries();
  std::vector<double> wave(m_NPoints);
  for ( Long64_t i = 0; i < nentries; i++ )
  {
    outfit->GetEvent(i);
    HWIdentifier id(channelId);
    ATH_MSG_INFO ( std::hex << id << std::dec );
 
    for ( unsigned int i = 0; i < m_NPoints; i++ ) wave[i]=0.;
    unsigned int skipped = 0;
    unsigned int limit = tIndex<m_NPoints.value() ? tIndex : m_NPoints.value();
    if ( m_skipPoints < m_prefixPoints ) limit = m_NPoints.value() + m_skipPoints.value() - m_prefixPoints.value();
    double dt=Time[1]-Time[0];
    for ( unsigned int i = 0; i < limit; i++ )
    {
      if(i>1 && Time[i] - Time[i-1] != dt) {
         ATH_MSG_ERROR("No equidistant time, could not process....");
         return StatusCode::FAILURE;
      }
      if ( skipped >= m_skipPoints ) 
      {
    wave[i-m_skipPoints+m_prefixPoints]=Amplitude[i];
      }
      else skipped++;
    }
 
    LArPhysWave newLArPhysWave(wave, dt, m_flag);
      
    // Add physics wave to container
    larPhysWaveContainerNew->setPdata(id, newLArPhysWave, (CaloGain::CaloGain)m_gain.value());
  }
 
  ATH_CHECK( detStore()->record(std::move(larPhysWaveContainerNew),m_store_key) );
  ATH_MSG_INFO ( "LArPhysWaveFromTuple finalized!" );
  return StatusCode::SUCCESS;
}

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_flag

Gaudi::Property<unsigned int> LArPhysWaveFromTuple::m_flag {this, "LArWaveFlag", 20, "Flag to store with PhysWave"}

private

flag for the PhysWave container

Definition at line 48 of file LArPhysWaveFromTuple.h.

48{this, "LArWaveFlag", 20, "Flag to store with PhysWave"};

◆ m_gain

Gaudi::Property< int > LArPhysWaveFromTuple::m_gain {this, "Gain", 0, "which gain to use ?"}

private

Definition at line 58 of file LArPhysWaveFromTuple.h.

58{this, "Gain", 0, "which gain to use ?"};

◆ m_groupingType

Gaudi::Property<std::string> LArPhysWaveFromTuple::m_groupingType {this, "GroupingType", "ExtendedFeedThrough", "container grouping type"}

private

Grouping type. Default is Feedthrough.

Definition at line 56 of file LArPhysWaveFromTuple.h.

56{this, "GroupingType", "ExtendedFeedThrough", "container grouping type"};

◆ m_isSC

Gaudi::Property< bool > LArPhysWaveFromTuple::m_isSC {this, "isSC", false, "Running for SuperCells ?"}

private

Definition at line 57 of file LArPhysWaveFromTuple.h.

57{this, "isSC", false, "Running for SuperCells ?"};

◆ m_NPoints

Gaudi::Property<unsigned int> LArPhysWaveFromTuple::m_NPoints {this, "NPoints", 800, "Max number of points in ntuple"}

private

max number of points of the waveform in the ntuple

Definition at line 42 of file LArPhysWaveFromTuple.h.

42{this, "NPoints", 800, "Max number of points in ntuple"};

◆ m_ntuple_name

Gaudi::Property<std::string> LArPhysWaveFromTuple::m_ntuple_name {this, "NtupleName", "PHYSWAVE", "which ntuple to read"}

private

ntuple name

Definition at line 52 of file LArPhysWaveFromTuple.h.

52{this, "NtupleName", "PHYSWAVE", "which ntuple to read"};

◆ m_prefixPoints

Gaudi::Property<unsigned int> LArPhysWaveFromTuple::m_prefixPoints {this, "PrefixPoints", 0, "How many points to add on front"}

private

make a PhysWave with the first m_prefixPoints as zeros

Definition at line 46 of file LArPhysWaveFromTuple.h.

46{this, "PrefixPoints", 0, "How many points to add on front"};

◆ m_root_file_name

Gaudi::Property<std::string> LArPhysWaveFromTuple::m_root_file_name {this, "FileName", "", "which file to open"}

private

input file name

Definition at line 50 of file LArPhysWaveFromTuple.h.

50{this, "FileName", "", "which file to open"};

◆ m_skipPoints

Gaudi::Property<unsigned int> LArPhysWaveFromTuple::m_skipPoints {this, "SkipPoints", 0, "How many points to skip"}

private

the first m_skipPoints points of the waveform in the ntuple are skipped

Definition at line 44 of file LArPhysWaveFromTuple.h.

44{this, "SkipPoints", 0, "How many points to skip"};

◆ m_store_key

Gaudi::Property<std::string> LArPhysWaveFromTuple::m_store_key {this, "StoreKey", "FROMTUPLE", "SG key of created container"}

private

key of the PhysWave collection in Storegate

Definition at line 54 of file LArPhysWaveFromTuple.h.

54{this, "StoreKey", "FROMTUPLE", "SG key of created container"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ LArPhysWaveFromTuple()

◆ ~LArPhysWaveFromTuple()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ stop()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_flag

◆ m_gain

◆ m_groupingType

◆ m_isSC

◆ m_NPoints

◆ m_ntuple_name

◆ m_prefixPoints

◆ m_root_file_name

◆ m_skipPoints

◆ m_store_key

◆ m_varHandleArraysDeclared

◆ m_vhka