ImFusion SDK 4.3
ImageElement Class Reference

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

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

+ Inheritance diagram for 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< DataElementclone (CloneOptions opt=CloneOptions::Everything) const override
 Create a (shallow or deep) copy of the element.
 
- Public Member Functions inherited from 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< SharedImageSetsis () const
 Get the underlying SharedImageSet.
 
void setSis (std::shared_ptr< SharedImageSet > sis)
 Sets the underlying SharedImageSet.
 
- Public Member Functions inherited from DataElement
template<typename Derived>
Derived * typed ()
 
template<typename Derived>
const Derived * typed () const
 
virtual std::shared_ptr< Datacontent () const
 Returns the underlying data object.
 
const DataComponentListcomponents () const
 Convenience function to expose the DataComponents of the underlying Data object.
 
DataComponentListcomponents ()
 
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< DataElementstack (const std::vector< std::shared_ptr< ImageElement > > &elements)
 
- Static Public Member Functions inherited from DataElement
static std::unique_ptr< DataElementstack (const std::vector< std::shared_ptr< DataElement > > &elements)
 Stack several elements along the batch dimension.
 

Additional Inherited Members

- Public Types inherited from DataElement
enum class  CloneOptions { Everything = 0 , 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 SISBasedElement
std::vector< std::shared_ptr< SharedImageSet > > splitToSIS ()
 
std::unique_ptr< SharedImageSetcloneToSIS (CloneOptions opt=CloneOptions::Everything) const
 
- Protected Member Functions inherited from NotCopyable
 NotCopyable (NotCopyable &&) noexcept=default
 
NotCopyableoperator= (NotCopyable &&) noexcept=default
 
 NotCopyable (const NotCopyable &)=delete
 
NotCopyableoperator= (const NotCopyable &)=delete
 
- Static Protected Member Functions inherited from SISBasedElement
static std::unique_ptr< SharedImageSetstackToSIS (const std::vector< std::shared_ptr< SISBasedElement > > &elements)
 
- Protected Attributes inherited from SISBasedElement
SharedImageSetm_sis = nullptr
 
- Protected Attributes inherited from DataElement
std::shared_ptr< Datam_data
 

Member Function Documentation

◆ type()

ElementType type ( ) const
inlineoverridevirtual

Returns the type of the underlying data.

Implements DataElement.

◆ split()

std::vector< std::shared_ptr< DataElement > > split ( )
overridevirtual

Split an element into several ones along the batch dimension.

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

Implements DataElement.

◆ clone()

std::unique_ptr< DataElement > clone ( CloneOptions opt = CloneOptions::Everything) const
overridevirtual

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

Implements DataElement.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close