img::DataProviderAlg Class Reference

#include "DataProviderAlg.h"

Inheritance diagram for img::DataProviderAlg:

Classes
struct	Config

Public Types
enum	EDownscaleMode { kMax = 1, kMaxMean = 2, kMean = 3 }

Public Member Functions
	DataProviderAlg (const fhicl::ParameterSet &pset)
	DataProviderAlg (const Config &config)
virtual	~DataProviderAlg (void)
bool	setWireDriftData (const std::vector< recob::Wire > &wires, unsigned int plane, unsigned int tpc, unsigned int cryo)
std::vector< float > const &	wireData (size_t widx) const
std::vector< std::vector< float > >	getPatch (size_t wire, float drift, size_t patchSizeW, size_t patchSizeD) const
float	getPixelOrZero (int wire, int drift) const
double	getAdcSum (void) const
size_t	getAdcArea (void) const
float	poolMax (int wire, int drift, size_t r=0) const
	Pool max value in a patch around the wire/drift pixel. More...
float	poolSum (int wire, int drift, size_t r=0) const
	Pool sum of pixels in a patch around the wire/drift pixel. More...
unsigned int	Cryo (void) const
unsigned int	TPC (void) const
unsigned int	Plane (void) const
unsigned int	NWires (void) const
unsigned int	NScaledDrifts (void) const
unsigned int	NCachedDrifts (void) const
unsigned int	DriftWindow (void) const
float	ZeroLevel (void) const
	Level of zero ADC after scaling. More...
double	LifetimeCorrection (double tick) const

Protected Member Functions
void	downscaleMax (std::vector< float > &dst, std::vector< float > const &adc, size_t tick0) const
void	downscaleMaxMean (std::vector< float > &dst, std::vector< float > const &adc, size_t tick0) const
void	downscaleMean (std::vector< float > &dst, std::vector< float > const &adc, size_t tick0) const
void	downscale (std::vector< float > &dst, std::vector< float > const &adc, size_t tick0) const
size_t	getDriftIndex (float drift) const
bool	setWireData (std::vector< float > const &adc, size_t wireIdx)
bool	patchFromDownsampledView (size_t wire, float drift, size_t size_w, size_t size_d, std::vector< std::vector< float > > &patch) const
bool	patchFromOriginalView (size_t wire, float drift, size_t size_w, size_t size_d, std::vector< std::vector< float > > &patch) const
virtual void	resizeView (size_t wires, size_t drifts)

Protected Attributes
unsigned int	fCryo
unsigned int	fTPC
unsigned int	fPlane
unsigned int	fNWires
unsigned int	fNDrifts
unsigned int	fNScaledDrifts
unsigned int	fNCachedDrifts
std::vector< raw::ChannelID_t >	fWireChannels
std::vector< std::vector< float > >	fWireDriftData
std::vector< float >	fLifetimeCorrFactors
EDownscaleMode	fDownscaleMode
size_t	fDriftWindow
bool	fDownscaleFullView
float	fDriftWindowInv
calo::CalorimetryAlg	fCalorimetryAlg
geo::GeometryCore const *	fGeometry
detinfo::DetectorProperties const *	fDetProp

Private Member Functions
float	scaleAdcSample (float val) const
void	scaleAdcSamples (std::vector< float > &values) const
void	applyBlur ()
void	addWhiteNoise ()
void	addCoherentNoise ()

Private Attributes
std::vector< float >	fAmplCalibConst
bool	fCalibrateAmpl
bool	fCalibrateLifetime
float	fAdcMax
float	fAdcMin
float	fAdcScale
float	fAdcOffset
float	fAdcZero
double	fAdcSumOverThr
double	fAdcSumThr
size_t	fAdcAreaOverThr
CLHEP::HepJamesRandom	fRndEngine
std::vector< float >	fBlurKernel
float	fNoiseSigma
float	fCoherentSigma

Detailed Description

Base class providing data for training / running image based classifiers. It can be used also for any other algorithms where 2D projection image is useful. Currently the image is 32-bit fp / pixel, as sson as have time will template it so e.g. byte pixels would be possible.

Definition at line 46 of file DataProviderAlg.h.

Member Enumeration Documentation

enum img::DataProviderAlg::EDownscaleMode

Enumerator
kMax
kMaxMean
kMean

Definition at line 49 of file DataProviderAlg.h.

{ kMax = 1, kMaxMean = 2, kMean = 3 };

Constructor & Destructor Documentation

img::DataProviderAlg::DataProviderAlg ( const fhicl::ParameterSet &  pset )

inline

Definition at line 98 of file DataProviderAlg.h.

References setWireDriftData(), and ~DataProviderAlg().

                                                       :
                DataProviderAlg(fhicl::Table<Config>(pset, {})())
        {}

img::DataProviderAlg::DataProviderAlg

(

const Config &

config

)

Definition at line 20 of file DataProviderAlg.cxx.

