ClFftAlgorithm Class Reference

#include <ImFusion/CL/ClFftAlgorithm.h>

Algorithm interface of the Fast Fourier Transform using the ClFFT library. More...

Inheritance diagram for ClFftAlgorithm:

Detailed Description

Algorithm interface of the Fast Fourier Transform using the ClFFT library.

Public Types
enum	OutputOption {   OUTPUT_REAL , OUTPUT_IMAG , OUTPUT_POWER_SPECTRUM , OUTPUT_REAL_AND_IMAG ,   OUTPUT_OPTIONS }
	Specifies possible output options. Values should match ClFourierTransform::OutputType.
Public Types inherited from Algorithm
enum	Status {   Unknown = -1 , Success = 0 , Error = 1 , InvalidInput ,   IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU ,   UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...

Public Member Functions
	ClFftAlgorithm (SharedImageSet &imagesReal, SharedImageSet *imagesImag=0)
	Construct algorithm from an imageset representing real values and an optional imageset respresenting imaginary values.
Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual void	setProgress (Progress *progress)
	Sets a Progress interface the algorithm can use to notify observers about its computing progress.
Progress *	progress () const
	Returns the progress interface if set.
virtual int	status () const
	Indicates the status of the last call to compute().
virtual bool	survivesDataDeletion (const Data *) const
	Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
const FactoryInfo &	factoryInfo () const
	Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory.
void	setFactoryInfo (const FactoryInfo &value)
	Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory.
Status	runAction (const std::string &id)
	Run the action with name id if it exists.
const std::vector< Action > &	actions ()
	Get a mapping from Action id to Action as registered in this algorithm.
Public Member Functions inherited from Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept

Protected Attributes
SharedImageSet *	m_imagesReal
	Real-valued images, non-owned.
SharedImageSet *	m_imagesImag
	Imaginary-valued images, non-owned.
std::unique_ptr< SharedImageSet >	m_outputReal
	Real-valued output.
std::unique_ptr< SharedImageSet >	m_outputImag
	Imaginary-valued output.
std::unique_ptr< SharedImageSet >	m_outputPowerSpectrum
	Power-spectrum output.
std::unique_ptr< ClFourierTransform >	m_fft
	ClFourierTransform instance.
int	m_direction
	Fourier transform direction. -1=forward, 1=backward.
int	m_dimension
	Fourier transform dimension. Less or equal to image dimension.
OutputOption	m_outputOption
	Output option according to enum.
bool	m_cropPadding
	Specify if padded image is cropped to original size of input.
double	m_paddingPercentage
Protected Attributes inherited from Algorithm
std::string	m_name
	Algorithm name.
Progress *	m_progress = nullptr
	Non-owing pointer to a progress interface. May be a nullptr.
FactoryInfo	m_factoryInfo = {}
	Record describing how this algorithm was instantiated by the AlgorithmFactory.
int	m_status = Status::Unknown
	Algorithm status after last call to compute()
std::vector< Action >	m_actions
	Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Algorithm interface methods
void	compute () override
	Execute the algorithm.
OwningDataList	takeOutput () override
	Output are two separate imagesets for real and imaginary result images of datatype float.
static bool	createCompatible (const DataList &data, Algorithm **a=0)

Configurable interface methods
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.

Additional Inherited Members
Static Public Member Functions inherited from Algorithm
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory function to check algorithm compatibility with input data and optionally instantiate it.
Public Attributes inherited from Algorithm
Signal	signalOutputChanged
	Signal should be emitted by Algorithms when their output/result has changed.
Signal	signalParametersChanged
	Signal should be emitted by Algorithms when their parameter configuration has changed.
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Member Functions inherited from Algorithm
void	loadDefaults ()
void	registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action)
	Register an action to be run via runAction.
template<typename D>
void	registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void))
	Template version of runAction that can be used with a pointer to a member function.
void	registerAction (const Action &action)
	Register an action.

Member Function Documentation

compute()

void compute ( )

overridevirtual

Execute the algorithm.

Implements Algorithm.

takeOutput()

OwningDataList takeOutput ( )

overridevirtual

Output are two separate imagesets for real and imaginary result images of datatype float.

Reimplemented from Algorithm.

configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from Configurable.

---

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

• ImFusion/CL/ClFftAlgorithm.h