PlaneImpactResponse.h

Go to the documentation of this file.

#ifndef WIRECELLGEN_PLANEIMPACTRESPONSE
#define WIRECELLGEN_PLANEIMPACTRESPONSE

#include "WireCellIface/IPlaneImpactResponse.h"
#include "WireCellIface/IConfigurable.h"

#include "WireCellUtil/Waveform.h"
#include "WireCellUtil/Units.h"
#include "WireCellUtil/Logging.h"

namespace WireCell {

    namespace Gen {

    /** The information about detector response at a particular impact
     * position (discrete position along the pitch direction of a
     * plane on which a response function is defined).  Note,
     * different physical positions may share the same ImpactResponse.
     */
    class ImpactResponse : public IImpactResponse {
        int m_impact;
        Waveform::compseq_t m_spectrum;
        Waveform::realseq_t m_waveform;
        int m_waveform_pad;

        Waveform::compseq_t m_long_spectrum;
        Waveform::realseq_t m_long_waveform;
        int m_long_waveform_pad;

    public:
        ImpactResponse(int impact, const Waveform::realseq_t& wf, int waveform_pad, const Waveform::realseq_t& long_wf, int long_waveform_pad)
          : m_impact(impact), m_waveform(wf), m_waveform_pad(waveform_pad)
          , m_long_waveform(long_wf), m_long_waveform_pad(long_waveform_pad)
        {}

        /// Frequency-domain spectrum of response
        const Waveform::compseq_t& spectrum();
        const Waveform::realseq_t& waveform() const {return m_waveform;};
        int waveform_pad() const {return m_waveform_pad;};

        const Waveform::compseq_t& long_aux_spectrum();
        const Waveform::realseq_t& long_aux_waveform() const {return m_long_waveform;};
        int long_aux_waveform_pad() const {return m_long_waveform_pad;};
        
        

        /// Corresponding impact number
        int impact() const { return m_impact; }

    };

    /** Collection of all impact responses for a plane */
    class PlaneImpactResponse : public IPlaneImpactResponse, public IConfigurable {
    public:

        /** Create a PlaneImpactResponse.

            Field response is assumed to be normalized in units of current.

            Pre-amplifier gain and peaking time is that of the FE
            electronics.  The preamp gain should be in units
            consistent with the field response.  If 0.0 then no
            electronics response will be convolved.

            A flat post-FEE amplifier gain can also be given to
            provide a global scaling of the output of the electronics.

            Fixme: field response should be provided by a component.
         */
        PlaneImpactResponse(int plane_ident = 0,
                            size_t nbins = 10000,
                            double tick = 0.5*units::us);
        ~PlaneImpactResponse();

        // IConfigurable interface
        virtual void configure(const WireCell::Configuration& cfg);
        virtual WireCell::Configuration default_configuration() const;

        /// Return the response at the impact position closest to
        /// the given relative pitch location (measured relative
        /// to the wire of interest).
        virtual IImpactResponse::pointer closest(double relpitch) const;

        /// Return the two responses which are associated with the
        /// impact positions on either side of the given pitch
        /// location (measured relative to the wire of interest).
        virtual TwoImpactResponses bounded(double relpitch) const;

        double pitch_range() const { return 2.0*m_half_extent; }
        double pitch() const { return m_pitch; }
        double impact() const { return m_impact; }

        int nwires() const { return m_bywire.size(); }

        size_t nbins() const { return m_nbins; }

        /// not in the interface
        int nimp_per_wire() const { return m_bywire[0].size(); }
        typedef std::vector<int> region_indices_t;
        typedef std::vector<region_indices_t> wire_region_indicies_t;
        const wire_region_indicies_t& bywire_map() const { return m_bywire; }
        std::pair<int,int> closest_wire_impact(double relpitch) const;


    private:
        std::string m_frname;
        std::vector<std::string> m_short;
        double m_overall_short_padding;
        std::vector<std::string> m_long;
        double m_long_padding;
        
        int m_plane_ident;
        size_t m_nbins;
        double m_tick;

        wire_region_indicies_t m_bywire;

        std::vector<IImpactResponse::pointer> m_ir;
        double m_half_extent, m_pitch, m_impact;

        Log::logptr_t l;

        void build_responses();

    };

}}

#endif