#include <ImFusion/Base/SyntheticDataAlgorithm.h>

Creates synthetic data for various test scenarios. More...

Inheritance diagram for SyntheticDataAlgorithm:

Detailed Description

Creates synthetic data for various test scenarios.

Public Types
enum	Mode { LINEAR_GRADIENT_X_2D , LINEAR_GRADIENT_Y_2D , BILINEAR_GRADIENT_2D , MANDELBROT_2D , RANDOM_CONTENT_2D , OSCILLATION_2D , MANDELBROT_3D , REGISTRATION_TEST_IMAGE , LINEAR_GRADIENT_X_3D , LINEAR_GRADIENT_Y_3D , LINEAR_GRADIENT_Z_3D , TRILINEAR_GRADIENT , BEAM_HARDENING_PHANTOM_3D , GRID_3D , CONTRAST_TEST_IMAGE_2D , TENSOR1D , NR_MODES }

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
	SyntheticDataAlgorithm ()
	Default constructor without data.

	~SyntheticDataAlgorithm () override
	Destructor.

void	setMode (int mode)
	Set the type of synthetic data to create.

void	setDescriptor (const ImageDescriptor &desc)
	Set optional descriptor for desired image properties.

void	setDescriptor (const Image &desc)

std::unique_ptr< MemImage >	generateContrastTestImage2D ()
	Generate synthetic test image for contrast filter.

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

Static Public Member Functions
template<typename T>
static std::unique_ptr< MemImage >	generateImage2D (int contentType, const ImageDescriptor &desc)
	Generates a memory image with specified content.

template<typename T>
static std::unique_ptr< MemImage >	generateImage3D (const ImageDescriptor &desc)
	Generates a 3D image of specified size with fractal content.

template<typename T>
static std::unique_ptr< MemImage >	generateLinearImage3D (int contentType, const ImageDescriptor &desc)
	Generates a 3D image of specified size with specified content.

template<typename T>
static std::unique_ptr< MemImage >	generateRegImage (const ImageDescriptor &desc)
	Generates a registration test image in 2D or 3D according to image descriptor.

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.

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().

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.

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

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

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

◆ generateImage2D()

template<typename T>

static std::unique_ptr< MemImage > generateImage2D	(	int	contentType,
		const ImageDescriptor &	desc )

static

Generates a memory image with specified content.

Parameters

desc	Setting width and/or height to zero will create an image with random width and/or height

◆ generateImage3D()

template<typename T>

static std::unique_ptr< MemImage > generateImage3D ( const ImageDescriptor & desc )

static

Generates a 3D image of specified size with fractal content.

Parameters

desc	The width of the descriptor specifies the image dimensions. They are set to 256 if width <= 1.

◆ generateLinearImage3D()

template<typename T>

static std::unique_ptr< MemImage > generateLinearImage3D	(	int	contentType,
		const ImageDescriptor &	desc )

static

Generates a 3D image of specified size with specified content.

Parameters

desc	If a dimension is zero, it is set to 256 by default. If slices <= 1, it is set to 256.

◆ generateRegImage()

template<typename T>

static std::unique_ptr< MemImage > generateRegImage ( const ImageDescriptor & desc )

static

Generates a registration test image in 2D or 3D according to image descriptor.

Parameters

desc	If a dimension is zero, it is set to 256 by default.

◆ generateContrastTestImage2D()

std::unique_ptr< MemImage > generateContrastTestImage2D ( )

Generate synthetic test image for contrast filter.

Note: Width, height and datatype are fixed.

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

ImFusion/Base/SyntheticDataAlgorithm.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Methods implementing the Algorithm interface

Additional Inherited Members

Member Function Documentation

◆ compute()

◆ takeOutput()

◆ configure()

◆ configuration()

◆ generateImage2D()

◆ generateImage3D()

◆ generateLinearImage3D()

◆ generateRegImage()

◆ generateContrastTestImage2D()