References img::DataProviderAlg::Config::AdcMax, img::DataProviderAlg::Config::AdcMin, img::DataProviderAlg::Config::BlurKernel, img::DataProviderAlg::Config::CalibrateAmpl, img::DataProviderAlg::Config::CalibrateLifetime, img::DataProviderAlg::Config::CalorimetryAlg, img::DataProviderAlg::Config::CoherentSigma, img::DataProviderAlg::Config::DownscaleFn, img::DataProviderAlg::Config::DownscaleFullView, img::DataProviderAlg::Config::DriftWindow, calo::CalorimetryAlg::ElectronsFromADCPeak(), fAdcMax, fAdcMin, fAdcOffset, fAdcScale, fAdcZero, fAmplCalibConst, fBlurKernel, fCalibrateAmpl, fCalibrateLifetime, fCalorimetryAlg, fCoherentSigma, fDownscaleFullView, fDownscaleMode, fDriftWindow, fDriftWindowInv, fGeometry, fNoiseSigma, kMax, kMaxMean, kMean, geo::GeometryCore::MaxPlanes(), img::DataProviderAlg::Config::NoiseSigma, img::DataProviderAlg::Config::OutMax, img::DataProviderAlg::Config::OutMin, and calo::CalorimetryAlg::reconfigure().

                                                        :
        fCryo(9999), fTPC(9999), fPlane(9999),
        fNWires(0), fNDrifts(0), fNScaledDrifts(0), fNCachedDrifts(0),
        fDownscaleMode(img::DataProviderAlg::kMax), fDriftWindow(10),
        fCalorimetryAlg(config.CalorimetryAlg()),
        fGeometry( &*(art::ServiceHandle<geo::Geometry>()) ),
        fDetProp(lar::providerFrom<detinfo::DetectorPropertiesService>()),
        fAdcSumOverThr(0), fAdcSumThr(10), // set fixed threshold of 10 ADC counts for counting the sum
        fAdcAreaOverThr(0),
        fNoiseSigma(0), fCoherentSigma(0)
{
        fCalorimetryAlg.reconfigure(config.CalorimetryAlg());
        fCalibrateLifetime = config.CalibrateLifetime();
        fCalibrateAmpl = config.CalibrateAmpl();

        fAmplCalibConst.resize(fGeometry->MaxPlanes());
        if (fCalibrateAmpl)
        {
            mf::LogInfo("DataProviderAlg") << "Using calibration constants:";
            for (size_t p = 0; p < fAmplCalibConst.size(); ++p)
            {
                try
                {
                    fAmplCalibConst[p] = 1.2e-3 * fCalorimetryAlg.ElectronsFromADCPeak(1.0, p);
                mf::LogInfo("DataProviderAlg") << "   plane:" << p << " const:" << 1.0 / fAmplCalibConst[p];
            }
            catch (...) { fAmplCalibConst[p] = 1.0; }
            }
        }
        else
        {
            mf::LogInfo("DataProviderAlg") << "No plane-to-plane calibration.";
            for (size_t p = 0; p < fAmplCalibConst.size(); ++p) { fAmplCalibConst[p] = 1.0; }
        }

        fDriftWindow = config.DriftWindow();
        fDownscaleFullView = config.DownscaleFullView();
        fDriftWindowInv = 1.0 / fDriftWindow;

        std::string mode_str = config.DownscaleFn();
        mf::LogVerbatim("DataProviderAlg") << "Downscale mode is: " << mode_str;
        if (mode_str == "maxpool")
        {
            //fnDownscale = [this](std::vector<float> & dst, std::vector<float> const & adc, size_t tick0) { downscaleMax(dst, adc, tick0); };
            fDownscaleMode = img::DataProviderAlg::kMax;
        }
        else if (mode_str == "maxmean")
        {
            //fnDownscale = [this](std::vector<float> & dst, std::vector<float> const & adc, size_t tick0) { downscaleMaxMean(dst, adc, tick0); };
            fDownscaleMode = img::DataProviderAlg::kMaxMean;
        }
        else if (mode_str == "mean")
        {
            //fnDownscale = [this](std::vector<float> & dst, std::vector<float> const & adc, size_t tick0) { downscaleMean(dst, adc, tick0); };
            fDownscaleMode = img::DataProviderAlg::kMean;
        }
        else
        {
                mf::LogError("DataProviderAlg") << "Downscale mode string not recognized, set to max pooling.";
                //fnDownscale = [this](std::vector<float> & dst, std::vector<float> const & adc, size_t tick0) { downscaleMax(dst, adc, tick0); };
                fDownscaleMode = img::DataProviderAlg::kMax;
        }

    fAdcMax = config.AdcMax();
    fAdcMin = config.AdcMin();
    fAdcOffset = config.OutMin();
    fAdcScale = (config.OutMax() - fAdcOffset) / (fAdcMax - fAdcMin);
    fAdcZero = fAdcOffset + fAdcScale * (0 - fAdcMin); // level of zero ADC after scaling

    if (fAdcMax <= fAdcMin) { throw cet::exception("img::DataProviderAlg") << "Misconfigured: AdcMax <= AdcMin" << std::endl; }
    if (fAdcScale == 0) { throw cet::exception("img::DataProviderAlg") << "Misconfigured: OutMax == OutMin" << std::endl; }

    fBlurKernel = config.BlurKernel();
    fNoiseSigma = config.NoiseSigma();
    fCoherentSigma = config.CoherentSigma();
}

img::DataProviderAlg::~DataProviderAlg ( void  )

virtual

Definition at line 98 of file DataProviderAlg.cxx.

Referenced by DataProviderAlg().

{
}

Member Function Documentation

void img::DataProviderAlg::addCoherentNoise ( )

private

Definition at line 507 of file DataProviderAlg.cxx.

References d, fCoherentSigma, fDownscaleFullView, fDriftWindow, fNCachedDrifts, fRndEngine, fWireDriftData, noise(), scaleAdcSample(), and w.

Referenced by setWireDriftData().

