ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
itk::GDCMImageIO Class Reference
Input and Output Filters | Module ITKIOGDCM

#include <itkGDCMImageIO.h>

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

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. Currently GDCM 2.4.6 (git SHA 1efe9e28) is used.

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

Using the CMake variable ITK_USE_SYSTEM_GDCM, it is possible to use a system installed GDCM build, instead of the one included within ITK itself.

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 explicitely 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).
Wiki 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/DICOM/DicomSeriesReadImageWrite3/Code.cxx, and WikiExamples/DICOM/ResampleDICOM.cxx.

Definition at line 73 of file itkGDCMImageIO.h.

Public Types

typedef SmartPointer< Self > Pointer
 
typedef GDCMImageIO Self
 
typedef ImageIOBase Superclass
 
- Public Types inherited from itk::ImageIOBase
typedef std::vector< std::string > ArrayOfExtensionsType
 
typedef ::itk::OffsetValueType BufferSizeType
 
enum  ByteOrder {
  BigEndian,
  LittleEndian,
  OrderNotApplicable
}
 
enum  FileType {
  ASCII,
  Binary,
  TypeNotApplicable
}
 
typedef ::itk::IndexValueType IndexValueType
 
enum  IOComponentType {
  UNKNOWNCOMPONENTTYPE,
  UCHAR,
  CHAR,
  USHORT,
  SHORT,
  UINT,
  INT,
  ULONG,
  LONG,
  FLOAT,
  DOUBLE
}
 
enum  IOPixelType {
  UNKNOWNPIXELTYPE,
  SCALAR,
  RGB,
  RGBA,
  OFFSET,
  VECTOR,
  POINT,
  COVARIANTVECTOR,
  SYMMETRICSECONDRANKTENSOR,
  DIFFUSIONTENSOR3D,
  COMPLEX,
  FIXEDARRAY,
  MATRIX
}
 
typedef SmartPointer< Self > Pointer
 
typedef ImageIOBase Self
 
typedef ::itk::intmax_t SizeType
 
typedef ::itk::SizeValueType SizeValueType
 
typedef LightProcessObject Superclass
 
- Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightObject Self
 

Public Member Functions

virtual bool CanReadFile (const char *) override
 
virtual bool CanWriteFile (const char *) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
void GetBodyPart (char *part)
 
void GetInstitution (char *ins)
 
void GetManufacturer (char *manu)
 
void GetModality (char *modality)
 
void GetModel (char *model)
 
virtual const char * GetNameOfClass () const
 
void GetNumberOfSeriesInStudy (char *series)
 
void GetNumberOfStudyRelatedSeries (char *series)
 
void GetPatientAge (char *age)
 
void GetPatientDOB (char *dob)
 
void GetPatientID (char *id)
 
void GetPatientName (char *name)
 
void GetPatientSex (char *sex)
 
void GetScanOptions (char *options)
 
void GetStudyDate (char *date)
 
void GetStudyDescription (char *desc)
 
void GetStudyID (char *id)
 
bool GetValueFromTag (const std::string &tag, std::string &value)
 
virtual void Read (void *buffer) override
 
virtual void ReadImageInformation () override
 
virtual void SetMaxSizeLoadEntry (const long)
 
virtual void Write (const void *buffer) override
 
virtual void WriteImageInformation () override
 
virtual IOComponentType GetInternalComponentType () const
 
virtual void SetInternalComponentType (const IOComponentType _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 KeepOriginalUIDOff ()
 
virtual void SetLoadPrivateTags (bool _arg)
 
virtual bool GetLoadPrivateTags () const
 
virtual void LoadPrivateTagsOn ()
 
virtual void LoadPrivateTagsOff ()
 
virtual void SetLoadSequences (const bool)
 
virtual bool GetLoadSequences () const
 
virtual void LoadSequencesOn ()
 
virtual void LoadSequencesOff ()
 
- 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 (ByteOrder) const
 
virtual unsigned int GetComponentSize () const
 
virtual IOComponentType GetComponentType () const
 
virtual const std::type_info & GetComponentTypeInfo () const
 
virtual std::vector< double > GetDefaultDirection (unsigned int i) const
 
virtual itk::SizeValueType GetDimensions (unsigned int i) const
 
virtual std::vector< double > GetDirection (unsigned int i) const
 
std::string GetFileTypeAsString (FileType) const
 
SizeType GetImageSizeInBytes () const
 
SizeType GetImageSizeInComponents () const
 
SizeType GetImageSizeInPixels () 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 IOComponentType _arg)
 
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)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const std::complex< TPixel > *)
 
