SimpleITK  1.0.1
Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Attributes | Friends | List of all members
itk::simple::ImageFileReader Class Reference

Read a 2D or 3D image and return a smart pointer to a SimpleITK image. More...

#include <sitkImageFileReader.h>

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

Public Types

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

Public Member Functions

Image Execute ()
 
std::string GetFileName () const
 
virtual std::string GetName () const
 
 ImageFileReader ()
 
SelfSetFileName (const std::string &fn)
 
virtual std::string ToString () const
 
- Public Member Functions inherited from itk::simple::ImageReaderBase
 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...
 
- 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 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

template<class TImageType >
Image ExecuteInternal (itk::ImageIOBase *)
 
- Protected Member Functions inherited from itk::simple::ImageReaderBase
unsigned int GetDimensionFromImageIO (const std::string &fileName, unsigned int i)
 
unsigned int GetDimensionFromImageIO (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 (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) throw ()
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 

Private Types

typedef Image(Self::* MemberFunctionType) (itk::ImageIOBase *)
 

Private Attributes

std::string m_FileName
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

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

Read a 2D or 3D image and return a smart pointer to a SimpleITK image.

This reader handles scalar and vector images and returns an image with the same type as the file on disk.

See also
itk::simple::ReadImage for the procedural interface
Examples:
FilterProgressReporting/FilterProgressReporting.cxx, ITKIntegration/ITKIntegration.cxx, Segmentation/ConnectedThresholdImageFilter.cxx, Segmentation/NeighborhoodConnectedImageFilter.cxx, and SimpleGaussian/SimpleGaussian.cxx.

Definition at line 38 of file sitkImageFileReader.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::ImageFileReader::MemberFunctionType) (itk::ImageIOBase *)
private

Definition at line 64 of file sitkImageFileReader.h.

Definition at line 42 of file sitkImageFileReader.h.

Constructor & Destructor Documentation

itk::simple::ImageFileReader::ImageFileReader ( )

Member Function Documentation

Image itk::simple::ImageFileReader::Execute ( )
virtual
template<class TImageType >
Image itk::simple::ImageFileReader::ExecuteInternal ( itk::ImageIOBase )
protected
std::string itk::simple::ImageFileReader::GetFileName ( ) const
virtual std::string itk::simple::ImageFileReader::GetName ( ) const
inlinevirtual

return user readable name fo the filter

Implements itk::simple::ProcessObject.

Definition at line 48 of file sitkImageFileReader.h.

Self& itk::simple::ImageFileReader::SetFileName ( const std::string &  fn)
virtual std::string itk::simple::ImageFileReader::ToString ( ) const
virtual

Print ourselves to string

Reimplemented from itk::simple::ImageReaderBase.

Friends And Related Function Documentation

Definition at line 67 of file sitkImageFileReader.h.

Member Data Documentation

std::string itk::simple::ImageFileReader::m_FileName
private

Definition at line 70 of file sitkImageFileReader.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ImageFileReader::m_MemberFactory
private

Definition at line 68 of file sitkImageFileReader.h.


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