{
    if (fCoherentSigma == 0) return;

    double effectiveSigma = scaleAdcSample(fCoherentSigma);
    if (fDownscaleFullView) effectiveSigma /= fDriftWindow;

    CLHEP::RandGauss gauss(fRndEngine);
    std::vector<double> amps1(fWireDriftData.size());
    std::vector<double> amps2(1 + (fWireDriftData.size() / 32));
    gauss.fireArray(amps1.size(), amps1.data(), 1., 0.1); // 10% wire-wire ampl. variation
    gauss.fireArray(amps2.size(), amps2.data(), 1., 0.1); // 10% group-group ampl. variation

    double group_amp = 1.0;
    std::vector<double> noise(fNCachedDrifts);
    for (size_t w = 0; w < fWireDriftData.size(); ++w)
    {
        if ((w & 31) == 0)
        {
            group_amp = amps2[w >> 5]; // div by 32
            gauss.fireArray(fNCachedDrifts, noise.data(), 0., effectiveSigma);
        } // every 32 wires

        auto & wire = fWireDriftData[w];
        for (size_t d = 0; d < wire.size(); ++d)
        {
            wire[d] += group_amp * amps1[w] * noise[d];
        }
    }
}

void img::DataProviderAlg::addWhiteNoise ( )

private

Definition at line 487 of file DataProviderAlg.cxx.

References d, fDownscaleFullView, fDriftWindow, fNCachedDrifts, fNoiseSigma, fRndEngine, fWireDriftData, noise(), and scaleAdcSample().

Referenced by setWireDriftData().

{
    if (fNoiseSigma == 0) return;

    double effectiveSigma = scaleAdcSample(fNoiseSigma);
    if (fDownscaleFullView) effectiveSigma /= fDriftWindow;

    CLHEP::RandGauss gauss(fRndEngine);
    std::vector<double> noise(fNCachedDrifts);
    for (auto & wire : fWireDriftData)
    {
        gauss.fireArray(fNCachedDrifts, noise.data(), 0., effectiveSigma);
        for (size_t d = 0; d < wire.size(); ++d)
        {
            wire[d] += noise[d];
        }
    }
}

void img::DataProviderAlg::applyBlur ( )

private

Definition at line 375 of file DataProviderAlg.cxx.

References d, fBlurKernel, fWireDriftData, and w.

Referenced by setWireDriftData().

{
    if (fBlurKernel.size() < 2) return;

    size_t margin_left = (fBlurKernel.size()-1) >> 1, margin_right = fBlurKernel.size() - margin_left - 1;

    std::vector< std::vector<float> > src(fWireDriftData.size());
    for (size_t w = 0; w < fWireDriftData.size(); ++w) { src[w] = fWireDriftData[w]; }

    for (size_t w = margin_left; w < fWireDriftData.size() - margin_right; ++w)
    {
        for (size_t d = 0; d < fWireDriftData[w].size(); ++d)
        {
            float sum = 0;
            for (size_t i = 0; i < fBlurKernel.size(); ++i)
            {
                sum += fBlurKernel[i] * src[w + i - margin_left][d];
            }
            fWireDriftData[w][d] = sum;
        }
    }
}

unsigned int img::DataProviderAlg::Cryo ( void  ) const

inline

Definition at line 157 of file DataProviderAlg.h.

References fCryo.

{ return fCryo; }

void img::DataProviderAlg::downscale ( std::vector< float > &  dst, std::vector< float > const &  adc, size_t  tick0  ) const

inlineprotected

Definition at line 189 of file DataProviderAlg.h.

References downscaleMax(), downscaleMaxMean(), downscaleMean(), kMax, kMaxMean, and kMean.

Referenced by patchFromOriginalView(), and setWireData().

        {
            switch (fDownscaleMode)
            {
                case img::DataProviderAlg::kMean: downscaleMean(dst, adc, tick0); break;
                case img::DataProviderAlg::kMaxMean: downscaleMaxMean(dst, adc, tick0); break;
                case img::DataProviderAlg::kMax: downscaleMax(dst, adc, tick0); break;
                default:throw cet::exception("img::DataProviderAlg") << "Downscale mode not supported." << std::endl; break;
            }
        }

void img::DataProviderAlg::downscaleMax ( std::vector< float > &  dst, std::vector< float > const &  adc, size_t  tick0  ) const

protected

Definition at line 182 of file DataProviderAlg.cxx.

References fDriftWindow, fLifetimeCorrFactors, and scaleAdcSamples().

Referenced by downscale().

{
        size_t kStop = dst.size();
        if (adc.size() < kStop) { kStop = adc.size(); }
        for (size_t i = 0, k0 = 0; i < kStop; ++i, k0 += fDriftWindow)
        {
                size_t k1 = k0 + fDriftWindow;

                float max_adc = adc[k0] * fLifetimeCorrFactors[k0 + tick0];
                for (size_t k = k0 + 1; k < k1; ++k)
                {
                        float ak = adc[k] * fLifetimeCorrFactors[k + tick0];
                        if (ak > max_adc) max_adc = ak;
                }

                dst[i] = max_adc;
        }
        scaleAdcSamples(dst);
}

void img::DataProviderAlg::downscaleMaxMean ( std::vector< float > &  dst, std::vector< float > const &  adc, size_t  tick0  ) const

protected

Definition at line 202 of file DataProviderAlg.cxx.

References fDriftWindow, fLifetimeCorrFactors, n, and scaleAdcSamples().

Referenced by downscale().

