ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
itk::GDCMImageIO Class Reference
Data Processing Objects » Filters » Input and Output FiltersGroup IO » | Module ITKIOGDCM

#include <itkGDCMImageIO.h>

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: https://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:
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 108 of file itkGDCMImageIO.h.

+ Inheritance diagram for itk::GDCMImageIO:
+ Collaboration diagram for itk::GDCMImageIO:

Public Types

using CompressionEnum = GDCMImageIOEnums::Compression
 
using Pointer = SmartPointer< Self >
 
using Self = GDCMImageIO
 
using Superclass = ImageIOBase
 
- Public Types inherited from itk::ImageIOBase
using ArrayOfExtensionsType = std::vector< std::string >
 
using BufferSizeType = itk::OffsetValueType
 
using ConstPointer = SmartPointer< const Self >
 
using IndexValueType = itk::IndexValueType
 
using IOByteOrderEnum = itk::IOByteOrderEnum
 
using IOComponentEnum = itk::IOComponentEnum
 
using IOFileEnum = itk::IOFileEnum
 
using Pointer = SmartPointer< Self >
 
using Self = ImageIOBase
 
using SizeType = itk::intmax_t
 
using SizeValueType = itk::SizeValueType
 
using Superclass = LightProcessObject
 
- 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
 
bool CanWriteFile (const char *) override
 
virtual CompressionEnum GetCompressionType () const
 
const char * GetNameOfClass () const override
 
bool GetValueFromTag (const std::string &tag, std::string &value)
 
void InternalSetCompressor (const std::string &_compressor) override
 
void Read (void *pointer) override
 
void ReadImageInformation () override
 
virtual void SetCompressionType (const CompressionEnum _arg)
 
void Write (const void *buffer) override
 
void WriteImageInformation () override
 
virtual itk::CommonEnums::IOComponent GetInternalComponentType () const
 
virtual void SetInternalComponentType (const itk::CommonEnums::IOComponent _arg)
 
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 SetLoadPrivateTags (bool _arg)
 
virtual bool GetLoadPrivateTags () const
 
virtual void LoadPrivateTagsOn ()
 
virtual void SetReadYBRtoRGB (bool _arg)
 
virtual bool GetReadYBRtoRGB () const
 
virtual void ReadYBRtoRGBOn ()
 
- Public Member Functions inherited from itk::ImageIOBase
virtual bool CanStreamRead ()
 
virtual bool CanStreamWrite ()
 
virtual ImageIORegion GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const
 
virtual unsigned int GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
std::string GetByteOrderAsString (IOByteOrderEnum) const
 
virtual unsigned int GetComponentSize () const
 
virtual IOComponentEnum GetComponentType () const
 
virtual const std::type_info & GetComponentTypeInfo () const
 
virtual int GetCompressionLevel () const
 
virtual const std::string & GetCompressor () const
 
virtual std::vector< double > GetDefaultDirection (unsigned int k) const
 
virtual SizeValueType GetDimensions (unsigned int i) const
 
virtual std::vector< double > GetDirection (unsigned int i) const
 
std::string GetFileTypeAsString (IOFileEnum) const
 
SizeType GetImageSizeInBytes () const
 
SizeType GetImageSizeInComponents () const
 
SizeType GetImageSizeInPixels () const
 
virtual bool GetIsReadAsScalarPlusPalette () const
 
virtual unsigned int GetNumberOfDimensions () const
 
virtual double GetOrigin (unsigned int i) const
 
virtual SizeType GetPixelStride () const
 
virtual double GetSpacing (unsigned int i) const
 
virtual ImageIORegion GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
const ArrayOfExtensionsType & GetSupportedReadExtensions () const
 
const ArrayOfExtensionsType & GetSupportedWriteExtensions () const
 
void SetByteOrderToLittleEndian ()
 
virtual void SetComponentType (const IOComponentEnum _arg)
 
virtual void SetCompressionLevel (int _arg)
 
virtual void SetCompressor (std::string _c)
 
virtual void SetDirection (unsigned int i, const std::vector< double > &direction)
 
virtual void SetDirection (unsigned int i, const vnl_vector< double > &direction)
 
void SetFileTypeToBinary ()
 
void SetNumberOfDimensions (unsigned int)
 
virtual void SetOrigin (unsigned int i, double origin)
 
virtual void SetSpacing (unsigned int i, double spacing)
 
template<typename TPixel >
void SetTypeInfo (const TPixel *)
 
virtual bool SupportsDimension (unsigned long dim)
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
virtual void SetDimensions (unsigned int i, SizeValueType dim)
 
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 SetNumberOfComponents (unsigned int _arg)
 
virtual const unsigned int & GetNumberOfComponents () const
 
virtual void SetUseCompression (bool _arg)
 
virtual bool GetUseCompression () const
 
virtual void UseCompressionOn ()
 
