DDDigi/noise/DigiPoissonNoise.h

0001 //==========================================================================
0002 //  AIDA Detector description implementation
0003 //--------------------------------------------------------------------------
0004 // Copyright (C) Organisation europeenne pour la Recherche nucleaire (CERN)
0005 // All rights reserved.
0006 //
0007 // For the licensing terms see $DD4hepINSTALL/LICENSE.
0008 // For the list of contributors see $DD4hepINSTALL/doc/CREDITS.
0009 //
0010 // Author     : M.Frank
0011 //
0012 //==========================================================================
0013 #ifndef DDDIGI_NOISE_DIGIPOISSONNOISE_H
0014 #define DDDIGI_NOISE_DIGIPOISSONNOISE_H
0015
0016 /// Framework include files
0017 #include <DDDigi/DigiSignalProcessor.h>
0018
0019 /// Namespace for the AIDA detector description toolkit
0020 namespace dd4hep {
0021
0022   /// Namespace for the Digitization part of the AIDA detector description toolkit
0023   namespace digi {
0024
0025     /// Generic noise source with a poisson distribution
0026     /**
0027      *  Generate poisson noise as it appears e.g. from electronic noise
0028      *  with a given mean and a given sigma
0029      *
0030      *  \author  M.Frank
0031      *  \version 1.0
0032      *  \ingroup DD4HEP_DIGITIZATION
0033      */
0034     class DigiPoissonNoise : public DigiSignalProcessor  {
0035     protected:
0036       /// Property: Mean value of the
0037       double    m_mean    = 0.0;
0038       /// Property: Cut-off parameter. Do nothing if existing energy deposit is above threshold
0039       double    m_cutoff  = -1.0;
0040
0041     protected:
0042       /// Define standard assignments and constructors
0043       DDDIGI_DEFINE_ACTION_CONSTRUCTORS(DigiPoissonNoise);
0044
0045     public:
0046       /// Standard constructor
0047       DigiPoissonNoise(const DigiKernel& kernel, const std::string& nam);
0048       /// Default destructor
0049       virtual ~DigiPoissonNoise();
0050       /// Callback to read event poissonnoise
0051       virtual double operator()(DigiCellContext& context)  const  override;
0052     };
0053   }    // End namespace digi
0054 }      // End namespace dd4hep
0055 #endif // DDDIGI_NOISE_DIGIPOISSONNOISE_H