This class is intended to be the main storage vessel for ANITA waveforms. It is similar in principle to RFWaveform from FFTtools. . More...

#include <AnalysisWaveform.h>

Collaboration diagram for AnalysisWaveform:

[legend]

Classes
struct	InterpolationOptions

class	PowerCalculationOptions

Public Types
enum	EvenEvaluationType { EVAL_LINEAR, EVAL_AKIMA }

enum	InterpolationType { AKIMA, SPARSE_YEN, REGULARIZED_SPARSE_YEN }

Public Member Functions
	AnalysisWaveform (int Nt, const double x, const double y, double nominal_dt=1./2.6, InterpolationType type=defaultInterpolationType, InterpolationOptions *opt=&defaultInterpolationOptions)

	AnalysisWaveform (int Nt, const double *y, double dt, double t0)

	AnalysisWaveform (int Nt, const FFTWComplex *f, double df, double t0)

	AnalysisWaveform (int Nt=260, double dt=1./2.6, double t0=0)

	AnalysisWaveform (const AnalysisWaveform &other)

AnalysisWaveform *	autoCorrelation (int npadtime=1, int npadfreq=0, double scale=1)

bool	checkIfPaddedInTime () const

double	deltaF () const

double	deltaT () const

void	drawEven (const char *opt="", int color=-1) const

void	drawHilbertEnvelope (const char *opt="", int color=-1) const

void	drawPhase (const char *opt="", int color=-1) const

void	drawPower (const char *opt="", int color=-1) const

void	drawPowerdB (const char *opt="", int color=-1) const

void	drawUneven (const char *opt="", int color=-1) const

double	evalEven (double t, EvenEvaluationType=EVAL_LINEAR) const

void	evalEven (int N, const double __restrict t, double __restrict v, EvenEvaluationType=EVAL_LINEAR) const

const TGraphAligned *	even () const

void	forceEvenSize (int size)

const FFTWComplex *	freq () const

double	getRMS () const

const TGraphAligned *	groupDelay () const

const TGraphAligned *	hilbertEnvelope () const

const AnalysisWaveform *	hilbertTransform () const

int	Neven () const

int	Nfreq () const

int	Nuneven () const

AnalysisWaveform &	operator= (const AnalysisWaveform &other)

void	padEven (int factor, int where=1)

void	padFreq (int factor)

void	padFreqAdd (int npad)

const TGraphAligned *	phase () const

const TGraphAligned *	power () const

const TGraphAligned *	powerdB () const

void	setColor (int c)

void	setFreqDisplayRange (double low, double high)

void	setPowerCalculationOptions (PowerCalculationOptions &opt)

void	setTimeDisplayRange (double low, double high)

void	setTitle (const char *title)

void	setWidth (int w)

const TGraphAligned *	uneven () const

TGraphAligned *	updateEven ()

void	updateEven (const TGraph *replace_even)

FFTWComplex *	updateFreq ()

void	updateFreq (int new_N, const FFTWComplex *new_freq, double new_df=0)

TGraphAligned *	updateUneven ()

void	updateUneven (const TGraph *replace_uneven)

void	zeroMeanEven ()

Static Public Member Functions
static void	allowEvenToUnevenConversion (bool allow)

static void	basisChange (AnalysisWaveform __restrict hpol_or_lcp, AnalysisWaveform __restrict vpol_or_rcp)

static AnalysisWaveform *	convolution (const AnalysisWaveform A, const AnalysisWaveform B, int npadfreq=0, double scale=1)

static AnalysisWaveform *	correlation (const AnalysisWaveform A, const AnalysisWaveform B, int npadfreq=0, double scale=1, int window_normalize=0)

static void	enableDebug (bool enable)

static AnalysisWaveform *	makeWf (const TGraph g, bool even=true, AnalysisWaveform replace=0)

static void	setCorrelationNag (bool nag)

static void	sumDifference (AnalysisWaveform __restrict a, AnalysisWaveform __restrict b)

Static Public Attributes
static InterpolationOptions	defaultInterpolationOptions

static InterpolationType	defaultInterpolationType

Detailed Description

This class is intended to be the main storage vessel for ANITA waveforms. It is similar in principle to RFWaveform from FFTtools. .

This class holds 3 coupled versions of the waveform:

uneven: An unevenly sampled time-domain waveform
even: An evenly sampled time-domain waveform
freq An evenly sampled frequency-domain waveform

Transforming between uneven and even is accomplished via interpolation (which is not strictly invertible) Transforming between even and freq is accomplished via FT (which is more or less invertible, up to machine precision)

