#include <ImFusion/Dicom/PhilipsQLabIOD.h>

Loads ultrasound volume stored by Philips QLab software. More...

Inheritance diagram for PhilipsQLabIOD:

Detailed Description

Loads ultrasound volume stored by Philips QLab software.

This does only support certain DICOMs exported by QLab (cartesian?).

Public Member Functions
	PhilipsQLabIOD (DcmDataset &dataset, const OFString &sopClassUID)

std::vector< Dicom::FrameDescriptor >	loadFrames () override
	Loads the descriptors of all individual frames stored in this IOD.

std::vector< Dicom::FrameDescriptorSet >	sortAndGroupFrames (const std::vector< Dicom::FrameDescriptor > &frames) const override
	Sorts and groups the given frames into sets of associated frames (e.g.

void	loadFrameData (const Dicom::FrameDescriptor &desc, MemImage &image, int slice=-1) override
	Loads the actual frame data into the given image.

void	loadFrameProperties (const Dicom::FrameDescriptor &desc, SharedImageSet &image) override
	Loads any additional properties into the given image.

void	save (SharedImageSet &imageSet, int sharedImageIndex, int sliceIndex) override
	Stores the general image descriptor and metadata of imageSet in the DICOM data set.

void	savePixelData (SharedImageSet &imageSet, int sharedImageIndex, int sliceIndex) override
	Writes the pixel data of imageSet in the DICOM data set.

Public Member Functions inherited from IOD
	IOD (DcmDataset &dataset, const OFString &sopClassUID)
	Creates a new IOD representation using the given DcmDataset and SOP class UID.

virtual void	checkErrors () const
	Checks modules for errors and adds them to the list.

template<typename T>
const T *	searchModule ()
	Returns the first module of the given type or nullptr if no such module exists.

DcmDataset &	dataset () override
	Returns the dataset represented by this IOD.

Public Member Functions inherited from ModuleList
const std::vector< const Module * > &	modules () const
	List of all modules.

Public Member Functions inherited from ElementList
const std::vector< ElementBase * > &	elements () const
	List of all elements.

Public Member Functions inherited from ErrorRecorder
virtual void *	registerErrorHandler (ErrorCallback handler)
	Registers a new handler callback function.

virtual void	unregisterErrorHandler (void *handler)
	Removes a previously registered handler again.

void *	forwardErrors (const ErrorRecorder *otherRecorder)
	Convenient function to forward all errors registered to this recorder to another recorder.

virtual void	registerError (const Error &error) const
	Sends the given error to all error handler callbacks.

void	registerError (Error::Code code, Error::Type type, const std::string &details, TagProxy tag=TagProxy()) const

Public Attributes
Dicom::Element< int >	slices

Dicom::Element< int >	numberOfFrames

Dicom::Element< int >	physicalUnitsX

Dicom::Element< int >	physicalUnitsY

Dicom::Element< int >	physicalUnitsZ

Dicom::Element< double >	physicalDeltaX

Dicom::Element< double >	physicalDeltaY

Dicom::Element< double >	physicalDeltaZ

Dicom::Element< double >	frameTime

Public Attributes inherited from IOD
const OFString	sopClassUID
	DICOM SOP used.

std::string	pathInfo
	Optional information from which file this IOD was loaded from (only use for display purposes)

CommonModule	common

ImagePixel	imagePixel

Element< int >	numberOfFrames
	If this element exists and is larger than 1, multiple frames will be loaded regardless of the SOP Class defining it or not.

Additional Inherited Members
Public Types inherited from ErrorRecorder
using	ErrorCallback = std::function<void(const Error&)>
	Alias for a function to call for each error recorded.

Protected Member Functions inherited from ModuleList
virtual void	addModule (const Module &m)
	Adds a the module to the list. Should only be called by the Module constructor.

virtual void	removeModule (const Module &m)

Protected Member Functions inherited from NotCopyable
	NotCopyable (NotCopyable &&) noexcept=default

NotCopyable &	operator= (NotCopyable &&) noexcept=default

	NotCopyable (const NotCopyable &)=delete

NotCopyable &	operator= (const NotCopyable &)=delete

Protected Attributes inherited from IOD
DcmDataset &	m_dataset

Protected Attributes inherited from ModuleList
std::vector< const Module * >	m_modules
	List of all modules.

Protected Attributes inherited from ElementList
std::vector< ElementBase * >	m_elements
	List of all elements.

Member Function Documentation

◆ loadFrames()

std::vector< Dicom::FrameDescriptor > loadFrames ( )

overridevirtual

Loads the descriptors of all individual frames stored in this IOD.

Except for Enhanced Multiframe Dicoms, most IODs will return one image. Does not load any pixel data.

Implements IOD.

◆ sortAndGroupFrames()

std::vector< Dicom::FrameDescriptorSet > sortAndGroupFrames ( const std::vector< Dicom::FrameDescriptor > & frames ) const

overridevirtual

Sorts and groups the given frames into sets of associated frames (e.g.

volumes).

All given frames should be somehow part of the returned frame sets. 2D images (i.e. IMAGESET) can be returned as framesets with only a single item. The exact order of the given frames is undefined. For multiframe Dicoms, this method is only called on the first frame. The IOD pointer held by each frame can be used to access special elements that are required for sorting and/or grouping.

Note: When overriding this method, it should be treated like a static method, i.e. no members should be accessed.

Implements IOD.

◆ loadFrameData()

void loadFrameData	(	const Dicom::FrameDescriptor &	desc,
		MemImage &	image,
		int	slice = -1 )

overridevirtual

Loads the actual frame data into the given image.

The frameNumber in the given FrameDescriptor is the index of the corresponding frame as returned by loadFrames. If slice is not -1, the frame should be loaded into the given slice of the image.

Implements IOD.

◆ loadFrameProperties()

void loadFrameProperties	(	const Dicom::FrameDescriptor &	desc,
		SharedImageSet &	image )

overridevirtual

Loads any additional properties into the given image.

This method is called after the complete image data has been loaded. desc will contain valid sharedImageIndex and sliceIndex parameters indicating where this frame has been stored in the image. Implementations must not reorder, remove or resize the images of the given SharedImageSet!

The order or amount of images must not be changed inside the SharedImageSet! Also, the size of the individual images must not change. Otherwise, this would lead to inconsistent sharedImageIndex and sliceIndex values.

This method might throw an exception if the properties somehow make the image completely invalid. This should only be used as a last restort if there is really no way to use the image in any meaningful way!

Note: The default implementation will create an ImageInfoDataComponent instance and attach it to image. Thus, when overriding this method make sure to call the base class method.

Reimplemented from IOD.

◆ save()

void save	(	SharedImageSet &	imageSet,
		int	sharedImageIndex,
		int	sliceIndex )

overridevirtual

Stores the general image descriptor and metadata of imageSet in the DICOM data set.

sharedImageIndex and sliceIndex describe which part of the image set should be stored.

Reimplemented from IOD.

◆ savePixelData()

void savePixelData	(	SharedImageSet &	imageSet,
		int	sharedImageIndex,
		int	sliceIndex )

overridevirtual

Writes the pixel data of imageSet in the DICOM data set.

sharedImageIndex and sliceIndex describe which part of the image set should be stored.

Implements IOD.

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

ImFusion/Dicom/PhilipsQLabIOD.h

Detailed Description

Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

◆ loadFrames()

◆ sortAndGroupFrames()

◆ loadFrameData()

◆ loadFrameProperties()

◆ save()

◆ savePixelData()