virtual void SetUseStreamedReading (bool _arg)
 
virtual bool GetUseStreamedReading () const
 
virtual void UseStreamedReadingOn ()
 
virtual void SetUseStreamedWriting (bool _arg)
 
virtual bool GetUseStreamedWriting () const
 
virtual void UseStreamedWritingOn ()
 
virtual void SetExpandRGBPalette (bool _arg)
 
virtual bool GetExpandRGBPalette () const
 
virtual void ExpandRGBPaletteOn ()
 
virtual void SetWritePalette (bool _arg)
 
virtual bool GetWritePalette () const
 
virtual void WritePaletteOn ()
 
virtual void SetFileType (const IOFileEnum _arg)
 
virtual IOFileEnum GetFileType () const
 
void SetFileTypeToASCII ()
 
virtual void SetByteOrder (const IOByteOrderEnum _arg)
 
virtual IOByteOrderEnum GetByteOrder () const
 
void SetByteOrderToBigEndian ()
 
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 int VLength>
void SetPixelTypeInfo (const Offset< VLength > *)
 
template<typename TPixel , unsigned int VLength>
void SetPixelTypeInfo (const Vector< TPixel, VLength > *)
 
template<typename TCoordRep , unsigned int VPointDimension>
void SetPixelTypeInfo (const Point< TCoordRep, VPointDimension > *)
 
template<typename TPixel , unsigned int VLength>
void SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)
 
template<typename TPixel , unsigned int 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 int 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 int 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 AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void UpdateOutputData ()
 
void UpdateProgress (float amount)
 
virtual void SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
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) const
 
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 bool GetLabelFromTag (const std::string &tag, std::string &labelId)
 
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 ()
 

Protected Member Functions

 GDCMImageIO ()
 
void InternalReadImageInformation ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GDCMImageIO () override
 
- Protected Member Functions inherited from itk::ImageIOBase
void AddSupportedReadExtension (const char *extension)
 
void AddSupportedWriteExtension (const char *extension)
 
void ComputeStrides ()
 
virtual unsigned int GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
 
SizeType GetComponentStride () const
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () const
 
virtual unsigned int GetPixelSize () const
 
SizeType GetRowStride () const
 
SizeType GetSliceStride () const
 
virtual ImageIORegion GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const
 
 ImageIOBase ()
 
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 ReadBufferAsASCII (std::istream &is, void *buffer, IOComponentEnum ctype, SizeType numComp)
 
bool ReadBufferAsBinary (std::istream &is, void *buffer, SizeType num)
 
virtual void Reset (const bool freeDynamic=true)
 
void Resize (const unsigned int numDimensions, const unsigned int *dimensions)
 
void SetSupportedReadExtensions (const ArrayOfExtensionsType &)
 
void SetSupportedWriteExtensions (const ArrayOfExtensionsType &)
 
virtual void WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentEnum ctype, SizeType numComp)
 
 ~ImageIOBase () override
 
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
 
- Protected Member Functions inherited from itk::LightProcessObject
virtual void GenerateData ()
 
 LightProcessObject ()
 
 ~LightProcessObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- 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

std::string m_FrameOfReferenceInstanceUID {}
 
bool m_KeepOriginalUID {}
 
bool m_LoadPrivateTags {}
 
bool m_ReadYBRtoRGB {}
 
double m_RescaleIntercept {}
 
double m_RescaleSlope {}
 
std::string m_SeriesInstanceUID {}
 
std::string m_StudyInstanceUID {}
 
std::string m_UIDPrefix {}
 
- Protected Attributes inherited from itk::ImageIOBase
IOByteOrderEnum m_ByteOrder { IOByteOrderEnum::OrderNotApplicable }
 
IOComponentEnum m_ComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }
 
int m_CompressionLevel { 30 }
 
std::string m_Compressor { "uninitialized" }
 
std::vector< SizeValueType > m_Dimensions {}
 
std::vector< std::vector< double > > m_Direction {}
 
bool m_ExpandRGBPalette {}
 
std::string m_FileName {}
 
IOFileEnum m_FileType { IOFileEnum::TypeNotApplicable }
 
bool m_Initialized {}
 
ImageIORegion m_IORegion {}
 
bool m_IsReadAsScalarPlusPalette {}
 
int m_MaximumCompressionLevel { 100 }
 
unsigned int m_NumberOfComponents {}
 
unsigned int m_NumberOfDimensions { 0 }
 
std::vector< double > m_Origin {}
 
IOPixelEnum m_PixelType { IOPixelEnum::SCALAR }
 
std::vector< double > m_Spacing {}
 
std::vector< SizeType > m_Strides {}
 
bool m_UseCompression { false }
 
bool m_UseStreamedReading {}
 
bool m_UseStreamedWriting {}
 