Because the transformation between even and uneven is not reversible, it usually only makes sense to access or modify uneven prior to modifying even or freq. If an access to uneven is attempted after modifying even or freq,

There are two types of accessors, const ones which retrieve const data:

And ones which allow modification of the data and will then recompute the other two versions the next time they're requested:

Those have two versions, one where you modify the return value and one where you replace the value.

In order to make it seem magic, there is a lot of internal state that is complicated to reason about. Hopefully there are no bugs...

Cosmin Deaconu cozzy.nosp@m.d@ki.nosp@m.cp.uc.nosp@m.hica.nosp@m.go.ed.nosp@m.u

Definition at line 47 of file AnalysisWaveform.h.

Member Enumeration Documentation

◆ EvenEvaluationType

enum AnalysisWaveform::EvenEvaluationType

The interpolation method used in e.g. evalEven

Definition at line 70 of file AnalysisWaveform.h.

◆ InterpolationType

enum AnalysisWaveform::InterpolationType

The interpolation method used to transform in between evenly-sampled and unevenly-sampled waveforms

Definition at line 62 of file AnalysisWaveform.h.

Constructor & Destructor Documentation

◆ AnalysisWaveform() [1/5]

AnalysisWaveform::AnalysisWaveform	(	int	Nt,
		const double *	x,
		const double *	y,
		double	nominal_dt = `1./2.6`,
		InterpolationType	type = `defaultInterpolationType`,
		InterpolationOptions *	opt = `&defaultInterpolationOptions`
	)

Constructor for unevenly sampled waveform

Parameters

Nt	the number of samples
x	the time values
y	the voltage values
nominal_dt	the mean sample rate, defaults to ANITA rate
type	the InterpolationType used, defaults to defaultInterpolationType (which is probalby what you want to change to influence e.g. FilteredAnitaEvent).
opt	the InterpolationOptions used, defaults to defaultInterpolationOptions (which is probably what you want to change to influence e.g. FilteredAnitaEvent).

◆ AnalysisWaveform() [2/5]

AnalysisWaveform::AnalysisWaveform	(	int	Nt,
		const double *	y,
		double	dt,
		double	t0
	)

Constructor for evenly sampled waveform. Uneven waveform is set to even.

◆ AnalysisWaveform() [3/5]

AnalysisWaveform::AnalysisWaveform	(	int	Nt,
		const FFTWComplex *	f,
		double	df,
		double	t0
	)

Constructor from frequency domain (and uneven is set to be the same)

◆ AnalysisWaveform() [4/5]

AnalysisWaveform::AnalysisWaveform	(	int	Nt = `260`,
		double	dt = `1./2.6`,
		double	t0 = `0`
	)

empty, even constructor

◆ AnalysisWaveform() [5/5]

AnalysisWaveform::AnalysisWaveform ( const AnalysisWaveform & other )

