ImFusion C++ SDK 4.5.0
ImFusion::ML::ImageElement Class Reference

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

DataElement for 2D and 3D images. More...

Inheritance diagram for ImFusion::ML::ImageElement:

Detailed Description

DataElement for 2D and 3D images.

Public Member Functions

 ImageElement (std::shared_ptr< SharedImageSet > sharedImageSet)
ElementType type () const override
 Returns the type of the underlying data.
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::SISBasedElement
 SISBasedElement (std::shared_ptr< SharedImageSet > 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 > sis) override
 Sets the underlying data.
std::shared_ptr< SharedImageSet > sis () const
 Get the underlying SharedImageSet.
void setSis (std::shared_ptr< SharedImageSet > sis)
 Sets the underlying SharedImageSet.
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< ImageElement > > &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::ML::SISBasedElement
std::vector< std::shared_ptr< SharedImageSet > > splitToSIS ()
std::unique_ptr< SharedImageSet > cloneToSIS (CloneOptions opt=CloneOptions::Everything) const
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
Static Protected Member Functions inherited from ImFusion::ML::SISBasedElement
static std::unique_ptr< SharedImageSet > stackToSIS (const std::vector< std::shared_ptr< SISBasedElement > > &elements)
Protected Attributes inherited from ImFusion::ML::SISBasedElement
SharedImageSet * m_sis = nullptr
Protected Attributes inherited from ImFusion::ML::DataElement
std::shared_ptr< Data > m_data

Member Function Documentation

◆ type()

ElementType ImFusion::ML::ImageElement::type ( ) const
inlineoverridevirtual

Returns the type of the underlying data.

Implements ImFusion::ML::DataElement.

◆ split()

std::vector< std::shared_ptr< DataElement > > ImFusion::ML::ImageElement::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::ImageElement::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/ImageElement.h
Search Tab / S to search, Esc to close