noisefilteralg::WireCellNoiseFilter Class Reference

Inheritance diagram for noisefilteralg::WireCellNoiseFilter:

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

Public Member Functions
	WireCellNoiseFilter (fhicl::ParameterSet const &pset)
virtual	~WireCellNoiseFilter ()
void	produce (art::Event &evt)
void	reconfigure (fhicl::ParameterSet const &pset)
void	beginJob ()
void	endJob ()
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 Member Functions
void	DoNoiseFilter (unsigned int runNum, const std::vector< raw::RawDigit > &, std::vector< raw::RawDigit > &) const

Private Attributes
std::string	fDigitModuleLabel
bool	fDoNoiseFiltering
size_t	fNumTicksToDropFront
size_t	fWindowSize

Detailed Description

Definition at line 44 of file WireCellNoiseFilter_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

noisefilteralg::WireCellNoiseFilter::WireCellNoiseFilter ( fhicl::ParameterSet const &  pset )

explicit

Definition at line 72 of file WireCellNoiseFilter_module.cc.

References reconfigure().

    : EDProducer()
{
    this->reconfigure(pset);
    produces<std::vector<raw::RawDigit> >();
}

noisefilteralg::WireCellNoiseFilter::~WireCellNoiseFilter ( )

virtual

Definition at line 80 of file WireCellNoiseFilter_module.cc.

{}

Member Function Documentation

void noisefilteralg::WireCellNoiseFilter::beginJob ( )

virtual

Reimplemented from art::EDProducer.

Definition at line 91 of file WireCellNoiseFilter_module.cc.

                                  {
    art::ServiceHandle<art::TFileService> tfs;
    //art::ServiceHandle<util::LArWireCellNoiseFilterService> larWireCellNF;
    //larWireCellNF->print(17);
}

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

void noisefilteralg::WireCellNoiseFilter::DoNoiseFilter ( unsigned int  runNum, const std::vector< raw::RawDigit > &  inputWaveforms, std::vector< raw::RawDigit > &  outputWaveforms  ) const

private

Definition at line 154 of file WireCellNoiseFilter_module.cc.

References DEFINE_ART_MODULE, fNumTicksToDropFront, fWindowSize, raw::kNone, min, noise(), geo::GeometryCore::Nwires(), and lar::dump::vector().

Referenced by produce().

