Arroyo::power_law Class Reference

#include <power_spectrum.h>

Inheritance diagram for Arroyo::power_law:

List of all members.

Public Member Functions
	power_law ()
	power_law (const power_law &plaw)
	power_law (const char *filename)
	power_law (const iofits &iof)
	power_law (double expnt, double coeff)
	power_law (double expnt, double r_0_meters, double r_0_ref_wavelength_meters)
	~power_law ()
power_law &	operator= (const power_law &plaw)
void	read (const char *filename)
void	read (const iofits &iof)
void	write (const char *filename) const
void	write (iofits &iof) const
virtual double	value (double spatial_frequency) const
virtual void	print (ostream &os, const char *prefix="") const
virtual bool	pole_at_zero_spatial_frequency () const
double	get_coefficient () const
double	get_exponent () const
Static Public Member Functions
power_law *	power_law_factory (const char *filename)
power_law *	power_law_factory (const iofits &iof)
Protected Attributes
double	exponent
double	coefficient
Friends
bool	operator== (const power_law &plaw1, const power_law &plaw2)

---

Detailed Description

A class to represent a power law

---

Constructor & Destructor Documentation

Arroyo::power_law::power_law (   )

Null constructor

Arroyo::power_law::power_law (  const power_law &  plaw  )

Copy constructor

Arroyo::power_law::power_law (  const char *  filename  )

Construct from file

Arroyo::power_law::power_law (  const iofits &  iof  )

Construct from iofits object

Arroyo::power_law::power_law (  double  expnt, double  coeff )

Construct from values

Arroyo::power_law::power_law (  double  expnt, double  r_0_meters, double  r_0_ref_wavelength_meters )

Construct from values

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

Virtual destructor

---

Member Function Documentation

double Arroyo::power_law::get_coefficient (   )  const [inline]

Get the coefficient on the power law

double Arroyo::power_law::get_exponent (   )  const [inline]

Get the exponent on the power law

power_law& Arroyo::power_law::operator= (  const power_law &  plaw  )

Copy constructor

virtual bool Arroyo::power_law::pole_at_zero_spatial_frequency (   )  const [inline, virtual]

Indicates whether there's a pole at zero spatial frequency Reimplemented in Arroyo::von_karman_power_law, and Arroyo::greenwood_power_law.

power_law* Arroyo::power_law::power_law_factory (  const iofits &  iof  )  [static]

Factory to construct a power_law from an iofits object

power_law* Arroyo::power_law::power_law_factory (  const char *  filename  )  [static]

Factory to construct a power_law from a file

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

Print Implements Arroyo::AO_sim_base. Reimplemented in Arroyo::von_karman_power_law, and Arroyo::greenwood_power_law.

void Arroyo::power_law::read (  const iofits &  iof  )

Read from iofits Reimplemented in Arroyo::von_karman_power_law, and Arroyo::greenwood_power_law.

void Arroyo::power_law::read (  const char *  filename  )

Read from file Reimplemented in Arroyo::von_karman_power_law, and Arroyo::greenwood_power_law.

virtual double Arroyo::power_law::value (  double  spatial_frequency  )  const [inline, virtual]

Return the value at a given spatial frequency Reimplemented in Arroyo::von_karman_power_law, and Arroyo::greenwood_power_law.

void Arroyo::power_law::write (  iofits &  iof  )  const

Write to iofits Reimplemented in Arroyo::von_karman_power_law, and Arroyo::greenwood_power_law.

void Arroyo::power_law::write (  const char *  filename  )  const

Write to file Reimplemented in Arroyo::von_karman_power_law, and Arroyo::greenwood_power_law.

---

Friends And Related Function Documentation

bool operator== (  const power_law &  plaw1, const power_law &  plaw2 )  [friend]

operator == - returns true if power laws are equal

---

Member Data Documentation

double Arroyo::power_law::coefficient [protected]

The coefficient on the power law Komolgorov spectra have exponent C_n^2

double Arroyo::power_law::exponent [protected]

The exponent on the power law Komolgorov spectra have exponent = 11/3rds

---

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

• power_spectrum.h

---