ldmx::NoiseGenerator Class Reference

Public Member Functions
	NoiseGenerator (double noiseValue=0.0001, bool gauss=true)
	Constructor.
	~NoiseGenerator ()
	Destructor.
void	seedGenerator (uint64_t seed)
	Seed the generator.
bool	hasSeed () const
	Has been seeded?
std::vector< double >	generateNoiseHits (int emptyChannels)
	Generate noise hits.
void	setNoiseThreshold (double noiseThreshold)
	Set the noise threshold.
void	setNoise (double noise)
	Set the mean noise.
void	setPedestal (double pedestal)
	Set the pedestal.

Private Attributes
std::unique_ptr< TRandom3 >	random_ {nullptr}
	Random number generator.
double	noiseThreshold_ {4}
	The noise threshold.
double	noise_ {1}
	Mean noise.
double	pedestal_ {0}
	Pedestal or baseline.
bool	useGaussianModel_ {true}
	Gaussian flag.
std::unique_ptr< boost::math::poisson_distribution<> >	poisson_dist_
	pdf for poisson errors

Detailed Description

Definition at line 31 of file NoiseGenerator.h.

Constructor & Destructor Documentation

NoiseGenerator()

ldmx::NoiseGenerator::NoiseGenerator	(	double	noiseValue = 0.0001,
		bool	gauss = true
	)

Constructor.

Definition at line 13 of file NoiseGenerator.cxx.

                                                            {
  noise_ = noiseValue;
  useGaussianModel_ = gauss;
  poisson_dist_ =
      std::make_unique<boost::math::poisson_distribution<> >(noiseValue);
}

References noise_, poisson_dist_, and useGaussianModel_.

~NoiseGenerator()

ldmx::NoiseGenerator::~NoiseGenerator

(

)

Destructor.

Definition at line 20 of file NoiseGenerator.cxx.

{}

Member Function Documentation

generateNoiseHits()

std::vector< double > ldmx::NoiseGenerator::generateNoiseHits

(

int

emptyChannels

)

Generate noise hits.

Parameters

emptyChannels

The total number of channels without a hit on them.

Returns

A vector containing the amplitude of the noise hits.

Definition at line 26 of file NoiseGenerator.cxx.

                                                                     {
  if (random_.get() == nullptr) {
    EXCEPTION_RAISE("RandomSeedException",
                    "Noise generator was not seeded before use");
  }
  // std::cout << "[ Noise Generator ]: Empty channels: "
  //           << emptyChannels << std::endl;
  // std::cout << "[ Noise Generator ]: Normalized integration limit: "
  //          << noiseThreshold_ << std::endl;
 
  double integral;
  if (useGaussianModel_)
    integral = ROOT::Math::normal_cdf_c(noiseThreshold_, noise_, pedestal_);
  else
    integral =
        boost::math::cdf(complement(*poisson_dist_, noiseThreshold_ - 1));
  // std::cout << "[ Noise Generator ]: Integral: "
  //          << integral << std::endl;
 
  double noiseHitCount = random_->Binomial(emptyChannels, integral);
  // std::cout << "[ Noise Generator ]: # Noise hits: "
  //          << noiseHitCount << std::endl;
 
  std::vector<double> noiseHits;
  for (int hitIndex = 0; hitIndex < noiseHitCount; ++hitIndex) {
    double rand = random_->Uniform();
    // std::cout << "[ Noise Generator ]: Rand: "
    //          << rand << std::endl;
    double draw = integral * rand;
    // std::cout << "[ Noise Generator ]: Draw: "
    //          << draw << std::endl;
 
    double cumulativeProb = 1.0 - integral + draw;
    // std::cout << "[ Noise Generator ]: Cumulative probability: "
    //          << cumulativeProb << std::endl;
 
    double valueAboveThreshold;
    if (useGaussianModel_)
      valueAboveThreshold =
          ROOT::Math::gaussian_quantile(cumulativeProb, noise_);
    else
      valueAboveThreshold =
          boost::math::quantile(*poisson_dist_, cumulativeProb);
    // std::cout << "[ Noise Generator ]: Noise value: "
    //          << gaussAboveThreshold << std::endl;
 
    noiseHits.push_back(valueAboveThreshold);
  }
 
  return noiseHits;
}

References noise_, noiseThreshold_, pedestal_, poisson_dist_, random_, and useGaussianModel_.

hasSeed()

bool ldmx::NoiseGenerator::hasSeed ( ) const

inline

Has been seeded?

Definition at line 43 of file NoiseGenerator.h.

{ return random_.get() != nullptr; }

References random_.

seedGenerator()

void ldmx::NoiseGenerator::seedGenerator

(

uint64_t

seed

)

Seed the generator.

Definition at line 22 of file NoiseGenerator.cxx.

                                                {
  random_ = std::make_unique<TRandom3>(seed);
}

References random_.

setNoise()

void ldmx::NoiseGenerator::setNoise ( double  noise )

inline

Set the mean noise.

Definition at line 60 of file NoiseGenerator.h.

{ noise_ = noise; };

References noise_.

setNoiseThreshold()

void ldmx::NoiseGenerator::setNoiseThreshold ( double  noiseThreshold )

inline

Set the noise threshold.

Definition at line 55 of file NoiseGenerator.h.

                                                {
    noiseThreshold_ = noiseThreshold;
  }

References noiseThreshold_.

setPedestal()

void ldmx::NoiseGenerator::setPedestal ( double  pedestal )

inline

Set the pedestal.

Definition at line 63 of file NoiseGenerator.h.

{ pedestal_ = pedestal; };

References pedestal_.

Member Data Documentation

noise_

double ldmx::NoiseGenerator::noise_ {1}

private

Mean noise.

Definition at line 73 of file NoiseGenerator.h.

{1};

Referenced by generateNoiseHits(), NoiseGenerator(), and setNoise().

noiseThreshold_

double ldmx::NoiseGenerator::noiseThreshold_ {4}

private

The noise threshold.

Definition at line 70 of file NoiseGenerator.h.

{4};

Referenced by generateNoiseHits(), and setNoiseThreshold().

pedestal_

double ldmx::NoiseGenerator::pedestal_ {0}

private

Pedestal or baseline.

Definition at line 76 of file NoiseGenerator.h.

{0};

Referenced by generateNoiseHits(), and setPedestal().

poisson_dist_

std::unique_ptr<boost::math::poisson_distribution<> > ldmx::NoiseGenerator::poisson_dist_

private

pdf for poisson errors

Definition at line 82 of file NoiseGenerator.h.

Referenced by generateNoiseHits(), and NoiseGenerator().

random_

std::unique_ptr<TRandom3> ldmx::NoiseGenerator::random_ {nullptr}

private

Random number generator.

Definition at line 67 of file NoiseGenerator.h.

{nullptr};

Referenced by generateNoiseHits(), hasSeed(), and seedGenerator().

useGaussianModel_

bool ldmx::NoiseGenerator::useGaussianModel_ {true}

private

Gaussian flag.

Definition at line 79 of file NoiseGenerator.h.

{true};

Referenced by generateNoiseHits(), and NoiseGenerator().

---

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

• Tools/include/Tools/NoiseGenerator.h
• Tools/src/Tools/NoiseGenerator.cxx