{

    // Recover services we will need
    const lariov::ChannelStatusProvider& channelStatus      = art::ServiceHandle<lariov::ChannelStatusService>()->GetProvider();
    const lariov::DetPedestalProvider&   pedestalValues     = art::ServiceHandle<lariov::DetPedestalService>()->GetPedestalProvider();
    const lariov::ElectronicsCalibProvider& elec_provider = art::ServiceHandle<lariov::ElectronicsCalibService>()->GetProvider();
    const geo::GeometryCore&             geometry           = *lar::providerFrom<geo::Geometry>();
    const detinfo::DetectorProperties&   detectorProperties = *lar::providerFrom<detinfo::DetectorPropertiesService>();
    
    const unsigned int n_channels = inputWaveforms.size();
    
    // S&C microboone sampling parameter database
    const double tick       = detectorProperties.SamplingRate(); // 0.5 * units::microsecond;
    const size_t nsamples   = inputWaveforms.at(0).NADC();
    const size_t windowSize = std::min(fWindowSize,nsamples);
    
    // Q&D microboone channel map
    std::vector<int> uchans(geometry.Nwires(0)), vchans(geometry.Nwires(1)), wchans(geometry.Nwires(2));
    const int nchans = uchans.size() + vchans.size() + wchans.size();
    std::iota(uchans.begin(), uchans.end(), 0);
    std::iota(vchans.begin(), vchans.end(), vchans.size());
    std::iota(wchans.begin(), wchans.end(), vchans.size() + uchans.size());
    
    // Q&D nominal baseline
    const double unombl=2048.0, vnombl=2048.0, wnombl=400.0;
    
    // Q&D miss-configured channel database
    std::vector<int> miscfgchan;
    for(int channelIdx=0; channelIdx<nchans; channelIdx++) {
      if (elec_provider.ExtraInfo(channelIdx).GetBoolData("is_misconfigured")) {
        miscfgchan.push_back(channelIdx);
      }
    }
    
    const double from_gain_mVfC=4.7, to_gain_mVfC=14.0,from_shaping=1.0*units::microsecond, to_shaping=2.0*units::microsecond;
    
    // Recover bad channels from the database
    std::vector<int> bad_channels;
    for(int channelIdx=0; channelIdx<nchans; channelIdx++) if (channelStatus.IsBad(channelIdx)) bad_channels.push_back(channelIdx);
    
    // Q&D RC+RC time constant - all have same.
    const double rcrc = 1.0*units::millisecond;
    std::vector<int> rcrcchans(nchans);
    std::iota(rcrcchans.begin(), rcrcchans.end(), 0);
    
    //harmonic noises
    std::vector<int> harmonicchans(uchans.size() + vchans.size());
    std::iota(harmonicchans.begin(), harmonicchans.end(), 0);
    
    std::vector<int> special_chans;
    special_chans.push_back(2240);
    
    WireCell::SigProc::SimpleChannelNoiseDB::mask_t h36kHz(0,169,173);
    WireCell::SigProc::SimpleChannelNoiseDB::mask_t h108kHz(0,513,516);
    WireCell::SigProc::SimpleChannelNoiseDB::mask_t hspkHz(0,17,19);
    WireCell::SigProc::SimpleChannelNoiseDB::multimask_t hharmonic;
    hharmonic.push_back(h36kHz);
    hharmonic.push_back(h108kHz);
    WireCell::SigProc::SimpleChannelNoiseDB::multimask_t hspecial;
    hspecial.push_back(h36kHz);
    hspecial.push_back(h108kHz);
    hspecial.push_back(hspkHz);
   
    float u_resp_array[120]={0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.364382, 0.387949, 0.411053, 0.433979, 0.456863, 0.479746, 0.502641, 0.52554, 0.548441, 0.57134, 0.591765, 0.609448, 0.626848, 0.644094, 0.661364, 0.678859, 0.695231, 0.710462, 0.726147, 0.742373, 0.761332, 0.783313, 0.806325, 0.830412, 0.857676, 0.888412, 0.920705, 0.954624, 0.990242, 1.02766, 1.06121, 1.09027, 1.12037, 1.15157, 1.18392, 1.21748, 1.25229, 1.28824, 1.32509, 1.36256, 1.40051, 1.43907, 1.47857, 1.51933, 1.56134, 1.60404, 1.72665, 1.94005, 2.16994, 2.42041, 2.69475, 3.07222, 3.67375, 4.60766, 5.91864, 7.30178, 8.3715, 8.94736, 8.93705, 8.40339, 7.2212, 5.76382, 3.8931, 1.07893, -3.52481, -11.4593, -20.4011, -29.1259, -34.9544, -36.9358, -35.3303, -31.2068, -25.8614, -20.3613, -15.3794, -11.2266, -7.96091, -5.50138, -3.71143, -2.44637, -1.57662, -0.99733, -0.62554, -0.393562, -0.249715, -0.15914, -0.100771, -0.062443, -0.037283, -0.0211508, -0.0112448, -0.00552085, -0.00245133, -0.000957821, -0.000316912, -8.51679e-05, -2.21299e-05, -1.37496e-05, -1.49806e-05, -1.36935e-05, -9.66758e-06, -5.20773e-06, -7.4787e-07, 3.71199e-06, 8.17184e-06, 1.26317e-05, 1.70916e-05, 2.15514e-05, 2.60113e-05, 3.04711e-05};
    float v_resp_array[120]={0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0865303, 0.0925559, 0.0983619, 0.104068, 0.109739, 0.115403, 0.121068, 0.126735, 0.132403, 0.138072, 0.143739, 0.149408, 0.155085, 0.160791, 0.166565, 0.172454, 0.178514, 0.184795, 0.191341, 0.198192, 0.205382, 0.212944, 0.220905, 0.229292, 0.238129, 0.247441, 0.257256, 0.267601, 0.278502, 0.28999, 0.298745, 0.304378, 0.310105, 0.315921, 0.321818, 0.327796, 0.333852, 0.339967, 0.346098, 0.352169, 0.358103, 0.363859, 0.36945, 0.374915, 0.380261, 0.385401, 0.39016, 0.394378, 0.39804, 0.401394, 0.405145, 0.410714, 0.4205, 0.437951, 0.467841, 0.516042, 0.587738, 0.694157, 0.840763, 1.01966, 1.22894, 1.5612, 2.12348, 3.31455, 5.59355, 9.10709, 14.1756, 18.4603, 19.9517, 17.4166, 10.6683, 1.40656, -10.0638, -19.034, -23.654, -24.0558, -21.4418, -17.3229, -12.9485, -9.08912, -6.05941, -3.86946, -2.38669, -1.43678, -0.853335, -0.503951, -0.296551, -0.173029, -0.0990099, -0.0547172, -0.0287882, -0.0142758, -0.00661815, -0.00284757, -0.00115702, -0.000456456, -0.000183439, -8.04214e-05, -4.20533e-05, -2.62903e-05, -1.64098e-05, -6.68039e-06, 3.04903e-06, 1.27784e-05, 2.25079e-05, 3.22373e-05, 4.19667e-05, 5.16961e-05, 6.14255e-05, 7.11549e-05};
    WireCell::Waveform::realseq_t u_resp(nsamples);
    WireCell::Waveform::realseq_t v_resp(nsamples);
    for (int i=0;i!=120;i++){
      u_resp.at(i) = u_resp_array[i];
      v_resp.at(i) = v_resp_array[i];
    }
    WireCell::Waveform::compseq_t u_resp_freq = WireCell::Waveform::dft(u_resp);
    WireCell::Waveform::compseq_t v_resp_freq = WireCell::Waveform::dft(v_resp);
    
    int uplane_time_shift = 79;
    int vplane_time_shift = 82;
 
    // do the coherent subtraction
    std::vector< std::vector<int> > channel_groups;
    for (unsigned int i=0;i!=172;i++){
        //for (int i=150;i!=151;i++){
        std::vector<int> channel_group;
        for (int j=0;j!=48;j++){
            channel_group.push_back(i*48+j);
        }
        channel_groups.push_back(channel_group);
    }
    
    auto noise = new WireCell::SigProc::SimpleChannelNoiseDB;
    // initialize
    noise->set_sampling(tick, nsamples);
    // set nominal baseline
    noise->set_nominal_baseline(uchans, unombl);
    noise->set_nominal_baseline(vchans, vnombl);
    noise->set_nominal_baseline(wchans, wnombl);

    noise->set_response(uchans,u_resp_freq);
    noise->set_response(vchans,v_resp_freq);

    noise->set_response_offset(uchans,uplane_time_shift);
    noise->set_response_offset(vchans,vplane_time_shift);

    noise->set_pad_window_front(uchans,20);
    noise->set_pad_window_back(uchans,10);
    noise->set_pad_window_front(vchans,10);
    noise->set_pad_window_back(vchans,10);
    noise->set_pad_window_front(wchans,10);
    noise->set_pad_window_back(wchans,10);

    // set misconfigured channels
    noise->set_gains_shapings(miscfgchan, from_gain_mVfC, to_gain_mVfC, from_shaping, to_shaping);
    // do the RCRC
    noise->set_rcrc_constant(rcrcchans, rcrc);
    // set initial bad channels
    noise->set_bad_channels(bad_channels);
    // set the harmonic filter
    noise->set_filter(harmonicchans,hharmonic);
    noise->set_filter(special_chans,hspecial);
    noise->set_channel_groups(channel_groups);
    
    for (unsigned int i=0;i!=uchans.size();i++){
      if (uchans.at(i)<100){
        noise->set_min_rms_cut_one(uchans.at(i),1);
        noise->set_max_rms_cut_one(uchans.at(i),5);
      }else if (uchans.at(i)<2000){
        noise->set_min_rms_cut_one(uchans.at(i),1.9);
        noise->set_max_rms_cut_one(uchans.at(i),11);
      }else{
        noise->set_min_rms_cut_one(uchans.at(i),0.9);
        noise->set_max_rms_cut_one(uchans.at(i),5);
      }
    }
    for (unsigned int i=0;i!=vchans.size();i++){
      if (vchans.at(i)<290+ (int) uchans.size()){
        noise->set_min_rms_cut_one(vchans.at(i),1);
        noise->set_max_rms_cut_one(vchans.at(i),5);
      }else if (vchans.at(i)<2200+(int) uchans.size()){
        noise->set_min_rms_cut_one(vchans.at(i),1.9);
        noise->set_max_rms_cut_one(vchans.at(i),11);
      }else{
        noise->set_min_rms_cut_one(vchans.at(i),1);
        noise->set_max_rms_cut_one(vchans.at(i),5);
      }
    }

    // these are the one after the Hardware Fix
    if( runNum > 8000 ){
      for (unsigned int i=0;i!=uchans.size();i++){
        if (uchans.at(i)<600){
          noise->set_min_rms_cut_one(uchans.at(i),1+(1.7-1)/600.*i);
          noise->set_max_rms_cut_one(uchans.at(i),5);
        }else if (uchans.at(i)<1800){
          noise->set_min_rms_cut_one(uchans.at(i),1.7);
          noise->set_max_rms_cut_one(uchans.at(i),11);
        }else{
          noise->set_min_rms_cut_one(uchans.at(i),1+ (1.7-1)/600.*(2399-i));
          noise->set_max_rms_cut_one(uchans.at(i),5);
        }
      }
      for (unsigned int i=0;i!=vchans.size();i++){
        if (vchans.at(i)<600+(int)uchans.size()){
          noise->set_min_rms_cut_one(vchans.at(i),0.8+(1.7-0.8)/600.*i);
          noise->set_max_rms_cut_one(vchans.at(i),5);
        }else if (vchans.at(i)<1800+(int)uchans.size()){
          noise->set_min_rms_cut_one(vchans.at(i),1.7);
          noise->set_max_rms_cut_one(vchans.at(i),11);
        }else{
          noise->set_min_rms_cut_one(vchans.at(i),0.8+ (1.7-0.8)/600.*(2399-i));
          noise->set_max_rms_cut_one(vchans.at(i),5);
        }
      }
    }

    noise->set_min_rms_cut(wchans,1.3);
    noise->set_max_rms_cut(wchans,8.0);

    //Define database object
    std::shared_ptr<WireCell::IChannelNoiseDatabase> noise_sp(noise);
    
    auto one = new WireCell::SigProc::Microboone::OneChannelNoise;
    one->set_channel_noisedb(noise_sp);
    std::shared_ptr<WireCell::IChannelFilter> one_sp(one);
    auto many = new WireCell::SigProc::Microboone::CoherentNoiseSub;
    many->set_channel_noisedb(noise_sp);
    std::shared_ptr<WireCell::IChannelFilter> many_sp(many);
    
    //define noisefilter object
    WireCell::SigProc::OmnibusNoiseFilter bus;
    bus.set_channel_filters({one_sp});
    bus.set_grouped_filters({many_sp});
    bus.set_channel_noisedb(noise_sp);
    
    // Enable truncation
    size_t startBin(fNumTicksToDropFront);
    size_t stopBin(startBin + windowSize);
    
    //load waveforms into traces
    WireCell::ITrace::vector traces;
    for(unsigned int ich=0; ich<n_channels; ich++)
    {
        if( inputWaveforms.at(ich).NADC() < windowSize ) continue;
        
        const raw::RawDigit::ADCvector_t& rawAdcVec = inputWaveforms.at(ich).ADCs();
        
        WireCell::ITrace::ChargeSequence charges;
        
        charges.resize(nsamples);
        
        std::transform(rawAdcVec.begin(), rawAdcVec.end(), charges.begin(), [](auto& adcVal){return float(adcVal);});
        
        unsigned int chan = inputWaveforms.at(ich).Channel();
        WireCell::SimpleTrace* st = new WireCell::SimpleTrace(chan, 0.0, charges);
        traces.push_back(WireCell::ITrace::pointer(st));
    }
    
    //Load traces into frame
    WireCell::SimpleFrame*    sf    = new WireCell::SimpleFrame(0, 0, traces);
    WireCell::IFrame::pointer frame = WireCell::IFrame::pointer(sf);
    WireCell::IFrame::pointer quiet = NULL;
   
    //Do filtering
    bus(frame, quiet);

    //std::cout << "HERE" << std::endl;
    //return;
    if( quiet == NULL )
        return;

    //Output results
    std::vector< short > waveform(windowSize);
    
    auto quiet_traces = quiet->traces();
    for (auto quiet_trace : *quiet_traces.get()) {
        //int tbin = quiet_trace->tbin();
        unsigned int channel = quiet_trace->channel();
        
        auto& quiet_charges = quiet_trace->charge();
        
        // Recover the database version of the pedestal, we'll offset the waveforms so it matches
        float pedestal = pedestalValues.PedMean(channel);
        
        std::transform(quiet_charges.begin() + startBin, quiet_charges.begin() + stopBin, waveform.begin(), [pedestal](auto charge){return std::round(charge+pedestal);});
        
        outputWaveforms.emplace_back( raw::RawDigit( channel , waveform.size(), waveform, raw::kNone) );
        outputWaveforms.back().SetPedestal(pedestal,1.75);
    }
    
    return;
}