{
        size_t kStop = dst.size();
        if (adc.size() < kStop) { kStop = adc.size(); }
        for (size_t i = 0, k0 = 0; i < kStop; ++i, k0 += fDriftWindow)
        {
                size_t k1 = k0 + fDriftWindow;

                size_t max_idx = k0;
                float max_adc = adc[k0] * fLifetimeCorrFactors[k0 + tick0];
                for (size_t k = k0 + 1; k < k1; ++k)
                {
                        float ak = adc[k] * fLifetimeCorrFactors[k + tick0];
                        if (ak > max_adc) { max_adc = ak; max_idx = k; }
                }

                size_t n = 1;
                if (max_idx > 0) { max_adc += adc[max_idx - 1] * fLifetimeCorrFactors[max_idx - 1 + tick0]; n++; }
                if (max_idx + 1 < adc.size()) { max_adc += adc[max_idx + 1] * fLifetimeCorrFactors[max_idx + 1 + tick0]; n++; }

                dst[i] = max_adc / n;
        }
        scaleAdcSamples(dst);
}

void img::DataProviderAlg::downscaleMean ( std::vector< float > &  dst, std::vector< float > const &  adc, size_t  tick0  ) const

protected

Definition at line 227 of file DataProviderAlg.cxx.

References fDriftWindow, fDriftWindowInv, fLifetimeCorrFactors, and scaleAdcSamples().

Referenced by downscale().

{
        size_t kStop = dst.size();
        if (adc.size() < kStop) { kStop = adc.size(); }
        for (size_t i = 0, k0 = 0; i < kStop; ++i, k0 += fDriftWindow)
        {
                size_t k1 = k0 + fDriftWindow;

                float sum_adc = 0;
                for (size_t k = k0; k < k1; ++k)
                {
                        sum_adc += adc[k] * fLifetimeCorrFactors[k + tick0];
                }
        dst[i] = sum_adc * fDriftWindowInv;
        }
        scaleAdcSamples(dst);
}

unsigned int img::DataProviderAlg::DriftWindow ( void  ) const

inline

Definition at line 164 of file DataProviderAlg.h.

References fDriftWindow.

{ return fDriftWindow; }

size_t img::DataProviderAlg::getAdcArea ( void  ) const

inline

Definition at line 149 of file DataProviderAlg.h.

References fAdcAreaOverThr, poolMax(), and poolSum().

{ return fAdcAreaOverThr; }

double img::DataProviderAlg::getAdcSum ( void  ) const

inline

Definition at line 148 of file DataProviderAlg.h.

References fAdcSumOverThr.

{ return fAdcSumOverThr; }

size_t img::DataProviderAlg::getDriftIndex ( float  drift ) const

inlineprotected

Definition at line 200 of file DataProviderAlg.h.

References fDriftWindowInv, patchFromDownsampledView(), patchFromOriginalView(), resizeView(), setWireData(), and lar::dump::vector().

Referenced by getPixelOrZero(), poolMax(), and poolSum().

    {
        if (fDownscaleFullView) return (size_t)(drift * fDriftWindowInv);
        else return (size_t)drift;
    }

std::vector< std::vector<float> > img::DataProviderAlg::getPatch ( size_t  wire, float  drift, size_t  patchSizeW, size_t  patchSizeD  ) const

inline

Return patch of data centered on the wire and drift, witht the size in (downscaled) pixels givent with patchSizeW and patchSizeD. Pad with the zero-level calue if patch extends beyond the event projection.

Definition at line 114 of file DataProviderAlg.h.

References fDownscaleFullView, patchFromDownsampledView(), and patchFromOriginalView().

        {
                bool ok = false;
                std::vector< std::vector<float> > patch;
                if (fDownscaleFullView)
                {
                        ok = patchFromDownsampledView(wire, drift, patchSizeW, patchSizeD, patch);
                }
                else
                {
                        ok = patchFromOriginalView(wire, drift, patchSizeW, patchSizeD, patch);
                }

                if (ok) return patch;
                else
                {
                        throw cet::exception("img::DataProviderAlg") << "Patch filling failed." << std::endl;
                }
        }

float img::DataProviderAlg::getPixelOrZero ( int  wire, int  drift  ) const

inline

Return value from the ADC buffer, or zero if coordinates are out of the view; will scale the drift according to the downscale settings.

Definition at line 136 of file DataProviderAlg.h.

References fNCachedDrifts, fWireDriftData, and getDriftIndex().

    {
        size_t didx = getDriftIndex(drift), widx = (size_t)wire;

        if ((widx < fWireDriftData.size()) &&
            (didx < fNCachedDrifts))
        {
            return fWireDriftData[widx][didx];
        }
        else { return 0; }
    }

double img::DataProviderAlg::LifetimeCorrection ( double  tick ) const

inline

Definition at line 169 of file DataProviderAlg.h.

References fCalorimetryAlg, and calo::CalorimetryAlg::LifetimeCorrection().

{ return fCalorimetryAlg.LifetimeCorrection(tick); }

unsigned int img::DataProviderAlg::NCachedDrifts ( void  ) const

inline

Definition at line 163 of file DataProviderAlg.h.

References fNCachedDrifts.

{ return fNCachedDrifts; }

unsigned int img::DataProviderAlg::NScaledDrifts ( void  ) const

inline

Definition at line 162 of file DataProviderAlg.h.

References fNScaledDrifts.

{ return fNScaledDrifts; }

unsigned int img::DataProviderAlg::NWires ( void  ) const

inline

Definition at line 161 of file DataProviderAlg.h.

References fNWires.

{ return fNWires; }

bool img::DataProviderAlg::patchFromDownsampledView ( size_t  wire, float  drift, size_t  size_w, size_t  size_d, std::vector< std::vector< float > > &  patch  ) const

protected

Definition at line 400 of file DataProviderAlg.cxx.

References d, fAdcZero, fDriftWindow, trkf::fill(), fWireDriftData, and w.

Referenced by getDriftIndex(), and getPatch().

