WireCell::SigProc::Microboone::OneChannelNoise Class Reference

#include <Microboone.h>

Inheritance diagram for WireCell::SigProc::Microboone::OneChannelNoise:

Public Member Functions
	OneChannelNoise (const std::string &anode_tn="AnodePlane", const std::string &noisedb="OmniChannelNoiseDB")
virtual	~OneChannelNoise ()
virtual WireCell::Waveform::ChannelMaskMap	apply (int channel, signal_t &sig) const
virtual WireCell::Waveform::ChannelMaskMap	apply (channel_signals_t &chansig) const
Public Member Functions inherited from WireCell::IChannelFilter
virtual	~IChannelFilter ()
Public Member Functions inherited from WireCell::IComponent< IChannelFilter >
virtual	~IComponent ()
Public Member Functions inherited from WireCell::Interface
virtual	~Interface ()
Public Member Functions inherited from WireCell::SigProc::Microboone::ConfigFilterBase
	ConfigFilterBase (const std::string &anode="AnodePlane", const std::string &noisedb="OmniChannelNoiseDB")
virtual	~ConfigFilterBase ()
virtual void	configure (const WireCell::Configuration &config)
	IConfigurable configuration interface. More...
virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...
void	set_channel_noisedb (WireCell::IChannelNoiseDatabase::pointer ndb)
Public Member Functions inherited from WireCell::IConfigurable
virtual	~IConfigurable ()
Public Member Functions inherited from WireCell::IComponent< IConfigurable >
virtual	~IComponent ()

Private Attributes
Diagnostics::Chirp	m_check_chirp
Diagnostics::Partial	m_check_partial

Additional Inherited Members
Public Types inherited from WireCell::IChannelFilter
typedef Waveform::realseq_t	signal_t
typedef std::map< int, signal_t >	channel_signals_t
Public Types inherited from WireCell::IComponent< IChannelFilter >
typedef std::shared_ptr< IChannelFilter >	pointer
	Access subclass facet by pointer. More...
typedef std::vector< pointer >	vector
	Vector of shared pointers. More...
Public Types inherited from WireCell::Interface
typedef std::shared_ptr< Interface >	pointer
Public Types inherited from WireCell::IComponent< IConfigurable >
typedef std::shared_ptr< IConfigurable >	pointer
	Access subclass facet by pointer. More...
typedef std::vector< pointer >	vector
	Vector of shared pointers. More...
Protected Attributes inherited from WireCell::SigProc::Microboone::ConfigFilterBase
std::string	m_anode_tn
std::string	m_noisedb_tn
IAnodePlane::pointer	m_anode
IChannelNoiseDatabase::pointer	m_noisedb

Detailed Description

Microboone style single channel noise subtraction.

Fixme: in principle, this class could be general purpose for other detectors. However, it uses the functions above which hard code microboone-isms. If those microboone-specific parameters can be pulled out to a higher layer then this class can become generic and move outside of this file.

Definition at line 97 of file Microboone.h.

Constructor & Destructor Documentation

Microboone::OneChannelNoise::OneChannelNoise	(	const std::string &	anode_tn = "AnodePlane",
		const std::string &	noisedb = "OmniChannelNoiseDB"
	)

Definition at line 956 of file Microboone.cxx.

    : ConfigFilterBase(anode, noisedb)
    , m_check_chirp() // fixme, there are magic numbers hidden here
    , m_check_partial() // fixme, here too.
{
}

Microboone::OneChannelNoise::~OneChannelNoise ( )

virtual

Definition at line 962 of file Microboone.cxx.

{
}

Member Function Documentation

WireCell::Waveform::ChannelMaskMap Microboone::OneChannelNoise::apply ( int  channel, signal_t &  sig  ) const

virtual

Filter in place the signal sig from given channel.

Implements WireCell::IChannelFilter.

Definition at line 966 of file Microboone.cxx.

