 |
ImFusion C++ SDK 4.5.0
|
|
ImFusion C++ SDK 4.5.0
|
#include <ImFusion/ML/DataElements/SISBasedElement.h>
Interface for DataElement based on SharedImageSet. More...
Interface for DataElement based on SharedImageSet.
This is not an actual element type but it will be used as the base class for VectorElement and ImageElement.
Public Member Functions | |
| 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 | |
| virtual ElementType | type () const =0 |
| Returns the type of the underlying data. | |
| template<typename Derived> | |
| Derived * | typed () |
| template<typename Derived> | |
| const Derived * | typed () const |
| virtual std::shared_ptr< Data > | content () const |
| Returns the underlying data object. | |
| virtual std::vector< std::shared_ptr< DataElement > > | split ()=0 |
| Split an element into several ones along the batch dimension. | |
| virtual std::unique_ptr< DataElement > | clone (CloneOptions opt=CloneOptions::Everything) const =0 |
| Create a (shallow or deep) copy of the element. | |
| 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. | |
Protected Member Functions | |
| 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 | |
| static std::unique_ptr< SharedImageSet > | stackToSIS (const std::vector< std::shared_ptr< SISBasedElement > > &elements) |
Protected Attributes | |
| SharedImageSet * | m_sis = nullptr |
| Protected Attributes inherited from ImFusion::ML::DataElement | |
| std::shared_ptr< Data > | m_data |
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... | |
| 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. | |
|
overridevirtual |
Returns the dimensionality of the underlying data.
Implements ImFusion::ML::DataElement.
Reimplemented in ImFusion::ML::VectorElement.
|
overridevirtual |
Returns the batch size of the element.
Implements ImFusion::ML::DataElement.
|
overridevirtual |
Sets the underlying data.
| DataElementException | if sis is nullptr or not of type SharedImageSet |
Implements ImFusion::ML::DataElement.
| void ImFusion::ML::SISBasedElement::setSis | ( | std::shared_ptr< SharedImageSet > | sis | ) |
Sets the underlying SharedImageSet.
| DataElementException | if sis is nullptr |