{
        int halfSizeW = size_w / 2;
        int halfSizeD = size_d / 2;

        int w0 = wire - halfSizeW;
        int w1 = wire + halfSizeW;

        size_t sd = (size_t)(drift / fDriftWindow);
        int d0 = sd - halfSizeD;
        int d1 = sd + halfSizeD;

        int wsize = fWireDriftData.size();
        for (int w = w0, wpatch = 0; w < w1; ++w, ++wpatch)
        {
                auto & dst = patch[wpatch];
                if ((w >= 0) && (w < wsize))
                {
                        auto & src = fWireDriftData[w];
                        int dsize = src.size();
                        for (int d = d0, dpatch = 0; d < d1; ++d, ++dpatch)
                        {
                                if ((d >= 0) && (d < dsize))
                                {
                                        dst[dpatch] = src[d];
                                }
                                else
                                {
                                        dst[dpatch] = fAdcZero;
                                }
                        }
                }
                else
                {
                        std::fill(dst.begin(), dst.end(), fAdcZero);
                }
        }

        return true;
}

bool img::DataProviderAlg::patchFromOriginalView ( size_t  wire, float  drift, size_t  size_w, size_t  size_d, std::vector< std::vector< float > > &  patch  ) const

protected

Definition at line 442 of file DataProviderAlg.cxx.

References d, downscale(), fAdcZero, fDriftWindow, trkf::fill(), fWireDriftData, tmp, and w.

Referenced by getDriftIndex(), and getPatch().

{
        int dsize = fDriftWindow * size_d;
        int halfSizeW = size_w / 2;
        int halfSizeD = dsize / 2;

        int w0 = wire - halfSizeW;
        int w1 = wire + halfSizeW;

        int d0 = drift - halfSizeD;
        int d1 = drift + halfSizeD;

        std::vector<float> tmp(dsize);
        int wsize = fWireDriftData.size();
        for (int w = w0, wpatch = 0; w < w1; ++w, ++wpatch)
        {
                if ((w >= 0) && (w < wsize))
                {
                        auto & src = fWireDriftData[w];
                        int src_size = src.size();
                        for (int d = d0, dpatch = 0; d < d1; ++d, ++dpatch)
                        {
                                if ((d >= 0) && (d < src_size))
                                {
                                        tmp[dpatch] = src[d];
                                }
                                else
                                {
                                        tmp[dpatch] = fAdcZero;
                                }
                        }
                }
                else
                {
                        std::fill(tmp.begin(), tmp.end(), fAdcZero);
                }

                downscale(patch[wpatch], tmp, d0);
        }

        return true;
}

unsigned int img::DataProviderAlg::Plane ( void  ) const

inline

Definition at line 159 of file DataProviderAlg.h.

References fPlane.

Referenced by setWireDriftData(), pma::ProjectionMatchingAlg::validate_on_adc(), and pma::ProjectionMatchingAlg::validate_on_adc_test().

{ return fPlane; }

float img::DataProviderAlg::poolMax	(	int	wire,
		int	drift,
		size_t	r = 0
	)		const

Pool max value in a patch around the wire/drift pixel.

Definition at line 133 of file DataProviderAlg.cxx.

References col, d, fDownscaleFullView, fDriftWindow, fNCachedDrifts, fNWires, fWireDriftData, getDriftIndex(), and w.

Referenced by getAdcArea(), pma::ProjectionMatchingAlg::validate_on_adc(), and pma::ProjectionMatchingAlg::validate_on_adc_test().

{
    size_t rw = r, rd = r;
    if (!fDownscaleFullView) { rd *= fDriftWindow; }

    size_t didx = getDriftIndex(drift);
    int d0 = didx - rd; if (d0 < 0) { d0 = 0; }
    int d1 = didx + rd; if (d1 >= (int)fNCachedDrifts) { d1 = fNCachedDrifts - 1; }

    int w0 = wire - rw; if (w0 < 0) { w0 = 0; }
    int w1 = wire + rw; if (w1 >= (int)fNWires) { w1 = fNWires - 1; }

    float adc, max_adc = 0;
    for (int w = w0; w <= w1; ++w)
    {
        auto const * col = fWireDriftData[w].data();
        for (int d = d0; d <= d1; ++d)
        {
            adc = col[d]; if (adc > max_adc) { max_adc = adc; }
        }
    }

    return max_adc;
}

float img::DataProviderAlg::poolSum	(	int	wire,
		int	drift,
		size_t	r = 0
	)		const

Pool sum of pixels in a patch around the wire/drift pixel.

Definition at line 159 of file DataProviderAlg.cxx.

References col, d, fDownscaleFullView, fDriftWindow, fNCachedDrifts, fNWires, fWireDriftData, getDriftIndex(), and w.

Referenced by getAdcArea().

{
    size_t rw = r, rd = r;
    if (!fDownscaleFullView) { rd *= fDriftWindow; }

    size_t didx = getDriftIndex(drift);
    int d0 = didx - rd; if (d0 < 0) { d0 = 0; }
    int d1 = didx + rd; if (d1 >= (int)fNCachedDrifts) { d1 = fNCachedDrifts - 1; }

    int w0 = wire - rw; if (w0 < 0) { w0 = 0; }
    int w1 = wire + rw; if (w1 >= (int)fNWires) { w1 = fNWires - 1; }

    float sum = 0;
    for (int w = w0; w <= w1; ++w)
    {
        auto const * col = fWireDriftData[w].data();
        for (int d = d0; d <= d1; ++d) { sum += col[d]; }
    }

    return sum;
}

void img::DataProviderAlg::resizeView ( size_t  wires, size_t  drifts  )

protectedvirtual

Reimplemented in nnet::TrainingDataAlg.