template<unsigned VLength>
void SetPixelTypeInfo (const Offset< VLength > *)
 
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, unsigned int dim)
 
virtual void SetIORegion (ImageIORegion _arg)
 
virtual const ImageIORegion & GetIORegion () const
 
virtual void SetPixelType (const IOPixelType _arg)
 
virtual IOPixelType 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 UseCompressionOff ()
 
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 SetFileType (const FileType _arg)
 
virtual FileType GetFileType () const
 
void SetFileTypeToASCII ()
 
virtual void SetByteOrder (const ByteOrder _arg)
 
virtual ByteOrder 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<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const Vector< TPixel, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const VariableLengthVector< TPixel > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)
 
- 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 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 *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 void SetLoadSequencesDefault (bool)
 
static void LoadSequencesDefaultOn ()
 
static void LoadSequencesDefaultOff ()
 
static bool GetLoadSequencesDefault ()
 
static void SetLoadPrivateTagsDefault (bool)
 
static void LoadPrivateTagsDefaultOn ()
 
static void LoadPrivateTagsDefaultOff ()
 
static bool GetLoadPrivateTagsDefault ()
 
- Static Public Member Functions inherited from itk::ImageIOBase
static std::string GetComponentTypeAsString (IOComponentType)
 
static IOComponentType GetComponentTypeFromString (const std::string &typeString)
 
static std::string GetPixelTypeAsString (IOPixelType)
 
static IOPixelType 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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 GDCMImageIO ()
 
void InternalReadImageInformation ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GDCMImageIO ()
 
- 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 &os, void *buffer, IOComponentType ctype, SizeType numberOfBytesToBeRead)
 
bool ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead)
 
virtual void Reset (const bool freeDynamic=true)
 
void Resize (const unsigned int numDimensions, const unsigned int *dimensions)
 
virtual void WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite)
 
 ~ImageIOBase ()
 
- Protected Member Functions inherited from itk::LightProcessObject
virtual void GenerateData ()
 
 LightProcessObject ()
 
 ~LightProcessObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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
 
double m_RescaleIntercept
 
double m_RescaleSlope
 
std::string m_SeriesInstanceUID
 
std::string m_StudyInstanceUID
 
std::string m_UIDPrefix
 
- Protected Attributes inherited from itk::ImageIOBase
ByteOrder m_ByteOrder
 
IOComponentType m_ComponentType
 
std::vector< SizeValueType > m_Dimensions
 
std::vector< std::vector
< double > > 		m_Direction
 
std::string m_FileName
 
FileType m_FileType
 
bool m_Initialized
 
ImageIORegion m_IORegion
 
unsigned int m_NumberOfComponents
 
unsigned int m_NumberOfDimensions
 
std::vector< double > m_Origin
 
IOPixelType m_PixelType
 
std::vector< double > m_Spacing
 
std::vector< SizeType > m_Strides
 
bool m_UseCompression
 
bool m_UseStreamedReading
 
bool m_UseStreamedWriting
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

 GDCMImageIO (const Self &) ITK_DELETE_FUNCTION
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

std::string m_BodyPart
 
TCompressionType m_CompressionType
 
InternalHeader * m_DICOMHeader
 
unsigned int m_GlobalNumberOfDimensions
 
std::string m_Institution
 
ImageIOBase::IOComponentType m_InternalComponentType
 
std::string m_Manufacturer
 
std::string m_Modality
 
std::string m_Model
 
std::string m_NumberOfSeriesInStudy
 
std::string m_NumberOfStudyRelatedSeries
 
std::string m_PatientAge
 
std::string m_PatientDOB
 
std::string m_PatientID
 
std::string m_PatientName
 
