raw::RecompressRawDigits Class Reference

Writes the input raw::RawDigit with a different compression. More...

Inheritance diagram for raw::RecompressRawDigits:

Classes
struct	Config

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

Public Member Functions
	RecompressRawDigits (Parameters const &config)
	Constructor; see module documentation for configuration directions. More...
virtual void	produce (art::Event &event) override
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 raw::RawDigit	recompress (raw::RawDigit const &digit, Compress_t newFormat, bool force=false)
	Returns a RawDigit with its waveform compressed in newFormat More...
static raw::Compress_t	parseCompressionType (std::string spec)
	Returns the compression mode corresponding to the specified string. More...
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
art::InputTag	fRawDigitLabel
	tag of input raw digit collection More...
raw::Compress_t	fCompressionType
	type of compression to be applied More...
std::string	fInstanceName
	instance name of output data product More...

Detailed Description

Writes the input raw::RawDigit with a different compression.

This module writes a collection of raw::RawDigit in a new data product, using the specified compression mode.

Input

A single collection of raw::RawDigit objects.

Output

A single collection of raw::RawDigit objects.

Configuration

• rawDigitLabel (input tag, mandatory): the input tag for the original raw::RawDigit collection
• compressionType (string, mandatory): the compression mode code (use names as in the enumerator raw::Compress_t)
• instanceName (string, optional): if specified, the output collection is saved with the specified product instance name (by default, none is used)

Definition at line 69 of file RecompressRawDigits_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

using raw::RecompressRawDigits::Parameters = art::EDProducer::Table<Config>

Definition at line 96 of file RecompressRawDigits_module.cc.

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

raw::RecompressRawDigits::RecompressRawDigits ( Parameters const &  config )

inlineexplicit

Constructor; see module documentation for configuration directions.

Definition at line 100 of file RecompressRawDigits_module.cc.

References fInstanceName, parseCompressionType(), produce(), and recompress().

      : fRawDigitLabel(config().rawDigitLabel())
      , fCompressionType(parseCompressionType(config().compressionType()))
      , fInstanceName(config().instanceName())
      {
        produces<std::vector<raw::RawDigit>>(fInstanceName);
      }

Member Function Documentation

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;
}

raw::Compress_t raw::RecompressRawDigits::parseCompressionType ( std::string  spec )

static

Returns the compression mode corresponding to the specified string.

Parameters

spec

Returns

the compression mode spec describes

Exceptions

art::Exception

(type: art::errors::Configuration) if invalid spec

This method returns the compression type described by the specification. Specification is not case sensitive and can omit the trailing letter k. Therefore, for example to specify kNone all the following specifications are valid: "kNone", "kNONE", "none".

Definition at line 238 of file RecompressRawDigits_module.cc.

References art::errors::Configuration, DEFINE_ART_MODULE, raw::kDynamicDec, raw::kHuffman, raw::kNone, raw::kZeroHuffman, and raw::kZeroSuppression.

Referenced by RecompressRawDigits().

{
  std::string SPEC(toupper(spec));
  
  if ((SPEC == "NONE"           ) || (SPEC == "KNONE"           )) return raw::kNone           ;
  if ((SPEC == "HUFFMAN"        ) || (SPEC == "KHUFFMAN"        )) return raw::kHuffman        ;
  if ((SPEC == "ZEROSUPPRESSION") || (SPEC == "KZEROSUPPRESSION")) return raw::kZeroSuppression;
  if ((SPEC == "ZEROHUFFMAN"    ) || (SPEC == "KZEROHUFFMAN"    )) return raw::kZeroHuffman    ;
  if ((SPEC == "DYNAMICDEC"     ) || (SPEC == "KDYNAMICDEC"     )) return raw::kDynamicDec     ;
  
  // if a valid one triggers this error, it needs to be added above
  throw art::Exception(art::errors::Configuration)
    << "Unrecognized compression type: '" << spec << "'\n";
  
} // raw::RecompressRawDigits::parseCompressionType()

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 raw::RecompressRawDigits::produce ( art::Event &  event )

overridevirtual

Implements art::EDProducer.

Definition at line 173 of file RecompressRawDigits_module.cc.

References fCompressionType, fInstanceName, fRawDigitLabel, and recompress().

Referenced by RecompressRawDigits().

                                                    {
  
  //
  // prepare input and output container
  //
  auto oldRawDigitHandle
    = event.getValidHandle<std::vector<raw::RawDigit>>(fRawDigitLabel);
  
  auto newRawDigits = std::make_unique<std::vector<raw::RawDigit>>();
  
  //
  // create a new compressed raw digit for each existing one
  //
  std::set<raw::Compress_t> formats;
  for (raw::RawDigit const& oldDigits: *oldRawDigitHandle) {
    
    // keep track of all the formats
    formats.insert(oldDigits.Compression());
    
    // recompress the digit, and put it into the future data product
    newRawDigits->emplace_back(recompress(oldDigits, fCompressionType));
    
  } // for oldDigits
  
  //
  // store the new digits into the event
  //
  event.put(std::move(newRawDigits), fInstanceName);
  
} // raw::RecompressRawDigits::produce()

raw::RawDigit raw::RecompressRawDigits::recompress ( raw::RawDigit const &  digit, Compress_t  newFormat, bool  force = false  )

static

Returns a RawDigit with its waveform compressed in newFormat

Parameters

digit	RawDigit to be recompressed
newFormat	compression format for the returned RawDigit
force	run even if input and target compression formats match

Returns

RawDigit with the waveform in a new compression format

A copy of RawDigit is always returned, with the waveform stored in the newFormat compression format. If the input RawDigit is already in that format, the waveform is simply copied, unless force is specified true, in which case data is uncompressed and compressed back.

Definition at line 208 of file RecompressRawDigits_module.cc.

References raw::RawDigit::ADCs(), raw::RawDigit::Channel(), raw::Compress(), raw::RawDigit::Compression(), raw::RawDigit::Samples(), and raw::Uncompress().

Referenced by produce(), and RecompressRawDigits().

{
  
  if ((newFormat == digit.Compression()) && !force) 
    return digit; // return a copy
  
  // uncompress the data
  raw::RawDigit::ADCvector_t ADCs(digit.Samples());
  raw::Uncompress(digit.ADCs(), ADCs, digit.Compression());    
  
  // compress the data (it happens in place)
  raw::Compress(ADCs, newFormat);
  
  // we force a copy in a buffer sized just big enough to host the data;
  // in case the buffer is already of the right size (as it happens when
  // newFormat specifies no compression), then no copy happens
  ADCs.shrink_to_fit();
  
  // create a new digit with the new buffer
  return raw::RawDigit{
    digit.Channel(),
    digit.Samples(),
    std::move(ADCs),
    newFormat
    };
  
} // raw::RecompressRawDigits::recompress()

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

raw::Compress_t raw::RecompressRawDigits::fCompressionType

private

type of compression to be applied

Definition at line 147 of file RecompressRawDigits_module.cc.

Referenced by produce().

std::string raw::RecompressRawDigits::fInstanceName

private

instance name of output data product

Definition at line 148 of file RecompressRawDigits_module.cc.

Referenced by produce(), and RecompressRawDigits().

art::InputTag raw::RecompressRawDigits::fRawDigitLabel

private

tag of input raw digit collection

Definition at line 146 of file RecompressRawDigits_module.cc.

Referenced by produce().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/DetSim/RecompressRawDigits_module.cc