Image Component Library (ICL)
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
icl::filter::IFFTOp Class Reference

This class implements the unary operator for the inverse fast and discrete 2D fourier transformation. More...

#include <IFFTOp.h>

Inheritance diagram for icl::filter::IFFTOp:
icl::filter::UnaryOp icl::utils::Configurable

Public Types

enum  SizeAdaptionMode { NO_SCALE, PAD_REMOVE, SCALE_UP, SCALE_DOWN }
 Modes how the sourceimage is to adapt before fftcomputation. More...
 
enum  ResultMode { REAL_ONLY, IMAG_ONLY, TWO_CHANNEL_COMPLEX }
 
- Public Types inherited from icl::utils::Configurable
typedef Function< void, const Property & > Callback
 Function type for changed properties. More...
 

Public Member Functions

 IFFTOp (ResultMode rm=REAL_ONLY, SizeAdaptionMode sam=NO_SCALE, utils::Rect roi=Rect(0, 0, 0, 0), bool join=true, bool ifftshift=true, bool forceIDFT=false)
 Creates a new IFFTOp-object. More...
 
 ~IFFTOp ()
 
void setJoinMatrix (bool pJoin)
 Sets if two channels shall be joined to one complex. More...
 
bool getJoinMatrix ()
 Returns if two channels shall be joined to one complex. More...
 
void setROI (utils::Rect roi)
 Sets the roi. More...
 
Rect getRoi ()
 Returns the current roi. More...
 
void setResultMode (ResultMode rm)
 Sets the resultmode. More...
 
int getResultMode ()
 Returns the resultmode as int. More...
 
void setSizeAdaptionMode (SizeAdaptionMode sam)
 Sets the sizeadaptionmode. More...
 
int getSizeAdaptionMode ()
 Returns the sizeadaptionmode. More...
 
bool getForceIDFT ()
 Returns true if the discrete inverse fourier transfarmation shall be used, else false. More...
 
void setForceIDFT (bool pForceDFT)
 Set wether to force the discrete inverse fourier transformation or to use the fast inverse fourier transformation. More...
 
virtual void apply (const core::ImgBase *src, core::ImgBase **dst)
 Call this method to start ifftcomputation. More...
 
- Public Member Functions inherited from icl::filter::UnaryOp
 UnaryOp ()
 Explicit empty constructor. More...
 
 UnaryOp (const UnaryOp &other)
 Explicit copy constructor. More...
 
UnaryOpoperator= (const UnaryOp &other)
 Explicit declaration of the assignment operator. More...
 
virtual ~UnaryOp ()
 Destructor. More...
 
virtual ICL_DEPRECATED void applyMT (const core::ImgBase *operand1, core::ImgBase **dst, unsigned int nThreads)
 apply function for multithreaded filtering (currently even slower than using one thread) More...
 
virtual const core::ImgBaseapply (const core::ImgBase *src)
 applys the filter usign an internal buffer as output image More...
 
void operator() (const core::ImgBase *src, core::ImgBase **dst)
 function operator (alternative for apply(src,dst) More...
 
const core::ImgBaseoperator() (const core::ImgBase *src)
 function operator for the implicit destination apply(src) call More...
 
const core::ImgBaseoperator() (const core::ImgBase &src)
 reference based function operator More...
 
void setClipToROI (bool bClipToROI)
 sets if the image should be clip to ROI or not More...
 
void setCheckOnly (bool bCheckOnly)
 sets if the destination image should be adapted to the source, or if it is only checked if it can be adapted. More...
 
bool getClipToROI () const
 returns the ClipToROI status More...
 
bool getCheckOnly () const
 returns the CheckOnly status More...
 
virtual void setPropertyValue (const std::string &propertyName, const utils::Any &value) throw (utils::ICLException)
 sets value of a property (always call call_callbacks(propertyName) or Configurable::setPropertyValue) More...
 
- Public Member Functions inherited from icl::utils::Configurable
virtual ~Configurable ()
 virtual destructor More...
 
 Configurable (const Configurable &other)
 Copy constructor. More...
 
Configurableoperator= (const Configurable &other)
 Assignment operator. More...
 
void setConfigurableID (const std::string &ID) throw (ICLException)
 sets the ID of this configurable More...
 
const std::string & getConfigurableID () const
 returns the configurables static ID More...
 
bool isOrderedFlagSet () const
 returns whether the ordered flag is set More...
 
void deactivateProperty (const std::string &pattern)
 adds an additional deativation pattern More...
 
void deleteDeactivationPattern (const std::string &pattern)
 removed a formerly added deactivation pattern More...
 
std::vector< std::string > getPropertyListWithoutDeactivated () const
 this returns a filtered list of properties (using all filters added by deactivateProperty) More...
 
virtual void adaptProperty (const std::string &name, const std::string &newType, const std::string &newInfo, const std::string &newToolTip) throw (ICLException)
 this function can be used to adapt a specific property afterwards More...
 
void registerCallback (const Callback &cb)
 add a callback for changed properties More...
 
void removedCallback (const Callback &cb)
 removes a callback that was registered before More...
 
void syncChangesTo (Configurable *others, int num=1)
 this can be used to let this instance also apply property changes to others More...
 
virtual std::vector< std::string > getPropertyList () const
 returns a list of All properties, that can be set using setProperty More...
 
virtual bool supportsProperty (const std::string &propertyName) const
 base implementation for property check (seaches in the property list) More...
 
virtual void saveProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC) const
 writes all available properties into a file More...
 