Definition at line 103 of file DataProviderAlg.cxx.

References fAdcZero, fCalibrateLifetime, fCalorimetryAlg, fDownscaleFullView, fDriftWindow, trkf::fill(), fLifetimeCorrFactors, fNCachedDrifts, fNDrifts, fNScaledDrifts, fNWires, fWireChannels, fWireDriftData, raw::InvalidChannelID, calo::CalorimetryAlg::LifetimeCorrection(), and w.

Referenced by getDriftIndex(), nnet::TrainingDataAlg::resizeView(), and setWireDriftData().

{
    fNWires = wires; fNDrifts = drifts;
    fNScaledDrifts = drifts / fDriftWindow;

    if (fDownscaleFullView) { fNCachedDrifts = fNScaledDrifts; }
    else { fNCachedDrifts = fNDrifts; }

    fWireChannels.resize(wires);
    std::fill(fWireChannels.begin(), fWireChannels.end(), raw::InvalidChannelID);

    fWireDriftData.resize(wires);
    for (auto & w : fWireDriftData)
    {
        w.resize(fNCachedDrifts);
        std::fill(w.begin(), w.end(), fAdcZero);
    }

    fLifetimeCorrFactors.resize(fNDrifts);
    if (fCalibrateLifetime)
    {
        for (size_t t = 0; t < fNDrifts; ++t) { fLifetimeCorrFactors[t] = fCalorimetryAlg.LifetimeCorrection(t); }
    }
    else
    {
        for (size_t t = 0; t < fNDrifts; ++t) { fLifetimeCorrFactors[t] = 1.0; }
    }
}

float img::DataProviderAlg::scaleAdcSample ( float  val ) const

private

Definition at line 331 of file DataProviderAlg.cxx.

References fAdcMax, fAdcMin, fAdcOffset, fAdcScale, fAmplCalibConst, and fPlane.

Referenced by addCoherentNoise(), addWhiteNoise(), and scaleAdcSamples().

{
    val *= fAmplCalibConst[fPlane];  // prescale by plane-to-plane calibration factors

    if (val < fAdcMin)      { val = fAdcMin; }  // saturate
    else if (val > fAdcMax) { val = fAdcMax; }

    return fAdcOffset + fAdcScale * (val - fAdcMin);  // shift and scale to the output range, shift to the output min
}

void img::DataProviderAlg::scaleAdcSamples ( std::vector< float > &  values ) const

private

Definition at line 341 of file DataProviderAlg.cxx.

References fAdcMax, fAdcMin, fAdcOffset, fAdcScale, fAmplCalibConst, fPlane, and scaleAdcSample().

Referenced by downscaleMax(), downscaleMaxMean(), and downscaleMean().

{
    float calib = fAmplCalibConst[fPlane];
    auto * data = values.data();

    size_t k = 0, size4 = values.size() >> 2, size = values.size();
    for (size_t i = 0; i < size4; ++i) // vectorize if you can
    {
        data[k] *= calib;  // prescale by plane-to-plane calibration factors
        data[k+1] *= calib;
        data[k+2] *= calib;
        data[k+3] *= calib;

        if (data[k] < fAdcMin) { data[k] = fAdcMin; }  // saturate min
        if (data[k+1] < fAdcMin) { data[k+1] = fAdcMin; }
        if (data[k+2] < fAdcMin) { data[k+2] = fAdcMin; }
        if (data[k+3] < fAdcMin) { data[k+3] = fAdcMin; }

        if (data[k] > fAdcMax) { data[k] = fAdcMax; }  // saturate max
        if (data[k+1] > fAdcMax) { data[k+1] = fAdcMax; }
        if (data[k+2] > fAdcMax) { data[k+2] = fAdcMax; }
        if (data[k+3] > fAdcMax) { data[k+3] = fAdcMax; }

        data[k] = fAdcOffset + fAdcScale * (data[k] - fAdcMin);  // shift and scale to the output range, shift to the output min
        data[k+1] = fAdcOffset + fAdcScale * (data[k+1] - fAdcMin);
        data[k+2] = fAdcOffset + fAdcScale * (data[k+2] - fAdcMin);
        data[k+3] = fAdcOffset + fAdcScale * (data[k+3] - fAdcMin);

        k += 4;
    }
    while (k < size) { data[k] = scaleAdcSample(data[k]); ++k; }  // do the tail
}

bool img::DataProviderAlg::setWireData ( std::vector< float > const &  adc, size_t  wireIdx  )

protected

Definition at line 245 of file DataProviderAlg.cxx.

References downscale(), fDownscaleFullView, and fWireDriftData.

Referenced by getDriftIndex(), and setWireDriftData().

{
        if (wireIdx >= fWireDriftData.size()) return false;
        auto & wData = fWireDriftData[wireIdx];

    if (fDownscaleFullView)
    {
        if (!adc.empty()) { downscale(wData, adc, 0); }
        else { return false; }
    }
    else
    {
        if (adc.empty()) { return false; }
        else if (adc.size() <= wData.size()) { std::copy(adc.begin(), adc.end(), wData.begin()); }
        else { std::copy(adc.begin(), adc.begin()+wData.size(), wData.begin()); }
    }
    return true;
}

bool img::DataProviderAlg::setWireDriftData	(	const std::vector< recob::Wire > &	wires,
		unsigned int	plane,
		unsigned int	tpc,
		unsigned int	cryo
	)

Definition at line 265 of file DataProviderAlg.cxx.