std::string m_PatientSex
 
std::string m_ScanOptions
 
std::string m_StudyDate
 
std::string m_StudyDescription
 
std::string m_StudyID
 
enum  TCompressionType {
  JPEG = 0,
  JPEG2000,
  JPEGLS,
  RLE
}
 
virtual void SetCompressionType (const TCompressionType _arg)
 
virtual TCompressionType GetCompressionType () const
 

Member Typedef Documentation

typedef SmartPointer< Self > itk::GDCMImageIO::Pointer

Definition at line 79 of file itkGDCMImageIO.h.

typedef GDCMImageIO itk::GDCMImageIO::Self

Standard class typedefs.

Definition at line 77 of file itkGDCMImageIO.h.

typedef ImageIOBase itk::GDCMImageIO::Superclass

Definition at line 78 of file itkGDCMImageIO.h.

Member Enumeration Documentation

enum itk::GDCMImageIO::TCompressionType

Set/Get a compression type to use.

Enumerator
JPEG 
JPEG2000 
JPEGLS 
RLE 

Definition at line 261 of file itkGDCMImageIO.h.

Constructor & Destructor Documentation

itk::GDCMImageIO::GDCMImageIO ( )
protected
itk::GDCMImageIO::~GDCMImageIO ( )
protected
itk::GDCMImageIO::GDCMImageIO ( const Self &  )
private

Member Function Documentation

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

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

Implements itk::ImageIOBase.

virtual 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.

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.

void itk::GDCMImageIO::GetBodyPart ( char *  part)
virtual TCompressionType itk::GDCMImageIO::GetCompressionType ( ) const
virtual

Set/Get a compression type to use.

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

Access the generated DICOM UID's.

void itk::GDCMImageIO::GetInstitution ( char *  ins)
virtual IOComponentType 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.

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

Preserve the original DICOM UID of the input files

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.
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.

static bool itk::GDCMImageIO::GetLoadPrivateTagsDefault ( )
inlinestatic

Global method to define the default value for LoadPrivateTags. When instances of GDCMImageIO are created, the ivar LoadPrivateTags is initialized to the value of LoadPrivateTagsDefault. This method is useful when relying on the IO factory mechanism to load images rather than specifying a particular ImageIO object on the readers. Default is false.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 256 of file itkGDCMImageIO.h.

virtual bool itk::GDCMImageIO::GetLoadSequences ( ) const
inlinevirtual

Parse any sequences in the DICOM file. Defaults to the value of LoadSequencesDefault. Loading DICOM files is faster when sequences are not needed.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 226 of file itkGDCMImageIO.h.

static bool itk::GDCMImageIO::GetLoadSequencesDefault ( )
inlinestatic

Global method to define the default value for LoadSequences. When instances of GDCMImageIO are created, the ivar LoadSequences is initialized to the value of LoadSequencesDefault. This method is useful when relying on the IO factory mechanism to load images rather than specifying a particular ImageIO object on the readers. Default is false.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 242 of file itkGDCMImageIO.h.

void itk::GDCMImageIO::GetManufacturer ( char *  manu)
void itk::GDCMImageIO::GetModality ( char *  modality)
void itk::GDCMImageIO::GetModel ( char *  model)
virtual const char* itk::GDCMImageIO::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

void itk::GDCMImageIO::GetNumberOfSeriesInStudy ( char *  series)
void itk::GDCMImageIO::GetNumberOfStudyRelatedSeries ( char *  series)
void itk::GDCMImageIO::GetPatientAge ( char *  age)
void itk::GDCMImageIO::GetPatientDOB ( char *  dob)
void itk::GDCMImageIO::GetPatientID ( char *  id)
void itk::GDCMImageIO::GetPatientName ( char *  name)

Convenience methods to query patient information and scanner information. These methods are here for compatibility with the DICOMImageIO2 class and as such should not be used in any new code. They rely on properly preallocated buffer, which is not a good practice. Instead user are encourage to use directly the GetValueFromTag function

void itk::GDCMImageIO::GetPatientSex ( char *  sex)
virtual double itk::GDCMImageIO::GetRescaleIntercept ( ) const
virtual

