Fourdee.h

Go to the documentation of this file.

#ifndef WIRECELL_FOURDEE_H
#define WIRECELL_FOURDEE_H

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

#include "WireCellIface/IDepoSource.h"
#include "WireCellIface/IDepoFilter.h"
#include "WireCellIface/IDrifter.h"
#include "WireCellIface/IDuctor.h"
#include "WireCellIface/IFrameSource.h"
#include "WireCellIface/IFrameFilter.h"
#include "WireCellIface/IFrameSink.h"

#include "WireCellUtil/Configuration.h"


namespace WireCell {
    namespace Gen {

        /**

           Fourdee is a Wire Cell Toolkit application class which
           handles a chain of "the 4 D's": deposition, drifting,
           "ducting" (induction response) and digitization.  There is
           an optional "5th D": "dissonance" which provides a source
           of noise to be summed.

           Each step provided by a model implemented as an instance of the
           associated component class.  A final sink is also provided if
           the digitization output is provided.

        */
        class Fourdee : public WireCell::IApplication, public WireCell::IConfigurable {

        public:
            Fourdee();
            virtual ~Fourdee();

            virtual void execute();
            virtual void execute_old();
            virtual void execute_new();

            virtual void configure(const WireCell::Configuration& config);
            virtual WireCell::Configuration default_configuration() const;

        private:

            WireCell::IDepoSource::pointer m_depos; // required
            WireCell::IDepoFilter::pointer m_depofilter; // optional
            WireCell::IDrifter::pointer m_drifter;       // optional, but likely
            WireCell::IDuctor::pointer m_ductor;         // effectively required
            WireCell::IFrameSource::pointer m_dissonance; // optional
            WireCell::IFrameFilter::pointer m_digitizer;  // optional
            WireCell::IFrameFilter::pointer m_filter;     // optional
            WireCell::IFrameSink::pointer m_output;       // optional
        };
    }
}

#endif