IGSTK
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
igstk::DICOMImageReader< TImageSpatialObject > Class Template Reference

This class reads DICOM files. More...

#include <igstkDICOMImageReader.h>

Inheritance diagram for igstk::DICOMImageReader< TImageSpatialObject >:
Inheritance graph
[legend]
Collaboration diagram for igstk::DICOMImageReader< TImageSpatialObject >:
Collaboration graph
[legend]

Public Types

typedef std::string DICOMInformationType
 Type used for returning string values from the DICOM header.

Public Member Functions

void RequestSetProgressCallback (itk::Command *progressCallback)
void RequestSetAbortCallback (itk::Command *abortCallback)
void RequestReadImage ()
 This method request image read.
void RequestGetModalityInformation ()
 This function should be used to request modality info.
void RequestGetPatientNameInformation ()
 This function will be used to request patient name info.
bool FileSuccessfullyRead () const
 Precondition that should be invoked and verified before attempting to use the values of the methods GetPatientName(), GetPatientID() and GetModality().
 igstkUnsafeGetMacro (PatientName, DICOMInformationType)
 Unsafe Get Macro for having access to the Patient Name.
 igstkUnsafeGetMacro (PatientID, DICOMInformationType)
 Unsafe Get Macro for having access to the Patient unique Identifier.
 igstkUnsafeGetMacro (Modality, DICOMInformationType)
 Unsafe Get Macro for having access to the image Modality.
void RequestGetImage ()
 Request to get the output image as an event.
 igstkLoadedTemplatedObjectEventMacro (ImageModifiedEvent, IGSTKEvent, TImageSpatialObject)
 Event type.
void SetLogger (LoggerType *logger)
 Connect the Logger for this class.

Protected Types

typedef Superclass::ImageType ImageType
typedef itk::ImageSeriesReader
< ImageType
ImageSeriesReaderType
typedef itk::ImageFileReader
< ImageType
ImageReaderType
- Protected Types inherited from igstk::ImageReader< TImageSpatialObject >
typedef
ImageSpatialObjectType::ImageType 
ImageType
 Some convenient typedefs for internal ITK image.
typedef ImageType::ConstPointer ImagePointer
typedef ImageType::RegionType ImageRegionType

Protected Member Functions

LoggerTypeGetLogger () const
 Declarations needed for the Logger.
 DICOMImageReader (void)
 ~DICOMImageReader (void)
void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.
virtual const ImageTypeGetITKImage () const
 This method MUST be protected n order to prevent unsafe access to the ITK image level.
- Protected Member Functions inherited from igstk::ImageReader< TImageSpatialObject >
 ImageReader ()
 ~ImageReader ()
void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print the object information in a stream.
void ConnectImage ()
 Connect the ITK image to the output ImageSpatialObject.
- Protected Member Functions inherited from igstk::Object
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator.
virtual ~Object (void)
void RegisterObservedObject (const ::igstk::Object *object, unsigned long tag)
 Register observed objects in an internal array so that they can be disconnected upon destruction.
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects.

Protected Attributes

itk::GDCMSeriesFileNames::Pointer m_FileNames
 Helper classes for the image series reader.
itk::GDCMImageIO::Pointer m_ImageIO
ImageSeriesReaderType::Pointer m_ImageSeriesReader
 Internal itkImageSeriesReader.
ImageReaderType::Pointer m_ImageFileReader
- Protected Attributes inherited from igstk::ImageReader< TImageSpatialObject >
ImageSpatialObjectType::Pointer m_ImageSpatialObject

Additional Inherited Members

- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
- Public Attributes inherited from igstk::ImageReader< TImageSpatialObject >
 igstkStandardTemplatedAbstractClassTraitsMacro (ImageReader, Object) public
 Macro with standard traits declarations.

Detailed Description

template<class TImageSpatialObject>
class igstk::DICOMImageReader< TImageSpatialObject >

This class reads DICOM files.

This class should not be instantiated directly, instead the derived classes that are specific to particular image modalities should be used.

igstkDICOMImageReader.png

"DICOM Image Reader State Machine Diagram"

"DICOM Image Reader State Machine Diagram"

Definition at line 85 of file igstkDICOMImageReader.h.

Member Typedef Documentation

template<class TImageSpatialObject>
typedef std::string igstk::DICOMImageReader< TImageSpatialObject >::DICOMInformationType

Type used for returning string values from the DICOM header.

Definition at line 123 of file igstkDICOMImageReader.h.

template<class TImageSpatialObject>
typedef Superclass::ImageType igstk::DICOMImageReader< TImageSpatialObject >::ImageType
protected

Definition at line 174 of file igstkDICOMImageReader.h.

template<class TImageSpatialObject>
typedef itk::ImageSeriesReader< ImageType > igstk::DICOMImageReader< TImageSpatialObject >::ImageSeriesReaderType
protected

Definition at line 176 of file igstkDICOMImageReader.h.

template<class TImageSpatialObject>
typedef itk::ImageFileReader< ImageType > igstk::DICOMImageReader< TImageSpatialObject >::ImageReaderType
protected

Definition at line 177 of file igstkDICOMImageReader.h.

Constructor & Destructor Documentation

template<class TImageSpatialObject>
igstk::DICOMImageReader< TImageSpatialObject >::DICOMImageReader ( void  )
protected
template<class TImageSpatialObject>
igstk::DICOMImageReader< TImageSpatialObject >::~DICOMImageReader ( void  )
protected

