Arroyo::generalized_subharmonic_method Class Reference

#include <subharmonic_method.h>

Inheritance diagram for Arroyo::generalized_subharmonic_method:

List of all members.

Public Member Functions
	generalized_subharmonic_method ()
	generalized_subharmonic_method (long sbdpth, long nsubpix_per_lvl, long nsubpix_per_pix)
	~generalized_subharmonic_method ()
	generalized_subharmonic_method (const generalized_subharmonic_method &generalized_subm)
	generalized_subharmonic_method (const char *filename)
	generalized_subharmonic_method (const iofits &iof)
generalized_subharmonic_method &	operator= (const generalized_subharmonic_method &generalized_subm)
generalized_subharmonic_method *	clone () const
void	read (const char *filename)
void	read (const iofits &iof)
void	write (const char *filename) const
void	write (iofits &iof) const
void	print (ostream &os, const char *prefix="") const
int	intrinsic_dimensionality () const
long	get_subharmonic_depth () const
void	set_subharmonic_depth (long nsubm)
Protected 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
void	apply_subharmonic_correction (const power_spectrum &pspec, const vector< long > &axes, double pixscale, bool random, float *data) const
void	apply_subharmonic_correction (const power_spectrum &pspec, const vector< long > &axes, double pixscale, bool random, double *data) const
bool	equal (const subharmonic_method &subm) const
Protected Attributes
long	subharmonic_depth
	the number of subharmonic levels to correct
long	nsubpixels_per_pixel
	the number of subpixels per pixel
long	nsubpixels_per_level

---

Detailed Description

A class to represent a generalization of the methods of subharmonic correction described by Johansson and Gavel, 1994, and Lane 1992

---

Constructor & Destructor Documentation

Arroyo::generalized_subharmonic_method::generalized_subharmonic_method (   )  [inline]

Null constructor

Arroyo::generalized_subharmonic_method::generalized_subharmonic_method (  long  sbdpth, long  nsubpix_per_lvl, long  nsubpix_per_pix )

Construct from the bits sbdpth is the number of subharmonic levels to use in the correction nsubpix_per_pix is the number of subpixels in each of the original pixels. This number must be odd nsubpix_per_lvl is the number of subpixels to use in each subharmonic level. This number must be odd and must be greater than nsubpix_per_pix and less than 3*nsubpix_per_pix

Arroyo::generalized_subharmonic_method::~generalized_subharmonic_method (   )  [inline]

destructor

Arroyo::generalized_subharmonic_method::generalized_subharmonic_method (  const generalized_subharmonic_method &  generalized_subm  )  [inline]

Copy constructor

Arroyo::generalized_subharmonic_method::generalized_subharmonic_method (  const char *  filename  )  [inline]

Construct from file

Arroyo::generalized_subharmonic_method::generalized_subharmonic_method (  const iofits &  iof  )  [inline]

Construct from iofits

---

Member Function Documentation

void Arroyo::generalized_subharmonic_method::apply_subharmonic_correction (  const power_spectrum &  pspec, const vector< long > &  axes, double  pixscale, bool  random, double *  data )  const [protected, virtual]

Implements Arroyo::subharmonic_method.

void Arroyo::generalized_subharmonic_method::apply_subharmonic_correction (  const power_spectrum &  pspec, const vector< long > &  axes, double  pixscale, bool  random, float *  data )  const [protected, virtual]

Implements Arroyo::subharmonic_method.

template<class T> void Arroyo::generalized_subharmonic_method::apply_subharmonic_correction_impl (  const power_spectrum &  pspec, const vector< long > &  axes, double  pixscale, bool  random, T *  data )  const [protected]

Function to apply the subharmonic correction to a raw array of data. This array is assumed to be halfcomplex Reimplemented from Arroyo::subharmonic_method.

generalized_subharmonic_method* Arroyo::generalized_subharmonic_method::clone (   )  const [inline, virtual]

Clone method Calling routine is responsible for deleting memory Implements Arroyo::subharmonic_method. Reimplemented in Arroyo::Lane_subharmonic_method, and Arroyo::Johansson_Gavel_subharmonic_method.

bool Arroyo::generalized_subharmonic_method::equal (  const subharmonic_method &  subm  )  const [inline, protected, virtual]

Returns false if the subharmonic method subm is not of type generalized_subharmonic_method If subm is of type generalized_subharmonic_method, returns true if the instances are equal Implements Arroyo::subharmonic_method.

long Arroyo::generalized_subharmonic_method::get_subharmonic_depth (   )  const [inline, virtual]

Get the number of subharmonics Implements Arroyo::subharmonic_method.

int Arroyo::generalized_subharmonic_method::intrinsic_dimensionality (   )  const [inline, virtual]

The generalized Johansson Gavel subharmonic correction may be used on arrays with odd dimensionality Implements Arroyo::subharmonic_method.

generalized_subharmonic_method& Arroyo::generalized_subharmonic_method::operator= (  const generalized_subharmonic_method &  generalized_subm  )  [inline]

operator =

void Arroyo::generalized_subharmonic_method::print (  ostream &  os, const char *  prefix = "" )  const [virtual]

Print Implements Arroyo::subharmonic_method. Reimplemented in Arroyo::Lane_subharmonic_method, and Arroyo::Johansson_Gavel_subharmonic_method.

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

Read from iofits Implements Arroyo::subharmonic_method. Reimplemented in Arroyo::Lane_subharmonic_method, and Arroyo::Johansson_Gavel_subharmonic_method.

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

Read from file Implements Arroyo::subharmonic_method. Reimplemented in Arroyo::Lane_subharmonic_method, and Arroyo::Johansson_Gavel_subharmonic_method.

void Arroyo::generalized_subharmonic_method::set_subharmonic_depth (  long  nsubm  )  [inline, virtual]

Set the number of subharmonics Implements Arroyo::subharmonic_method.

void Arroyo::generalized_subharmonic_method::write (  iofits &  iof  )  const [virtual]

Write to iofits Implements Arroyo::subharmonic_method. Reimplemented in Arroyo::Lane_subharmonic_method, and Arroyo::Johansson_Gavel_subharmonic_method.

void Arroyo::generalized_subharmonic_method::write (  const char *  filename  )  const [virtual]

Write to file Implements Arroyo::subharmonic_method. Reimplemented in Arroyo::Lane_subharmonic_method, and Arroyo::Johansson_Gavel_subharmonic_method.

---

Member Data Documentation

long Arroyo::generalized_subharmonic_method::nsubpixels_per_level [protected]

the number of subpixels for each subharmonic level

long Arroyo::generalized_subharmonic_method::nsubpixels_per_pixel [protected]

the number of subpixels per pixel

long Arroyo::generalized_subharmonic_method::subharmonic_depth [protected]

the number of subharmonic levels to correct

---

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

• subharmonic_method.h

---