MNoiseCrossFrequencyCovariance Class Reference

compute correlation between different frequencies More...

Inheritance diagram for MNoiseCrossFrequencyCovariance:

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 (const Diana::QVector &in, Diana::QVectorC &out)

Private Attributes
std::vector< int >	fChannelList
size_t	fTimeLength
std::map< int, std::map< int, ChannelInfo > >	fRosetta
std::string	fOutput
Diana::QFFT::WindowType	fWindowType
int	fCoherentGain
Diana::QRealComplexFFT *	fTransformer
bool	fUseMainEvent
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...
bool	fSingleChannel
	see description 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 MNoiseCrossPowerSpectrum computes the correlation of each frequency across channels, this module computes also the correlation between different frequencies across different channels.

• Config example:

     module NoiseCrossFrequencyCovariance
     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:
  • SingleChannel [bool = false]: estimate frequency covariance across same channel only.
• Reads:
  • DAQ@Pulse (QPulse)
  • DAQ@PulseInfo (QPulseInfo)
  • DAQ@Header (QHeader)
• Writes
  • CovarianceFreq (global QMatrixC for each channel pair): covariance matrix across frequencies.
  • Coherence (global QVectorC for each channel): self correlation of each frequency in a channel.

Definition at line 55 of file MNoiseCrossFrequencyCovariance.hh.

Member Function Documentation

Do()

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

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

Definition at line 58 of file MNoiseCrossFrequencyCovariance.cc.

References QMatrixC::Conjugate(), QMatrixC::Div(), err, MNoiseCrossFrequencyCovariance::ChannelInfo::fCoherence, MNoiseCrossFrequencyCovariance::ChannelInfo::fCovarianceFreq, MNoiseCrossFrequencyCovariance::ChannelInfo::fNevents, MNoiseCrossFrequencyCovariance::ChannelInfo::fPower, QEvent::Get(), QEvent::GetByLabel(), QVectorConstView::GetVector(), QMatrixC::H(), QMatrixC::Magnitude(), QMatrixC::Mult(), QEventList::Push(), and QEventList::Size().

Done()

void MNoiseCrossFrequencyCovariance::Done

(

)

Done method.

Definition at line 167 of file MNoiseCrossFrequencyCovariance.cc.

References MNoiseCrossFrequencyCovariance::ChannelInfo::fCoherence, MNoiseCrossFrequencyCovariance::ChannelInfo::fCovarianceFreq, MNoiseCrossFrequencyCovariance::ChannelInfo::fNevents, and MNoiseCrossFrequencyCovariance::ChannelInfo::fPower.

Init()

void MNoiseCrossFrequencyCovariance::Init

(

Diana::QEvent &

ev

)

Init method.

Definition at line 23 of file MNoiseCrossFrequencyCovariance.cc.

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

Transform()

int MNoiseCrossFrequencyCovariance::Transform ( const Diana::QVector &  in, Diana::QVectorC &  out  )

private

Definition at line 230 of file MNoiseCrossFrequencyCovariance.cc.

Member Data Documentation

fChannelList

std::vector<int> MNoiseCrossFrequencyCovariance::fChannelList

private

Definition at line 80 of file MNoiseCrossFrequencyCovariance.hh.

fCoherentGain

int MNoiseCrossFrequencyCovariance::fCoherentGain

private

Definition at line 87 of file MNoiseCrossFrequencyCovariance.hh.

fCurrentRun

int MNoiseCrossFrequencyCovariance::fCurrentRun

private

Definition at line 107 of file MNoiseCrossFrequencyCovariance.hh.

fOutput

std::string MNoiseCrossFrequencyCovariance::fOutput

private

Definition at line 84 of file MNoiseCrossFrequencyCovariance.hh.

fPulseLabel

std::string MNoiseCrossFrequencyCovariance::fPulseLabel

private

Definition at line 109 of file MNoiseCrossFrequencyCovariance.hh.

fRosetta

std::map<int,std::map<int,ChannelInfo> > MNoiseCrossFrequencyCovariance::fRosetta

private

Definition at line 83 of file MNoiseCrossFrequencyCovariance.hh.

fSingleChannel

bool MNoiseCrossFrequencyCovariance::fSingleChannel

private

see description

Definition at line 102 of file MNoiseCrossFrequencyCovariance.hh.

fSRuns

std::vector<int> MNoiseCrossFrequencyCovariance::fSRuns

private

vector of runs used for nps calculation

Definition at line 105 of file MNoiseCrossFrequencyCovariance.hh.

fTimeLength

size_t MNoiseCrossFrequencyCovariance::fTimeLength

private

Definition at line 82 of file MNoiseCrossFrequencyCovariance.hh.

fTransformer

Diana::QRealComplexFFT* MNoiseCrossFrequencyCovariance::fTransformer

private

Definition at line 88 of file MNoiseCrossFrequencyCovariance.hh.

fUseMainEvent

bool MNoiseCrossFrequencyCovariance::fUseMainEvent

private

Definition at line 91 of file MNoiseCrossFrequencyCovariance.hh.

fValidityEnd

int MNoiseCrossFrequencyCovariance::fValidityEnd

private

Validity end last run (or dataset) of validity.

Definition at line 99 of file MNoiseCrossFrequencyCovariance.hh.

fValidityKind

std::string MNoiseCrossFrequencyCovariance::fValidityKind

private

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

Definition at line 93 of file MNoiseCrossFrequencyCovariance.hh.

fValidityStart

int MNoiseCrossFrequencyCovariance::fValidityStart

private

Validity start first run (or dataset) of validity.

Definition at line 96 of file MNoiseCrossFrequencyCovariance.hh.

fWindowType

Diana::QFFT::WindowType MNoiseCrossFrequencyCovariance::fWindowType

private

Definition at line 86 of file MNoiseCrossFrequencyCovariance.hh.

---

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

• pkg/modfreqdecorrelator/MNoiseCrossFrequencyCovariance.hh
• pkg/modfreqdecorrelator/MNoiseCrossFrequencyCovariance.cc