itk::GDCMImageIO Class Reference

#include <itkGDCMImageIO.h>

Inheritance diagram for itk::GDCMImageIO:

Collaboration diagram for itk::GDCMImageIO:

Public Types
using	Pointer = SmartPointer< Self >
using	Self = GDCMImageIO
using	Superclass = ImageIOBase
Public Types inherited from itk::ImageIOBase
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = ImageIOBase
using	Superclass = LightProcessObject
using	IndexValueType = ::itk::IndexValueType
using	SizeValueType = ::itk::SizeValueType
using	IOComponentEnum = itk::IOComponentEnum
using	IOFileEnum = itk::IOFileEnum
using	IOByteOrderEnum = itk::IOByteOrderEnum
using	SizeType = ::itk::intmax_t
using	BufferSizeType = ::itk::OffsetValueType
using	ArrayOfExtensionsType = std::vector< std::string >
Public Types inherited from itk::LightProcessObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightProcessObject
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
bool	CanReadFile (const char *) override
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () const
void	Read (void *pointer) override
void	ReadImageInformation () override
Public Member Functions inherited from itk::ImageIOBase
virtual void	SetFileName (const char *_arg)
virtual const char *	GetFileName () const
void	SetNumberOfDimensions (unsigned int)
virtual unsigned int	GetNumberOfDimensions () const
virtual void	SetDimensions (unsigned int i, SizeValueType dim)
virtual SizeValueType	GetDimensions (unsigned int i) const
virtual void	SetOrigin (unsigned int i, double origin)
virtual double	GetOrigin (unsigned int i) const
virtual void	SetSpacing (unsigned int i, double spacing)
virtual double	GetSpacing (unsigned int i) const
virtual void	SetDirection (unsigned int i, const std::vector< double > &direction)
virtual void	SetDirection (unsigned int i, const vnl_vector< double > &direction)
virtual std::vector< double >	GetDirection (unsigned int i) const
virtual std::vector< double >	GetDefaultDirection (unsigned int k) const
virtual void	SetIORegion (ImageIORegion _arg)
virtual const ImageIORegion &	GetIORegion () const
virtual void	SetPixelType (const ::itk::CommonEnums::IOPixel _arg)
virtual ::itk::CommonEnums::IOPixel	GetPixelType () const
virtual void	SetComponentType (const IOComponentEnum _arg)
virtual IOComponentEnum	GetComponentType () const
virtual const std::type_info &	GetComponentTypeInfo () const
virtual void	SetNumberOfComponents (unsigned int _arg)
virtual const unsigned int &	GetNumberOfComponents () const
virtual void	SetUseCompression (bool _arg)
virtual bool	GetUseCompression () const
virtual void	UseCompressionOn ()
virtual void	UseCompressionOff ()
virtual void	SetCompressionLevel (int _arg)
virtual int	GetCompressionLevel () const
virtual void	SetCompressor (std::string _c)
virtual const std::string &	GetCompressor () const
virtual void	SetUseStreamedReading (bool _arg)
virtual bool	GetUseStreamedReading () const
virtual void	UseStreamedReadingOn ()
virtual void	UseStreamedReadingOff ()
virtual void	SetUseStreamedWriting (bool _arg)
virtual bool	GetUseStreamedWriting () const
virtual void	UseStreamedWritingOn ()
virtual void	UseStreamedWritingOff ()
virtual void	SetExpandRGBPalette (bool _arg)
virtual bool	GetExpandRGBPalette () const
virtual void	ExpandRGBPaletteOn ()
virtual void	ExpandRGBPaletteOff ()
virtual void	SetWritePalette (bool _arg)
virtual bool	GetWritePalette () const
virtual void	WritePaletteOn ()
virtual void	WritePaletteOff ()
virtual bool	GetIsReadAsScalarPlusPalette () const
virtual void	SetFileType (const IOFileEnum _arg)
virtual IOFileEnum	GetFileType () const
void	SetFileTypeToASCII ()
void	SetFileTypeToBinary ()
virtual void	SetByteOrder (const IOByteOrderEnum _arg)
virtual IOByteOrderEnum	GetByteOrder () const
void	SetByteOrderToBigEndian ()
void	SetByteOrderToLittleEndian ()
std::string	GetFileTypeAsString (IOFileEnum) const
std::string	GetByteOrderAsString (IOByteOrderEnum) const
virtual SizeType	GetPixelStride () const
SizeType	GetImageSizeInPixels () const
SizeType	GetImageSizeInBytes () const
SizeType	GetImageSizeInComponents () const
virtual unsigned int	GetComponentSize () const
virtual bool	CanStreamRead ()
virtual bool	CanStreamWrite ()
virtual bool	SupportsDimension (unsigned long dim)
virtual ImageIORegion	GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const
virtual unsigned int	GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
virtual ImageIORegion	GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
const ArrayOfExtensionsType &	GetSupportedReadExtensions () const
const ArrayOfExtensionsType &	GetSupportedWriteExtensions () const
template<typename TPixel >
void	SetTypeInfo (const TPixel *)
template<typename TPixel >
void	SetPixelTypeInfo (const TPixel *)
template<typename TPixel >
void	SetPixelTypeInfo (const RGBPixel< TPixel > *)
template<typename TPixel >
void	SetPixelTypeInfo (const RGBAPixel< TPixel > *)
template<unsigned VLength>
void	SetPixelTypeInfo (const Offset< VLength > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Vector< TPixel, VLength > *)
template<typename TCoordRep , unsigned NPointDimension>
void	SetPixelTypeInfo (const Point< TCoordRep, NPointDimension > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)
template<typename TPixel >
void	SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)
template<typename TPixel >
void	SetPixelTypeInfo (const std::complex< TPixel > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)
template<typename TPixel >
void	SetPixelTypeInfo (const VariableLengthVector< TPixel > *)
template<typename TValue >
void	SetPixelTypeInfo (const Array< TValue > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)
template<typename TValue >
void	SetPixelTypeInfo (const VariableSizeMatrix< TValue > *)
Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData () const
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual const float &	GetProgress () const
void	UpdateProgress (float amount)
virtual void	UpdateOutputData ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexcept override
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
Pointer	Clone () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageIOBase
static std::string	GetComponentTypeAsString (IOComponentEnum)
static IOComponentEnum	GetComponentTypeFromString (const std::string &typeString)
static std::string	GetPixelTypeAsString (IOPixelEnum)
static IOPixelEnum	GetPixelTypeFromString (const std::string &pixelString)
Static Public Member Functions inherited from itk::LightProcessObject
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()
using	CompressionEnum = GDCMImageIOEnums::Compression
double	m_RescaleSlope
double	m_RescaleIntercept
std::string	m_UIDPrefix
std::string	m_StudyInstanceUID
std::string	m_SeriesInstanceUID
std::string	m_FrameOfReferenceInstanceUID
bool	m_KeepOriginalUID
bool	m_LoadPrivateTags
bool	m_ReadYBRtoRGB
unsigned int	m_GlobalNumberOfDimensions
CompressionEnum	m_CompressionType
bool	m_SingleBit
IOComponentEnum	m_InternalComponentType
InternalHeader *	m_DICOMHeader
static bool	GetLabelFromTag (const std::string &tag, std::string &labelId)
virtual ::itk::CommonEnums::IOComponent	GetInternalComponentType () const
virtual void	SetInternalComponentType (const ::itk::CommonEnums::IOComponent _arg)
bool	CanWriteFile (const char *) override
void	WriteImageInformation () override
void	Write (const void *buffer) override
virtual double	GetRescaleSlope () const
virtual double	GetRescaleIntercept () const
virtual const char *	GetUIDPrefix () const
virtual void	SetUIDPrefix (const char *_arg)
virtual const char *	GetStudyInstanceUID () const
virtual const char *	GetSeriesInstanceUID () const
virtual const char *	GetFrameOfReferenceInstanceUID () const
virtual void	SetKeepOriginalUID (bool _arg)
virtual bool	GetKeepOriginalUID () const
virtual void	KeepOriginalUIDOn ()
virtual void	KeepOriginalUIDOff ()
virtual void	SetLoadPrivateTags (bool _arg)
virtual bool	GetLoadPrivateTags () const
virtual void	LoadPrivateTagsOn ()
virtual void	LoadPrivateTagsOff ()
virtual void	SetReadYBRtoRGB (bool _arg)
virtual bool	GetReadYBRtoRGB () const
virtual void	ReadYBRtoRGBOn ()
virtual void	ReadYBRtoRGBOff ()
bool	GetValueFromTag (const std::string &tag, std::string &value)
virtual void	SetCompressionType (const CompressionEnum _arg)
virtual CompressionEnum	GetCompressionType () const
void	InternalSetCompressor (const std::string &_compressor) override
	GDCMImageIO ()
	~GDCMImageIO () override
