GlPolarToCartesian Class Reference

#include <ImFusion/GL/GlPolarToCartesian.h>

Converts data from polar coordinate to Cartesian space, with constant degree between polar lines. More...

Inheritance diagram for GlPolarToCartesian:

Detailed Description

Converts data from polar coordinate to Cartesian space, with constant degree between polar lines.

Public Types
enum class	InterpolationMode { Nearest , Linear }
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
	GlPolarToCartesian (GL::Framebuffer *fbo=0)
	Constructor with optional FBO to use. If no FBO is specified a private FBO is created.
	~GlPolarToCartesian () override
	Destructor.
void	setParam (float fanAngle, float radius=0.f, float offsetY=0.f, bool flipX=false, bool flipY=false)
	Parameters must be set before calling the compute function.
void	setApexPoint (const vec2 &pos)
void	setFlipYInput (bool flag)
	Define optionally whether the input data shall be vertically flipped.
void	setFlat (bool flag)
	Define whether the polar lines should be arranged flat on top of the cartesian image.
void	setInverse (bool flag)
	Define whether the inverse transform gets computed Note: The inverse transform currently does not support m_flat.
void	setInterpolationMode (InterpolationMode mode)
	Define the interpolation mode.
void	compute (const GlImage &imgIn, GlImage &imgOut) override
	Computes the polar transformation.
bool	good () const override
	Return true if the filter can be used, in particular if the shaders are available and parameters are set.
Public Member Functions inherited from GlFilter
	GlFilter (GL::Framebuffer *fbo=0)
	Constructor with optional FBO to use. If no FBO is specified a private FBO is created.
	~GlFilter () override
	Destructor.
void	compute () override
	Algorithm interface.
virtual bool	setKernelSize (int, double)
	Common interface to set filter kernel size and parameter.
virtual bool	setKernelSize (double, vec3, double)
	Common interface to set filter kernel size in mm and parameter.
virtual void	compute (SharedImage &imgIn, SharedImage &imgOut)
virtual void	compute (const std::vector< GlImage * > &imgIn, std::vector< GlImage * > &imgOut)
	Convenience function for executing filter on multiple images.
virtual void	prepareForMasking (Mask *)
	Prepare the filter's GlProgram(s) for masking.
virtual bool	supportsMetricMode () const
	Return true if the filter supports anisotropic spacing, i.e. metric.
void	setMetricMode (bool value)
	If the GlFilter supports metric, i.e.
bool	metricMode () const
	Getter for m_metricMode.
Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual OwningDataList	takeOutput ()
	Return any new Data that was created by the Algorithm during the last call to compute().
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	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.
virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.
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

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.
Protected Attributes inherited from GlFilter
GL::Framebuffer *	m_fbo
bool	m_ownFbo
bool	m_metricMode
	If set to true the GlFilter result will be computed taking the spacing into account.
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.

Member Function Documentation

setParam()

void setParam	(	float	fanAngle,
		float	radius = 0.f,
		float	offsetY = 0.f,
		bool	flipX = false,
		bool	flipY = false )

Parameters must be set before calling the compute function.

Parameters

fanAngle	angle [degree] between the first and last polar line (maximum 360)
radius	offset [mm] of the radius in polar coordinate (fan's smaller radius from the center in Cartesian space)
offsetY	amount of shift [mm] in Y direction in Cartesian space after the conversion
flipX	if true the final image is flipped in X direction
flipY	if true the final image is flipped in Y direction

compute()

void compute ( const GlImage & imgIn, GlImage & imgOut )

overridevirtual

Computes the polar transformation.

Parameters

imgIn	If m_inverse is false the input is given in polar coordinate, (angle, radius) each scan line in a column. Otherwise the input is given in cartesian coordinates.
imgOut	set the spacing and dimension of imgOut before calling this function, glKernel is executed according to the size of imgOut

Implements GlFilter.

good()

bool good ( ) const

overridevirtual

Return true if the filter can be used, in particular if the shaders are available and parameters are set.

Implements GlFilter.

---

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

• ImFusion/GL/GlPolarToCartesian.h