#include <itkNumericSeriesFileNames.h>

Inheritance diagram for itk::NumericSeriesFileNames:

Collaboration diagram for itk::NumericSeriesFileNames:

Detailed Description

Generate an ordered sequence of filenames.

This class generate an ordered sequence of files whose filenames contain a single unique, non-negative, integral value (e.g. test.1.png, test2.png, foo.3, etc.).

The file name is created from a sprintf-style series format which should contain an integer format string like "%d". Bad formats will cause the series reader to throw an exception.

Warning: returned filenames (which may be full or relative paths) are not checked against any system-imposed path-length limit, because of difficulties finding a portable method to do so.

Wiki Examples:

Examples:: Examples/IO/ImageReadDicomSeriesWrite.cxx, Examples/IO/ImageReadImageSeriesWrite.cxx, Examples/IO/ImageSeriesReadWrite.cxx, Examples/IO/RGBImageSeriesReadWrite.cxx, Examples/IO/VisibleHumanStreamReadWrite.cxx, SphinxExamples/src/Core/Common/ReRunPipelineWithChangingLargestPossibleRegion/Code.cxx, WikiExamples/DICOM/ResampleDICOM.cxx, and WikiExamples/IO/VolumeFromSlices.cxx.

Definition at line 54 of file itkNumericSeriesFileNames.h.

Public Types
typedef SmartPointer< Self >	Pointer

typedef NumericSeriesFileNames	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

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

virtual const char *	GetNameOfClass () const


virtual void	SetStartIndex (SizeValueType _arg)

virtual SizeValueType	GetStartIndex () const


virtual void	SetEndIndex (SizeValueType _arg)

virtual SizeValueType	GetEndIndex () const


virtual void	SetIncrementIndex (SizeValueType _arg)

virtual SizeValueType	GetIncrementIndex () const


virtual void	SetSeriesFormat (const char *_arg)

virtual const char *	GetSeriesFormat () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	NumericSeriesFileNames ()

virtual void	PrintSelf (std::ostream &os, Indent indent) const override

	~NumericSeriesFileNames ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
	NumericSeriesFileNames (const Self &)

void	operator= (const Self &)

Private Attributes
SizeValueType	m_EndIndex

std::vector< std::string >	m_FileNames

SizeValueType	m_IncrementIndex

std::string	m_SeriesFormat

SizeValueType	m_StartIndex

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

typedef SmartPointer< Self > itk::NumericSeriesFileNames::Pointer

Definition at line 60 of file itkNumericSeriesFileNames.h.

typedef NumericSeriesFileNames itk::NumericSeriesFileNames::Self

Standard class typedefs.

Definition at line 58 of file itkNumericSeriesFileNames.h.

typedef Object itk::NumericSeriesFileNames::Superclass

Definition at line 59 of file itkNumericSeriesFileNames.h.

Constructor & Destructor Documentation

itk::NumericSeriesFileNames::NumericSeriesFileNames ( )

protected

itk::NumericSeriesFileNames::~NumericSeriesFileNames ( )

inlineprotected

Definition at line 102 of file itkNumericSeriesFileNames.h.

itk::NumericSeriesFileNames::NumericSeriesFileNames ( const Self & )

private

Member Function Documentation

virtual::itk::LightObject::Pointer itk::NumericSeriesFileNames::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

virtual SizeValueType itk::NumericSeriesFileNames::GetEndIndex ( ) const

virtual

Set the end index of the numeric series. The default is 1.

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

Returns a vector containing the series' file names. The file names are ordered by Index.

virtual SizeValueType itk::NumericSeriesFileNames::GetIncrementIndex ( ) const

virtual

Set the increment of the index of the numeric series. The default value is 1.

virtual const char* itk::NumericSeriesFileNames::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

virtual const char* itk::NumericSeriesFileNames::GetSeriesFormat ( ) const

virtual

The format string used to generate the series. Different subclasses require different characteristics of this string. For example, the subclass NumericSeriesFileNames requires a "%d" or some integral format specified to be embedded in the string. Default is "%d".

virtual SizeValueType itk::NumericSeriesFileNames::GetStartIndex ( ) const

virtual

Use this method to set the starting index of the numeric series. The default value is 1.

static Pointer itk::NumericSeriesFileNames::New ( )

static

Method for creation through the object factory.

Examples:: Examples/Segmentation/GeodesicActiveContourShapePriorLevelSetImageFilter.cxx, SphinxExamples/src/IO/ImageBase/CreateAListOfFileNames/Code.cxx, and SphinxExamples/src/IO/ImageBase/GenerateSlicesFromVolume/Code.cxx.

void itk::NumericSeriesFileNames::operator= ( const Self & )

private

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

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

virtual void itk::NumericSeriesFileNames::SetEndIndex ( SizeValueType _arg )

virtual

Set the end index of the numeric series. The default is 1.

virtual void itk::NumericSeriesFileNames::SetIncrementIndex ( SizeValueType _arg )

virtual

Set the increment of the index of the numeric series. The default value is 1.

virtual void itk::NumericSeriesFileNames::SetSeriesFormat ( const char * _arg )

virtual

The format string used to generate the series. Different subclasses require different characteristics of this string. For example, the subclass NumericSeriesFileNames requires a "%d" or some integral format specified to be embedded in the string. Default is "%d".

virtual void itk::NumericSeriesFileNames::SetStartIndex ( SizeValueType _arg )

virtual

Use this method to set the starting index of the numeric series. The default value is 1.