opdet::BoDataFrameInput Class Reference

Inheritance diagram for opdet::BoDataFrameInput:

Public Types
using	ModuleType = EDProducer
using	WorkerType = WorkerT< EDProducer >
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerBase::Table< UserConfig, KeysToIgnore >

Public Member Functions
	BoDataFrameInput (const fhicl::ParameterSet &)
virtual	~BoDataFrameInput ()
void	produce (art::Event &)
void	beginJob ()
template<typename PROD , BranchType B = InEvent>
ProductID	getProductID (std::string const &instanceName={}) const
template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const
bool	modifiesEvent () const
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)
base_engine_t &	createEngine (seed_t seed)
base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)
base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)
seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
CurrentProcessingContext const *	currentContext () const
void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
void	prepareForJob (fhicl::ParameterSet const &pset)
void	showMissingConsumes () const

Private Attributes
std::string	fInputFile
std::ifstream	fTextFile

Detailed Description

Definition at line 25 of file BoDataFrameInput_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 43 of file EDProducer.h.

using art::EDProducer::WorkerType = WorkerT<EDProducer>

inherited

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

opdet::BoDataFrameInput::BoDataFrameInput

(

const fhicl::ParameterSet &

)

Definition at line 103 of file BoDataFrameInput_module.cc.

References fInputFile, fTextFile, and fhicl::ParameterSet::get().

  {
    // Infrastructure piece
    produces<std::vector< raw::OpDetPulse> >();

    // Input filename read from fcl
    fInputFile = pset.get<std::string>("InputFile");    
    std::string FullFilePath(""); 
    cet::search_path sp("FW_SEARCH_PATH");
    if( !sp.find_file(fInputFile, FullFilePath) )
      throw cet::exception("BoDataFrameInput") << "Unable to find optical data file in " << sp.to_string() << "\n";


    // We want to throw away the first command, as it will be "evt"
    std::string sub;
    getline(fTextFile, sub, ',');
    if(sub.substr(0,3)!=std::string("evt"))
      {
        mf::LogInfo("BoDataFrameInput")<<"Warning: first command in text file is not an evt block as expected. Trying to persevere anyway : " << sub; 
      }




    // Open file for reading
    fTextFile.open(FullFilePath);

  }

opdet::BoDataFrameInput::~BoDataFrameInput ( )

virtual

Definition at line 142 of file BoDataFrameInput_module.cc.

  {
  }

Member Function Documentation

void opdet::BoDataFrameInput::beginJob ( )

virtual

Reimplemented from art::EDProducer.

Definition at line 135 of file BoDataFrameInput_module.cc.

  {
  }

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::consumes ( InputTag const &  )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const &  it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::consumesView ( InputTag const &  )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const &  it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

{
  return rng()->createEngine(placeholder_schedule_id(), seed);
}

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed, std::string const &  kind_of_engine_to_make  )

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

{
  return rng()->createEngine(
    placeholder_schedule_id(), seed, kind_of_engine_to_make);
}

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t  seed, std::string const &  kind_of_engine_to_make, label_t const &  engine_label  )

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

{
  return rng()->createEngine(
    placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
}

CurrentProcessingContext const * art::EDProducer::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

  {
    return current_context_.get();
  }

EngineCreator::seed_t EngineCreator::get_seed_value ( fhicl::ParameterSet const &  pset, char const  key[] = "seed", seed_t const  implicit_seed = -1  )

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

{
  auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
  return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
}

template<typename PROD , BranchType B>

ProductID art::EDProducer::getProductID ( std::string const &  instanceName = {} ) const

inlineinherited

Definition at line 123 of file EDProducer.h.

References art::EDProducer::moduleDescription_.

  {
    return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                               instanceName);
  }

template<typename PROD , BranchType B>

ProductID art::ProducerBase::getProductID ( ModuleDescription const &  moduleDescription, std::string const &  instanceName  ) const

inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

  {
    auto const& pd =
      get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
    return pd.productID();
  }

template<typename T , BranchType = InEvent>

ProductToken<T> art::Consumer::mayConsume ( InputTag const &  )

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const &  it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ProductToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::Product,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ProductToken<T>{it};
}

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

{
  if (!moduleContext_)
    return;

  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
}

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::Consumer::mayConsumeView ( InputTag const &  )

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const &  it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

{
  if (!moduleContext_)
    return ViewToken<T>::invalid();

  consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                TypeID{typeid(T)},
                                it.label(),
                                it.instance(),
                                it.process());
  return ViewToken<T>{it};
}

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

    {
      return true;
    }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