void	PrintSelf (std::ostream &os, Indent indent) const override
void	InternalReadImageInformation ()

Additional Inherited Members
Protected Member Functions inherited from itk::ImageIOBase
	ImageIOBase ()
	~ImageIOBase () override
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
virtual bool	HasSupportedReadExtension (const char *fileName, bool ignoreCase=true)
virtual bool	HasSupportedWriteExtension (const char *fileName, bool ignoreCase=true)
virtual void	SetMaximumCompressionLevel (int)
virtual int	GetMaximumCompressionLevel () const
virtual void	Reset (const bool freeDynamic=true)
void	Resize (const unsigned int numDimensions, const unsigned int *dimensions)
virtual unsigned int	GetPixelSize () const
void	ComputeStrides ()
SizeType	GetComponentStride () const
SizeType	GetRowStride () const
SizeType	GetSliceStride () const
virtual void	OpenFileForReading (std::ifstream &inputStream, const std::string &filename, bool ascii=false)
virtual void	OpenFileForWriting (std::ofstream &outputStream, const std::string &filename, bool truncate=true, bool ascii=false)
virtual void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentEnum ctype, SizeType numComp)
virtual void	ReadBufferAsASCII (std::istream &is, void *buffer, IOComponentEnum ctype, SizeType numComp)
bool	ReadBufferAsBinary (std::istream &is, void *buffer, SizeType num)
void	AddSupportedReadExtension (const char *extension)
void	AddSupportedWriteExtension (const char *extension)
void	SetSupportedReadExtensions (const ArrayOfExtensionsType &)
void	SetSupportedWriteExtensions (const ArrayOfExtensionsType &)
virtual unsigned int	GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
virtual ImageIORegion	GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const
Protected Member Functions inherited from itk::LightProcessObject
	LightProcessObject ()
	~LightProcessObject () override
