This class defines a DICOM SOP instance. It is useful during the whole writing process. This class allows to share data between module writers. More...

#include <DicomInstance.hpp>

Public Types
typedef std::shared_ptr< DicomInstance >	sptr

typedef std::vector< std::string >	SOPInstanceUIDContainerType
	SOP Instance Container Type.

Public Member Functions
FWGDCMIO_API	DicomInstance ()
	Constructor.

FWGDCMIO_API	DicomInstance (const std::shared_ptr< const ::fwMedData::Series > &series, const std::shared_ptr< ::fwLog::Logger > &logger=nullptr, bool isMultiFiles=true)
	Constructor. More...

FWGDCMIO_API	DicomInstance (const std::shared_ptr< const ::fwMedData::DicomSeries > &dicomSeries, const std::shared_ptr< ::fwLog::Logger > &logger=nullptr)
	Constructor. More...

FWGDCMIO_API	DicomInstance (const DicomInstance &dicomInstance)
	Copy constructor.

virtual FWGDCMIO_API	~DicomInstance ()
	Destructor.

bool	getIsMultiFiles () const
	Get the flag on multi-files state of an image series.

void	setIsMultiFiles (bool isMultiFiles)
	Set the flag on multi-files state of an image series.

const std::string &	getSOPClassUID () const
	Get SOP Class UID.

void	setSOPClassUID (const std::string &SOPClassUID)
	Set SOP Class UID.

const std::string &	getSeriesInstanceUID () const
	Get Series Instance UID.

void	setSeriesInstanceUID (const std::string &seriesInstanceUID)
	Set Series Instance UID.

const std::string &	getStudyInstanceUID () const
	Get Study Instance UID.

void	setStudyInstanceUID (const std::string &studyInstanceUID)
	Set Study Instance UID.

const std::string &	getFrameOfReferenceUID () const
	Get Study Instance UID.

void	setFrameOfReferenceUID (const std::string &frameOfReferenceUID)
	Set Study Instance UID.

const SOPInstanceUIDContainerType &	getSOPInstanceUIDContainer () const
	Get SOP Instance UID container.

SOPInstanceUIDContainerType &	getSOPInstanceUIDContainer ()
	Get SOP Instance UID container.

void	setSOPInstanceUIDContainer (const SOPInstanceUIDContainerType &SOPInstanceUIDContainer)
	Set SOP Instance UID Container.

Protected Member Functions
void	computeSOPClassUID (const std::shared_ptr< const ::fwMedData::Series > &series)
	Compute SOPClassUID. More...

void	generateSOPInstanceUIDs (const std::shared_ptr< const ::fwMedData::Series > &series)
	Generate SOPInstanceUIDs according to series type and dimension. More...

void	readUIDFromDicomSeries (const std::shared_ptr< const ::fwMedData::DicomSeries > &dicomSeries)
	Extract 'SOP Instance UIDs' and 'Frame of Reference UID' from a DICOM series. More...

Detailed Description

This class defines a DICOM SOP instance. It is useful during the whole writing process. This class allows to share data between module writers.

Definition at line 38 of file DicomInstance.hpp.

Constructor & Destructor Documentation

FWGDCMIO_API fwGdcmIO::container::DicomInstance::DicomInstance	(	const std::shared_ptr< const ::fwMedData::Series > &	series,
		const std::shared_ptr< ::fwLog::Logger > &	logger = `nullptr`,
		bool	isMultiFiles = `true`
	)

Constructor.

Parameters

[in]	series	Series from which the instance is created
[in]	isMultiFiles	Set whether the instance must be split in several files or not
[in]	logger	Logger

FWGDCMIO_API fwGdcmIO::container::DicomInstance::DicomInstance	(	const std::shared_ptr< const ::fwMedData::DicomSeries > &	dicomSeries,
		const std::shared_ptr< ::fwLog::Logger > &	logger = `nullptr`
	)

Constructor.

Parameters

[in]	dicomSeries	DicomSeries from which the instance is created
[in]	logger	Logger

Member Function Documentation

void fwGdcmIO::container::DicomInstance::computeSOPClassUID ( const std::shared_ptr< const ::fwMedData::Series > & series )

protected

Compute SOPClassUID.

Parameters

[in] series Series

Definition at line 99 of file DicomInstance.cpp.

References getIsMultiFiles(), and setSOPClassUID().

Referenced by DicomInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

void fwGdcmIO::container::DicomInstance::generateSOPInstanceUIDs ( const std::shared_ptr< const ::fwMedData::Series > & series )

protected

Generate SOPInstanceUIDs according to series type and dimension.

Parameters

[in] series Series

Definition at line 143 of file DicomInstance.cpp.

Referenced by DicomInstance().

Here is the caller graph for this function:

void fwGdcmIO::container::DicomInstance::readUIDFromDicomSeries ( const std::shared_ptr< const ::fwMedData::DicomSeries > & dicomSeries )

protected

Extract 'SOP Instance UIDs' and 'Frame of Reference UID' from a DICOM series.

Parameters

[in] dicomSeries DICOM Series from which the UIDs are extracted

Definition at line 163 of file DicomInstance.cpp.

References SLM_WARN_IF, and SPTR.

Referenced by DicomInstance().

Here is the caller graph for this function:

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

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation