Detailed Description

Replace in-place a set of image values with others values.

The input image is expected to have either a UBYTE or USHORT type. The algorithm runs on the GPU unless one of the conditions is met:

the parameter ForceCPU is set to true,
the input has more than four channels or a shift/scale,
there is a reference image.

An additional set of compatible reference images may be provided in the constructor; when this is the case, the values will be read from the reference images but replaced in the main ones.

For convenience purposes, a default value can be set, in which case all not explicitly defined non-zero input values will be assigned this value.

Warning: Any shift/scale will be burned in the memory buffer, i.e. the output image will have a zero-shift and a unit-scale.

Example:

SharedImageSet inputImage; // example: 1d image with values [0, 0, 0, 1]
SharedImageSet referenceImage; // example: 1d image with values [1, 1, 2, 3]
 
ReplaceValuesAlgorithm replaceValuesAlgorithm(&inputImage, &referenceImage);
replaceValuesAlgorithm.setReplaceValues({1, 3}, {2, 0});  // 1 will be replaced by 2, 3 will be replaced by 0
replaceValuesAlgorithm.compute();
// now inputImage = [2, 2, 0, 0]

Public Member Functions
	ReplaceValuesAlgorithm (SharedImageSet img, const SharedImageSet imgRef=nullptr)
	Creates the algorithm instance with an image and optional reference image of the same size and type.

void	setReplaceValues (const std::vector< uint16_t > &oldValues, const std::vector< uint16_t > &newValues)
	Define the replacement pattern for value substitution.

void	setForceCPU (bool forceCPU)
	Forces the computation to be run on the CPU.

void	setUpdateLabelsDataComponent (bool update)
	Replaces the old-values in the LabelsDataComponent with the mapped ones.

void	setDefaultValue (std::optional< uint16_t > val)
	Replaces the default target value to be used for all values not explicitly specified.

void	setInput (SharedImageSet img, const SharedImageSet imgRef=nullptr)
	Change the image inputs.

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	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 Member Functions
void	computeGPU ()

void	computeCPU ()

template<typename T>
void	replaceValuesCPU (TypedImage< T > img, const TypedImage< T > imgRef)

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.

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

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.

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.

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 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

◆ setReplaceValues()

void setReplaceValues	(	const std::vector< uint16_t > &	oldValues,
		const std::vector< uint16_t > &	newValues )

Define the replacement pattern for value substitution.

All values are in original units.

Parameters

oldValues	List of values that should be replaced
newValues	List of new values that should be assigned to the corresponding old values.

◆ compute()

void compute ( )

overridevirtual

Execute the algorithm.

Implements 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/Base/ReplaceValuesAlgorithm.h

Detailed Description

Public Member Functions

Protected Member Functions

Methods implementing the algorithm interface

Methods implementing the Configurable interface

Additional Inherited Members

Member Function Documentation

◆ setReplaceValues()

◆ compute()

◆ configure()

◆ configuration()