#include <MQwMockable.h>

Inheritance diagram for MQwMockable:

Public Member Functions
	MQwMockable ()

virtual	~MQwMockable ()

Parity mock data generation
static boost::mt19937	fRandomnessGenerator
	Internal randomness generator. More...

static boost::normal_distribution < double >	fNormalDistribution
	Internal normal probability distribution. More...

static boost::variate_generator < boost::mt19937, boost::normal_distribution < double > >	fNormalRandomVariable
	Internal normal random variable. More...

bool	fUseExternalRandomVariable
	Flag to use an externally provided normal random variable. More...

double	fExternalRandomVariable
	Externally provided normal random variable. More...

Double_t	fMockAsymmetry
	Helicity asymmetry. More...

Double_t	fMockGaussianMean
	Mean of normal distribution. More...

Double_t	fMockGaussianSigma
	Sigma of normal distribution. More...

std::vector< Double_t >	fMockDriftAmplitude
	Harmonic drift amplitude. More...

std::vector< Double_t >	fMockDriftFrequency
	Harmonic drift frequency. More...

std::vector< Double_t >	fMockDriftPhase
	Harmonic drift phase. More...

void	SetRandomEventDriftParameters (Double_t amplitude, Double_t phase, Double_t frequency)
	Set a single set of harmonic drift parameters. More...

void	AddRandomEventDriftParameters (Double_t amplitude, Double_t phase, Double_t frequency)
	Add drift parameters to the internal set. More...

void	SetRandomEventParameters (Double_t mean, Double_t sigma)
	Set the normal random event parameters. More...

void	SetRandomEventAsymmetry (Double_t asymmetry)
	Set the helicity asymmetry. More...

Double_t	GetRandomValue ()

virtual void	RandomizeEventData (int helicity=0, double time=0.0)=0
	Internally generate random event data. More...

virtual void	EncodeEventData (std::vector< UInt_t > &buffer)=0
	Encode the event data into a CODA buffer. More...

void	UseExternalRandomVariable ()
	Set the flag to use an externally provided random variable. More...

void	SetExternalRandomVariable (Double_t random_variable)
	Set the externally provided random variable. More...

Detailed Description

Definition at line 19 of file MQwMockable.h.

Constructor & Destructor Documentation

MQwMockable::MQwMockable ( )

inline

Class: MQwMockable Mix-in class to enable mock-data generation for a data element. Only the data element classes which actually contain raw data (such as QwVQWK_Channel, QwScaler_Channel, etc.) should inherit from this class.

Definition at line 29 of file MQwMockable.h.

References fMockDriftAmplitude, fMockDriftFrequency, and fMockDriftPhase.

                : fUseExternalRandomVariable(false),
      fMockAsymmetry(0.0), fMockGaussianMean(0.0),
                  fMockGaussianSigma(0.0)
   {
     // Mock drifts
     fMockDriftAmplitude.clear();
     fMockDriftFrequency.clear();
     fMockDriftPhase.clear();
   }

virtual MQwMockable::~MQwMockable ( )

inlinevirtual

Definition at line 38 of file MQwMockable.h.

References fMockDriftAmplitude, fMockDriftFrequency, and fMockDriftPhase.

                          {
     fMockDriftAmplitude.clear();
     fMockDriftFrequency.clear();
     fMockDriftPhase.clear();
   }

Member Function Documentation

void MQwMockable::AddRandomEventDriftParameters	(	Double_t	amplitude,
		Double_t	phase,
		Double_t	frequency
	)

Add drift parameters to the internal set.

Definition at line 32 of file MQwMockable.cc.

References fMockDriftAmplitude, fMockDriftFrequency, and fMockDriftPhase.

Referenced by QwIntegrationPMT::AddRandomEventDriftParameters().

 {
   // Add new values
   fMockDriftAmplitude.push_back(amplitude);
   fMockDriftFrequency.push_back(frequency);
   fMockDriftPhase.push_back(phase);
   return;
 }

