MOptimumFilter Class Reference

Optimum Filter. More...

Inheritance diagram for MOptimumFilter:

Classes
struct	ChannelInfo

Public Member Functions
void	Init (Diana::QEvent &ev)
	Init method. More...
void	Do (Diana::QEvent &ev)
	Do method. Declare and implement only one of the two versions. More...
void	Done ()
	Done method. More...

Private Attributes
std::map< int, ChannelInfo >	fMap
std::string	fAvgNoiseInput
std::string	fAvgPulseInput
std::string	fAvgPulse
std::string	fPulseLabel
std::string	fAvgNoiseOwner
std::string	fAvgPulseOwner
std::string	fParametersOutput
bool	fDifferentiationOn
QOptimumFilter::JitterMode	fJitterMode
bool	fTomV
bool	fInterpolationOn
int	fMaxJitter
double	fChi2Threshold1
bool	fSaveSamples
bool	fShiftFilteredSamples

Detailed Description

Optimum Filter.

Author

Marco Vignati

This module implements the optimum filter. The filter is shaped to give correct results in a limited range of pulse jitters with respect to the average pulse. This limitation allows to obtain correct results with almost any kind average pulse or noise power spectra.

• Config example:

     module OptimumFilter
     enable = true
     verbosity = info
     AmplitudeMode = AbsoluteMaximum
     InterpolationOn = true
     AvgPulseInput = average_pulses.root
     AvgNoiseInput = average_noise_power_spectra.root
     endmod  
     

• Parameters
  • AvgNoiseInput [string = ""]: Input for average noise power spectra (file or DB)
  • AvgPulseInput [string = ""]: Input for average pulses (file or DB)
  • InterpolationOn [bool = true]: interpolate amplitude and jitter around the maximum amplitude value
  • AmplitudeMode [string = AbsoluteMaximum]: On events different from noise (on noise events it applies NoSearch):
    • AbsoluteMaximum: search for absolute maximum in the full window
    • NoSearch: do not search for maximum. Evaluates amplitude at the position of the maximum of the average pulse
    • LocalMaximum: search for the first maximum after the trigger.
    • FixedDistance: Go a fixed distance away from the trigger, then move left or right according to the slope at that time until you find a LOCAL maximum. Fixed distance is distance from trigger to maximum in average pulse
  • DifferentiationOn [bool = true]: apply an additional derivative filter. It removes the information on the mean first derivative. Useful when the baseline is not flat.
• Optional parameters
  • AvgNoiseOwner [string = AveragePulses]: owner of the average pulse
  • AvgPulseOwner [string = NoiseAvgPowerSpectrum]: owner of the average noise power spectra
  • MaxJitter [int = -1]: maximum allowed positive and negative jitter of the filtered pulse. If negative, the MaxJitter is autocomputed from the rise time of the average pulse.
  • ParametersOutput [string = ]: writes QCOFData to file, if ParametersOutput = DB also writes amplitude algo, ap algo, nps algo and validity kind into DB
  • SaveSamples [bool = false]: save filtered samples to output files. If false they only resides in the event memory.
  • ShiftFilteredSamples [bool = false]: shift filtered samples by the position of the maximum of the avg. pulsein order to align filtered data with unfiltered ones.
  • PulseLabel [string = DAQ@Pulse]:
  • ConvertTomV [bool = true]: convert ADC units to mV based on ADC2mV label of the QPulse to process
  • Chi2Threshold1 [double = 1]: Threshold in relative SNR for the computation of the Chi^2
  • Chi2Threshold2 [double = 1]: Threshold in relative SNR for the computation of the Chi^2
• Reads:
  • DAQ@Pulse (QPulse)
  • DAQ@PulseInfo (QPulseInfo)
  • DAQ@Header (QHeader)
• Writes
  • Amplitude (QDouble): amplitude of the filtered pulse [mV]
  • Integral (QDouble): integral of the pulse computed as Amplitude*(Integral of normalized average pulse) [mV x s]
  • ChiSquare (QDouble): Chi^2/ndof of the optimum filter
  • Jitter (QDouble): jitter of the filtered pulse w.r.t the average pulse [ms]
  • FilteredSamples (QVector): filtered pulse (see option SaveSamples)
  • HighSNRChiSquare1: Chi^2 computed on freqencies with SNR higher than Chi2Threshold1. Variable has zero mean and unit variance
  • HighSNRChiSquare2: Chi^2 computed on freqencies with SNR higher than Chi2Threshold2. Variable has zero mean and unit variance

Definition at line 81 of file MOptimumFilter.hh.

Member Function Documentation

Do()

void MOptimumFilter::Do

(

Diana::QEvent &

ev

)

Do method. Declare and implement only one of the two versions.

Definition at line 68 of file MOptimumFilter.cc.

References MOptimumFilter::ChannelInfo::BlackSheep, err, QChannelRunData::fADC2mV, QOptimumFilter::Filter(), QCOFData::fResolutionmV, QChannelRunData::fSamplingFrequency, QEvent::Get(), QOptimumFilter::Get(), QEvent::GetByLabel(), QPulseInfo::GetChannelId(), QRunData::GetChannelRunData(), QOptimumFilter::GetFiltered(), QOptimumFilter::GetFilteredShifted(), QOptimumFilter::GetHighSNRChi2(), QOptimumFilter::GetInterpolated(), QPulseInfo::GetIsNoise(), QPulseInfo::GetMasterSample(), QOptimumFilter::GetMaxJitter(), QSampleInfo::GetSampleIndex(), QPulse::GetSamples(), QOptimumFilter::J_LOCMAX, QOptimumFilter::J_NOJITTER, MOptimumFilter::ChannelInfo::of, of, Q_DOUBLE_DEFAULT, Q_INT_DEFAULT, QERR_SUCCESS, rHandle, QCOFParametersHandle::SetAPLabel(), QCOFParametersHandle::SetAPValidityKind(), QCOFParametersHandle::SetAPVersion(), QOptimumFilter::SetJitter(), QCOFParametersHandle::SetNPSLabel(), QCOFParametersHandle::SetNPSValidityKind(), and QCOFParametersHandle::SetNPSVersion().

Done()

void MOptimumFilter::Done

(

)

Done method.

Definition at line 224 of file MOptimumFilter.cc.

Init()

void MOptimumFilter::Init

(

Diana::QEvent &

ev

)

Init method.

Definition at line 19 of file MOptimumFilter.cc.

References QEvent::Add(), QOptimumFilter::J_ABSMAX, QOptimumFilter::J_FIXED, QOptimumFilter::J_LOCMAX, QOptimumFilter::J_NOJITTER, QEvent::Require(), and QEvent::RequireByLabel().

Member Data Documentation

fAvgNoiseInput

std::string MOptimumFilter::fAvgNoiseInput

private

Definition at line 106 of file MOptimumFilter.hh.

fAvgNoiseOwner

std::string MOptimumFilter::fAvgNoiseOwner

private

Definition at line 110 of file MOptimumFilter.hh.

fAvgPulse

std::string MOptimumFilter::fAvgPulse

private

Definition at line 108 of file MOptimumFilter.hh.

fAvgPulseInput

std::string MOptimumFilter::fAvgPulseInput

private

Definition at line 107 of file MOptimumFilter.hh.

fAvgPulseOwner

std::string MOptimumFilter::fAvgPulseOwner

private

Definition at line 111 of file MOptimumFilter.hh.

fChi2Threshold1

double MOptimumFilter::fChi2Threshold1

private

Definition at line 120 of file MOptimumFilter.hh.

fDifferentiationOn

bool MOptimumFilter::fDifferentiationOn

private

Definition at line 113 of file MOptimumFilter.hh.

fInterpolationOn

bool MOptimumFilter::fInterpolationOn

private

Definition at line 118 of file MOptimumFilter.hh.

fJitterMode

QOptimumFilter::JitterMode MOptimumFilter::fJitterMode

private

Definition at line 114 of file MOptimumFilter.hh.

fMap

std::map<int,ChannelInfo> MOptimumFilter::fMap

private

Definition at line 104 of file MOptimumFilter.hh.

fMaxJitter

int MOptimumFilter::fMaxJitter

private

Definition at line 119 of file MOptimumFilter.hh.

fParametersOutput

std::string MOptimumFilter::fParametersOutput

private

Definition at line 112 of file MOptimumFilter.hh.

fPulseLabel

std::string MOptimumFilter::fPulseLabel

private

Definition at line 109 of file MOptimumFilter.hh.

fSaveSamples

bool MOptimumFilter::fSaveSamples

private

Definition at line 121 of file MOptimumFilter.hh.

fShiftFilteredSamples

bool MOptimumFilter::fShiftFilteredSamples

private

Definition at line 122 of file MOptimumFilter.hh.

fTomV

bool MOptimumFilter::fTomV

private

Definition at line 115 of file MOptimumFilter.hh.

---

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

• pkg/modoptimumfilter/MOptimumFilter.hh
• pkg/modoptimumfilter/MOptimumFilter.cc