Writer series of image from a SimpleITK image. More...

#include <sitkImageSeriesWriter.h>

Inheritance diagram for itk::simple::ImageSeriesWriter:

Collaboration diagram for itk::simple::ImageSeriesWriter:

Public Types
typedef ImageSeriesWriter	Self

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

Public Member Functions
Self &	Execute (const Image &)

Self &	Execute (const Image &image, const std::vector< std::string > &inFileNames, bool inUseCompression)

virtual std::string	GetName () const

	ImageSeriesWriter ()

virtual std::string	ToString () const


Self &	SetUseCompression (bool UseCompression)
	Enable compression if available for file type. More...

bool	GetUseCompression (void) const
	Enable compression if available for file type. More...

Self &	UseCompressionOn (void)
	Enable compression if available for file type. More...

Self &	UseCompressionOff (void)
	Enable compression if available for file type. More...


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

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

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 >
Self &	ExecuteInternal (const Image &inImage)

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 Self &(Self::*	MemberFunctionType) (const Image &)

Private Attributes
std::vector< std::string >	m_FileNames

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

bool	m_UseCompression

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

Writer series of image from a SimpleITK image.

The ImageSeriesWriter is for writing a 3D image as a series of 2D images. A list of names for the series of 2D images must be provided, and an exception will be generated if the number of file names does not match the size of the image in the z-direction.

DICOM series cannot be written with this class, as an exception will be generated. To write a DICOM series the individual slices must be extracted, proper DICOM tags must be added to the dictionaries, then written with the ImageFileWriter.

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

Definition at line 45 of file sitkImageSeriesWriter.h.

Member Typedef Documentation

typedef Self&(Self::* itk::simple::ImageSeriesWriter::MemberFunctionType) (const Image &)

private

Definition at line 92 of file sitkImageSeriesWriter.h.

typedef ImageSeriesWriter itk::simple::ImageSeriesWriter::Self

Definition at line 49 of file sitkImageSeriesWriter.h.

Constructor & Destructor Documentation

itk::simple::ImageSeriesWriter::ImageSeriesWriter ( )

Member Function Documentation

Self& itk::simple::ImageSeriesWriter::Execute ( const Image & )

Self& itk::simple::ImageSeriesWriter::Execute	(	const Image &	image,
		const std::vector< std::string > &	inFileNames,
		bool	inUseCompression
	)

template<class TImageType >

Self& itk::simple::ImageSeriesWriter::ExecuteInternal ( const Image & inImage )

protected

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

The filenames to where the image slices are written.

The number of filenames must match the number of slices in the image.

virtual std::string itk::simple::ImageSeriesWriter::GetName ( ) const

inlinevirtual

return user readable name fo the filter

Implements itk::simple::ProcessObject.

Definition at line 57 of file sitkImageSeriesWriter.h.

bool itk::simple::ImageSeriesWriter::GetUseCompression ( void ) const

Enable compression if available for file type.

These methods Set/Get/Toggle the UseCompression flag which get's passed to image file's itk::ImageIO object. This is only a request as not all file formatts support compression.

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

The filenames to where the image slices are written.

The number of filenames must match the number of slices in the image.

Self& itk::simple::ImageSeriesWriter::SetUseCompression ( bool UseCompression )

Enable compression if available for file type.

These methods Set/Get/Toggle the UseCompression flag which get's passed to image file's itk::ImageIO object. This is only a request as not all file formatts support compression.

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

virtual

Print ourselves to string

Reimplemented from itk::simple::ProcessObject.

Self& itk::simple::ImageSeriesWriter::UseCompressionOff ( void )

inline

Enable compression if available for file type.

These methods Set/Get/Toggle the UseCompression flag which get's passed to image file's itk::ImageIO object. This is only a request as not all file formatts support compression.

Definition at line 69 of file sitkImageSeriesWriter.h.

Self& itk::simple::ImageSeriesWriter::UseCompressionOn ( void )

inline

Enable compression if available for file type.

These methods Set/Get/Toggle the UseCompression flag which get's passed to image file's itk::ImageIO object. This is only a request as not all file formatts support compression.

Definition at line 68 of file sitkImageSeriesWriter.h.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 95 of file sitkImageSeriesWriter.h.

Member Data Documentation

std::vector<std::string> itk::simple::ImageSeriesWriter::m_FileNames

private

Definition at line 99 of file sitkImageSeriesWriter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ImageSeriesWriter::m_MemberFactory

private

Definition at line 96 of file sitkImageSeriesWriter.h.

bool itk::simple::ImageSeriesWriter::m_UseCompression

private

Definition at line 98 of file sitkImageSeriesWriter.h.

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

sitkImageSeriesWriter.h

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation