#include <itkNumericSeriesFileNames.h>

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

ITK Sphinx Examples:

All ITK Sphinx Examples

Create A List Of File Names

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, SphinxExamples/src/IO/GDCM/ResampleDICOMSeries/Code.cxx, and SphinxExamples/src/IO/ImageBase/Create3DFromSeriesOf2D/Code.cxx.

Definition at line 54 of file itkNumericSeriesFileNames.h.

Inheritance diagram for itk::NumericSeriesFileNames:

Collaboration diagram for itk::NumericSeriesFileNames:

Public Types
using	Pointer = SmartPointer< Self >

using	Self = NumericSeriesFileNames

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const std::vector< std::string > &	GetFileNames ()

const char *	GetNameOfClass () const override


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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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 val)

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

static Pointer	New ()

Protected Member Functions
	NumericSeriesFileNames ()

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

	~NumericSeriesFileNames () override=default

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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 Attributes
SizeValueType	m_EndIndex { 1 }

std::vector< std::string >	m_FileNames {}

SizeValueType	m_IncrementIndex { 1 }

std::string	m_SeriesFormat {}

SizeValueType	m_StartIndex { 1 }

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ Pointer

using itk::NumericSeriesFileNames::Pointer = SmartPointer<Self>

Definition at line 62 of file itkNumericSeriesFileNames.h.

◆ Self

using itk::NumericSeriesFileNames::Self = NumericSeriesFileNames

Standard class type aliases.

Definition at line 60 of file itkNumericSeriesFileNames.h.

◆ Superclass

using itk::NumericSeriesFileNames::Superclass = Object

Definition at line 61 of file itkNumericSeriesFileNames.h.

Constructor & Destructor Documentation

◆ NumericSeriesFileNames()

itk::NumericSeriesFileNames::NumericSeriesFileNames ( )

protected

◆ ~NumericSeriesFileNames()

itk::NumericSeriesFileNames::~NumericSeriesFileNames ( )

overrideprotecteddefault

Member Function Documentation

◆ GetEndIndex()

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

virtual

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

◆ GetFileNames()

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

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

◆ GetIncrementIndex()

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

virtual

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

◆ GetNameOfClass()

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetSeriesFormat()

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

◆ GetStartIndex()

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

virtual

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

◆ New()

static Pointer itk::NumericSeriesFileNames::New ( )

static

Method for creation through the object factory.

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

◆ PrintSelf()

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.

◆ SetEndIndex()

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

virtual

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

◆ SetIncrementIndex()

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

virtual

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

◆ SetSeriesFormat()

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

◆ SetStartIndex()

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.

Member Data Documentation

◆ m_EndIndex

SizeValueType itk::NumericSeriesFileNames::m_EndIndex { 1 }

private

Definition at line 111 of file itkNumericSeriesFileNames.h.

◆ m_FileNames

std::vector<std::string> itk::NumericSeriesFileNames::m_FileNames {}

private

Definition at line 117 of file itkNumericSeriesFileNames.h.

◆ m_IncrementIndex

SizeValueType itk::NumericSeriesFileNames::m_IncrementIndex { 1 }

private

Definition at line 112 of file itkNumericSeriesFileNames.h.

◆ m_SeriesFormat

std::string itk::NumericSeriesFileNames::m_SeriesFormat {}

private

A string for formatting the names of files in the series.

Definition at line 115 of file itkNumericSeriesFileNames.h.

◆ m_StartIndex

SizeValueType itk::NumericSeriesFileNames::m_StartIndex { 1 }

private

Definition at line 110 of file itkNumericSeriesFileNames.h.

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

itkNumericSeriesFileNames.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ NumericSeriesFileNames()

◆ ~NumericSeriesFileNames()

Member Function Documentation

◆ GetEndIndex()

◆ GetFileNames()

◆ GetIncrementIndex()

◆ GetNameOfClass()

◆ GetSeriesFormat()

◆ GetStartIndex()

◆ New()

◆ PrintSelf()

◆ SetEndIndex()

◆ SetIncrementIndex()

◆ SetSeriesFormat()

◆ SetStartIndex()

Member Data Documentation

◆ m_EndIndex

◆ m_FileNames

◆ m_IncrementIndex

◆ m_SeriesFormat

◆ m_StartIndex