ImFusion SDK 4.3
RTStructureDatasetHandler Class Reference

#include <ImFusion/Dicom/RTStructureDatasetHandler.h>

A DatasetHandler for loading DICOM RTStructureSet. More...

+ Inheritance diagram for RTStructureDatasetHandler:

Detailed Description

A DatasetHandler for loading DICOM RTStructureSet.

Each ROI is loaded as a PointCloud. All points from all 'Contour Data' inside a 'ROI Contour Sequence' are combined in into one PointCloud. The original structure of contours is stored in a RTStructureDataComponent.

Instead of using this class directly, DicomIoAlgorithm should be used.

Public Member Functions

std::tuple< DcmDatasetList, DcmDatasetListselectDatasets (const DcmDatasetList &datasets) const override
 Function that selects the datasets this handler will load based on some property of the dataset.
 
OwningDataList loadFromDataset (DcmDataset &dataset, ErrorRecorder *errors, Progress *progress) const override
 Load the given datasets.
 
std::string displayName () const override
 Display name for the DatasetHandler, e.g. for subproperty label.
 
- Public Member Functions inherited from Configurable
virtual void configure (const Properties *p)
 Configure this object instance by de-serializing the given Properties.
 
virtual void configuration (Properties *p) const
 Serialize the current object configuration into the given Properties object.
 
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
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 

Additional Inherited Members

- Public Types inherited from DatasetHandler
using DcmDatasetList = std::vector<std::shared_ptr<DcmDataset>>
 
- 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 DatasetHandler
std::tuple< DcmDatasetList, DcmDatasetListselectDatasetsBySopClass (const DcmDatasetList &datasets, const std::string &sopClass) const
 Convenient method to select datasets according to their SOPClassUID.
 
- Protected Attributes inherited from Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Member Function Documentation

◆ selectDatasets()

std::tuple< DcmDatasetList, DcmDatasetList > selectDatasets ( const DcmDatasetList & datasets) const
overridevirtual

Function that selects the datasets this handler will load based on some property of the dataset.

Returns
list of datasets this handler will not load, and list of datasets this handler will handle

Implements DatasetHandler.

◆ loadFromDataset()

OwningDataList loadFromDataset ( DcmDataset & dataset,
ErrorRecorder * errors,
Progress * progress ) const
overridevirtual

Load the given datasets.

Implements DatasetHandler.

◆ displayName()

std::string displayName ( ) const
overridevirtual

Display name for the DatasetHandler, e.g. for subproperty label.

Implements DatasetHandler.


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