FastFourierTrans2dBodyC - Put a brief description of your class body here

Developer Documentation

Centre for Vision, Speech & Signal Processing

Comments:
Put a more detailed description of your class here. You use embedded html to make it clearer in the html documentation. This documentation should be aimed at people who might what to extend your class.

Parent Classes:

BodyRefCounterVC

Variables:

ImageC data;: input data
ImageC transform;: transform of data
fftwnd_plan forplan;: forward plan
fftwnd_plan backplan;: backwards plan

Methods:

FastFourierTrans2dBodyC(const ByteImageC & image): Construct from a ByteImage
FastFourierTrans2dBodyC(const ImageC<ComplexC> & image): Constructor from complex image
FastFourierTrans2dBodyC(const DoubleImageC & image): Construct from a double image
FastFourierTrans2dBodyC(const ImageC<DoubleImageValueT> & image): Construct from a ImageC double image
FastFourierTrans2dBodyC(const IntImageC & image): Construct from an int image
FastFourierTrans2dBodyC(istream & in): Operators ---------
BodyRefCounterVC & Copy() const: Creat a copy of this object.
BooleanT Save(ostream & out) const: Methods -------
void ApplyForward(): Apply the forward transform
void ApplyBackward(): Apply the backward transform to internally stored complex image
void SetTransformImage(const ImageC<ComplexC> & image): Change the image held by transform
ImageC<ComplexC> TransformImage() const: Access to complex transformed image
ImageC<ComplexC> InputImage() const: Access to complex input image
DoubleImageC Re(BooleanT transform = FORWARD) const: Return the real part of (input || transform)
DoubleImageC Im(BooleanT transform = FORWARD) const: Return the imaginary part of (input || transform)
void Shift(): Shifts DC component to image centre
DoubleImageC PowerSpectrum() const: Returns the power spectrum of the transform Friends -------
ostream & operator<<(ostream & s,const FastFourierTrans2dBodyC & out): output stream operator
istream & operator>>(istream & s,FastFourierTrans2dBodyC & in): input stream operator

#include "amma/BRefCntV.hh"

BodyRefCounterVC & Copy() const: Creat a copy of this object.
BooleanT operator==(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT operator!=(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT Save(ostream & out) const: Save to ostream.

#include "amma/BRefCnt.hh"

void AddReference(): Another reference to the object has been created.
void RemoveReference(): One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.
void SetConst(void) const: This locks the object.
Often objects you wish to lock are already const.
void SetConst(void): This locks the object.
BooleanT IsConst(void) const: Returns TRUE if the object is locked, ie. it is assumed to be constant.
BooleanT IsNotConst(void) const: Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------
BooleanT ToBeDeleted() const: Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.
BooleanT ToBeDeletedRemoveIgnoreNoRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object.
BooleanT ToBeDeletedRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.
BooleanT BodyMightBeDeleted() const: Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .
BooleanT IsCountZero() const: Are there any refrences left ?
BooleanT BRCPtrCanDeleteObject() const: Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.
IntT Count() const: Returns the current state of the counter, ie. how many references to this object exist.
const BodyRefCounterC & operator=(const BodyRefCounterC & b): It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.
BooleanT IsValidObject() const: Test if object is valid.
When amma check is disabled this always returns true.
BooleanT UserBitTest(IntT x) const: Test user flag.
void UserBitSet(IntT x,BooleanT setit = TRUE): Test user flag.
void UserBitZero(IntT x): Set bit to zero.
void ReportBRCError(char * Msg): Report error, used in BRCPtrC.
UIntT Hash() const: Hash on address of object.
void SetUndeletable(): Make object undeletable.
Usefull to prevent recursive deleting in graph structures. Only hackers need this function.
void ReportInvalidObject(char * Msg = 0) const: Tell user about validation failure.

#include "amma/RefCBase.hh"

LabelT Label() const: Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.

Programmer:Kieron J Messer, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

FastFourierTrans2dBodyC

Put a brief description of your class body here

include	"amma/FastFourierTrans2d.hh"
User Level:	Default
Library:	FastFourierTrans2d
Example:	exMultiLevelMatchEst.cc
Section:	default.Kieron J Messer
In Scope:	std