Inheritance diagram for ContoursStorageComponent:

Public Member Functions
	ContoursStorageComponent (const ContoursStorageComponent &other)

ContoursStorageComponent &	operator= (const ContoursStorageComponent &other)

bool	operator== (const ContoursStorageComponent &) const
	The equals operator checks whether all contours are equal.

int	add (const Seg::Contour &contour)

int	add (Seg::Contour &&contour)

bool	remove (int whichFrame, int whichContour)

void	removeAll (int whichFrame)

void	removeAll ()

int	size (int whichFrame)
	Get the number of contours in a frame or, if called with -1 or no argument, the total number of all contours.

int	size ()
	Get the total number of all contours.

std::vector< std::unique_ptr< Seg::Contour > > &	contours (int whichFrame)
	Returns the contours on the given frame.

std::vector< Seg::Contour * >	contours ()
	Returns a flattened vector of Seg::Contour pointers.

std::vector< std::pair< Seg::Contour &, int > >	filterContours (Flags< Seg::Contour::CreationMode > filter, std::optional< int > whichFrame=std::nullopt)

bool	hasContours (int whichFrame, std::optional< Seg::Contour::CreationMode > filter=std::nullopt)

std::string	id () const override
	Returns a unique string identifier for this type of data component.

void	configure (const Properties *) override
	Configure this object instance by de-serializing the given Properties.

void	configuration (Properties *) const override
	Serialize the current object configuration into the given Properties object.

std::unique_ptr< FrameBasedPointCloud >	createPointCloud (TrackedSharedImageSet &trackedSharedImageSet, const int whichLabelValue=1) const
	Create a frame based point cloud out of the points in the contours in the component.

Public Member Functions inherited from DataComponent< ContoursStorageComponent >
std::unique_ptr< DataComponentBase >	clone () const override
	Creates a clone of this data component.

std::unique_ptr< Subclass >	cloneDerived () const

bool	assign (const DataComponentBase &other) override
	Assigns the content of other to this data component.

bool	equals (const DataComponentBase &other) const override
	Compares this data component to other for equality.

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

Additional Inherited Members
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 DataComponentBase
	DataComponentBase (const DataComponentBase &)=default

DataComponentBase &	operator= (const DataComponentBase &other)=default

Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

◆ contours()

std::vector< std::unique_ptr< Seg::Contour > > & contours ( int whichFrame )

Returns the contours on the given frame.

Parameters

whichFrame The given frame. Cannot be -1.

Returns: A reference to the contours.

◆ id()

std::string id ( ) const

inlineoverridevirtual

Returns a unique string identifier for this type of data component.

Note: To avoid conflicts make sure to include potential plugin names into this ID. Due to the modular architecture of the ImFusion library, uniqueness of IDs cannot be checked at compile time. However, DataComponentFactory will check the uniqueness of the ID during registration.

Implements DataComponentBase.

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

◆ createPointCloud()

std::unique_ptr< FrameBasedPointCloud > createPointCloud	(	TrackedSharedImageSet &	trackedSharedImageSet,
		const int	whichLabelValue = 1 ) const

Create a frame based point cloud out of the points in the contours in the component.

Pass in the TrackedSharedImageSet to which the contours pertain.

Parameters

trackedSharedImageSet The data to which the contours are attached. The matrices are used to create the point cloud

Returns: A frame based point cloud from the contours

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

ImFusion/Seg/ContoursStorageComponent.h