{
    WireCell::Waveform::ChannelMaskMap ret;

    // sanity check data/config match.
    const size_t nsiglen = signal.size();
    int nmismatchlen = 0;

    // fixme: some channels are just bad can should be skipped.

    // get signal with nominal baseline correction
    float baseline = m_noisedb->nominal_baseline(ch);

    // get signal with nominal gain correction 
    float gc = m_noisedb->gain_correction(ch);
    WireCell::Waveform::increase(signal, baseline *(-1));

    auto signal_gc = signal; // copy, need to keep original signal
    
    WireCell::Waveform::scale(signal_gc, gc);
    
    // std::cerr << "OneChannelNoise: ch="<<ch<<" gain scaled sum=" << Waveform::sum(signal_gc)
    //           << std::endl;;


    // determine if chirping
    WireCell::Waveform::BinRange chirped_bins;
    bool is_chirp = m_check_chirp(signal_gc, chirped_bins.first, chirped_bins.second);
    if (is_chirp) {
      ret["chirp"][ch].push_back(chirped_bins);
       
      auto wpid = m_anode->resolve(ch);      
      const int iplane = wpid.index();

      if (iplane!=2){ // not collection
          if (chirped_bins.first>0 || chirped_bins.second<int(signal.size())){
              ret["lf_noisy"][ch].push_back(chirped_bins);
              //std::cout << "Chirp " << ch << std::endl;
          }
      }
    }

    auto spectrum = WireCell::Waveform::dft(signal);
    //std::cerr << "OneChannelNoise: "<<ch<<" dft spectral sum="<<Waveform::sum(spectrum)<<"\n";

    bool is_partial = m_check_partial(spectrum); // Xin's "IS_RC()"
    
    int nspec=0;                // just catch any non-zero
    if (!is_partial) {
        auto const& spec = m_noisedb->rcrc(ch);
        WireCell::Waveform::shrink(spectrum, spec);

        if (nsiglen != spec.size()) {
            ++nmismatchlen;
            nspec=spec.size();
        }
    }

    {
        auto const& spec = m_noisedb->config(ch);
        WireCell::Waveform::scale(spectrum, spec);

        if (nsiglen != spec.size()) {
            ++nmismatchlen;
            nspec=spec.size();
        }
    }

    {
        auto const& spec = m_noisedb->noise(ch);
        WireCell::Waveform::scale(spectrum, spec);

        if (nsiglen != spec.size()) {
            ++nmismatchlen;
            nspec=spec.size();
        }
    }

    if (nmismatchlen) {
        std::cerr << "OneChannelNoise: WARNING: "<<nmismatchlen << " config/data mismatches. "
                  << "#spec="<<nspec <<", #wave=" << nsiglen << ".\n"
                  << "\tResults may be suspect."
                  << std::endl;
    }

    // remove the DC component 
    spectrum.front() = 0;
    signal = WireCell::Waveform::idft(spectrum);
    
    //std::cerr << "OneChannelNoise: "<<ch<<" after dft: sigsum="<<Waveform::sum(signal)<<"\n";

    //Now calculate the baseline ...
    std::pair<double,double> temp = WireCell::Waveform::mean_rms(signal);
    auto temp_signal = signal;
    for (size_t i=0;i!=temp_signal.size();i++){
        if (fabs(temp_signal.at(i)-temp.first)>6*temp.second){
            temp_signal.at(i) = temp.first;
        }
    }
    baseline = WireCell::Waveform::median_binned(temp_signal);
    //correct baseline
    WireCell::Waveform::increase(signal, baseline *(-1));


    //*** from here down is where things become way too microboone
    //*** specific and are basically copy-pasted from the prototype


    // Now do adaptive baseline for the chirping channels
    if (is_chirp) {
        Microboone::Chirp_raise_baseline(signal,chirped_bins.first, chirped_bins.second);
        Microboone::SignalFilter(signal);
        Microboone::RawAdapativeBaselineAlg(signal);
    }
    // Now do the adaptive baseline for the bad RC channels
    if (is_partial) {
        // add something
        WireCell::Waveform::BinRange temp_chirped_bins;
        temp_chirped_bins.first = 0;
        temp_chirped_bins.second = signal.size();

        auto wpid = m_anode->resolve(ch);
        const int iplane = wpid.index();
        if (iplane!=2) {        // not collection
            ret["lf_noisy"][ch].push_back(temp_chirped_bins);
            //std::cout << "Partial " << ch << std::endl;
        }
        Microboone::SignalFilter(signal);
        Microboone::RawAdapativeBaselineAlg(signal);
    }

    // std::cerr << "OneChannelNoise: "<<ch<<" before SignalFilter: sigsum="<<Waveform::sum(signal)<<"\n";

    // Identify the Noisy channels ... 
    Microboone::SignalFilter(signal);

    //
    const float min_rms = m_noisedb->min_rms_cut(ch);
    const float max_rms = m_noisedb->max_rms_cut(ch);
    
    //std::cerr << "OneChannelNoise: "<<ch<< " RMS:["<<min_rms<<","<<max_rms<<"] sigsum="<<Waveform::sum(signal)<<"\n";

    bool is_noisy = Microboone::NoisyFilterAlg(signal,min_rms,max_rms);
    Microboone::RemoveFilterFlags(signal);

    if (is_noisy) {
        // std::cerr << "OneChannelNoise: "<<ch
        //           <<" is_noisy="<<is_noisy
        //           <<", is_chirp="<<is_chirp
        //           <<", is_partial="<<is_partial
        //           <<", baseline="<<baseline<<std::endl;

        chirped_bins.first = 0;
        chirped_bins.second = signal.size();
        ret["noisy"][ch].push_back(chirped_bins);

        if (ret.find("lf_noisy") != ret.end()) {
            if(ret["lf_noisy"].find(ch)!=ret["lf_noisy"].end())
                ret["lf_noisy"].erase(ch);
        }
        
    }

    return ret;
}

WireCell::Waveform::ChannelMaskMap Microboone::OneChannelNoise::apply ( channel_signals_t &  chansig ) const

virtual

Filter in place a group of signals together.

Implements WireCell::IChannelFilter.

Definition at line 1134 of file Microboone.cxx.

{
    return WireCell::Waveform::ChannelMaskMap();
}

Member Data Documentation

Diagnostics::Chirp WireCell::SigProc::Microboone::OneChannelNoise::m_check_chirp

private

Definition at line 115 of file Microboone.h.

Diagnostics::Partial WireCell::SigProc::Microboone::OneChannelNoise::m_check_partial

private

Definition at line 116 of file Microboone.h.

---

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

• wire-cell-build/sigproc/inc/WireCellSigProc/Microboone.h
• wire-cell-build/sigproc/src/Microboone.cxx