#include <ImFusion/GL/PointCorrAlgorithm.h>

Algorithm for defining point correspondences on a pair of images. More...

Inheritance diagram for PointCorrAlgorithm:

Detailed Description

Algorithm for defining point correspondences on a pair of images.

PointCorrAlgorithm wraps around the basic PointCorr class and enriches it with automatic conversion between different coordinate systems, and handling of image transformations and deformations. Essentially, PointCorrAlgorithm distinguished between two different coordinate systems:

Image coordinate system: The point correspondences are stored in the image's local image coordinate system. If the image's transformation matrix or deformation changes, the point correspondences are automatically updated accordingly.
World coordinate system: The point correspondences are stored in the global world coordinate system before deformations(!), so are linked to deformations but not transformations. You can query/define the coordinate system to use for each of the two images by world()/setWorld(). The currently set coordinate system for an image is also referred to as "storage coordinate system". If the world-image mapping of this image changes, the stored points will be kept constant in the storage coord system.

The internal PointCorr class, which is used for registration purposes, will periodically be updated with point correspondences in world space.

The result of this algorithm is applied to the first input image.

Classes
struct	CorrItem
	Structure encapsulating a single point correspondence item defined by a pair of points. More...

Public Member Functions
	PointCorrAlgorithm (SharedImageSet img1, SharedImageSet img2, bool moveFirstImage=true)
	Creates the algorithm instance with two images.

void	setMoveFirstImage (bool v)
	Denote whether the first input image is moved/deformed. Otherwise the second one is.

void	setWorld (bool flag, int idx=0)
	Denote whether points shall be in world or in image coordinates.

double	evaluate ()
	Evaluate average error considering whether points are in image or world coordinates.

const PointCorr &	corrInternal () const
	Read access to the internal point correspondence container. Its points may be outdated.

PointCorr &	corrInternal ()
	Write access to the internal point correspondence container, needed e.g.

SharedImageSet *	img (int idx=0)
	Return one of the used images.

bool	world (int idx=0) const
	Return if the points for an image are in world coordinates.

bool	findCorrespondences () const
	Return the flag for finding correspondences.

void	setFindCorrespondences (bool val)
	Set the flag for finding correspondences (automatic point pairing)

void	setRegistrationMode (int mode)
	Set registration mode: 0 = rigid (default), 1 = affine, 2 = TPS.

int	registrationMode () const

void	setExportAsPointClouds (bool flag)
	Specify whether compute() shall export point clouds rather than execute the registration.

bool	exportAsPointClouds () const
	Return the export to point clouds flag.

void	add (const vec4 &p1, const vec4 &p2)
	Adds the two given points to the set of point correspondences.

void	insert (int index, const vec4 &p1, const vec4 &p2)
	Adds the two given points to the set of point correspondences at the given index.

void	set (int index, const vec4 &p1, const vec4 &p2)
	Sets the point correspondences at the given index to the two given points.

void	remove (int index)
	Removes the point correspondence at the given index.

void	clear ()
	Removes all point correspondences.

const std::vector< CorrItem > &	corrs () const
	Returns a const version of the list of point correspondences.

std::vector< CorrItem > &	writableCorrs ()
	Returns a writable version of the list of point correspondences.

int	size () const
	Returns the number of point correspondences.

void	updatePoints ()
	Updates the internal PointCorr instance with the current world positions of all point correspondences.

vec4	worldToStorage (int index, const vec3 &p)
	Converts given point from world space to storage space of the image with the given index.

vec4	storageToWorld (int index, const vec4 &p)
	Converts given point from storage space of the image with the given index to world space.

bool	loadTagFile (const std::string &filename, bool swap)
	Load point correspondences from MINC/TAG format.

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

Public Member Functions inherited from SignalReceiver
	SignalReceiver ()=default
	Default constructor.

	SignalReceiver (const SignalReceiver &other)
	Copy constructor, does not copy any existing signal connections from other.

SignalReceiver &	operator= (SignalReceiver rhs)
	Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.

virtual	~SignalReceiver ()
	Virtual destructor disconnects from all connected signals.

Public Attributes
Signal	signalErrorChanged
	Signal emitted every time the point correspondences error has changed (e.g. changed points, transformation, ...).

Signal	signalPointsChanged

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.

Methods implementing the Algorithm interface
void	compute () override
	Execute the algorithm.

OwningDataList	takeOutput () override
	Return any new Data that was created by the Algorithm during the last call to compute().

static bool	createCompatible (const DataList &data, Algorithm **a=0)

Methods implementing the Configurable interface
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.

Listeners implementation
void	deformationChanged (const SharedImage *img)

void	onDeformationEvent (const DeformationEvent &event)

void	transformationChanged (const Data *data)

Additional Inherited Members
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...

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.

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 Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.

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

◆ setWorld()

void setWorld	(	bool	flag,
		int	idx = 0 )

Denote whether points shall be in world or in image coordinates.

If this method is called when points are loaded already, they are converted accordingly.

◆ corrInternal()

PointCorr & corrInternal ( )

inline

Write access to the internal point correspondence container, needed e.g.

for its ErrorFunction interface

Note: Please be aware, that any changes are of temporary nature only since PointCorrAlgorithm may overwrite its contents at any time.

◆ add()

void add	(	const vec4 &	p1,
		const vec4 &	p2 )

Adds the two given points to the set of point correspondences.

Both points have to be in the storage coordinate system of the corresponding image.

◆ insert()

void insert	(	int	index,
		const vec4 &	p1,
		const vec4 &	p2 )

Adds the two given points to the set of point correspondences at the given index.

Both points have to be in the storage coordinate system of the corresponding image.

◆ set()

void set	(	int	index,
		const vec4 &	p1,
		const vec4 &	p2 )

Sets the point correspondences at the given index to the two given points.

Both points have to be in the storage coordinate system of the corresponding image.

◆ writableCorrs()

std::vector< CorrItem > & writableCorrs ( )

Returns a writable version of the list of point correspondences.

Note: Calling this method sets the dirty for the internal PointCorr instance.

◆ updatePoints()

void updatePoints ( )

Updates the internal PointCorr instance with the current world positions of all point correspondences.

If a point correspondence item has a GlPoint annotation assigned, its coordinates are updated as well.

◆ compute()

void compute ( )

overridevirtual

Execute the algorithm.

Implements Algorithm.

◆ takeOutput()

OwningDataList takeOutput ( )

overridevirtual

Return any new Data that was created by the Algorithm during the last call to compute().

The default implementation will return an empty list.

Note: Since ownership of the data is transferred, you can call this method only once between calls to compute().

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/GL/PointCorrAlgorithm.h

Detailed Description

Classes

Public Member Functions

Public Attributes

Methods implementing the Algorithm interface

Methods implementing the Configurable interface

Listeners implementation

Additional Inherited Members

Member Function Documentation

◆ setWorld()

◆ corrInternal()

◆ add()

◆ insert()

◆ set()

◆ writableCorrs()

◆ updatePoints()

◆ compute()

◆ takeOutput()

◆ configure()

◆ configuration()