virtual void	GenerateData ()
Protected Member Functions inherited from itk::Object
	Object ()
	~Object () override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()
Protected Attributes inherited from itk::ImageIOBase
IOPixelEnum	m_PixelType { IOPixelEnum::SCALAR }
IOComponentEnum	m_ComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }
IOByteOrderEnum	m_ByteOrder { IOByteOrderEnum::OrderNotApplicable }
IOFileEnum	m_FileType { IOFileEnum::TypeNotApplicable }
bool	m_Initialized
std::string	m_FileName
unsigned int	m_NumberOfComponents
unsigned int	m_NumberOfDimensions { 0 }
bool	m_UseCompression { false }
int	m_CompressionLevel { 30 }
int	m_MaximumCompressionLevel { 100 }
std::string	m_Compressor { "uninitialized" }
bool	m_UseStreamedReading
bool	m_UseStreamedWriting
bool	m_ExpandRGBPalette
bool	m_IsReadAsScalarPlusPalette
bool	m_WritePalette
ImageIORegion	m_IORegion
std::vector< SizeValueType >	m_Dimensions
std::vector< double >	m_Spacing
std::vector< double >	m_Origin
std::vector< std::vector< double > >	m_Direction
std::vector< SizeType >	m_Strides
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

ImageIO class for reading and writing DICOM V3.0 and ACR/NEMA 1&2 uncompressed images. This class is only an adaptor to the GDCM library.

