#include <igstkDICOMImageReader.h>
Public Types | |
typedef std::string | DICOMInformationType |
Type used for returning string values from the DICOM header. | |
Public Member Functions | |
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 |
Some convenient typedefs for internal ITK image. | |
typedef itk::ImageSeriesReader < ImageType > | ImageSeriesReaderType |
typedef itk::ImageFileReader < ImageType > | ImageReaderType |
Protected Member Functions | |
LoggerType * | GetLogger () 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 ImageType * | GetITKImage () const |
This method MUST be protected n order to prevent unsafe access to the ITK image level. | |
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 |
This class should not be instantiated directly, instead the derived classes that are specific to particular image modalities should be used.
"DICOM Image Reader State Machine Diagram"
Definition at line 85 of file igstkDICOMImageReader.h.
typedef std::string igstk::DICOMImageReader< TImageSpatialObject >::DICOMInformationType |
Type used for returning string values from the DICOM header.
Definition at line 113 of file igstkDICOMImageReader.h.
typedef Superclass::ImageType igstk::DICOMImageReader< TImageSpatialObject >::ImageType [protected] |
Some convenient typedefs for internal ITK image.
These types must not be exposed in the API of this class.
Reimplemented from igstk::ImageReader< TImageSpatialObject >.
Definition at line 164 of file igstkDICOMImageReader.h.
typedef itk::ImageSeriesReader< ImageType > igstk::DICOMImageReader< TImageSpatialObject >::ImageSeriesReaderType [protected] |
Definition at line 166 of file igstkDICOMImageReader.h.
typedef itk::ImageFileReader< ImageType > igstk::DICOMImageReader< TImageSpatialObject >::ImageReaderType [protected] |
Definition at line 167 of file igstkDICOMImageReader.h.
igstk::DICOMImageReader< TImageSpatialObject >::DICOMImageReader | ( | void | ) | [protected] |
igstk::DICOMImageReader< TImageSpatialObject >::~DICOMImageReader | ( | void | ) | [protected] |
void igstk::DICOMImageReader< TImageSpatialObject >::RequestReadImage | ( | ) |
This method request image read.
void igstk::DICOMImageReader< TImageSpatialObject >::RequestGetModalityInformation | ( | ) |
This function should be used to request modality info.
void igstk::DICOMImageReader< TImageSpatialObject >::RequestGetPatientNameInformation | ( | ) |
This function will be used to request patient name info.
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 119 of file igstkDICOMImageReader.h.
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 GetPatientID() in any other situation will lead to unpredictable behavior.
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.
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.
void igstk::DICOMImageReader< TImageSpatialObject >::RequestGetImage | ( | ) |
Request to get the output image as an event.
igstk::DICOMImageReader< TImageSpatialObject >::igstkLoadedTemplatedObjectEventMacro | ( | ImageModifiedEvent | , | |
IGSTKEvent | , | |||
TImageSpatialObject | ||||
) |
Event type.
LoggerType* igstk::DICOMImageReader< TImageSpatialObject >::GetLogger | ( | ) | const [protected] |
void igstk::DICOMImageReader< TImageSpatialObject >::SetLogger | ( | LoggerType * | logger | ) |
void igstk::DICOMImageReader< TImageSpatialObject >::PrintSelf | ( | std::ostream & | os, | |
itk::Indent | indent | |||
) | const [protected, virtual] |
Print the object information in a stream.
Reimplemented from igstk::Object.
Reimplemented in igstk::CTImageReader, igstk::MRImageReader, and igstk::USImageReader.
virtual const ImageType* igstk::DICOMImageReader< TImageSpatialObject >::GetITKImage | ( | ) | const [protected, virtual] |
This method MUST be protected n order to prevent unsafe access to the ITK image level.
Implements igstk::ImageReader< TImageSpatialObject >.
itk::GDCMSeriesFileNames::Pointer igstk::DICOMImageReader< TImageSpatialObject >::m_FileNames [protected] |
itk::GDCMImageIO::Pointer igstk::DICOMImageReader< TImageSpatialObject >::m_ImageIO [protected] |
Definition at line 162 of file igstkDICOMImageReader.h.
ImageSeriesReaderType::Pointer igstk::DICOMImageReader< TImageSpatialObject >::m_ImageSeriesReader [protected] |
ImageReaderType::Pointer igstk::DICOMImageReader< TImageSpatialObject >::m_ImageFileReader [protected] |
Definition at line 171 of file igstkDICOMImageReader.h.