#include <ImFusion/Dicom/DatasetHandler.h>

Read access handler for proprietary / non-standard DICOM image formats, or non-image datasets. More...

Inheritance diagram for DatasetHandler:

Detailed Description

Read access handler for proprietary / non-standard DICOM image formats, or non-image datasets.

\experimental

Public Types
using	DcmDatasetList = std::vector<std::shared_ptr<DcmDataset>>

Public Member Functions
virtual std::tuple< DcmDatasetList, DcmDatasetList >	selectDatasets (const DcmDatasetList &datasets) const =0
	Function that selects the datasets this handler will load based on some property of the dataset.

virtual OwningDataList	loadFromDataset (DcmDataset &dataset, ErrorRecorder errors, Progress progress) const =0
	Load the given datasets.

virtual std::string	displayName () const =0
	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

Configurable &	operator= (const Configurable &)

Configurable &	operator= (Configurable &&) noexcept

Protected Member Functions
std::tuple< DcmDatasetList, DcmDatasetList >	selectDatasetsBySopClass (const DcmDatasetList &datasets, const std::string &sopClass) const
	Convenient method to select datasets according to their SOPClassUID.

Additional Inherited Members
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' `signalValueChanged` signal was emitted.

Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

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

pure virtual

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

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

pure virtual

Load the given datasets.

virtual std::string displayName ( ) const

pure virtual

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

std::tuple< DcmDatasetList, DcmDatasetList > selectDatasetsBySopClass	(	const DcmDatasetList &	datasets,
		const std::string &	sopClass ) const

protected

Convenient method to select datasets according to their SOPClassUID.

Can be used to implement selectDatasets above.

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