IGSTK
Public Member Functions | List of all members
igstk::USImageReader Class Reference

This class implements a reader specific for US modality. More...

#include <igstkUSImageReader.h>

Inheritance diagram for igstk::USImageReader:
Inheritance graph
[legend]
Collaboration diagram for igstk::USImageReader:
Collaboration graph
[legend]

Public Member Functions

bool CheckModalityType (DICOMInformationType modality)
 check if the dicom data is from a "US" modality More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream. More...
 
- Public Member Functions inherited from igstk::DICOMImageReader< USImageObject >
void RequestSetProgressCallback (itk::Command *progressCallback)
 
void RequestSetAbortCallback (itk::Command *abortCallback)
 
void RequestReadImage ()
 This method request image read. More...
 
void RequestGetModalityInformation ()
 This function should be used to request modality info. More...
 
void RequestGetPatientNameInformation ()
 This function will be used to request patient name info. More...
 
bool FileSuccessfullyRead () const
 Precondition that should be invoked and verified before attempting to use the values of the methods GetPatientName(), GetPatientID() and GetModality(). More...
 
 igstkUnsafeGetMacro (PatientName, DICOMInformationType)
 Unsafe Get Macro for having access to the Patient Name. More...
 
 igstkUnsafeGetMacro (PatientID, DICOMInformationType)
 Unsafe Get Macro for having access to the Patient unique Identifier. More...
 
 igstkUnsafeGetMacro (Modality, DICOMInformationType)
 Unsafe Get Macro for having access to the image Modality. More...
 
void RequestGetImage ()
 Request to get the output image as an event. More...
 
 igstkLoadedTemplatedObjectEventMacro (ImageModifiedEvent, IGSTKEvent, USImageObject)
 Event type. More...
 
void SetLogger (LoggerType *logger)
 
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
 
void SetLogger (LoggerType *logger)
 Connect the Logger for this class. More...
 
void RemoveObserver (unsigned long tag) const
 

Additional Inherited Members

- Public Types inherited from igstk::DICOMImageReader< USImageObject >
typedef std::string DICOMInformationType
 Type used for returning string values from the DICOM header. More...
 
- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs. More...
 
typedef ::itk::Object Superclass
 
typedef ::itk::SmartPointer< SelfPointer
 
typedef ::itk::SmartPointer
< const Self
ConstPointer
 
typedef igstk::Logger LoggerType
 
- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
 
- Public Attributes inherited from igstk::ImageReader< USImageObject >
 igstkStandardTemplatedAbstractClassTraitsMacro (ImageReader, Object) public
 Macro with standard traits declarations. More...
 
- Protected Types inherited from igstk::DICOMImageReader< USImageObject >
typedef Superclass::ImageType ImageType
 
typedef itk::ImageSeriesReader
< ImageType
ImageSeriesReaderType
 
typedef itk::ImageFileReader
< ImageType
ImageReaderType
 
- Protected Types inherited from igstk::ImageReader< USImageObject >
typedef
ImageSpatialObjectType::ImageType 
ImageType
 Some convenient typedefs for internal ITK image. More...
 
typedef ImageType::ConstPointer ImagePointer
 
typedef ImageType::RegionType ImageRegionType
 
- Protected Member Functions inherited from igstk::DICOMImageReader< USImageObject >
LoggerTypeGetLogger () const
 Declarations needed for the Logger. More...
 
 DICOMImageReader (void)
 
 ~DICOMImageReader (void)
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream. More...
 
virtual const ImageTypeGetITKImage () const
 This method MUST be protected n order to prevent unsafe access to the ITK image level. More...
 
- Protected Member Functions inherited from igstk::ImageReader< USImageObject >
 ImageReader ()
 
 ~ImageReader ()
 
void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print the object information in a stream. More...
 
void ConnectImage ()
 Connect the ITK image to the output ImageSpatialObject. More...
 
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator. More...
 
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. More...
 
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects. More...
 
- Protected Attributes inherited from igstk::DICOMImageReader< USImageObject >
itk::GDCMSeriesFileNames::Pointer m_FileNames
 Helper classes for the image series reader. More...
 
itk::GDCMImageIO::Pointer m_ImageIO
 
ImageSeriesReaderType::Pointer m_ImageSeriesReader
 Internal itkImageSeriesReader. More...
 
ImageReaderType::Pointer m_ImageFileReader
 
- Protected Attributes inherited from igstk::ImageReader< USImageObject >
ImageSpatialObjectType::Pointer m_ImageSpatialObject
 

Detailed Description

This class implements a reader specific for US modality.

This class derives from the DICOMImageReader. It expects to load a volume from a set of DICOM files.

Warning
: To be fixed: It will verify that the image modality is US.

Definition at line 38 of file igstkUSImageReader.h.

Member Function Documentation

bool igstk::USImageReader::CheckModalityType ( DICOMInformationType  modality)
virtual

check if the dicom data is from a "US" modality

Reimplemented from igstk::DICOMImageReader< USImageObject >.

void igstk::USImageReader::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
virtual

Print the object information in a stream.

Reimplemented from igstk::Object.


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