dsp::SKLimits Class Reference

Computes the upper and lower bounds on estimates of the generalized spectral kurtosis. More...

#include <SKLimits.h>

Public Member Functions
	SKLimits (unsigned M, float std_devs)
void	calc_limits ()
double	get_lower_threshold () const
double	get_upper_threshold () const
double	get_symmetric_threshold () const
void	set_M (unsigned M)
	Set the number of intensity samples used to estimate the spectral kurtosis.
void	set_Nd (unsigned Nd)
	Set the number of Nyquist-sampled intensities integrated in each intensity sample. More...
void	set_std_devs (float std_devs)
	Set the number of standard deviations used to define the family-wise error rate.
void	set_fwer (float fwer)
	Set the family-wise error rate. More...
void	set_ntest (unsigned ntest)
	Set the number of times that a given sample will be tested. More...
dsp::ProbabilityDensity *	get_pdf ()
	Get the probability density function appropriate to the input values of M and Nd.

Static Public Member Functions
static PearsonIV::Parameters	parametersIV (double M)
	Equation (53) of Nita & Gary (2010a) More...
static PearsonIV::Parameters	parametersIV (double M, double Nd)
	Equation (9) of Nita & Gary (2010b) followed by computation of beta1 and beta2. More...
static PearsonVI::Parameters	parametersVI (double M, double Nd)
	Equation (9) of Nita & Gary (2010b) More...

Detailed Description

Computes the upper and lower bounds on estimates of the generalized spectral kurtosis.

The bounds are computed by using the Newton-Raphson method to invert the cumulative distribution function (CF) and complementary CF (CCF) of the generalized spectral kurtosis (SK) estimator. Both the CF and CCF are computed by numerically integrating the probability density function (PDF) of SK. As described by Nita & Gary (2010b; MNRAS 406:60) https://ui.adsabs.harvard.edu/abs/2010MNRAS.406L..60N/abstract, the PDF of SK is approximated using either a PearsonIV or PearsonVI distribution. The decision to use one or the other is based on Equation 11 of Nita & Gary (2010b) and the text that follows this equation (note that there is a small error in this text, where "Type III" should read "Type VI", as in Figure 1 and its caption).

Member Function Documentation

parametersIV() [1/2]

dsp::PearsonIV::Parameters dsp::SKLimits::parametersIV ( double  M )

static

Equation (53) of Nita & Gary (2010a)

Calculate the standard statistical parameters for Nyquist-sampled intensities

parametersIV() [2/2]

dsp::PearsonIV::Parameters dsp::SKLimits::parametersIV ( double  M, double  Nd  )

static

Equation (9) of Nita & Gary (2010b) followed by computation of beta1 and beta2.

Calculate the standard statistical parameters for integrated intensities

parametersVI()

dsp::PearsonVI::Parameters dsp::SKLimits::parametersVI ( double  M, double  Nd  )

static

Equation (9) of Nita & Gary (2010b)

Calculate the standard statistical parameters for integrated intensities

set_fwer()

void dsp::SKLimits::set_fwer

(

float

fwer

)

Set the family-wise error rate.

e.g. see https://en.wikipedia.org/wiki/Multiple_comparisons_problem

set_Nd()

void dsp::SKLimits::set_Nd

(

unsigned

Nd

)

Set the number of Nyquist-sampled intensities integrated in each intensity sample.

Should be set to ndat * npol * ndim

set_ntest()

void dsp::SKLimits::set_ntest

(

unsigned

ntest

)

Set the number of times that a given sample will be tested.

e.g. the number of polarizations times the overlap factor

---

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

• SKLimits.h
• SKLimits.C