ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members

#include <itkDCMTKImageIO.h>

Detailed Description

Read DICOM image file format.

Definition at line 71 of file itkDCMTKImageIO.h.

+ Inheritance diagram for itk::DCMTKImageIO:
+ Collaboration diagram for itk::DCMTKImageIO:

Public Types

using LogLevelEnum = DCMTKImageIOEnums::LogLevel
 
using Pointer = SmartPointer< Self >
 
using Self = DCMTKImageIO
 
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
 
 DCMTKImageIO ()
 
LogLevelEnum GetLogLevel () const
 
 itkOverrideGetNameOfClassMacro (DCMTKImageIO)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void Read (void *buffer) override
 
void ReadImageInformation () override
 
void SetDicomImagePointer (DicomImage *UserProvided)
 
void SetLogLevel (LogLevelEnum level)
 
void Write (const void *buffer) override
 
void WriteImageInformation () override
 
 ~DCMTKImageIO () override
 
- 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 ArrayOfExtensionsTypeGetSupportedReadExtensions () const
 
const ArrayOfExtensionsTypeGetSupportedWriteExtensions () const
 
 itkOverrideGetNameOfClassMacro (ImageIOBase)
 
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 ImageIORegionGetIORegion () 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
 
 itkOverrideGetNameOfClassMacro (LightProcessObject)
 
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
 
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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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 ()
 

Private Member Functions

void OpenDicomImage ()
 
void ReorderRGBValues (void *buffer, const void *data, vcl_size_t count, unsigned int voxel_size)
 
template<typename T >
void ReorderRGBValues (void *buffer, const void *data, vcl_size_t count, unsigned int voxel_size)
 

Private Attributes

bool m_DicomImageSetByUser {}
 
DicomImage * m_DImage {}
 
std::string m_LastFileName {}
 
double m_RescaleIntercept {}
 
double m_RescaleSlope {}
 
bool m_UseJPEGCodec {}
 
bool m_UseJPLSCodec {}
 
bool m_UseRLECodec {}
 

Additional Inherited Members

- 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 ImageRegionSplitterBaseGetImageRegionSplitter () 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 InternalSetCompressor (const std::string &_compressor)
 
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 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< SizeValueTypem_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< SizeTypem_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 {}
 

Member Typedef Documentation

◆ LogLevelEnum

Definition at line 87 of file itkDCMTKImageIO.h.

◆ Pointer

Definition at line 79 of file itkDCMTKImageIO.h.

◆ Self

Standard class type aliases.

Definition at line 77 of file itkDCMTKImageIO.h.

◆ Superclass

Definition at line 78 of file itkDCMTKImageIO.h.

Constructor & Destructor Documentation

◆ DCMTKImageIO()

itk::DCMTKImageIO::DCMTKImageIO ( )

◆ ~DCMTKImageIO()

itk::DCMTKImageIO::~DCMTKImageIO ( )
override

Member Function Documentation

◆ CanReadFile()

bool itk::DCMTKImageIO::CanReadFile ( const char *  )
overridevirtual

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

Implements itk::ImageIOBase.

◆ CanWriteFile()

bool itk::DCMTKImageIO::CanWriteFile ( const char *  )
overridevirtual

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

Implements itk::ImageIOBase.

◆ GetLogLevel()

LogLevelEnum itk::DCMTKImageIO::GetLogLevel ( ) const

Get the DCMTK Message Logging Level

◆ itkOverrideGetNameOfClassMacro()

itk::DCMTKImageIO::itkOverrideGetNameOfClassMacro ( DCMTKImageIO  )

Run-time type information (and related methods).

◆ New()

static Pointer itk::DCMTKImageIO::New ( )
static

Method for creation through the object factory.

◆ OpenDicomImage()

void itk::DCMTKImageIO::OpenDicomImage ( )
private

◆ PrintSelf()

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

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::DCMTKImageIO::Read ( void *  buffer)
overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

◆ ReadImageInformation()

void itk::DCMTKImageIO::ReadImageInformation ( )
overridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

◆ ReorderRGBValues() [1/2]

void itk::DCMTKImageIO::ReorderRGBValues ( void *  buffer,
const void *  data,
vcl_size_t  count,
unsigned int  voxel_size 
)
private

Finds the correct type to call the templated function ReorderRGBValues(...)

◆ ReorderRGBValues() [2/2]

template<typename T >
void itk::DCMTKImageIO::ReorderRGBValues ( void *  buffer,
const void *  data,
vcl_size_t  count,
unsigned int  voxel_size 
)
inlineprivate

Reorders RGB values in an image from color-by-plane (R1R2R3...G1G2G3...B1B2B3...) to color-by-pixel (R1G1B1...R2G2B2...R3G3B3...). voxel_size specifies the pixel size: It should be 3 for RGB images, and 4 for RGBA images. The code in this function is based on code available in DCMTK dcmimage/include/dcmtk/dcmimage/dicoopxt.h in the Convert(...) function.

Definition at line 166 of file itkDCMTKImageIO.h.

◆ SetDicomImagePointer()

void itk::DCMTKImageIO::SetDicomImagePointer ( DicomImage *  UserProvided)
inline

Definition at line 101 of file itkDCMTKImageIO.h.

◆ SetLogLevel()

void itk::DCMTKImageIO::SetLogLevel ( LogLevelEnum  level)

Set the DCMTK Message Logging Level

◆ Write()

void itk::DCMTKImageIO::Write ( const void *  buffer)
overridevirtual

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

Implements itk::ImageIOBase.

◆ WriteImageInformation()

void itk::DCMTKImageIO::WriteImageInformation ( )
overridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

Member Data Documentation

◆ m_DicomImageSetByUser

bool itk::DCMTKImageIO::m_DicomImageSetByUser {}
private

Definition at line 187 of file itkDCMTKImageIO.h.

◆ m_DImage

DicomImage* itk::DCMTKImageIO::m_DImage {}
private

Definition at line 185 of file itkDCMTKImageIO.h.

◆ m_LastFileName

std::string itk::DCMTKImageIO::m_LastFileName {}
private

Definition at line 191 of file itkDCMTKImageIO.h.

◆ m_RescaleIntercept

double itk::DCMTKImageIO::m_RescaleIntercept {}
private

Definition at line 190 of file itkDCMTKImageIO.h.

◆ m_RescaleSlope

double itk::DCMTKImageIO::m_RescaleSlope {}
private

Definition at line 189 of file itkDCMTKImageIO.h.

◆ m_UseJPEGCodec

bool itk::DCMTKImageIO::m_UseJPEGCodec {}
private

Definition at line 181 of file itkDCMTKImageIO.h.

◆ m_UseJPLSCodec

bool itk::DCMTKImageIO::m_UseJPLSCodec {}
private

Definition at line 182 of file itkDCMTKImageIO.h.

◆ m_UseRLECodec

bool itk::DCMTKImageIO::m_UseRLECodec {}
private

Definition at line 183 of file itkDCMTKImageIO.h.


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