virtual void loadProperties (const std::string &filename, const std::vector< std::string > &propertiesToSkip=EMPTY_VEC)
 reads a camera config file from disc More...
 
virtual std::string getPropertyType (const std::string &propertyName) const
 get type of property More...
 
virtual std::string getPropertyInfo (const std::string &propertyName) const
 get information of a properties valid values More...
 
virtual Any getPropertyValue (const std::string &propertyName) const
 returns the current value of a property or a parameter More...
 
virtual std::string getPropertyToolTip (const std::string &propertyName) const
 returns the tooltip description for a given property More...
 
virtual int getPropertyVolatileness (const std::string &propertyName) const
 Returns whether this property may be changed internally. More...
 

Private Member Functions

template<class SrcT , class DstT >
void apply_internal (const core::Img< SrcT > &src, core::Img< DstT > &dst, math::DynMatrix< std::complex< DstT > > &buf, math::DynMatrix< std::complex< DstT > > &dstBuf)
 
template<class T >
const core::Img< T > * adapt_source (const core::Img< T > *src)
 
template<typename T >
void apply_inplace_ifftshift (math::DynMatrix< T > &m)
 

Private Attributes

Data * m_data
 Class for internal params and buffers. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from icl::filter::UnaryOp
static UnaryOpfromString (const std::string &definition) throw (utils::ICLException)
 Creates a UnaryOp instance from given string definition. More...
 
static std::string getFromStringSyntax (const std::string &opSpecifier) throw (utils::ICLException)
 gives a string syntax description for given opSpecifier More...
 
static std::vector< std::string > listFromStringOps ()
 returns a list of all supported OP_SPEC values for the fromString function More...
 
static void applyFromString (const std::string &definition, const core::ImgBase *src, core::ImgBase **dst) throw (utils::ICLException)
 creates, applies and releases a UnaryOp defined by given definition string More...
 
- Static Public Member Functions inherited from icl::utils::Configurable
static std::string create_default_ID (const std::string &prefix)
 this function can be used in subclasses to create a default ID More...
 
static Configurableget (const std::string &id)
 returns configurable by given ID More...
 
static void register_configurable_type (const std::string &classname, Function< Configurable * > creator) throw (ICLException)
 registers a configurable type More...
 
static std::vector< std::string > get_registered_configurables ()
 returns a list of all registered configurable classnames More...
 
static Configurablecreate_configurable (const std::string &classname) throw (ICLException)
 creates a configurable by given name More...
 
- Static Public Attributes inherited from icl::utils::Configurable
static const std::vector< std::string > EMPTY_VEC
 used as shortcut – just an empty vector of std::strings More...
 
- Protected Member Functions inherited from icl::filter::UnaryOp
bool prepare (core::ImgBase **ppoDst, core::depth eDepth, const utils::Size &imgSize, core::format eFormat, int nChannels, const utils::Rect &roi, utils::Time timestamp=utils::Time::null)
 
virtual bool prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc)
 check+adapt destination image to properties of given source image More...
 
virtual bool prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc, core::depth eDepth)
 
- Protected Member Functions inherited from icl::utils::Configurable
void addProperty (const std::string &name, const std::string &type, const std::string &info, const Any &value=Any(), const int volatileness=0, const std::string &tooltip=std::string()) throw (ICLException)
 This can be used by derived classes to store supported properties in the internal list. More...
 
void addChildConfigurable (Configurable *configurable, const std::string &childPrefix="")
 This adds another configurable as child. More...
 
void removeChildConfigurable (Configurable *configurable)
 removes the given child configurable More...
 
Propertyprop (const std::string &propertyName) throw (ICLException)
 this CAN be used e.g. to store a property value in internal property-list More...
 
const Propertyprop (const std::string &propertyName) const throw (ICLException)
 this CAN be used e.g. to store a property value in internal property-list More...
 
 Configurable (const std::string &ID="", bool ordered=true) throw (ICLException)
 create this configurable with given ID More...
 
void call_callbacks (const std::string &propertyName, const Configurable *caller) const
 calls all registered callbacks More...
 
- Protected Attributes inherited from icl::filter::UnaryOp
utils::MultiThreaderm_poMT
 
- Protected Attributes inherited from icl::utils::Configurable
std::vector< Callbackcallbacks
 internally managed list of callbacks More...
 

Detailed Description

This class implements the unary operator for the inverse fast and discrete 2D fourier transformation.

As known the ifft can only be applied if the datasize is a power of 2. This implementation uses the ifft as far as it can be applied and switches to the idft, so you can use it if datasize is not a power of 2 too. If MKL or IPP is available, IFFTOp tries to use it if possible.

Member Enumeration Documentation

Several resultmodes for destinationimage.

Enumerator
REAL_ONLY 

alternates real- and imaginarypart of ifftcomputation

IMAG_ONLY 

imaginarypart of ifftcomputation

TWO_CHANNEL_COMPLEX 

realpart of ifftcomputation

Modes how the sourceimage is to adapt before fftcomputation.

Several sizeadaptionmodes for sourceimage.

Enumerator
NO_SCALE 

sourceimage stays as is

PAD_REMOVE 

removes PAD_MIRROR,PAD_ZERO and PAD_COPY from the sourceimage(new size is given from contructorparameter roi)

SCALE_UP 

zooms to next higher power of 2 of originsize, or origanalsize if it is power of 2

SCALE_DOWN 

zooms to next lower power of 2 of originsize, or origanalsize if it is power of 2

Constructor & Destructor Documentation

icl::filter::IFFTOp::IFFTOp ( ResultMode  rm = REAL_ONLY,
SizeAdaptionMode  sam = NO_SCALE,
utils::Rect  roi = Rect(0, 0, 0, 0),
bool  join = true,
bool  ifftshift = true,
bool  forceIDFT = false 
)

Creates a new IFFTOp-object.

Constructor. Params can be changed later.

Parameters
rmthe resultmode
samthe sizeadaptionmode before applying IFFTOp
roideterminates the size if removing padding is needed
joinwether to join to channel to one complex for the ifftcomputation or not
ifftshiftundo fftshift before the isfftcomputation or not
forceIDFTwether to apply idft or ifft
icl::filter::IFFTOp::~IFFTOp ( )

Destructor

Member Function Documentation

template<class T >
const core::Img<T>* icl::filter::IFFTOp::adapt_source ( const core::Img< T > *  src)
private

Called by apply. Adapts sourceimage to specified values(scaling, padding on so on). Possible sourceparam is: Img<icl8u>, Img<icl16s>, Img<icl32s>, Img<icl32f>, Img<icl64f>

virtual void icl::filter::IFFTOp::apply ( const core::ImgBase src,
core::ImgBase **  dst 
)
virtual

Call this method to start ifftcomputation.

Applies IFFTOp on src and dst.

Parameters
*srcpointer to sourceimage
**dstpointer to pointer to destinationimage

Implements icl::filter::UnaryOp.

template<typename T >
void icl::filter::IFFTOp::apply_inplace_ifftshift ( math::DynMatrix< T > &  m)
private

Applies inplace ifftshift on destinationimage after ifftcomputation. Possible sourceparam is: Img<icl32f> and Img<icl64f>

template<class SrcT , class DstT >
void icl::filter::IFFTOp::apply_internal ( const core::Img< SrcT > &  src,
core::Img< DstT > &  dst,
math::DynMatrix< std::complex< DstT > > &  buf,
math::DynMatrix< std::complex< DstT > > &  dstBuf 
)
private

Called by apply. Aplies ifft/idft and resultmode. Possible sourceparam is: Img<icl8u>, Img<icl16s>, Img<icl32s>, Img<icl32f>, Img<icl64f>. Possible destinationparam is: Img<icl32f> and Img<icl64f>.

bool icl::filter::IFFTOp::getForceIDFT ( )

Returns true if the discrete inverse fourier transfarmation shall be used, else false.

Returns
true for idft, false for ifft
bool icl::filter::IFFTOp::getJoinMatrix ( )

Returns if two channels shall be joined to one complex.

Returns
the current value
int icl::filter::IFFTOp::getResultMode ( )

Returns the resultmode as int.

Returns
the current resultmode.
Rect icl::filter::IFFTOp::getRoi ( )

Returns the current roi.

Returns
roi the current roi
int icl::filter::IFFTOp::getSizeAdaptionMode ( )

Returns the sizeadaptionmode.

Returns
the current sizeadationmode
void icl::filter::IFFTOp::setForceIDFT ( bool  pForceDFT)

Set wether to force the discrete inverse fourier transformation or to use the fast inverse fourier transformation.

Parameters
pForceDFT
void icl::filter::IFFTOp::setJoinMatrix ( bool  pJoin)

Sets if two channels shall be joined to one complex.

Parameters
pJointrue if channels shall be joined to one complex
void icl::filter::IFFTOp::setResultMode ( ResultMode  rm)

Sets the resultmode.

void icl::filter::IFFTOp::setROI ( utils::Rect  roi)

Sets the roi.

Parameters
roithe new roi
void icl::filter::IFFTOp::setSizeAdaptionMode ( SizeAdaptionMode  sam)

Sets the sizeadaptionmode.

Parameters
samthe sizeadaptionmode to be set

Member Data Documentation

Data* icl::filter::IFFTOp::m_data
private

Class for internal params and buffers.


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