Copy constructor. Will not blindly copy everything (like it won't bother copying anything that will have to be recalculated on its next access

Member Function Documentation

◆ allowEvenToUnevenConversion()

static void AnalysisWaveform::allowEvenToUnevenConversion ( bool allow )

static

Enable (or disable) conversion from even to uneven. The default is that it's not allowed, which means that as soon as some transformation is done on the evenly-sampled waveform or in the frequency domain, the uneven waveform is set equal to the even waveform.

◆ autoCorrelation()

AnalysisWaveform* AnalysisWaveform::autoCorrelation	(	int	npadtime = `1`,
		int	npadfreq = `0`,
		double	scale = `1`
	)

Compute the (circular) autocorrelation of this waveform.

If you want non-circular correlation, you can pass 1 (or more) to npadtime. No scaling is applied, but you can set a scale by passing a scale parameter. User responsible for deleting returned value;

◆ basisChange()

static void AnalysisWaveform::basisChange	(	AnalysisWaveform *__restrict	hpol_or_lcp,
		AnalysisWaveform *__restrict	vpol_or_rcp
	)

static

change between vpol / hpol and lcp / rcp

◆ checkIfPaddedInTime()

bool AnalysisWaveform::checkIfPaddedInTime ( ) const

Checks if the even waveform is zeropadded (by comparing second half to zero)

◆ correlation()

static AnalysisWaveform* AnalysisWaveform::correlation	(	const AnalysisWaveform *	A,
		const AnalysisWaveform *	B,
		int	npadfreq = `0`,
		double	scale = `1`,
		int	window_normalize = `0`
	)

static

Computes the (circular) correlation (in the frequency domain) of the two waveforms as a new waveform. Note that if you want to correlate two traces, they should be padded first. This does not pad them for you, but will complain if they are not! To turn off the nagging, see below function. It is also assumed the two are of the same length.

By default is no normalization done at all, the frequency values are simply multiplied appropriately and then everything is divided by 1/scale.

If window_normalize is non-zero, then the total power of the overlapping window of at least size window_normalize at each point is used to scale. Smaller window sizes will use the smallest window size power ot normalize. An overall factor of scale is still applied.

◆ deltaF()

double AnalysisWaveform::deltaF ( ) const

inline

Return the spacing between frequencies in the frequency domain

Definition at line 228 of file AnalysisWaveform.h.

◆ deltaT()

double AnalysisWaveform::deltaT ( ) const

inline

Return the mean sampling period

Definition at line 225 of file AnalysisWaveform.h.

◆ drawEven()

void AnalysisWaveform::drawEven	(	const char *	opt = `""`,
		int	color = `-1`
	)		const

Draw even

◆ drawHilbertEnvelope()

void AnalysisWaveform::drawHilbertEnvelope	(	const char *	opt = `""`,
		int	color = `-1`
	)		const

Draw Hilbert envelope

◆ drawPhase()

void AnalysisWaveform::drawPhase	(	const char *	opt = `""`,
		int	color = `-1`
	)		const

Draw phase

◆ drawPower()

void AnalysisWaveform::drawPower	(	const char *	opt = `""`,
		int	color = `-1`
	)		const

Draw power

◆ drawPowerdB()

void AnalysisWaveform::drawPowerdB	(	const char *	opt = `""`,
		int	color = `-1`
	)		const

Draw power in dB

◆ drawUneven()

void AnalysisWaveform::drawUneven	(	const char *	opt = `""`,
		int	color = `-1`
	)		const

Draw uneven

◆ enableDebug()

static void AnalysisWaveform::enableDebug ( bool enable )

static

Enable (or disable) a bunch of debugging crap. Only possible with ANITA_ANALYSIS_DEBUG defined to avoid slow branches

◆ evalEven() [1/2]

double AnalysisWaveform::evalEven	(	double	t,
		EvenEvaluationType	= `EVAL_LINEAR`
	)		const

Evaluate the even waveform at a point.

◆ evalEven() [2/2]

void AnalysisWaveform::evalEven	(	int	N,
		const double *__restrict	t,
		double *__restrict	v,
		EvenEvaluationType	= `EVAL_LINEAR`
	)		const

Evaluate the even waveform at the specified points.

◆ even()

const TGraphAligned* AnalysisWaveform::even ( ) const

Constant accessor for even waveform. Dont' coerce into non-const unless you know what you're doing

◆ forceEvenSize()

void AnalysisWaveform::forceEvenSize ( int size )

Forces the even waveform to be a particular size. This is equivalent to updateEven()->Set() (with padding) with the exception that it may be deferred if even waveform needs to be (re)calculated.

◆ freq()

const FFTWComplex* AnalysisWaveform::freq ( ) const

Constant accessor for frequency domain waveform. Dont' coerce into non-const unless you know what you're doing

◆ groupDelay()

const TGraphAligned* AnalysisWaveform::groupDelay ( ) const

Get the group delay

◆ hilbertEnvelope()

const TGraphAligned* AnalysisWaveform::hilbertEnvelope ( ) const

Get the hilbert envelope

◆ hilbertTransform()

const AnalysisWaveform* AnalysisWaveform::hilbertTransform ( ) const

Get the Hilbert Transform

◆ makeWf()

static AnalysisWaveform* AnalysisWaveform::makeWf	(	const TGraph *	g,
		bool	even = `true`,
		AnalysisWaveform *	replace = `0`
	)

static

Constructor from TGraph. If even is true, it will assume it's evenly sampled, otherwise will check

◆ Neven()

int AnalysisWaveform::Neven ( ) const

inline

Return the number of samples in the even waveform

Definition at line 219 of file AnalysisWaveform.h.

◆ Nfreq()

int AnalysisWaveform::Nfreq ( ) const

Return the length of the frequency domain complex waveform

◆ Nuneven()

int AnalysisWaveform::Nuneven ( ) const

inline

Return the number of samples in the uneven waveform

Definition at line 222 of file AnalysisWaveform.h.

◆ padEven()

void AnalysisWaveform::padEven	(	int	factor,
		int	where = `1`
	)

pad the even waveform (equivalent to upsampling the frequency).

if where > 0, zeroes will be added at the end if where < 0, zeroes will be added at the beginning if where == 0, zeroes will be padded before and after

◆ padFreq()

void AnalysisWaveform::padFreq ( int factor )

pad the frequency (equivalent to upsampling the even values)

◆ padFreqAdd()

void AnalysisWaveform::padFreqAdd ( int npad )

pad the frequency with a specific number of points (equivalent to upsampling the even values)

◆ phase()

const TGraphAligned* AnalysisWaveform::phase ( ) const

Get the phase

◆ power()

const TGraphAligned* AnalysisWaveform::power ( ) const

Get the power

◆ powerdB()

const TGraphAligned* AnalysisWaveform::powerdB ( ) const

Get the power in dB

◆ setPowerCalculationOptions()

void AnalysisWaveform::setPowerCalculationOptions ( PowerCalculationOptions & opt )

Change the options for calculating the power. This obviously will invalidate power() and powerdB()

◆ sumDifference()

static void AnalysisWaveform::sumDifference	(	AnalysisWaveform *__restrict	a,
		AnalysisWaveform *__restrict	b
	)

static

Change between a ,b -> (a + b)/2, (a - b)/2

◆ uneven()

const TGraphAligned* AnalysisWaveform::uneven ( ) const

Constant accessor for uneven waveform. Dont' coerce into non-const unless you know what you're doing

◆ updateEven() [1/2]

TGraphAligned* AnalysisWaveform::updateEven ( )

Update the even graph by modifying return value

◆ updateEven() [2/2]

void AnalysisWaveform::updateEven ( const TGraph * replace_even )

Update the even graph by replacing with argument

◆ updateFreq() [1/2]

FFTWComplex* AnalysisWaveform::updateFreq ( )

Update frequency graph by modifying return value

◆ updateFreq() [2/2]

void AnalysisWaveform::updateFreq	(	int	new_N,
		const FFTWComplex *	new_freq,
		double	new_df = `0`
	)

Update frequency graph by replacing with argumetnts

◆ updateUneven() [1/2]

TGraphAligned* AnalysisWaveform::updateUneven ( )

Update the uneven graph by modifying return value

◆ updateUneven() [2/2]

void AnalysisWaveform::updateUneven ( const TGraph * replace_uneven )

Update the uneven graph by replacing with argument

◆ zeroMeanEven()

void AnalysisWaveform::zeroMeanEven ( )

Zero mean even graph

Member Data Documentation

◆ defaultInterpolationOptions

InterpolationOptions AnalysisWaveform::defaultInterpolationOptions

static

Default interpolation options, may be changed by user

Definition at line 112 of file AnalysisWaveform.h.

◆ defaultInterpolationType

InterpolationType AnalysisWaveform::defaultInterpolationType

static

The default type used. May be changed by user

Definition at line 77 of file AnalysisWaveform.h.

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

include/AnalysisWaveform.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ EvenEvaluationType

◆ InterpolationType

Constructor & Destructor Documentation

◆ AnalysisWaveform() [1/5]

◆ AnalysisWaveform() [2/5]

◆ AnalysisWaveform() [3/5]

◆ AnalysisWaveform() [4/5]

◆ AnalysisWaveform() [5/5]

Member Function Documentation

◆ allowEvenToUnevenConversion()

◆ autoCorrelation()

◆ basisChange()

◆ checkIfPaddedInTime()

◆ correlation()

◆ deltaF()

◆ deltaT()

◆ drawEven()

◆ drawHilbertEnvelope()

◆ drawPhase()

◆ drawPower()

◆ drawPowerdB()

◆ drawUneven()

◆ enableDebug()

◆ evalEven() [1/2]

◆ evalEven() [2/2]

◆ even()

◆ forceEvenSize()

◆ freq()

◆ groupDelay()

◆ hilbertEnvelope()

◆ hilbertTransform()

◆ makeWf()

◆ Neven()

◆ Nfreq()

◆ Nuneven()

◆ padEven()

◆ padFreq()

◆ padFreqAdd()

◆ phase()

◆ power()

◆ powerdB()

◆ setPowerCalculationOptions()

◆ sumDifference()

◆ uneven()

◆ updateEven() [1/2]

◆ updateEven() [2/2]

◆ updateFreq() [1/2]

◆ updateFreq() [2/2]

◆ updateUneven() [1/2]

◆ updateUneven() [2/2]

◆ zeroMeanEven()

Member Data Documentation

◆ defaultInterpolationOptions

◆ defaultInterpolationType