Here is the caller graph for this function:

virtual void MQwMockable::EncodeEventData ( std::vector< UInt_t > & buffer )

pure virtual

Encode the event data into a CODA buffer.

Implemented in QwScaler_Channel< data_mask, data_shift >, QwScaler_Channel< 0x00ffffff, 0 >, QwVQWK_Channel, QwSIS3320_Channel, and VQwScaler_Channel.

Double_t MQwMockable::GetRandomValue ( )

Return a random value generated either from the internal or external Random Variable.

Definition at line 54 of file MQwMockable.cc.

References fExternalRandomVariable, fNormalRandomVariable, and fUseExternalRandomVariable.

Referenced by VQwScaler_Channel::RandomizeEventData(), and QwVQWK_Channel::RandomizeEventData().

                                     {
   Double_t random_variable;
   if (fUseExternalRandomVariable)
     // external normal random variable
     random_variable = fExternalRandomVariable;
   else
     // internal normal random variable
     random_variable = fNormalRandomVariable();
   return random_variable;
 }

Here is the caller graph for this function:

virtual void MQwMockable::RandomizeEventData	(	int	helicity = `0`,
		double	time = `0.0`
	)

pure virtual

Internally generate random event data.

Implemented in QwVQWK_Channel, QwSIS3320_Channel, and VQwScaler_Channel.

void MQwMockable::SetExternalRandomVariable ( Double_t random_variable )

inline

Set the externally provided random variable.

Definition at line 69 of file MQwMockable.h.

References fExternalRandomVariable, and fUseExternalRandomVariable.

Referenced by QwIntegrationPMT::SetExternalRandomVariable().

                                                             {
     fUseExternalRandomVariable = true;
     fExternalRandomVariable = random_variable;
   };

Here is the caller graph for this function:

void MQwMockable::SetRandomEventAsymmetry ( Double_t asymmetry )

Set the helicity asymmetry.

Definition at line 48 of file MQwMockable.cc.

References fMockAsymmetry.

Referenced by QwIntegrationPMT::SetRandomEventAsymmetry().

 {
   fMockAsymmetry = asymmetry;
   return;
 }

Here is the caller graph for this function:

void MQwMockable::SetRandomEventDriftParameters	(	Double_t	amplitude,
		Double_t	phase,
		Double_t	frequency
	)

Set a single set of harmonic drift parameters.

Definition at line 19 of file MQwMockable.cc.

References fMockDriftAmplitude, fMockDriftFrequency, and fMockDriftPhase.

Referenced by QwIntegrationPMT::SetRandomEventDriftParameters().

 {
   // Clear existing values
   fMockDriftAmplitude.clear();
   fMockDriftFrequency.clear();
   fMockDriftPhase.clear();
   // Add new values
   fMockDriftAmplitude.push_back(amplitude);
   fMockDriftFrequency.push_back(frequency);
   fMockDriftPhase.push_back(phase);
   return;
 }

Here is the caller graph for this function:

void MQwMockable::SetRandomEventParameters	(	Double_t	mean,
		Double_t	sigma
	)

Set the normal random event parameters.

Definition at line 41 of file MQwMockable.cc.

References fMockGaussianMean, and fMockGaussianSigma.

Referenced by VQwScaler_Channel::InitializeChannel(), QwIntegrationPMT::SetRandomEventParameters(), QwQPD::SetRandomEventParameters(), and QwLinearDiodeArray::SetRandomEventParameters().

 {
   fMockGaussianMean = mean;
   fMockGaussianSigma = sigma;
   return;
 }

Here is the caller graph for this function:

void MQwMockable::UseExternalRandomVariable ( )

inline

Set the flag to use an externally provided random variable.

Definition at line 67 of file MQwMockable.h.

References fUseExternalRandomVariable.

Referenced by QwIntegrationPMT::UseExternalRandomVariable().

67 { fUseExternalRandomVariable = true; };