void noisefilteralg::WireCellNoiseFilter::endJob ( )

virtual

Reimplemented from art::EDProducer.

Definition at line 98 of file WireCellNoiseFilter_module.cc.

                                {
    art::ServiceHandle<art::TFileService> tfs;
}

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 noisefilteralg::WireCellNoiseFilter::produce ( art::Event &  evt )

virtual

Implements art::EDProducer.

Definition at line 103 of file WireCellNoiseFilter_module.cc.

References DoNoiseFilter(), fDigitModuleLabel, fDoNoiseFiltering, fNumTicksToDropFront, fWindowSize, art::DataViewImpl::getByLabel(), art::Handle< T >::isValid(), raw::kNone, min, art::Event::put(), and art::Event::run().

{
    // Recover services we will need
    const lariov::DetPedestalProvider& pedestalValues = art::ServiceHandle<lariov::DetPedestalService>()->GetPedestalProvider();
    
    art::Handle< std::vector<raw::RawDigit> > rawDigitHandle;
    evt.getByLabel(fDigitModuleLabel,rawDigitHandle);
    
    // Define the output vector (in case we don't do anything)
    std::unique_ptr<std::vector<raw::RawDigit> > filteredRawDigit(new std::vector<raw::RawDigit>);
    
    if (rawDigitHandle.isValid() && rawDigitHandle->size() > 0)
    {
        const std::vector<raw::RawDigit>& rawDigitVector(*rawDigitHandle);
        
        // Make sure we have the correct window size (e.g. window size = 9600 but data is 9595)
        size_t windowSize(std::min(fWindowSize,rawDigitVector.at(0).NADC()));
        
        if (fNumTicksToDropFront + windowSize > rawDigitVector.at(0).NADC())
            throw cet::exception("WireCellNoiseFilter") << "Ticks to drop + windowsize larger than input buffer\n";
        
        if (fDoNoiseFiltering) DoNoiseFilter(evt.run(), rawDigitVector, *filteredRawDigit);
        else
        {
            // Enable truncation
            size_t startBin(fNumTicksToDropFront);
            size_t stopBin(startBin + windowSize);
            
            raw::RawDigit::ADCvector_t outputVector(windowSize);
            
            for(const auto& rawDigit : rawDigitVector)
            {
                if (rawDigit.NADC() < windowSize) continue;
                
                const raw::RawDigit::ADCvector_t& rawAdcVec = rawDigit.ADCs();
                
                unsigned int channel  = rawDigit.Channel();
                float        pedestal = pedestalValues.PedMean(channel);
                
                std::copy(rawAdcVec.begin() + startBin, rawAdcVec.begin() + stopBin, outputVector.begin());
                
                filteredRawDigit->emplace_back( raw::RawDigit( channel , outputVector.size(), outputVector, raw::kNone) );
                filteredRawDigit->back().SetPedestal(pedestal,2.0);
            }
        }
    }

    //filtered raw digits       
    evt.put(std::move(filteredRawDigit));
}

