casacore::FFTW Class Reference

C++ interface to the FFTWw library. More...

#include <FFTW.h>

List of all members.

Public Member Functions
	FFTW ()
	~FFTW ()
void	plan_r2c (const IPosition &size, Float *in, Complex *out)
	polymorphic interface to fftw[f]_plan.
void	plan_r2c (const IPosition &size, Double *in, DComplex *out)
void	plan_c2r (const IPosition &size, Complex *in, Float *out)
void	plan_c2r (const IPosition &size, DComplex *in, Double *out)
void	plan_c2c_forward (const IPosition &size, DComplex *in)
void	plan_c2c_forward (const IPosition &size, Complex *in)
void	plan_c2c_backward (const IPosition &size, DComplex *in)
void	plan_c2c_backward (const IPosition &size, Complex *in)
void	r2c (const IPosition &size, Float *in, Complex *out)
	polymorphic interface to fftw[f]_execute.
void	r2c (const IPosition &size, Double *in, DComplex *out)
void	c2r (const IPosition &size, Complex *in, Float *out)
void	c2r (const IPosition &size, DComplex *in, Double *out)
void	c2c (const IPosition &size, Complex *in, Bool forward)
void	c2c (const IPosition &size, DComplex *in, Bool forward)
Private Attributes
FFTWPlanf *	itsPlanR2Cf
FFTWPlan *	itsPlanR2C
FFTWPlanf *	itsPlanC2Rf
FFTWPlan *	itsPlanC2R
FFTWPlanf *	itsPlanC2CFf
FFTWPlan *	itsPlanC2CF
FFTWPlanf *	itsPlanC2CBf
FFTWPlan *	itsPlanC2CB
unsigned	flags
Static Private Attributes
static volatile Bool	is_initialized_fftw
static Mutex	theirMutex
	only once per process, not once per object

---

Detailed Description

C++ interface to the FFTWw library.

Review Status

Reviewed By:

NONE

Synopsis

This is a wrapper of FFTW3. It is only active if FFTW3 was found during the build. If not found, all functions won't do anything at all.

The interface is such that the presence of FFTW3 is only visible in the implementation. The header file does not need to know. In this way external code using this class does not need to set HAVE_FFTW.

Definition at line 57 of file FFTW.h.

---

Constructor & Destructor Documentation

casacore::FFTW::FFTW

(

)

casacore::FFTW::~FFTW

(

)

---

Member Function Documentation

void casacore::FFTW::c2c	(	const IPosition &	size,
		DComplex *	in,
		Bool	forward
	)

void casacore::FFTW::c2c	(	const IPosition &	size,
		Complex *	in,
		Bool	forward
	)

void casacore::FFTW::c2r	(	const IPosition &	size,
		DComplex *	in,
		Double *	out
	)

void casacore::FFTW::c2r	(	const IPosition &	size,
		Complex *	in,
		Float *	out
	)

void casacore::FFTW::plan_c2c_backward	(	const IPosition &	size,
		Complex *	in
	)

void casacore::FFTW::plan_c2c_backward	(	const IPosition &	size,
		DComplex *	in
	)

void casacore::FFTW::plan_c2c_forward	(	const IPosition &	size,
		Complex *	in
	)

void casacore::FFTW::plan_c2c_forward	(	const IPosition &	size,
		DComplex *	in
	)

void casacore::FFTW::plan_c2r	(	const IPosition &	size,
		DComplex *	in,
		Double *	out
	)

void casacore::FFTW::plan_c2r	(	const IPosition &	size,
		Complex *	in,
		Float *	out
	)

void casacore::FFTW::plan_r2c	(	const IPosition &	size,
		Double *	in,
		DComplex *	out
	)

void casacore::FFTW::plan_r2c	(	const IPosition &	size,
		Float *	in,
		Complex *	out
	)

polymorphic interface to fftw[f]_plan.

.\.

void casacore::FFTW::r2c	(	const IPosition &	size,
		Double *	in,
		DComplex *	out
	)

void casacore::FFTW::r2c	(	const IPosition &	size,
		Float *	in,
		Complex *	out
	)

polymorphic interface to fftw[f]_execute.

.\.

---

Member Data Documentation

unsigned casacore::FFTW::flags [private]

Definition at line 95 of file FFTW.h.

volatile Bool casacore::FFTW::is_initialized_fftw [static, private]

Definition at line 97 of file FFTW.h.

FFTWPlan* casacore::FFTW::itsPlanC2CB [private]

Definition at line 93 of file FFTW.h.

FFTWPlanf* casacore::FFTW::itsPlanC2CBf [private]

Definition at line 92 of file FFTW.h.

FFTWPlan* casacore::FFTW::itsPlanC2CF [private]

Definition at line 90 of file FFTW.h.

FFTWPlanf* casacore::FFTW::itsPlanC2CFf [private]

Definition at line 89 of file FFTW.h.

FFTWPlan* casacore::FFTW::itsPlanC2R [private]

Definition at line 87 of file FFTW.h.

FFTWPlanf* casacore::FFTW::itsPlanC2Rf [private]

Definition at line 86 of file FFTW.h.

FFTWPlan* casacore::FFTW::itsPlanR2C [private]

Definition at line 84 of file FFTW.h.

FFTWPlanf* casacore::FFTW::itsPlanR2Cf [private]

Definition at line 83 of file FFTW.h.

Mutex casacore::FFTW::theirMutex [static, private]

only once per process, not once per object

Definition at line 100 of file FFTW.h.

---

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

• casacore/scimath/Mathematics/FFTW.h