speckleAmpPSD.hpp File Reference

Calculates the PSD of speckle intensity given a modified Fourier mode amplitude PSD. More...

Calculates the PSD of speckle intensity given a modified Fourier mode amplitude PSD.

Author

Jared R. Males (jared.nosp@m.male.nosp@m.s@gma.nosp@m.il.c.nosp@m.om)

Definition in file speckleAmpPSD.hpp.

#include <vector>
#include <Eigen/Dense>
#include "../../math/constants.hpp"
#include "../../math/randomT.hpp"
#include "../../math/vectorUtils.hpp"
#include "../../sigproc/signalWindows.hpp"
#include "../../sigproc/psdUtils.hpp"
#include "../../sigproc/psdFilter.hpp"
#include "../../sigproc/psdVarMean.hpp"
#include "../../sigproc/averagePeriodogram.hpp"
#include "jincFuncs.hpp"

Go to the source code of this file.

Namespaces
namespace	mx
	The mxlib c++ namespace.

Functions
template<typename realT>
int	mx::AO::analysis::speckleAmpPSD (std::vector< realT > &spFreq, std::vector< realT > &spPSD, const std::vector< realT > &freq, const std::vector< realT > &fmPSD, const std::vector< std::complex< realT > > &fmXferFxn, const std::vector< realT > &nPSD, const std::vector< std::complex< realT > > &nXferFxn, int N, std::vector< realT > *vars=nullptr, std::vector< realT > *bins=nullptr, bool noPSD=false)
	Calculate the PSD of the speckle intensity given the PSD of Fourier mode amplitude.
template<typename realT>
int	mx::AO::analysis::speckleAmpVarMean (std::vector< realT > &vars, std::vector< realT > &bins, std::vector< realT > &freq, std::vector< realT > &fmPSD, std::vector< std::complex< realT > > &fmXferFxn, std::vector< realT > &nPSD, std::vector< std::complex< realT > > &nXferFxn, int N)
	Calculate the variance of the mean vs bin size in a speckle time-series.

Function Documentation

speckleAmpPSD()

template<typename realT>

int mx::AO::analysis::speckleAmpPSD	(	std::vector< realT > &	spFreq,
		std::vector< realT > &	spPSD,
		const std::vector< realT > &	freq,
		const std::vector< realT > &	fmPSD,
		const std::vector< std::complex< realT > > &	fmXferFxn,
		const std::vector< realT > &	nPSD,
		const std::vector< std::complex< realT > > &	nXferFxn,
		int	N,
		std::vector< realT > *	vars = nullptr,
		std::vector< realT > *	bins = nullptr,
		bool	noPSD = false )

Calculate the PSD of the speckle intensity given the PSD of Fourier mode amplitude.

Does so by generating a time-series from the PSD using Fourier-domain convolution, and calculating the average periodogram.

A Hann window is used.

Statistics are not currently normalized. You need to normalize to match expected contrast if desired.

Will also calculate the binned-variances in the generated time-series, if the arguments vars and bins are not null pointers.

Todo

Figure out what's going on with psdFilter normalization!

probably need to not do overlapped averaging in periodogram. Could drop mean-sub then.

Parameters

[out]	spFreq	The frequency grid of the output PSD
[out]	spPSD	The speckle amplitude PSD corresponding to the freq coordinates. Will be resized.
[in]	freq	The Frequency grid of the input PSD
[in]	fmPSD	The Fourier mode PSD.
[in]	fmXferFxn	The complex error transfer function, as a function of freq
[in]	nPSD	The open-loop noise PSD
[in]	nXferFxn	The noise transfer function, as a function of freq
[in]	N	The number of trials to use in calculating the amplitude PSD.
[out]	vars	[optional] The binned variances of the time series generated.
[in]	bins	[optional] The bin sizes to use in calculating vars.
[in]	noPSD	[optional] if true then the PSD is not actually calculated, only the binned variances

Definition at line 50 of file speckleAmpPSD.hpp.

References mx::sigproc::augment1SidedPSD(), backward, mx::math::half_pi(), mx::sigproc::window::hann(), mx::sigproc::psdVar(), mx::math::randomT< typeT, _ranengT, _randistT >::seed(), mx::sigproc::averagePeriodogram< realT >::size(), mx::math::vectorBinMeans(), mx::math::vectorMeanSub(), mx::math::vectorVariance(), and mx::sigproc::averagePeriodogram< realT >::win().

speckleAmpVarMean()

template<typename realT>

int mx::AO::analysis::speckleAmpVarMean	(	std::vector< realT > &	vars,
		std::vector< realT > &	bins,
		std::vector< realT > &	freq,
		std::vector< realT > &	fmPSD,
		std::vector< std::complex< realT > > &	fmXferFxn,
		std::vector< realT > &	nPSD,
		std::vector< std::complex< realT > > &	nXferFxn,
		int	N )

Calculate the variance of the mean vs bin size in a speckle time-series.

Does so by generating a time-series from the PSD using Fourier-domain convolution, then calculates the binned-variances in the generated time-series.

This is just a wrapper for speckleAmpPSD, with no actual PSD calculation.

Parameters

[out]	vars	The binned variances of the time series generated.
[in]	bins	The bin sizes to use to calculate the variances.
[in]	freq	The Frequency grid of the input PSD
[in]	fmPSD	The open-loop Fourier mode PSD.
[in]	fmXferFxn	The complex error transfer function, as a function of freq
[in]	nPSD	The open-loop noise PSD
[in]	nXferFxn	The noise transfer function, as a function of freq
[in]	N	The number of trials to use in calculating the amplitude time-series.

Definition at line 277 of file speckleAmpPSD.hpp.