GDCM can be found at: http://sourceforge.net/projects/gdcm

To learn more about the revision shipped with ITK, call

git log – Modules/ThirdParty/GDCM/src/

from an ITK Git checkout.

The compressors supported include "JPEG2000" (default), and "JPEG". The compression level parameter is not supported.

Warning

There are several restrictions to this current writer:

• Even though during the writing process you pass in a DICOM file as input The output file may not contains ALL DICOM field from the input file. In particular:
  • The SeQuence DICOM field (SQ).
  • Fields from Private Dictionary.
• Some very long (>0xfff) binary fields are not loaded (typically 0029|0010), you need to explicitly set the maximum length of elements to load to be bigger (see Get/SetMaxSizeLoadEntry).
• In DICOM some fields are stored directly using their binary representation. When loaded into the MetaDataDictionary some fields are converted to ASCII (only VR: OB/OW/OF and UN are encoded as mime64).

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Resample DICOM Series

• Read DICOM Series and Write 3D Image

Examples

Examples/IO/DicomImageReadChangeHeaderWrite.cxx, Examples/IO/DicomImageReadPrintTags.cxx, Examples/IO/DicomImageReadWrite.cxx, Examples/IO/DicomSeriesReadGaussianImageWrite.cxx, Examples/IO/DicomSeriesReadImageWrite2.cxx, Examples/IO/DicomSeriesReadPrintTags.cxx, Examples/IO/DicomSeriesReadSeriesWrite.cxx, Examples/IO/ImageReadDicomSeriesWrite.cxx, SphinxExamples/src/IO/GDCM/ReadAndPrintDICOMTags/Code.cxx, SphinxExamples/src/IO/GDCM/ReadDICOMSeriesAndWrite3DImage/Code.cxx, and SphinxExamples/src/IO/GDCM/ResampleDICOMSeries/Code.cxx.

Definition at line 109 of file itkGDCMImageIO.h.

Member Typedef Documentation

CompressionEnum

using itk::GDCMImageIO::CompressionEnum = GDCMImageIOEnums::Compression

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 351 of file itkGDCMImageIO.h.

Pointer

using itk::GDCMImageIO::Pointer = SmartPointer<Self>

Definition at line 118 of file itkGDCMImageIO.h.

Self

using itk::GDCMImageIO::Self = GDCMImageIO

Standard class type aliases.

Definition at line 116 of file itkGDCMImageIO.h.

Superclass

using itk::GDCMImageIO::Superclass = ImageIOBase

Definition at line 117 of file itkGDCMImageIO.h.

Constructor & Destructor Documentation

GDCMImageIO()

itk::GDCMImageIO::GDCMImageIO ( )

protected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

~GDCMImageIO()

itk::GDCMImageIO::~GDCMImageIO ( )

overrideprotected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Member Function Documentation

CanReadFile()

bool itk::GDCMImageIO::CanReadFile ( const char *  )

overridevirtual

Determine the file type. Returns true if this ImageIO can read the file specified.

Implements itk::ImageIOBase.

CanWriteFile()

bool itk::GDCMImageIO::CanWriteFile ( const char *  )

overridevirtual

Determine the file type. Returns true if this ImageIO can write the file specified. GDCM triggers on ".dcm" and ".dicom".

Implements itk::ImageIOBase.

CreateAnother()

virtual::itk::LightObject::Pointer itk::GDCMImageIO::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightProcessObject.

GetCompressionType()

virtual CompressionEnum itk::GDCMImageIO::GetCompressionType ( ) const

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

