Arroyo::subharmonic_method Class Reference

#include <subharmonic_method.h>

Inheritance diagram for Arroyo::subharmonic_method:

List of all members.


Public Member Functions
template<class T>
void	apply_subharmonic_correction_impl (const power_spectrum &pspec, const vector< long > &axes, double pixscale, bool random, T *data) const
virtual void	apply_subharmonic_correction (const power_spectrum &pspec, const vector< long > &axes, double pixscale, bool random, float *data) const =0
virtual void	apply_subharmonic_correction (const power_spectrum &pspec, const vector< long > &axes, double pixscale, bool random, double *data) const =0
	subharmonic_method ()
virtual	~subharmonic_method ()
virtual subharmonic_method *	clone () const =0
virtual void	read (const char *filename)=0
virtual void	read (const iofits &iof)=0
virtual void	write (const char *filename) const =0
virtual void	write (iofits &iof) const =0
virtual void	print (ostream &os, const char *prefix="") const =0
virtual int	intrinsic_dimensionality () const =0
virtual long	get_subharmonic_depth () const =0
virtual void	set_subharmonic_depth (long nsubm)=0
Static Public Member Functions
subharmonic_method *	subharmonic_method_factory (const char *filename)
subharmonic_method *	subharmonic_method_factory (const iofits &iof)
Static Public Attributes
int	verbose_level
Friends
bool	operator== (const subharmonic_method &subm1, const subharmonic_method &subm2)

Detailed Description

A virtual base class to represent methods for performing subharmonic corrections when constructing refractive_atmospheric_layers from power spectra

Constructor & Destructor Documentation

Arroyo::subharmonic_method::subharmonic_method ( ) [inline]

Null constructor

virtual Arroyo::subharmonic_method::~subharmonic_method ( ) [inline, virtual]

Virtual destructor

Member Function Documentation

virtual void Arroyo::subharmonic_method::apply_subharmonic_correction ( const power_spectrum & pspec,

const vector< long > & axes,

double pixscale,

bool random,

double * data

) const [pure virtual]

Implemented in Arroyo::generalized_subharmonic_method.

virtual void Arroyo::subharmonic_method::apply_subharmonic_correction ( const power_spectrum & pspec,

const vector< long > & axes,

double pixscale,

bool random,

float * data

) const [pure virtual]

Implemented in Arroyo::generalized_subharmonic_method.

template<class T>

void Arroyo::subharmonic_method::apply_subharmonic_correction_impl ( const power_spectrum & pspec,

const vector< long > & axes,

double pixscale,

bool random,

T * data

) const

Virtual function to apply the subharmonic correction to a raw array of data.
This array is assumed to be halfcomplex The axes contain the two dimensions of the halfcomplex array, with the second dimension corresponding to the shortened axis. These axes count complex elements
Reimplemented in Arroyo::generalized_subharmonic_method.

virtual subharmonic_method* Arroyo::subharmonic_method::clone ( ) const [pure virtual]

Virtual clone method
Calling routine is responsible for deleting memory
Implemented in Arroyo::null_subharmonic_method, Arroyo::generalized_subharmonic_method, Arroyo::Lane_subharmonic_method, Arroyo::Johansson_Gavel_subharmonic_method, and Arroyo::quad_pixel_subharmonic_method.

virtual long Arroyo::subharmonic_method::get_subharmonic_depth ( ) const [pure virtual]

Get the number of subharmonics
Implemented in Arroyo::null_subharmonic_method, Arroyo::generalized_subharmonic_method, and Arroyo::quad_pixel_subharmonic_method.

virtual int Arroyo::subharmonic_method::intrinsic_dimensionality ( ) const [pure virtual]

Subharmonic methods are intended to be used on arrays with either even or odd dimensional axes. This function returns zero if the method should be used on even axes, and 1 if the method should be used on odd axes. If either is acceptable, this function returns -1
Implemented in Arroyo::null_subharmonic_method, Arroyo::generalized_subharmonic_method, and Arroyo::quad_pixel_subharmonic_method.

virtual void Arroyo::subharmonic_method::print ( ostream & os,

const char * prefix = ""

) const [pure virtual]

Print
Implements Arroyo::AO_sim_base.
Implemented in Arroyo::null_subharmonic_method, Arroyo::generalized_subharmonic_method, Arroyo::Lane_subharmonic_method, Arroyo::Johansson_Gavel_subharmonic_method, and Arroyo::quad_pixel_subharmonic_method.

virtual void Arroyo::subharmonic_method::read ( const iofits & iof ) [pure virtual]

Read from iofits
Implemented in Arroyo::null_subharmonic_method, Arroyo::generalized_subharmonic_method, Arroyo::Lane_subharmonic_method, Arroyo::Johansson_Gavel_subharmonic_method, and Arroyo::quad_pixel_subharmonic_method.

virtual void Arroyo::subharmonic_method::read ( const char * filename ) [pure virtual]

Read from file
Implemented in Arroyo::null_subharmonic_method, Arroyo::generalized_subharmonic_method, Arroyo::Lane_subharmonic_method, Arroyo::Johansson_Gavel_subharmonic_method, and Arroyo::quad_pixel_subharmonic_method.

virtual void Arroyo::subharmonic_method::set_subharmonic_depth ( long nsubm ) [pure virtual]

Set the number of subharmonics
Implemented in Arroyo::null_subharmonic_method, Arroyo::generalized_subharmonic_method, and Arroyo::quad_pixel_subharmonic_method.

subharmonic_method* Arroyo::subharmonic_method::subharmonic_method_factory ( const iofits & iof ) [static]

Factory to construct subharmonic methods from an iofits object

subharmonic_method* Arroyo::subharmonic_method::subharmonic_method_factory ( const char * filename ) [static]

Factory to construct subharmonic methods from file