IROILocator.h

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////
///
/// \file   IROILocator.h
///
/// \brief  This provides an interface for tools which are tasked with
///         finding ROI's in input waveforms. This allows different
///         approaches to be tried interchangeably
///
/// \author T. Usher
///
////////////////////////////////////////////////////////////////////////

#ifndef IROILocator_H
#define IROILocator_H

#include "fhiclcpp/ParameterSet.h"
#include "larcore/Geometry/Geometry.h"
#include "art/Framework/Principal/Event.h" 
#include "larcoreobj/SimpleTypesAndConstants/RawTypes.h"

namespace art { class TFileDirectory; }

namespace icarus_tool
{
    class IROILocator
    {
    public:
        virtual ~IROILocator() noexcept = default;
        
        virtual void configure(const fhicl::ParameterSet& pset) = 0;
        virtual void initializeHistograms(art::TFileDirectory&) = 0;
        
        // Define the waveform container
        using VectorBool  = std::vector<bool>;
        using VectorFloat = std::vector<float>;
        using ArrayBool   = std::vector<VectorBool>;
        using ArrayFloat  = std::vector<VectorFloat>;

        using PlaneIDVec  = std::vector<geo::PlaneID>;
        
        // Find the ROI's
        virtual void FindROIs(const art::Event&, const ArrayFloat&, const std::vector<raw::ChannelID_t>&, const geo::PlaneID&, ArrayFloat&, ArrayBool&) = 0;
    };
}

#endif