References addCoherentNoise(), addWhiteNoise(), applyBlur(), geo::GeometryCore::ChannelToWire(), fAdcAreaOverThr, fAdcSumOverThr, fAdcSumThr, fCryo, fDetProp, fGeometry, fPlane, fTPC, fWireChannels, detinfo::DetectorProperties::NumberTimeSamples(), geo::GeometryCore::Nwires(), Plane(), resizeView(), and setWireData().

Referenced by DataProviderAlg(), nnet::TrainingDataAlg::setDataEventData(), and nnet::TrainingDataAlg::setEventData().

{
    mf::LogInfo("DataProviderAlg") << "Create image for cryo:"
        << cryo << " tpc:" << tpc << " plane:" << plane;

        fCryo = cryo; fTPC = tpc; fPlane = plane;

    fAdcSumOverThr = 0;
    fAdcAreaOverThr = 0;

        size_t nwires = fGeometry->Nwires(plane, tpc, cryo);
        size_t ndrifts = fDetProp->NumberTimeSamples();

        resizeView(nwires, ndrifts);

    auto const & channelStatus = art::ServiceHandle< lariov::ChannelStatusService >()->GetProvider();

    bool allWrong = true;
    for (auto const & wire : wires)
        {
                auto wireChannelNumber = wire.Channel();
                if (!channelStatus.IsGood(wireChannelNumber)) { continue; }

                size_t w_idx = 0;
                for (auto const& id : fGeometry->ChannelToWire(wireChannelNumber))
                {
                        if ((id.Plane == plane) && (id.TPC == tpc) && (id.Cryostat == cryo))
                        {
                            w_idx = id.Wire;

                            auto adc = wire.Signal();
                            if (adc.size() < ndrifts)
                            {
                                mf::LogWarning("DataProviderAlg") << "Wire ADC vector size lower than NumberTimeSamples.";
                                continue; // not critical, maybe other wires are OK, so continue
                            }

                            if (!setWireData(adc, w_idx))
                            {
                                mf::LogWarning("DataProviderAlg") << "Wire data not set.";
                                continue; // also not critical, try to set other wires
                            }

                for (auto v : adc) { if (v >= fAdcSumThr) { fAdcSumOverThr += v; fAdcAreaOverThr++; } }

                            fWireChannels[w_idx] = wireChannelNumber;
                            allWrong = false;
                        }
                }
        }
        if (allWrong)
        {
            mf::LogError("DataProviderAlg") << "Wires data not set in the cryo:"
                << cryo << " tpc:" << tpc << " plane:" << plane;
            return false;
        }
        
    applyBlur();
    addWhiteNoise();
    addCoherentNoise();

        return true;
}

unsigned int img::DataProviderAlg::TPC ( void  ) const

inline

Definition at line 158 of file DataProviderAlg.h.

References fTPC.

{ return fTPC; }

std::vector<float> const& img::DataProviderAlg::wireData ( size_t  widx ) const

inline

Definition at line 109 of file DataProviderAlg.h.

References fWireDriftData.

{ return fWireDriftData[widx]; }

float img::DataProviderAlg::ZeroLevel ( void  ) const

inline

Level of zero ADC after scaling.

Definition at line 167 of file DataProviderAlg.h.

References fAdcZero.

{ return fAdcZero; }

Member Data Documentation

size_t img::DataProviderAlg::fAdcAreaOverThr

private

Definition at line 228 of file DataProviderAlg.h.

Referenced by getAdcArea(), and setWireDriftData().

float img::DataProviderAlg::fAdcMax

private

Definition at line 226 of file DataProviderAlg.h.

Referenced by DataProviderAlg(), scaleAdcSample(), and scaleAdcSamples().

float img::DataProviderAlg::fAdcMin

private

Definition at line 226 of file DataProviderAlg.h.

Referenced by DataProviderAlg(), scaleAdcSample(), and scaleAdcSamples().

float img::DataProviderAlg::fAdcOffset

private

Definition at line 226 of file DataProviderAlg.h.

Referenced by DataProviderAlg(), scaleAdcSample(), and scaleAdcSamples().

float img::DataProviderAlg::fAdcScale

private

Definition at line 226 of file DataProviderAlg.h.

Referenced by DataProviderAlg(), scaleAdcSample(), and scaleAdcSamples().

double img::DataProviderAlg::fAdcSumOverThr

private

Definition at line 227 of file DataProviderAlg.h.

Referenced by getAdcSum(), and setWireDriftData().

double img::DataProviderAlg::fAdcSumThr

private

Definition at line 227 of file DataProviderAlg.h.

Referenced by setWireDriftData().

float img::DataProviderAlg::fAdcZero

private

Definition at line 226 of file DataProviderAlg.h.

Referenced by DataProviderAlg(), patchFromDownsampledView(), patchFromOriginalView(), resizeView(), and ZeroLevel().

std::vector<float> img::DataProviderAlg::fAmplCalibConst

private

Definition at line 223 of file DataProviderAlg.h.

Referenced by DataProviderAlg(), scaleAdcSample(), and scaleAdcSamples().

std::vector<float> img::DataProviderAlg::fBlurKernel

private

Definition at line 233 of file DataProviderAlg.h.

Referenced by applyBlur(), and DataProviderAlg().

bool img::DataProviderAlg::fCalibrateAmpl

private

Definition at line 224 of file DataProviderAlg.h.

Referenced by DataProviderAlg().

bool img::DataProviderAlg::fCalibrateLifetime

private

Definition at line 224 of file DataProviderAlg.h.

Referenced by DataProviderAlg(), and resizeView().

calo::CalorimetryAlg img::DataProviderAlg::fCalorimetryAlg

protected

Definition at line 214 of file DataProviderAlg.h.