Macro to access Rescale Slope and Rescale Intercept. Which are needed to rescale properly image when needed. User then need to Always check those value when access value from the DICOM header

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

Macro to access Rescale Slope and Rescale Intercept. Which are needed to rescale properly image when needed. User then need to Always check those value when access value from the DICOM header

void itk::GDCMImageIO::GetScanOptions ( char *  options)
virtual const char* itk::GDCMImageIO::GetSeriesInstanceUID ( ) const
virtual

Access the generated DICOM UID's.

void itk::GDCMImageIO::GetStudyDate ( char *  date)
void itk::GDCMImageIO::GetStudyDescription ( char *  desc)
void itk::GDCMImageIO::GetStudyID ( char *  id)
virtual const char* itk::GDCMImageIO::GetStudyInstanceUID ( ) const
virtual

Access the generated DICOM UID's.

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.

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").

void itk::GDCMImageIO::InternalReadImageInformation ( )
protected
virtual void itk::GDCMImageIO::KeepOriginalUIDOff ( )
virtual

Preserve the original DICOM UID of the input files

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

Preserve the original DICOM UID of the input files

static void itk::GDCMImageIO::LoadPrivateTagsDefaultOff ( )
inlinestatic

Global method to define the default value for LoadPrivateTags. When instances of GDCMImageIO are created, the ivar LoadPrivateTags is initialized to the value of LoadPrivateTagsDefault. This method is useful when relying on the IO factory mechanism to load images rather than specifying a particular ImageIO object on the readers. Default is false.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 255 of file itkGDCMImageIO.h.

static void itk::GDCMImageIO::LoadPrivateTagsDefaultOn ( )
inlinestatic

Global method to define the default value for LoadPrivateTags. When instances of GDCMImageIO are created, the ivar LoadPrivateTags is initialized to the value of LoadPrivateTagsDefault. This method is useful when relying on the IO factory mechanism to load images rather than specifying a particular ImageIO object on the readers. Default is false.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 254 of file itkGDCMImageIO.h.

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

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.

static void itk::GDCMImageIO::LoadSequencesDefaultOff ( )
inlinestatic

Global method to define the default value for LoadSequences. When instances of GDCMImageIO are created, the ivar LoadSequences is initialized to the value of LoadSequencesDefault. This method is useful when relying on the IO factory mechanism to load images rather than specifying a particular ImageIO object on the readers. Default is false.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 241 of file itkGDCMImageIO.h.

static void itk::GDCMImageIO::LoadSequencesDefaultOn ( )
inlinestatic

Global method to define the default value for LoadSequences. When instances of GDCMImageIO are created, the ivar LoadSequences is initialized to the value of LoadSequencesDefault. This method is useful when relying on the IO factory mechanism to load images rather than specifying a particular ImageIO object on the readers. Default is false.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 240 of file itkGDCMImageIO.h.

virtual void itk::GDCMImageIO::LoadSequencesOff ( )
inlinevirtual

Parse any sequences in the DICOM file. Defaults to the value of LoadSequencesDefault. Loading DICOM files is faster when sequences are not needed.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 228 of file itkGDCMImageIO.h.

virtual void itk::GDCMImageIO::LoadSequencesOn ( )
inlinevirtual

Parse any sequences in the DICOM file. Defaults to the value of LoadSequencesDefault. Loading DICOM files is faster when sequences are not needed.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 227 of file itkGDCMImageIO.h.

static Pointer itk::GDCMImageIO::New ( )
static

Method for creation through the object factory.

Examples:
Examples/IO/DicomPrintPatientInformation.cxx.
void itk::GDCMImageIO::operator= ( const Self &  )
private
virtual 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.

virtual void itk::GDCMImageIO::Read ( void *  buffer)
overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual void itk::GDCMImageIO::ReadImageInformation ( )
overridevirtual

Set the spacing and dimesion information for the current filename.

Implements itk::ImageIOBase.

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

Set/Get a compression type to use.