void noisefilteralg::WireCellNoiseFilter::reconfigure

(

fhicl::ParameterSet const &

pset

)

Definition at line 83 of file WireCellNoiseFilter_module.cc.

References fDigitModuleLabel, fDoNoiseFiltering, fNumTicksToDropFront, fWindowSize, and fhicl::ParameterSet::get().

Referenced by WireCellNoiseFilter().

                                                                  {
    fDigitModuleLabel    = pset.get<std::string>("DigitModuleLabel",    "daq");
    fDoNoiseFiltering    = pset.get<bool>       ("DoNoiseFiltering",    true );
    fNumTicksToDropFront = pset.get<size_t>     ("NumTicksToDropFront", 2400 );
    fWindowSize          = pset.get<size_t>     ("WindowSize",          6400 );
}

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 noisefilteralg::WireCellNoiseFilter::fDigitModuleLabel

private

Definition at line 62 of file WireCellNoiseFilter_module.cc.

Referenced by produce(), and reconfigure().

bool noisefilteralg::WireCellNoiseFilter::fDoNoiseFiltering

private

Definition at line 63 of file WireCellNoiseFilter_module.cc.

Referenced by produce(), and reconfigure().

size_t noisefilteralg::WireCellNoiseFilter::fNumTicksToDropFront

private

Definition at line 64 of file WireCellNoiseFilter_module.cc.

Referenced by DoNoiseFilter(), produce(), and reconfigure().

size_t noisefilteralg::WireCellNoiseFilter::fWindowSize

private

Definition at line 65 of file WireCellNoiseFilter_module.cc.

Referenced by DoNoiseFilter(), produce(), and reconfigure().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larwirecell/v07_05_02/source/larwirecell/LArInterface/WireCellNoiseFilter_module.cc