GetFrameOfReferenceInstanceUID()

virtual const char* itk::GDCMImageIO::GetFrameOfReferenceInstanceUID ( ) const

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

GetInternalComponentType()

virtual ::itk::CommonEnums::IOComponent itk::GDCMImageIO::GetInternalComponentType

(

)

const

Set/Get the original component type of the image. This differs from ComponentType which may change as a function of rescale slope and intercept.

GetKeepOriginalUID()

virtual bool itk::GDCMImageIO::GetKeepOriginalUID ( ) const

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

GetLabelFromTag()

static bool itk::GDCMImageIO::GetLabelFromTag ( const std::string &  tag, std::string &  labelId  )

static

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Examples

Examples/IO/DicomImageReadPrintTags.cxx.

GetLoadPrivateTags()

virtual bool itk::GDCMImageIO::GetLoadPrivateTags ( ) const

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

GetNameOfClass()

virtual const char* itk::GDCMImageIO::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

GetReadYBRtoRGB()

virtual bool itk::GDCMImageIO::GetReadYBRtoRGB ( ) const

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

GetRescaleIntercept()

virtual double itk::GDCMImageIO::GetRescaleIntercept ( ) const

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

GetRescaleSlope()

virtual double itk::GDCMImageIO::GetRescaleSlope ( ) const

virtual

Macro to access Rescale Slope and Rescale Intercept.

GetSeriesInstanceUID()

virtual const char* itk::GDCMImageIO::GetSeriesInstanceUID ( ) const

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

GetStudyInstanceUID()

virtual const char* itk::GDCMImageIO::GetStudyInstanceUID ( ) const

virtual

Access the generated DICOM UIDs.

GetUIDPrefix()

virtual const char* itk::GDCMImageIO::GetUIDPrefix ( ) const

virtual

Macro to access the DICOM UID prefix. By default this is the ITK root id. This default can be overriden if the exam is for example part of an existing study.

GetValueFromTag()

bool itk::GDCMImageIO::GetValueFromTag	(	const std::string &	tag,
		std::string &	value
	)

More general method to retrieve an arbitrary DICOM value based on a DICOM Tag (eg "0123|45ef").

InternalReadImageInformation()

void itk::GDCMImageIO::InternalReadImageInformation ( )

protected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

InternalSetCompressor()

void itk::GDCMImageIO::InternalSetCompressor ( const std::string &  _compressor )

overridevirtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Reimplemented from itk::ImageIOBase.

KeepOriginalUIDOff()

virtual void itk::GDCMImageIO::KeepOriginalUIDOff ( )

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

KeepOriginalUIDOn()

virtual void itk::GDCMImageIO::KeepOriginalUIDOn ( )

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

LoadPrivateTagsOff()

virtual void itk::GDCMImageIO::LoadPrivateTagsOff ( )

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

LoadPrivateTagsOn()

virtual void itk::GDCMImageIO::LoadPrivateTagsOn ( )

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

New()

static Pointer itk::GDCMImageIO::New ( )

static

Method for creation through the object factory.

Examples

Examples/IO/DicomPrintPatientInformation.cxx.

PrintSelf()

void itk::GDCMImageIO::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Reimplemented from itk::ImageIOBase.

Read()

void itk::GDCMImageIO::Read ( void *  pointer )

overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

ReadImageInformation()

void itk::GDCMImageIO::ReadImageInformation ( )

overridevirtual

Read the spacing and dimension information for the current filename.

Implements itk::ImageIOBase.

ReadYBRtoRGBOff()

virtual void itk::GDCMImageIO::ReadYBRtoRGBOff ( )

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

ReadYBRtoRGBOn()

virtual void itk::GDCMImageIO::ReadYBRtoRGBOn ( )

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

SetCompressionType()

virtual void itk::GDCMImageIO::SetCompressionType ( const CompressionEnum  _arg )

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

SetInternalComponentType()