MQwMockable::fUseExternalRandomVariable

bool fUseExternalRandomVariable

Flag to use an externally provided normal random variable.

Definition: MQwMockable.h:86

Here is the caller graph for this function:

Field Documentation

double MQwMockable::fExternalRandomVariable

protected

Externally provided normal random variable.

Definition at line 88 of file MQwMockable.h.

Referenced by GetRandomValue(), and SetExternalRandomVariable().

Double_t MQwMockable::fMockAsymmetry

protected

Helicity asymmetry.

Definition at line 91 of file MQwMockable.h.

Referenced by QwVQWK_Channel::InitializeChannel(), QwSIS3320_Channel::InitializeChannel(), VQwScaler_Channel::RandomizeEventData(), QwVQWK_Channel::RandomizeEventData(), and SetRandomEventAsymmetry().

std::vector<Double_t> MQwMockable::fMockDriftAmplitude

protected

Harmonic drift amplitude.

Definition at line 94 of file MQwMockable.h.

Referenced by AddRandomEventDriftParameters(), QwVQWK_Channel::InitializeChannel(), MQwMockable(), VQwScaler_Channel::RandomizeEventData(), QwVQWK_Channel::RandomizeEventData(), SetRandomEventDriftParameters(), and ~MQwMockable().

std::vector<Double_t> MQwMockable::fMockDriftFrequency

protected

Harmonic drift frequency.

Definition at line 95 of file MQwMockable.h.

Referenced by AddRandomEventDriftParameters(), QwVQWK_Channel::InitializeChannel(), MQwMockable(), VQwScaler_Channel::RandomizeEventData(), QwVQWK_Channel::RandomizeEventData(), SetRandomEventDriftParameters(), and ~MQwMockable().

std::vector<Double_t> MQwMockable::fMockDriftPhase

protected

Harmonic drift phase.

Definition at line 96 of file MQwMockable.h.

Referenced by AddRandomEventDriftParameters(), QwVQWK_Channel::InitializeChannel(), MQwMockable(), VQwScaler_Channel::RandomizeEventData(), QwVQWK_Channel::RandomizeEventData(), SetRandomEventDriftParameters(), and ~MQwMockable().

Double_t MQwMockable::fMockGaussianMean

protected

Mean of normal distribution.

Definition at line 92 of file MQwMockable.h.

Referenced by QwVQWK_Channel::InitializeChannel(), QwSIS3320_Channel::InitializeChannel(), VQwScaler_Channel::RandomizeEventData(), QwVQWK_Channel::RandomizeEventData(), and SetRandomEventParameters().

Double_t MQwMockable::fMockGaussianSigma

protected

Sigma of normal distribution.

Definition at line 93 of file MQwMockable.h.

Referenced by QwVQWK_Channel::InitializeChannel(), QwSIS3320_Channel::InitializeChannel(), VQwScaler_Channel::RandomizeEventData(), QwVQWK_Channel::RandomizeEventData(), and SetRandomEventParameters().

boost::normal_distribution< double > MQwMockable::fNormalDistribution

staticprotected

Internal normal probability distribution.

Definition at line 81 of file MQwMockable.h.

boost::variate_generator< boost::mt19937, boost::normal_distribution< double > > MQwMockable::fNormalRandomVariable

staticprotected

Internal normal random variable.

Definition at line 84 of file MQwMockable.h.

Referenced by GetRandomValue().

boost::mt19937 MQwMockable::fRandomnessGenerator

staticprotected

Internal randomness generator.

Definition at line 79 of file MQwMockable.h.

bool MQwMockable::fUseExternalRandomVariable

protected

Flag to use an externally provided normal random variable.

Definition at line 86 of file MQwMockable.h.

Referenced by GetRandomValue(), QwVQWK_Channel::InitializeChannel(), SetExternalRandomVariable(), and UseExternalRandomVariable().

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

Public Member Functions

Parity mock data generation

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation