ImFusion::ML::BoundingBoxElement Class Reference

#include <ImFusion/ML/DataElements/BoundingBoxElement.h>

DataElement based on BoundingBoxSet. More...

Inheritance diagram for ImFusion::ML::BoundingBoxElement:

Detailed Description

DataElement based on BoundingBoxSet.

Public Member Functions
	BoundingBoxElement (std::shared_ptr< BoundingBoxSet > boxes)
	BoundingBoxElement (const BoundingBoxSet &boxes)
	BoundingBoxElement (BoundingBoxSet &&boxes)
ElementType	type () const override
	Returns the type of the underlying data.
int	dimension () const override
	Returns the dimensionality of the underlying data.
size_t	batchSize () const override
	Returns the batch size of the element.
void	setContent (std::shared_ptr< Data > boxes) override
	Sets the underlying data.
std::shared_ptr< BoundingBoxSet >	boxes () const
void	setBoxes (std::shared_ptr< BoundingBoxSet > boxes)
	Sets the underlying BoundingBoxSet.
std::vector< std::shared_ptr< DataElement > >	split () override
	Split an element into several ones along the batch dimension.
std::unique_ptr< DataElement >	clone (CloneOptions opt=CloneOptions::Everything) const override
	Create a (shallow or deep) copy of the element.
Public Member Functions inherited from ImFusion::ML::DataElement
template<typename Derived>
Derived *	typed ()
template<typename Derived>
const Derived *	typed () const
virtual std::shared_ptr< Data >	content () const
	Returns the underlying data object.
const DataComponentList &	components () const
	Convenience function to expose the DataComponents of the underlying Data object.
DataComponentList &	components ()
bool	isTarget () const
	Returns true if this element is marked as a label.
void	tagAsTarget ()
	Mark this element as being a label.
void	untagAsTarget ()
	Remove label status from this element.

Static Public Member Functions
static std::unique_ptr< DataElement >	stack (const std::vector< std::shared_ptr< BoundingBoxElement > > &elements)
Static Public Member Functions inherited from ImFusion::ML::DataElement
static std::unique_ptr< DataElement >	stack (const std::vector< std::shared_ptr< DataElement > > &elements)
	Stack several elements along the batch dimension.

Additional Inherited Members
Public Types inherited from ImFusion::ML::DataElement
enum class	CloneOptions { Everything = 0 , Shallow , Container , NoImageData }
	Option to control which parts of the data element are to be copied when cloning the DataElement. More...
Protected Member Functions inherited from ImFusion::Utils::NotCopyable
	NotCopyable (NotCopyable &&) noexcept=default
NotCopyable &	operator= (NotCopyable &&) noexcept=default
	NotCopyable (const NotCopyable &)=delete
NotCopyable &	operator= (const NotCopyable &)=delete
Protected Attributes inherited from ImFusion::ML::DataElement
std::shared_ptr< Data >	m_data

Member Function Documentation

type()

ElementType ImFusion::ML::BoundingBoxElement::type ( ) const

inlineoverridevirtual

Returns the type of the underlying data.

Implements ImFusion::ML::DataElement.

dimension()

int ImFusion::ML::BoundingBoxElement::dimension ( ) const

overridevirtual

Returns the dimensionality of the underlying data.

Implements ImFusion::ML::DataElement.

batchSize()

size_t ImFusion::ML::BoundingBoxElement::batchSize ( ) const

overridevirtual

Returns the batch size of the element.

Implements ImFusion::ML::DataElement.

setContent()

void ImFusion::ML::BoundingBoxElement::setContent ( std::shared_ptr< Data > boxes )

overridevirtual

Sets the underlying data.

Exceptions

DataElementException

if boxes is nullptr or not of type BoundingBoxSet

Implements ImFusion::ML::DataElement.

setBoxes()

void ImFusion::ML::BoundingBoxElement::setBoxes

(

std::shared_ptr< BoundingBoxSet >

boxes

)

Sets the underlying BoundingBoxSet.

Exceptions

DataElementException

if boxes is nullptr

split()

std::vector< std::shared_ptr< DataElement > > ImFusion::ML::BoundingBoxElement::split ( )

overridevirtual

Split an element into several ones along the batch dimension.

After a call to this function, the element is empty.

Implements ImFusion::ML::DataElement.

clone()

std::unique_ptr< DataElement > ImFusion::ML::BoundingBoxElement::clone ( CloneOptions opt = CloneOptions::Everything ) const

overridevirtual

Create a (shallow or deep) copy of the element.

Implements ImFusion::ML::DataElement.

---

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

• ImFusion/ML/DataElements/BoundingBoxElement.h