Member Function Documentation

template<class TImageSpatialObject>
void igstk::DICOMImageReader< TImageSpatialObject >::RequestSetProgressCallback ( itk::Command *  progressCallback)
inline

Definition at line 103 of file igstkDICOMImageReader.h.

template<class TImageSpatialObject>
void igstk::DICOMImageReader< TImageSpatialObject >::RequestSetAbortCallback ( itk::Command *  abortCallback)
inline

Definition at line 108 of file igstkDICOMImageReader.h.

template<class TImageSpatialObject>
void igstk::DICOMImageReader< TImageSpatialObject >::RequestReadImage ( )

This method request image read.

template<class TImageSpatialObject>
void igstk::DICOMImageReader< TImageSpatialObject >::RequestGetModalityInformation ( )

This function should be used to request modality info.

template<class TImageSpatialObject>
void igstk::DICOMImageReader< TImageSpatialObject >::RequestGetPatientNameInformation ( )

This function will be used to request patient name info.

template<class TImageSpatialObject>
bool igstk::DICOMImageReader< TImageSpatialObject >::FileSuccessfullyRead ( ) const
inline

Precondition that should be invoked and verified before attempting to use the values of the methods GetPatientName(), GetPatientID() and GetModality().

Definition at line 129 of file igstkDICOMImageReader.h.

template<class TImageSpatialObject>
igstk::DICOMImageReader< TImageSpatialObject >::igstkUnsafeGetMacro ( PatientName  ,
DICOMInformationType   
)

Unsafe Get Macro for having access to the Patient Name.

This method is considered unsafe because it is not subject to the control of the internal state machine. The method GetPatientName() should only be invoked if the precondition method FileSuccessfullyRead() has already been called and it has returned true. Calling GetPatientName() in any other situation will lead to unpredictable behavior.

template<class TImageSpatialObject>
igstk::DICOMImageReader< TImageSpatialObject >::igstkUnsafeGetMacro ( PatientID  ,
DICOMInformationType   
)

Unsafe Get Macro for having access to the Patient unique Identifier.

This method is considered unsafe because it is not subject to the control of the internal state machine. The method GetPatientID() should only be invoked if the precondition method FileSuccessfullyRead() has already been called and it has returned true. Calling GetPatientID() in any other situation will lead to unpredictable behavior.

template<class TImageSpatialObject>
igstk::DICOMImageReader< TImageSpatialObject >::igstkUnsafeGetMacro ( Modality  ,
DICOMInformationType   
)

Unsafe Get Macro for having access to the image Modality.

This method is considered unsafe because it is not subject to the control of the internal state machine. The method GetModality() should only be invoked if the precondition method FileSuccessfullyRead() has already been called and it has returned true. Calling GetModality() in any other situation will lead to unpredictable behavior.

template<class TImageSpatialObject>
void igstk::DICOMImageReader< TImageSpatialObject >::RequestGetImage ( )

Request to get the output image as an event.

template<class TImageSpatialObject>
igstk::DICOMImageReader< TImageSpatialObject >::igstkLoadedTemplatedObjectEventMacro ( ImageModifiedEvent  ,
IGSTKEvent  ,
TImageSpatialObject   
)

Event type.

template<class TImageSpatialObject>
LoggerType* igstk::DICOMImageReader< TImageSpatialObject >::GetLogger ( ) const
protected

Declarations needed for the Logger.

Reimplemented from igstk::Object.

template<class TImageSpatialObject>
void igstk::DICOMImageReader< TImageSpatialObject >::SetLogger ( LoggerType logger)

Connect the Logger for this class.

Reimplemented from igstk::Object.

template<class TImageSpatialObject>
void igstk::DICOMImageReader< TImageSpatialObject >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

Print the object information in a stream.

Reimplemented from igstk::Object.

Reimplemented in igstk::USImageReader, igstk::CTImageReader, igstk::MRImageReader, and igstk::PETImageReader.

template<class TImageSpatialObject>
virtual const ImageType* igstk::DICOMImageReader< TImageSpatialObject >::GetITKImage ( ) const
protectedvirtual

This method MUST be protected n order to prevent unsafe access to the ITK image level.

Implements igstk::ImageReader< TImageSpatialObject >.

Member Data Documentation

template<class TImageSpatialObject>
itk::GDCMSeriesFileNames::Pointer igstk::DICOMImageReader< TImageSpatialObject >::m_FileNames
protected

Helper classes for the image series reader.

Definition at line 171 of file igstkDICOMImageReader.h.

template<class TImageSpatialObject>
itk::GDCMImageIO::Pointer igstk::DICOMImageReader< TImageSpatialObject >::m_ImageIO
protected

Definition at line 172 of file igstkDICOMImageReader.h.

template<class TImageSpatialObject>
ImageSeriesReaderType::Pointer igstk::DICOMImageReader< TImageSpatialObject >::m_ImageSeriesReader
protected

Internal itkImageSeriesReader.

Definition at line 180 of file igstkDICOMImageReader.h.

template<class TImageSpatialObject>
ImageReaderType::Pointer igstk::DICOMImageReader< TImageSpatialObject >::m_ImageFileReader
protected

Definition at line 181 of file igstkDICOMImageReader.h.


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