RegistrationResults::Result Struct Reference

#include <ImFusion/Reg/RegistrationResults.h>

Represents a complete registration result, composed by multiple DataResult objects. More...

Detailed Description

Represents a complete registration result, composed by multiple DataResult objects.

Public Member Functions
	Result (const DataList &datalist, std::string name, const std::function< uint64_t(const Data &)> &computeHash, Properties regAlgProps={})
	Constructs a Result object from a list of data.
DataList	apply () const
	Applies the registration result to all associated data.
bool	dataDeleted (Data *data)
	Accommodate removal of data.
bool	hasAllData () const
	Checks whether all data required by this result is available.
const DataResult *	getDataResult (const Data *data) const
	Retrieves the DataResult corresponding to a specific data object.
DataList	getData () const
	Retrieves all data included in this result.
bool	isTheSame (const DataList &data) const
	Checks whether the provided data matches the order, pose, and deformation of this result.
bool	operator== (const Result &other) const
	Compares two Result objects for equality.

Public Attributes
std::string	name
	Name of the registration result.
bool	isGroundTruth = false
	Flag indicating whether this result is ground truth.
std::vector< DataResult >	dataResults
	List of DataResult objects included in this result.
Properties	regAlgConfig
	Configuration of the registration algorithm used to produce this result.
Filesystem::Path	originFile = ""
	Path to the file from which this result was loaded, if applicable.

Constructor & Destructor Documentation

Result()

Result	(	const DataList &	datalist,
		std::string	name,
		const std::function< uint64_t(const Data &)> &	computeHash,
		Properties	regAlgProps = {} )

Constructs a Result object from a list of data.

Parameters

datalist	List of data to include in the result.
name	Name of the result.
computeHash	Function to compute the hash of each data object.
regAlgProps	Properties of the registration algorithm.

Member Function Documentation

apply()

DataList apply

(

)

const

Applies the registration result to all associated data.

Returns

A list of data objects affected by the application.

dataDeleted()

bool dataDeleted

(

Data *

data

)

Accommodate removal of data.

Returns true if this result was affected

Parameters

data	Pointer to the data being removed.

Returns

True if the result was affected by the removal.

getDataResult()

const DataResult * getDataResult

(

const Data *

data

)

const

Retrieves the DataResult corresponding to a specific data object.

Parameters

data	Pointer to the data.

Returns

Pointer to the corresponding DataResult, or nullptr if not found.

getData()

DataList getData

(

)

const

Retrieves all data included in this result.

Returns

A DataList containing all associated data.

isTheSame()

bool isTheSame

(

const DataList &

data

)

const

Checks whether the provided data matches the order, pose, and deformation of this result.

Parameters

data	List of data which will be inspected.

operator==()

bool operator==

(

const Result &

other

)

const

Compares two Result objects for equality.

dataResults are compared in order, so the order of data in the list matters. regAlgConfig is ignored in the comparison.

---

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

• ImFusion/Reg/RegistrationResults.h