SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::simple::ImageReaderBase Class Referenceabstract

An abract base class for image readers. More...

#include <sitkImageReaderBase.h>

+ Inheritance diagram for itk::simple::ImageReaderBase:
+ Collaboration diagram for itk::simple::ImageReaderBase:

Public Types

typedef ImageReaderBase Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

virtual Image Execute ()=0
 
virtual std::vector< std::string > GetRegisteredImageIOs () const
 Get a vector of the names of registered itk ImageIOs. More...
 
 ImageReaderBase ()
 
virtual std::string ToString () const
 
virtual ~ImageReaderBase ()
 
SelfSetOutputPixelType (PixelIDValueEnum pixelID)
 Set/Get The output PixelType of the image. More...
 
PixelIDValueEnum GetOutputPixelType (void) const
 Set/Get The output PixelType of the image. More...
 
virtual SelfSetLoadPrivateTags (bool loadPrivateTags)
 Set/Get loading private DICOM tags into Image's MetaData. More...
 
virtual bool GetLoadPrivateTags () const
 Set/Get loading private DICOM tags into Image's MetaData. More...
 
virtual void LoadPrivateTagsOn ()
 Set/Get loading private DICOM tags into Image's MetaData. More...
 
virtual void LoadPrivateTagsOff ()
 Set/Get loading private DICOM tags into Image's MetaData. More...
 
virtual SelfSetImageIO (const std::string &imageio)
 Set/Get name of ImageIO to use. More...
 
virtual std::string GetImageIO (void) const
 Set/Get name of ImageIO to use. More...
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual std::string GetName () const =0
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 

Protected Member Functions

unsigned int GetDimensionFromImageIO (const std::string &fileName, unsigned int i)
 
unsigned int GetDimensionFromImageIO (const itk::ImageIOBase *iobase, unsigned int i)
 
itk::SmartPointer< ImageIOBaseGetImageIOBase (const std::string &fileName)
 
void GetPixelIDFromImageIO (const std::string &fileName, PixelIDValueType &outPixelType, unsigned int &outDimensions)
 
void GetPixelIDFromImageIO (const itk::ImageIOBase *iobase, PixelIDValueType &outPixelType, unsigned int &outDimensions)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 

Private Member Functions

PixelIDValueType ExecuteInternalReadComplex (int componentType)
 
PixelIDValueType ExecuteInternalReadScalar (int componentType)
 
PixelIDValueType ExecuteInternalReadVector (int componentType)
 

Private Attributes

std::string m_ImageIOName
 
bool m_LoadPrivateTags
 
PixelIDValueEnum m_OutputPixelType
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

An abract base class for image readers.

Definition at line 39 of file sitkImageReaderBase.h.

Member Typedef Documentation

Definition at line 43 of file sitkImageReaderBase.h.

Constructor & Destructor Documentation

virtual itk::simple::ImageReaderBase::~ImageReaderBase ( )
virtual
itk::simple::ImageReaderBase::ImageReaderBase ( )

Member Function Documentation

virtual Image itk::simple::ImageReaderBase::Execute ( )
pure virtual
PixelIDValueType itk::simple::ImageReaderBase::ExecuteInternalReadComplex ( int  componentType)
private
PixelIDValueType itk::simple::ImageReaderBase::ExecuteInternalReadScalar ( int  componentType)
private
PixelIDValueType itk::simple::ImageReaderBase::ExecuteInternalReadVector ( int  componentType)
private
unsigned int itk::simple::ImageReaderBase::GetDimensionFromImageIO ( const std::string &  fileName,
unsigned int  i 
)
protected
unsigned int itk::simple::ImageReaderBase::GetDimensionFromImageIO ( const itk::ImageIOBase iobase,
unsigned int  i 
)
protected
virtual std::string itk::simple::ImageReaderBase::GetImageIO ( void  ) const
virtual

Set/Get name of ImageIO to use.

An option to override the automatically detected ImageIO used to read the image. The available ImageIOs are listed by the GetRegisteredImageIOs method. If the ImageIO can not be constructed an exception will be generated. If the ImageIO can not read the file an exception will be generated.

The default value is an empty string (""). This indicates that the ImageIO will be automatically determined by the ITK ImageIO factory mechanism.

itk::SmartPointer<ImageIOBase> itk::simple::ImageReaderBase::GetImageIOBase ( const std::string &  fileName)
protected
virtual bool itk::simple::ImageReaderBase::GetLoadPrivateTags ( ) const
virtual

Set/Get loading private DICOM tags into Image's MetaData.

Unknown private tags may be encoded with Base64 encoding.

PixelIDValueEnum itk::simple::ImageReaderBase::GetOutputPixelType ( void  ) const

Set/Get The output PixelType of the image.

By default the value is sitkUnknown, which enable the output pixel type to be same as the file. If the pixel type is specified then the itk::ConvertPixelBuffer will be used to convert the pixels.

void itk::simple::ImageReaderBase::GetPixelIDFromImageIO ( const std::string &  fileName,
PixelIDValueType outPixelType,
unsigned int &  outDimensions 
)
protected
void itk::simple::ImageReaderBase::GetPixelIDFromImageIO ( const itk::ImageIOBase iobase,
PixelIDValueType outPixelType,
unsigned int &  outDimensions 
)
protected
virtual std::vector<std::string> itk::simple::ImageReaderBase::GetRegisteredImageIOs ( ) const
virtual

Get a vector of the names of registered itk ImageIOs.

virtual void itk::simple::ImageReaderBase::LoadPrivateTagsOff ( )
virtual

Set/Get loading private DICOM tags into Image's MetaData.

Unknown private tags may be encoded with Base64 encoding.

virtual void itk::simple::ImageReaderBase::LoadPrivateTagsOn ( )
virtual

Set/Get loading private DICOM tags into Image's MetaData.

Unknown private tags may be encoded with Base64 encoding.

virtual Self& itk::simple::ImageReaderBase::SetImageIO ( const std::string &  imageio)
virtual

Set/Get name of ImageIO to use.

An option to override the automatically detected ImageIO used to read the image. The available ImageIOs are listed by the GetRegisteredImageIOs method. If the ImageIO can not be constructed an exception will be generated. If the ImageIO can not read the file an exception will be generated.

The default value is an empty string (""). This indicates that the ImageIO will be automatically determined by the ITK ImageIO factory mechanism.

virtual Self& itk::simple::ImageReaderBase::SetLoadPrivateTags ( bool  loadPrivateTags)
virtual

Set/Get loading private DICOM tags into Image's MetaData.

Unknown private tags may be encoded with Base64 encoding.

Self& itk::simple::ImageReaderBase::SetOutputPixelType ( PixelIDValueEnum  pixelID)

Set/Get The output PixelType of the image.

By default the value is sitkUnknown, which enable the output pixel type to be same as the file. If the pixel type is specified then the itk::ConvertPixelBuffer will be used to convert the pixels.

virtual std::string itk::simple::ImageReaderBase::ToString ( ) const
virtual

Member Data Documentation

std::string itk::simple::ImageReaderBase::m_ImageIOName
private

Definition at line 127 of file sitkImageReaderBase.h.

bool itk::simple::ImageReaderBase::m_LoadPrivateTags
private

Definition at line 125 of file sitkImageReaderBase.h.

PixelIDValueEnum itk::simple::ImageReaderBase::m_OutputPixelType
private

Definition at line 124 of file sitkImageReaderBase.h.


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