virtual void itk::GDCMImageIO::SetInternalComponentType ( const ::itk::CommonEnums::IOComponent  _arg )

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

SetKeepOriginalUID()

virtual void itk::GDCMImageIO::SetKeepOriginalUID ( bool  _arg )

virtual

Preserve the original DICOM UIDs of the input files.

SetLoadPrivateTags()

virtual void itk::GDCMImageIO::SetLoadPrivateTags ( bool  _arg )

virtual

Parse and load any private tags in the DICOM file. Loading DICOM files is faster when private tags are not needed. Default is false.

SetReadYBRtoRGB()

virtual void itk::GDCMImageIO::SetReadYBRtoRGB ( bool  _arg )

virtual

Convert Y'CbCr (YBR_FULL, YBR_FULL_422) to RGB. Default is true, not required for YBR_RCT and YBR_ICT.

SetUIDPrefix()

virtual void itk::GDCMImageIO::SetUIDPrefix ( const char *  _arg )

virtual

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Write()

void itk::GDCMImageIO::Write ( const void *  buffer )

overridevirtual

Writes the data to disk from the memory buffer provided. Make sure that the IORegion has been set properly.

Implements itk::ImageIOBase.

WriteImageInformation()

void itk::GDCMImageIO::WriteImageInformation ( )

overridevirtual

Writes the spacing and dimensions of the image. Assumes SetFileName has been called with a valid file name.

Implements itk::ImageIOBase.

Member Data Documentation

m_CompressionType

CompressionEnum itk::GDCMImageIO::m_CompressionType

private

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 431 of file itkGDCMImageIO.h.

m_DICOMHeader

InternalHeader* itk::GDCMImageIO::m_DICOMHeader

private

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 437 of file itkGDCMImageIO.h.

m_FrameOfReferenceInstanceUID

std::string itk::GDCMImageIO::m_FrameOfReferenceInstanceUID

protected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 386 of file itkGDCMImageIO.h.

m_GlobalNumberOfDimensions

unsigned int itk::GDCMImageIO::m_GlobalNumberOfDimensions

private

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 429 of file itkGDCMImageIO.h.

m_InternalComponentType

IOComponentEnum itk::GDCMImageIO::m_InternalComponentType

private

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 435 of file itkGDCMImageIO.h.

m_KeepOriginalUID

bool itk::GDCMImageIO::m_KeepOriginalUID

protected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 388 of file itkGDCMImageIO.h.

m_LoadPrivateTags

bool itk::GDCMImageIO::m_LoadPrivateTags

protected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 390 of file itkGDCMImageIO.h.

m_ReadYBRtoRGB

bool itk::GDCMImageIO::m_ReadYBRtoRGB

protected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 392 of file itkGDCMImageIO.h.

m_RescaleIntercept

double itk::GDCMImageIO::m_RescaleIntercept

protected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 378 of file itkGDCMImageIO.h.

m_RescaleSlope

double itk::GDCMImageIO::m_RescaleSlope

protected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 376 of file itkGDCMImageIO.h.

m_SeriesInstanceUID

std::string itk::GDCMImageIO::m_SeriesInstanceUID

protected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 384 of file itkGDCMImageIO.h.

m_SingleBit

bool itk::GDCMImageIO::m_SingleBit

private

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 433 of file itkGDCMImageIO.h.

m_StudyInstanceUID

std::string itk::GDCMImageIO::m_StudyInstanceUID

protected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 382 of file itkGDCMImageIO.h.

m_UIDPrefix

std::string itk::GDCMImageIO::m_UIDPrefix

protected

Method for consulting the DICOM dictionary and recovering the text description of a field using its numeric tag represented as a string. If the tagkey is not found in the dictionary then this static method return false and the value "Unknown " in the labelId. If the tagkey is found then this static method returns true and the actual string descriptor of the tagkey is returned in the variable labelId.

Definition at line 380 of file itkGDCMImageIO.h.

---

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

• itkGDCMImageIO.h