INoiseFilter.h

Go to the documentation of this file.

/**
 *  @file   INoiseFilter.h
 *
 *  @brief  This provides an art tool interface definition for tools which "decode" artdaq 
 *          fragments into LArSoft data objects
 *
 *  @author usher@slac.stanford.edu
 *
 */
#ifndef INoiseFilter_h
#define INoiseFilter_h

// Framework Includes
#include "fhiclcpp/ParameterSet.h"
#include "art/Framework/Principal/Event.h"

// Algorithm includes
#include "artdaq-core/Data/Fragment.hh"
namespace detinfo {
  class DetectorClocksData;
}

#include "icarus_signal_processing/ICARUSSigProcDefs.h"

//------------------------------------------------------------------------------------------------------------------------------------------

namespace daq
{
/**
 *  @brief  IDecoderFilter interface class definiton
 */
class INoiseFilter
{
public:
    /**
     *  @brief  Virtual Destructor
     */
    virtual ~INoiseFilter() noexcept = default;

    /**
     *  @brief Interface for configuring the particular algorithm tool
     *
     *  @param ParameterSet  The input set of parameters for configuration
     */
    virtual void configure(const fhicl::ParameterSet&) = 0;

    /**
     *  @brief Given a set of recob hits, run DBscan to form 3D clusters
     *
     *  @param ChannelVec           list of channels associated to input data array
     *  @param ArrayFloat           array by channel of the waveforms
     */
    using ChannelPlanePair = std::pair<unsigned int,unsigned int>;
    using ChannelPlaneVec  = std::vector<ChannelPlanePair>;

    virtual void process_fragment(detinfo::DetectorClocksData const&,
                                  const daq::INoiseFilter::ChannelPlaneVec&,
                                  const icarus_signal_processing::ArrayFloat&,
                                  const size_t&) = 0;

    /**
     *  @brief Recover the channels for the processed fragment
     */
    virtual const icarus_signal_processing::VectorInt&  getChannelIDs()        const = 0;

    /**
     *  @brief Recover the selection values
     */
    virtual const icarus_signal_processing::ArrayBool&  getSelectionVals()     const = 0;

    /**
     *  @brief Recover the ROI values
     */
    virtual const icarus_signal_processing::ArrayBool&  getROIVals()           const = 0;

    /**
     *  @brief Recover the original raw waveforms
     */
    virtual const icarus_signal_processing::ArrayFloat& getRawWaveforms()      const = 0;

    /**
     *  @brief Recover the pedestal corrected waveforms
     */
    virtual const icarus_signal_processing::ArrayFloat& getPedCorWaveforms()   const = 0;

    /**
     *  @brief Recover the "intrinsic" RMS
     */
    virtual const icarus_signal_processing::ArrayFloat& getIntrinsicRMS()      const = 0;

    /**
     *  @brief Recover the correction median values
     */
    virtual const icarus_signal_processing::ArrayFloat& getCorrectedMedians()  const = 0;

    /**
     *  @brief Recover the waveforms less coherent noise
     */
    virtual const icarus_signal_processing::ArrayFloat& getWaveLessCoherent()  const = 0;

    /**
     *  @brief Recover the morphological filter waveforms
     */
    virtual const icarus_signal_processing::ArrayFloat& getMorphedWaveforms()  const = 0;

    /**
     *  @brief Recover the pedestals for each channel
     */
    virtual const icarus_signal_processing::VectorFloat& getPedestalVals()     const = 0;

    /**
     *  @brief Recover the full RMS before coherent noise
     */
    virtual const icarus_signal_processing::VectorFloat& getFullRMSVals()      const = 0;
 
    /**
     *  @brief Recover the truncated RMS noise 
     */
    virtual const icarus_signal_processing::VectorFloat& getTruncRMSVals()     const = 0;

    /**
     *  @brief Recover the number of bins after truncation
     */
    virtual const icarus_signal_processing::VectorInt&   getNumTruncBins() const = 0;
 
};

} // namespace lar_cluster3d
#endif