bool m_WritePalette {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Private Attributes

CompressionEnum m_CompressionType {}
 
InternalHeader * m_DICOMHeader {}
 
unsigned int m_GlobalNumberOfDimensions {}
 
IOComponentEnum m_InternalComponentType {}
 
bool m_SingleBit {}
 

Member Typedef Documentation

◆ CompressionEnum

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

Definition at line 350 of file itkGDCMImageIO.h.

◆ Pointer

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

Definition at line 117 of file itkGDCMImageIO.h.

◆ Self

using itk::GDCMImageIO::Self = GDCMImageIO

Standard class type aliases.

Definition at line 115 of file itkGDCMImageIO.h.

◆ Superclass

using itk::GDCMImageIO::Superclass = ImageIOBase

Definition at line 116 of file itkGDCMImageIO.h.

Constructor & Destructor Documentation

◆ GDCMImageIO()

itk::GDCMImageIO::GDCMImageIO ( )
protected

◆ ~GDCMImageIO()

itk::GDCMImageIO::~GDCMImageIO ( )
overrideprotected

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.

◆ GetCompressionType()

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

◆ GetFrameOfReferenceInstanceUID()

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

Access the generated DICOM UIDs.

◆ GetInternalComponentType()

virtual itk::CommonEnums::IOComponent itk::GDCMImageIO::GetInternalComponentType ( ) const
virtual

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

Preserve the original DICOM UIDs of the input files.

◆ 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

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

◆ GetNameOfClass()

const char* itk::GDCMImageIO::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ImageIOBase.

◆ GetReadYBRtoRGB()

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

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

◆ GetRescaleIntercept()

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

Macro to access Rescale Slope and Rescale Intercept.

◆ 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

Access the generated DICOM UIDs.

◆ 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 overridden 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

◆ InternalSetCompressor()

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

Called when the compressor changes value. The compressor string is converted to uppercase for case insensitive comparisons.

Reimplemented from itk::ImageIOBase.

◆ KeepOriginalUIDOn()

virtual void itk::GDCMImageIO::KeepOriginalUIDOn ( )
virtual

Preserve the original DICOM UIDs of the input files.

◆ LoadPrivateTagsOn()

virtual void itk::GDCMImageIO::LoadPrivateTagsOn ( )
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.

◆ 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

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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.

◆ ReadYBRtoRGBOn()

virtual void itk::GDCMImageIO::ReadYBRtoRGBOn ( )
virtual

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

◆ SetCompressionType()

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

◆ SetInternalComponentType()

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

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

◆ 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

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

◆ 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

Definition at line 430 of file itkGDCMImageIO.h.

◆ m_DICOMHeader

InternalHeader* itk::GDCMImageIO::m_DICOMHeader {}
private

Definition at line 436 of file itkGDCMImageIO.h.

◆ m_FrameOfReferenceInstanceUID

std::string itk::GDCMImageIO::m_FrameOfReferenceInstanceUID {}
protected

Definition at line 385 of file itkGDCMImageIO.h.

◆ m_GlobalNumberOfDimensions

unsigned int itk::GDCMImageIO::m_GlobalNumberOfDimensions {}
private

Definition at line 428 of file itkGDCMImageIO.h.

◆ m_InternalComponentType

IOComponentEnum itk::GDCMImageIO::m_InternalComponentType {}
private

Definition at line 434 of file itkGDCMImageIO.h.

◆ m_KeepOriginalUID

bool itk::GDCMImageIO::m_KeepOriginalUID {}
protected

Definition at line 387 of file itkGDCMImageIO.h.

◆ m_LoadPrivateTags

bool itk::GDCMImageIO::m_LoadPrivateTags {}
protected

Definition at line 389 of file itkGDCMImageIO.h.

◆ m_ReadYBRtoRGB

bool itk::GDCMImageIO::m_ReadYBRtoRGB {}
protected

Definition at line 391 of file itkGDCMImageIO.h.

◆ m_RescaleIntercept

double itk::GDCMImageIO::m_RescaleIntercept {}
protected

Definition at line 377 of file itkGDCMImageIO.h.

◆ m_RescaleSlope

double itk::GDCMImageIO::m_RescaleSlope {}
protected

Definition at line 375 of file itkGDCMImageIO.h.

◆ m_SeriesInstanceUID

std::string itk::GDCMImageIO::m_SeriesInstanceUID {}
protected

Definition at line 383 of file itkGDCMImageIO.h.

◆ m_SingleBit

bool itk::GDCMImageIO::m_SingleBit {}
private

Definition at line 432 of file itkGDCMImageIO.h.

◆ m_StudyInstanceUID

std::string itk::GDCMImageIO::m_StudyInstanceUID {}
protected

Definition at line 381 of file itkGDCMImageIO.h.

◆ m_UIDPrefix

std::string itk::GDCMImageIO::m_UIDPrefix {}
protected

Definition at line 379 of file itkGDCMImageIO.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16