virtual void itk::GDCMImageIO::SetInternalComponentType ( const IOComponentType  _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.

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

Preserve the original DICOM UID of the input files

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.

static void itk::GDCMImageIO::SetLoadPrivateTagsDefault ( bool  )
inlinestatic

Global method to define the default value for LoadPrivateTags. When instances of GDCMImageIO are created, the ivar LoadPrivateTags is initialized to the value of LoadPrivateTagsDefault. This method is useful when relying on the IO factory mechanism to load images rather than specifying a particular ImageIO object on the readers. Default is false.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 253 of file itkGDCMImageIO.h.

virtual void itk::GDCMImageIO::SetLoadSequences ( const bool  )
inlinevirtual

Parse any sequences in the DICOM file. Defaults to the value of LoadSequencesDefault. Loading DICOM files is faster when sequences are not needed.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 225 of file itkGDCMImageIO.h.

static void itk::GDCMImageIO::SetLoadSequencesDefault ( bool  )
inlinestatic

Global method to define the default value for LoadSequences. When instances of GDCMImageIO are created, the ivar LoadSequences is initialized to the value of LoadSequencesDefault. This method is useful when relying on the IO factory mechanism to load images rather than specifying a particular ImageIO object on the readers. Default is false.

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 239 of file itkGDCMImageIO.h.

virtual void itk::GDCMImageIO::SetMaxSizeLoadEntry ( const long  )
inlinevirtual

A DICOM file can contains multiple binary stream that can be very long For example an Overlay on the image. Most of the time user do not want to load this binary structure in memory since it can consume lot of memory. Therefore any field that is bigger than the default value 0xfff is discarded and just seek'd This method allow advanced user to force the reading of such field

Warning
this is a GDCM 1.x only option, no effect on GDCM 2.x

Definition at line 218 of file itkGDCMImageIO.h.

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 overriden if the exam is for example part of an existing study.

virtual 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.

virtual 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

std::string itk::GDCMImageIO::m_BodyPart
private

Definition at line 295 of file itkGDCMImageIO.h.

TCompressionType itk::GDCMImageIO::m_CompressionType
private

Definition at line 311 of file itkGDCMImageIO.h.

InternalHeader* itk::GDCMImageIO::m_DICOMHeader
private

Definition at line 314 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_FrameOfReferenceInstanceUID
protected

Definition at line 279 of file itkGDCMImageIO.h.

unsigned int itk::GDCMImageIO::m_GlobalNumberOfDimensions
private

defines whether this image is a 2D out of a 2D image or a 2D out of a 3D image.

Definition at line 310 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_Institution
private

Definition at line 303 of file itkGDCMImageIO.h.

ImageIOBase::IOComponentType itk::GDCMImageIO::m_InternalComponentType
private

Definition at line 313 of file itkGDCMImageIO.h.

bool itk::GDCMImageIO::m_KeepOriginalUID
protected

Definition at line 281 of file itkGDCMImageIO.h.

bool itk::GDCMImageIO::m_LoadPrivateTags
protected

Definition at line 283 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_Manufacturer
private

Definition at line 302 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_Modality
private

Definition at line 301 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_Model
private

Definition at line 304 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_NumberOfSeriesInStudy
private

Definition at line 296 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_NumberOfStudyRelatedSeries
private

Definition at line 297 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_PatientAge
private

Definition at line 299 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_PatientDOB
private

Definition at line 292 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_PatientID
private

Definition at line 291 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_PatientName
private

Definition at line 290 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_PatientSex
private

Definition at line 298 of file itkGDCMImageIO.h.

double itk::GDCMImageIO::m_RescaleIntercept
protected

Definition at line 274 of file itkGDCMImageIO.h.

double itk::GDCMImageIO::m_RescaleSlope
protected

Definition at line 273 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_ScanOptions
private

Definition at line 305 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_SeriesInstanceUID
protected

Definition at line 278 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_StudyDate
private

Definition at line 300 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_StudyDescription
private

Definition at line 294 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_StudyID
private

Definition at line 293 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_StudyInstanceUID
protected

Definition at line 277 of file itkGDCMImageIO.h.

std::string itk::GDCMImageIO::m_UIDPrefix
protected

Definition at line 276 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.
Generated on Sat Jan 30 2016 05:00:09 for ITK by   doxygen 1.8.5