IGSTK
|
This class reads DICOM files. More...
#include <igstkDICOMImageReader.h>
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 |
![]() | |
typedef ImageSpatialObjectType::ImageType | ImageType |
Some convenient typedefs for internal ITK image. | |
typedef ImageType::ConstPointer | ImagePointer |
typedef ImageType::RegionType | ImageRegionType |
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. | |
![]() | |
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. | |
![]() | |
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 |
![]() | |
ImageSpatialObjectType::Pointer | m_ImageSpatialObject |
Additional Inherited Members | |
![]() | |
static Pointer | New (void) |
![]() | |
igstkStandardTemplatedAbstractClassTraitsMacro (ImageReader, Object) public | |
Macro with standard traits declarations. |
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.
"DICOM Image Reader State Machine Diagram"
"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 123 of file igstkDICOMImageReader.h.
|
protected |
Definition at line 174 of file igstkDICOMImageReader.h.
|
protected |
Definition at line 176 of file igstkDICOMImageReader.h.
|
protected |
Definition at line 177 of file igstkDICOMImageReader.h.
|
protected |
|
protected |
|
inline |
Definition at line 103 of file igstkDICOMImageReader.h.
|
inline |
Definition at line 108 of file igstkDICOMImageReader.h.
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.
|
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.
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.
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.
|
protected |
Declarations needed for the Logger.
Reimplemented from igstk::Object.
void igstk::DICOMImageReader< TImageSpatialObject >::SetLogger | ( | LoggerType * | logger | ) |
Connect the Logger for this class.
Reimplemented from igstk::Object.
|
protectedvirtual |
Print the object information in a stream.
Reimplemented from igstk::Object.
Reimplemented in igstk::USImageReader, igstk::CTImageReader, igstk::MRImageReader, and igstk::PETImageReader.
|
protectedvirtual |
This method MUST be protected n order to prevent unsafe access to the ITK image level.
Implements igstk::ImageReader< TImageSpatialObject >.
|
protected |
Helper classes for the image series reader.
Definition at line 171 of file igstkDICOMImageReader.h.
|
protected |
Definition at line 172 of file igstkDICOMImageReader.h.
|
protected |
Internal itkImageSeriesReader.
Definition at line 180 of file igstkDICOMImageReader.h.
|
protected |
Definition at line 181 of file igstkDICOMImageReader.h.