ExponentialChannelNoiseService.h

Go to the documentation of this file.

// ExponentialChannelNoiseService

// David Adams
// January 2016
//
// Implementation of TPC channel noise model with an exponential
// shape in frequency.
// Same as the nose model 1 in SimWireDUNE35t, e.g. from dunetpc v04_29_01.
//
// DLA Feb 2016: Change normalization so RMS does not vary with FFT size.
// See https://cdcvs.fnal.gov/redmine/issues/11470.
//
// DLA Aug 2018: Add new option for low frequency cutoff that has constant noise
// level below that frequency matched to the height of the exponential.
// It is selected with a negative value (-freq) in LowCutoffX (X= U, V, Z).
// See https://cdcvs.fnal.gov/redmine/issues/20621.

#ifndef ExponentialChannelNoiseService_H
#define ExponentialChannelNoiseService_H

#include "dunecore/DuneInterface/Service/ChannelNoiseService.h"
#include <vector>
#include <iostream>

namespace detinfo {
  class DetectorClocksData;
}

class TH1;
namespace CLHEP {
class HepRandomEngine;
}

class ExponentialChannelNoiseService : public ChannelNoiseService {

public:

  // Ctor.
  ExponentialChannelNoiseService(fhicl::ParameterSet const& pset);

  // Ctor.
  ExponentialChannelNoiseService(fhicl::ParameterSet const& pset, art::ActivityRegistry&);

  // Dtor.
  ~ExponentialChannelNoiseService();

  // Add noise to a signal array.
  int addNoise(detinfo::DetectorClocksData const& clockData,
               detinfo::DetectorPropertiesData const& detProp,
               Channel chan, AdcSignalVector& sigs) const;

  // Print the configuration.
  std::ostream& print(std::ostream& out =std::cout, std::string prefix ="") const;

  // Fill a noise vector.
  // Input vector contents are lost.
  // The size of the vector is obtained from the FFT service.
  void generateNoise(detinfo::DetectorClocksData const& clockData,
                     float aNoiseNorm, float aNoiseWidth, float aLowCutoff,
                     AdcSignalVector& noise, TH1* aNoiseHist) const;

private:
 
  // Fill the noise vectors.
  void generateNoise(detinfo::DetectorClocksData const& clockData);

  // Parameters.
  float        fNoiseNormZ;        ///< noise scale factor for Z (collection) plane
  float        fNoiseWidthZ;       ///< exponential noise width (kHz)  for Z (collection) plane
  float        fLowCutoffZ;        ///< low frequency filter cutoff (kHz) for Z (collection) plane
  float        fNoiseNormU;        ///< noise scale factor  for U plane
  float        fNoiseWidthU;       ///< exponential noise width (kHz)   for U plane
  float        fLowCutoffU;        ///< low frequency filter cutoff (kHz)  for U plane
  float        fNoiseNormV;        ///< noise scale factor   for V plane
  float        fNoiseWidthV;       ///< exponential noise width (kHz)   for V plane
  float        fLowCutoffV;        ///< low frequency filter cutoff (kHz)  for V plane
  unsigned int fNoiseArrayPoints;  ///< number of points in randomly generated noise array
  bool         fOldNoiseIndex;     ///< Use old selection of noise array index
  float        fWhiteNoiseZ;       ///< Level (per freq bin) for white noise for Z.
  float        fWhiteNoiseU;       ///< Level (per freq bin) for white noise for U.
  float        fWhiteNoiseV;       ///< Level (per freq bin) for white noise for V.
  int          fRandomSeed;        ///< Seed for random number service. If absent or zero, use SeedSvc.
  int          fLogLevel;          ///< Log message level: 0=quiet, 1=init only, 2+=every event

  // Noise arrays.
  AdcSignalVectorVector fNoiseZ;  ///< noise on each channel for each time for Z (collection) plane
  AdcSignalVectorVector fNoiseU;  ///< noise on each channel for each time for U plane
  AdcSignalVectorVector fNoiseV;  ///< noise on each channel for each time for V plane

  // Histograms.
  //TH1* fNoiseHist;      ///< distribution of noise counts // unused
  TH1* fNoiseHistZ;     ///< distribution of noise counts for Z
  TH1* fNoiseHistU;     ///< distribution of noise counts for U
  TH1* fNoiseHistV;     ///< distribution of noise counts for V
  TH1* fNoiseChanHist;  ///< distribution of accessed noise samples

  CLHEP::HepRandomEngine* m_pran;

};

DECLARE_ART_SERVICE_INTERFACE_IMPL(ExponentialChannelNoiseService, ChannelNoiseService, LEGACY)

#endif