Diana Software: MNoiseFrequencyCoherence Class Reference

Diana Software

compute correlation between different frequencies More...

Inheritance diagram for MNoiseFrequencyCoherence:

Classes
class	ChannelInfo

Public Member Functions
void	Init (Diana::QEvent &ev)
	Init method. More...

void	Do (Diana::QEvent &ev, const Diana::QEventList &neighbours)
	Do method. Declare and implement only one of the two versions. More...

void	Done ()
	Done method. More...

Private Member Functions
int	Transform (Diana::QRealComplexFFT *transformer, const Diana::QVector &in, Diana::QVectorC &out)

Private Attributes
std::map< int, ChannelInfo >	fChannelInfos

std::string	fOutput

Diana::QFFT::WindowType	fWindowType

int	fCoherentGain

std::string	fValidityKind
	Validity kind defines the kind of validity range for covariance matrix (run or dataset) More...

int	fValidityStart
	Validity start first run (or dataset) of validity. More...

int	fValidityEnd
	Validity end last run (or dataset) of validity. More...

std::vector< int >	fSRuns
	vector of runs used for nps calculation More...

int	fCurrentRun

std::string	fPulseLabel

Detailed Description

compute correlation between different frequencies

Author: M. Vignati

While MNoiseFrequencyCoherence computes the correlation of each frequency on the same channel channel using neighbours

Config example:

   module NoiseFrequencyCoherence
   verbosity = info
   enable = true
   ValidityKind = dataset
   ValidityStart = 6001
   ValidityEnd = 6001
   WindowType = welch
   WindowCoherentGain = 2
   Output = NODEFAULT
   endmod

Parameters:
- ValidityKind [string = "dataset"]: defines the kind of validity range for the crossnps, can be run or dataset
- ValidityStart: first run (or dataset) of validity
- ValidityEnd: last run (or dataset) of validity
- Output [string = NODEFAULT] output file for crossnps.
- WindowType [string = "None"]: type of window used for windowing (default is rectangular)
- WindowCoherentGain [int = 2]: defines window normalization
Optional Parameters: PulseLabel [string = "DAQ@Pulse"]: label of the QPulse storing the event waveform.
Reads:
- DAQ@Pulse (QPulse)
- DAQ@PulseInfo (QPulseInfo)
- DAQ@Header (QHeader)
Writes
- Coherence (global QAverageVector for each channel): self correlation of each frequency in a channel.

Definition at line 53 of file MNoiseFrequencyCoherence.hh.

Member Function Documentation

◆ Do()

void MNoiseFrequencyCoherence::Do	(	Diana::QEvent &	ev,
		const Diana::QEventList &	neighbours
	)

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

Definition at line 53 of file MNoiseFrequencyCoherence.cc.

References chanRunData, err, MNoiseFrequencyCoherence::ChannelInfo::fCovariance, MNoiseFrequencyCoherence::ChannelInfo::fNumEvents, MNoiseFrequencyCoherence::ChannelInfo::fPower, MNoiseFrequencyCoherence::ChannelInfo::fPowerB, QChannelRunData::fSamplingFrequency, MNoiseFrequencyCoherence::ChannelInfo::fTransformer, QEvent::Get(), QEvent::GetByLabel(), QPulseInfo::GetChannelId(), QRunData::GetChannelRunData(), QPulseInfo::GetMasterSample(), QHeader::GetRun(), QSampleInfo::GetSampleIndex(), QHeader::GetTime(), rHandle, and QEventList::Size().

◆ Done()

void MNoiseFrequencyCoherence::Done ( )

Done method.

Definition at line 134 of file MNoiseFrequencyCoherence.cc.

References channel, MNoiseFrequencyCoherence::ChannelInfo::fCovariance, MNoiseFrequencyCoherence::ChannelInfo::fNumEvents, MNoiseFrequencyCoherence::ChannelInfo::fPower, MNoiseFrequencyCoherence::ChannelInfo::fPowerB, QAverageVectorC::SetNumEvents(), and QAverageVectorC::SetSourceRuns().

◆ Init()

void MNoiseFrequencyCoherence::Init ( Diana::QEvent & ev )

Init method.

Definition at line 19 of file MNoiseFrequencyCoherence.cc.

References Q_INT_DEFAULT, Q_STRING_DEFAULT, QEvent::Require(), QEvent::RequireByLabel(), QFFT::StrToWindowType(), QFFT::WT_None, and QFFT::WT_Rect.

◆ Transform()

int MNoiseFrequencyCoherence::Transform	(	Diana::QRealComplexFFT *	transformer,
		const Diana::QVector &	in,
		Diana::QVectorC &	out
	)

private

Definition at line 185 of file MNoiseFrequencyCoherence.cc.

Member Data Documentation

◆ fChannelInfos

std::map<int,ChannelInfo > MNoiseFrequencyCoherence::fChannelInfos

private

Definition at line 80 of file MNoiseFrequencyCoherence.hh.

◆ fCoherentGain

int MNoiseFrequencyCoherence::fCoherentGain

private

Definition at line 84 of file MNoiseFrequencyCoherence.hh.

◆ fCurrentRun

int MNoiseFrequencyCoherence::fCurrentRun

private

Definition at line 100 of file MNoiseFrequencyCoherence.hh.

◆ fOutput

std::string MNoiseFrequencyCoherence::fOutput

private

Definition at line 81 of file MNoiseFrequencyCoherence.hh.

◆ fPulseLabel

std::string MNoiseFrequencyCoherence::fPulseLabel

private

Definition at line 101 of file MNoiseFrequencyCoherence.hh.

◆ fSRuns

std::vector<int> MNoiseFrequencyCoherence::fSRuns

private

vector of runs used for nps calculation

Definition at line 98 of file MNoiseFrequencyCoherence.hh.

◆ fValidityEnd

int MNoiseFrequencyCoherence::fValidityEnd

private

Validity end last run (or dataset) of validity.

Definition at line 94 of file MNoiseFrequencyCoherence.hh.

◆ fValidityKind

std::string MNoiseFrequencyCoherence::fValidityKind

private

Validity kind defines the kind of validity range for covariance matrix (run or dataset)

Definition at line 88 of file MNoiseFrequencyCoherence.hh.

◆ fValidityStart

int MNoiseFrequencyCoherence::fValidityStart

private

Validity start first run (or dataset) of validity.

Definition at line 91 of file MNoiseFrequencyCoherence.hh.

◆ fWindowType

Diana::QFFT::WindowType MNoiseFrequencyCoherence::fWindowType

private

Definition at line 83 of file MNoiseFrequencyCoherence.hh.

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

pkg/modfreqdecorrelator/MNoiseFrequencyCoherence.hh
pkg/modfreqdecorrelator/MNoiseFrequencyCoherence.cc