Read series of image into a SimpleITK image. More...

#include <sitkImageSeriesReader.h>

Inheritance diagram for itk::simple::ImageSeriesReader:

Collaboration diagram for itk::simple::ImageSeriesReader:

Public Types
typedef ImageSeriesReader	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 ()

const std::vector< std::string > &	GetFileNames () const

virtual std::string	GetName () const

	ImageSeriesReader ()

Self &	SetFileNames (const std::vector< std::string > &fileNames)

virtual std::string	ToString () const

Public Member Functions inherited from itk::simple::ImageReaderBase
	ImageReaderBase ()

Self &	SetOutputPixelType (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 Self &	SetLoadPrivateTags (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

Static Public Member Functions
static std::vector< std::string >	GetGDCMSeriesFileNames (const std::string &directory, const std::string &seriesID="", bool useSeriesDetails=false, bool recursive=false, bool loadSequences=false)
	Generate a sequence of filenames from a directory with a DICOM data set and a series ID. More...

static std::vector< std::string >	GetGDCMSeriesIDs (const std::string &directory)
	Get all the seriesIDs from a DICOM data set. More...

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...

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< ImageIOBase >	GetImageIOBase (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::ProcessObject *	GetActiveProcess ()

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::vector< std::string >	m_FileNames

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
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::EventObject &	GetITKEventObject (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 series of image into a SimpleITK image.

See also: itk::simple::ReadImage for the procedural interface

Examples:: DicomSeriesReader/DicomSeriesReader.cxx.

Definition at line 34 of file sitkImageSeriesReader.h.

Member Typedef Documentation

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

private

Definition at line 90 of file sitkImageSeriesReader.h.

typedef ImageSeriesReader itk::simple::ImageSeriesReader::Self

Definition at line 38 of file sitkImageSeriesReader.h.

Constructor & Destructor Documentation

itk::simple::ImageSeriesReader::ImageSeriesReader ( )

Member Function Documentation

Image itk::simple::ImageSeriesReader::Execute ( )

virtual

Implements itk::simple::ImageReaderBase.

Examples:: DicomSeriesReader/DicomSeriesReader.cxx.

template<class TImageType >

Image itk::simple::ImageSeriesReader::ExecuteInternal ( itk::ImageIOBase * )

protected

const std::vector<std::string>& itk::simple::ImageSeriesReader::GetFileNames ( ) const

static std::vector<std::string> itk::simple::ImageSeriesReader::GetGDCMSeriesFileNames	(	const std::string &	directory,
		const std::string &	seriesID = `""`,
		bool	useSeriesDetails = `false`,
		bool	recursive = `false`,
		bool	loadSequences = `false`
	)

static

Generate a sequence of filenames from a directory with a DICOM data set and a series ID.

This method generates a sequence of filenames whose filenames point to DICOM files. The data set may contain multiple series. The seriesID string is used to select a specific series. The ordering of the filenames is based of one of several strategies, which will read all images in the directory ( assuming there is only one study/series ).

Parameters

directory	Set the directory that contains the DICOM data set.
recursive	Recursively parse the input directory.
seriesID	Set the name that identifies a particular series. Default value is an empty string which will return the file names associated with the first series found in the directory.
useSeriesDetails	Use additional series information such as ProtocolName and SeriesName to identify when a single SeriesUID contains multiple 3D volumes - as can occur with perfusion and DTI imaging.
loadSequences	Parse any sequences in the DICOM data set. Loading DICOM files is faster when sequences are not needed.