Referenced by DataProviderAlg(), LifetimeCorrection(), and resizeView().

float img::DataProviderAlg::fCoherentSigma

private

Definition at line 239 of file DataProviderAlg.h.

Referenced by addCoherentNoise(), and DataProviderAlg().

unsigned int img::DataProviderAlg::fCryo

protected

Definition at line 172 of file DataProviderAlg.h.

Referenced by nnet::TrainingDataAlg::collectVtxFlags(), Cryo(), and setWireDriftData().

detinfo::DetectorProperties const* img::DataProviderAlg::fDetProp

protected

Definition at line 218 of file DataProviderAlg.h.

Referenced by nnet::TrainingDataAlg::getProjection(), and setWireDriftData().

bool img::DataProviderAlg::fDownscaleFullView

protected

Definition at line 183 of file DataProviderAlg.h.

Referenced by addCoherentNoise(), addWhiteNoise(), DataProviderAlg(), getPatch(), nnet::PointIdAlg::isCurrentPatch(), nnet::PointIdAlg::isSamePatch(), poolMax(), poolSum(), resizeView(), setWireData(), and nnet::TrainingDataAlg::setWireEdepsAndLabels().

EDownscaleMode img::DataProviderAlg::fDownscaleMode

protected

Definition at line 179 of file DataProviderAlg.h.

Referenced by DataProviderAlg().

size_t img::DataProviderAlg::fDriftWindow

protected

Definition at line 182 of file DataProviderAlg.h.

Referenced by addCoherentNoise(), addWhiteNoise(), DataProviderAlg(), downscaleMax(), downscaleMaxMean(), downscaleMean(), DriftWindow(), nnet::PointIdAlg::isCurrentPatch(), nnet::PointIdAlg::isInsideFiducialRegion(), nnet::PointIdAlg::isSamePatch(), patchFromDownsampledView(), patchFromOriginalView(), poolMax(), poolSum(), resizeView(), and nnet::TrainingDataAlg::setWireEdepsAndLabels().

float img::DataProviderAlg::fDriftWindowInv

protected

Definition at line 184 of file DataProviderAlg.h.

Referenced by DataProviderAlg(), downscaleMean(), and getDriftIndex().

geo::GeometryCore const* img::DataProviderAlg::fGeometry

protected

Definition at line 217 of file DataProviderAlg.h.

Referenced by DataProviderAlg(), nnet::TrainingDataAlg::getProjection(), and setWireDriftData().

std::vector<float> img::DataProviderAlg::fLifetimeCorrFactors

protected

Definition at line 177 of file DataProviderAlg.h.

Referenced by downscaleMax(), downscaleMaxMean(), downscaleMean(), and resizeView().

unsigned int img::DataProviderAlg::fNCachedDrifts

protected

Definition at line 173 of file DataProviderAlg.h.

Referenced by addCoherentNoise(), addWhiteNoise(), getPixelOrZero(), NCachedDrifts(), poolMax(), poolSum(), resizeView(), nnet::TrainingDataAlg::resizeView(), and nnet::TrainingDataAlg::setWireEdepsAndLabels().

unsigned int img::DataProviderAlg::fNDrifts

protected

Definition at line 173 of file DataProviderAlg.h.

Referenced by resizeView(), nnet::TrainingDataAlg::setDataEventData(), and nnet::TrainingDataAlg::setEventData().

float img::DataProviderAlg::fNoiseSigma

private

Definition at line 236 of file DataProviderAlg.h.

Referenced by addWhiteNoise(), and DataProviderAlg().

unsigned int img::DataProviderAlg::fNScaledDrifts

protected

Definition at line 173 of file DataProviderAlg.h.

Referenced by nnet::PointIdAlg::isInsideFiducialRegion(), NScaledDrifts(), and resizeView().

unsigned int img::DataProviderAlg::fNWires

protected

Definition at line 173 of file DataProviderAlg.h.

Referenced by nnet::PointIdAlg::isInsideFiducialRegion(), NWires(), poolMax(), poolSum(), resizeView(), and nnet::TrainingDataAlg::setEventData().

unsigned int img::DataProviderAlg::fPlane

protected

Definition at line 172 of file DataProviderAlg.h.

Referenced by Plane(), scaleAdcSample(), scaleAdcSamples(), and setWireDriftData().

CLHEP::HepJamesRandom img::DataProviderAlg::fRndEngine

private

Definition at line 230 of file DataProviderAlg.h.

Referenced by addCoherentNoise(), and addWhiteNoise().

unsigned int img::DataProviderAlg::fTPC

protected

Definition at line 172 of file DataProviderAlg.h.

Referenced by nnet::TrainingDataAlg::collectVtxFlags(), setWireDriftData(), and TPC().

std::vector< raw::ChannelID_t > img::DataProviderAlg::fWireChannels

protected

Definition at line 175 of file DataProviderAlg.h.

Referenced by resizeView(), nnet::TrainingDataAlg::setEventData(), and setWireDriftData().

std::vector< std::vector<float> > img::DataProviderAlg::fWireDriftData

protected

Definition at line 176 of file DataProviderAlg.h.

Referenced by addCoherentNoise(), addWhiteNoise(), applyBlur(), getPixelOrZero(), patchFromDownsampledView(), patchFromOriginalView(), poolMax(), poolSum(), resizeView(), setWireData(), and wireData().

---

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

• larreco/v06_64_02/source/larreco/RecoAlg/ImagePatternAlgs/DataProvider/DataProviderAlg.h
• larreco/v06_64_02/source/larreco/RecoAlg/ImagePatternAlgs/DataProvider/DataProviderAlg.cxx