Referenced by art::RootOutput::beginSubRun(), art::OutputModule::doBeginRun(), art::OutputModule::doBeginSubRun(), art::OutputModule::doEndRun(), art::OutputModule::doEndSubRun(), art::ProducingService::doPostReadEvent(), art::ProducingService::doPostReadRun(), art::ProducingService::doPostReadSubRun(), art::OutputModule::doWriteEvent(), art::ProcessPackage< L >::postScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::Run >::End::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::End::postScheduleSignal(), art::ProcessPackage< L >::preScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::preScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::preScheduleSignal(), art::EventProcessor::readEvent(), art::EventProcessor::readRun(), art::EmptyEvent::readRun_(), art::EventProcessor::readSubRun(), and art::EmptyEvent::readSubRun_().

{
  static Consumer invalid{InvalidTag{}};
  return &invalid;
}

void art::Consumer::prepareForJob ( fhicl::ParameterSet const &  pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

{
  if (!moduleContext_)
    return;

  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
  for (auto& consumablesPerBranch : consumables_) {
    cet::sort_all(consumablesPerBranch);
  }
}

void opdet::BoDataFrameInput::produce ( art::Event &  evt )

virtual

Implements art::EDProducer.

Definition at line 149 of file BoDataFrameInput_module.cc.

References art::EventID::event(), fInputFile, fTextFile, art::Event::id(), art::Event::put(), and ss.

  {
    // Infrastructure piece
    std::unique_ptr<std::vector< raw::OpDetPulse > >  StoragePtr (new std::vector<raw::OpDetPulse>);
 
    // Create vector of pointers to our waveform pulses for each OpDet
    std::vector<raw::OpDetPulse*> ThePulses;

    if(!fTextFile)
      {
        mf::LogError("BoDataFrameInput")<<"Error in reading input file : " << fInputFile;
      }

    // Build an array of comma separated commands

    mf::LogInfo("BoDataFrameInput")<<"Reading optical pulses for event " <<evt.id().event() ;
    std::vector<std::string>  Commands;
    std::vector<unsigned int> Values;

    bool ContinueRead = true;
    std::string sub("");
    std::string line("");

    unsigned int CurrentChannel=0;


    unsigned int ChannelsThisEvent=0;
    unsigned int FEMModule=0;
    unsigned int TriggerID=0;
    unsigned int EventFrameNumber=0;
    unsigned int TriggerTypeThisChannel=0;
    unsigned int PMTFrameNumber=0;

    unsigned int FirstSample=0;

    std::map<int, std::vector<raw::OpDetPulse*> > PulsesThisEvent;
    
    while(fTextFile.good() && ContinueRead)
      {    
        getline(fTextFile, line);
        std::stringstream linestream(line);
        while(linestream.good() && ContinueRead)
          {
            getline(linestream, sub, ',');
            std::stringstream ss(sub);
            std::string Command("");
            int Value=0;
            ss>>Command;
            ss>>Value;
            mf::LogInfo("BoDataFrameInput")<<"Parsed a single line as  C: " << Command<< "  V: "<<Value;
            
            // Structural commands
            if(Command=="evt")
              {
                // This command specifies the beginning of the next readout event.
                //  if we find it, finish processing for now.
                mf::LogInfo("BoDataFrameInput")<<"Found start of next event, ID = " <<  Value<<", finish frame readout";
                ContinueRead=false;
              }
            else if(Command=="nch")
              {
                // Number of channels in this event readout
                if(ChannelsThisEvent==0)
                  ChannelsThisEvent=Value;
                else
                  mf::LogInfo("BoDataFrameInput")<<"Confused by data input: nch specified twice for the same event. Persevering anyway...";     
              }
            else if(Command=="mod")
              {
                // ID of the FEM module
                FEMModule=Value;
                Value=FEMModule; // This line just suppresses a compiler warning
              }
            else if(Command=="tid")
              {
                // Trigger type (cosmic, michel, etc)
                TriggerID=Value;
                Value = TriggerID; // This line just suppresses a compiler warning
              }
            else if(Command=="efr")
              {
                // The event frame number - see longer note under pfr
                EventFrameNumber=Value;
              }


            // Per readout window commands
            
            else if(Command=="chn")
              {
                // chn tells us the channel number on the shaper board
                mf::LogInfo("BoDataFrameInput")<<"Beginning channel " <<Value;
        
                CurrentChannel = Value;
                PulsesThisEvent[CurrentChannel].push_back( new raw::OpDetPulse(CurrentChannel) );       
                
                FirstSample    = 0;
                PMTFrameNumber = 0;
              }
            else if(Command=="cid")
              {
                // This gives the trigger type. Encoding not totally clear,
                // but we know 16 = external trigger
                TriggerTypeThisChannel=Value;
                Value =TriggerTypeThisChannel; // This line just suppresses a compiler warning
              }
            else if(Command=="smp")
              {
                // smp tells us which sample to start at within the window
                FirstSample=Value;
                PulsesThisEvent[CurrentChannel].at(PulsesThisEvent[CurrentChannel].size()-1)->SetFirstSample(FirstSample);
              }
            else if(Command=="pfr")
              {
                // This part is a bit complicated.
                // The PMT frame number tells us which readout frame 
                //  this signal occupies.
                // The PMT frame always occurs after the event frame.
                // The pfr value is the last 3 bits of the PMT frame number
                // So the goal is to find the first number after efr with
                //  these last 3 bits.

                // In practice : 
                //  if the last 3 bits of efr are > pfr
                //    the PMT frame is (all but 3 lsb of)efr + 8 + pfr  
                //  if the last 3 bits of efr are < pfr
                //    the PMT frame is (all but 3 lsb of)efr + pfr

                // This mask gets the 3LSB 
                int mask = 0x007;

                int EvLowBits =  EventFrameNumber & mask;
                int EvHighBits = EventFrameNumber & ~mask;

                if(Value < EvLowBits)
                  {
                    PMTFrameNumber = EvHighBits + 8 + Value;
                  }
                else if(Value > EvLowBits)
                  {
                    PMTFrameNumber = EvHighBits + Value;
                  }
                else if(Value == EvLowBits)
                  {
                    PMTFrameNumber = EvHighBits + EvLowBits;
                  }
                else
                  {
                    mf::LogError("BoDataFrameInput") << "pfr routine confused - this should be impossible";
                  }
                
                PulsesThisEvent[CurrentChannel].at(PulsesThisEvent[CurrentChannel].size()-1)->SetPMTFrame(PMTFrameNumber);
                
              }
            else if(Command=="adc")
              {
                // Add one sample to the pulse object
                PulsesThisEvent[CurrentChannel].at(PulsesThisEvent[CurrentChannel].size()-1)->Waveform().push_back(Value);
              }
          }  
      }    
    

    // Now pack away the pulses we found into the event
    for(std::map<int, std::vector<raw::OpDetPulse*> >::const_iterator it = PulsesThisEvent.begin();
        it!=PulsesThisEvent.end(); ++it)
      {
        for(size_t pulse=0; pulse!=it->second.size(); ++pulse)
          {
            StoragePtr->push_back( *(it->second.at(pulse)) );
          }
      }
    
    evt.put(std::move(StoragePtr));
  }  

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

{
  if (!moduleContext_)
    return;

  // If none of the branches have missing consumes statements, exit early.
  if (std::all_of(cbegin(missingConsumes_),
                  cend(missingConsumes_),
                  [](auto const& perBranch) { return perBranch.empty(); }))
    return;

  constexpr cet::HorizontalRule rule{60};
  mf::LogPrint log{"MTdiagnostics"};
  log << '\n'
      << rule('=') << '\n'
      << "The following consumes (or mayConsume) statements are missing from\n"
      << module_context(moduleDescription_) << '\n'
      << rule('-') << '\n';

  cet::for_all_with_index(
    missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
      for (auto const& pi : perBranch) {
        log << "  "
            << assemble_consumes_statement(static_cast<BranchType>(i), pi)
            << '\n';
      }
    });
  log << rule('=');
}

void art::Consumer::validateConsumedProduct ( BranchType const  bt, ProductInfo const &  pi  )

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

{
  // Early exits if consumes tracking has been disabled or if the
  // consumed product is an allowed consumable.
  if (!moduleContext_)
    return;

  if (cet::binary_search_all(consumables_[bt], pi))
    return;

  if (requireConsumes_) {
    throw Exception(errors::ProductRegistrationFailure,
                    "Consumer: an error occurred during validation of a "
                    "retrieved product\n\n")
      << "The following consumes (or mayConsume) statement is missing from\n"
      << module_context(moduleDescription_) << ":\n\n"
      << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
  }

  missingConsumes_[bt].insert(pi);
}

Member Data Documentation

std::string opdet::BoDataFrameInput::fInputFile

private

Definition at line 39 of file BoDataFrameInput_module.cc.

Referenced by BoDataFrameInput(), and produce().

std::ifstream opdet::BoDataFrameInput::fTextFile

private

Definition at line 40 of file BoDataFrameInput_module.cc.

Referenced by BoDataFrameInput(), and produce().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larana/v07_04_02/source/larana/OpticalDetector/BoDataFrameInput_module.cc