itk::NumericSeriesFileNames Class Reference
[Input and Output Filters]

Generate an ordered sequence of filenames. More...

#include <itkNumericSeriesFileNames.h>

Inheritance diagram for itk::NumericSeriesFileNames:

[legend]Collaboration diagram for itk::NumericSeriesFileNames:

[legend]List of all members.

Public Types
typedef NumericSeriesFileNames	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
Public Member Functions
virtual const char *	GetClassName () const
const std::vector< std::string > &	GetFileNames ()
virtual void	SetStartIndex (unsigned long _arg)
virtual unsigned long	GetStartIndex ()
virtual void	SetEndIndex (unsigned long _arg)
virtual unsigned long	GetEndIndex ()
virtual void	SetIncrementIndex (unsigned long _arg)
virtual unsigned long	GetIncrementIndex ()
virtual void	SetSeriesFormat (const char *_arg)
virtual const char *	GetSeriesFormat () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	NumericSeriesFileNames ()
	~NumericSeriesFileNames ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

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.

Definition at line 49 of file itkNumericSeriesFileNames.h.

---

Member Typedef Documentation

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

Reimplemented from itk::Object. Definition at line 55 of file itkNumericSeriesFileNames.h.

typedef NumericSeriesFileNames itk::NumericSeriesFileNames::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 53 of file itkNumericSeriesFileNames.h. Referenced by ~NumericSeriesFileNames().

typedef Object itk::NumericSeriesFileNames::Superclass

Reimplemented from itk::Object. Definition at line 54 of file itkNumericSeriesFileNames.h.

---

Constructor & Destructor Documentation

itk::NumericSeriesFileNames::NumericSeriesFileNames (   )  [protected]

itk::NumericSeriesFileNames::~NumericSeriesFileNames (   )  [inline, protected]

Definition at line 96 of file itkNumericSeriesFileNames.h. References Self.

---

Member Function Documentation

virtual const char* itk::NumericSeriesFileNames::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

virtual unsigned long itk::NumericSeriesFileNames::GetEndIndex (   )  [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 unsigned long itk::NumericSeriesFileNames::GetIncrementIndex (   )  [virtual]

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

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 unsigned long itk::NumericSeriesFileNames::GetStartIndex (   )  [virtual]

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

Pointer itk::NumericSeriesFileNames::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

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

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 (  unsigned long  _arg  )  [virtual]

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

virtual void itk::NumericSeriesFileNames::SetIncrementIndex (  unsigned long  _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 (  unsigned long  _arg  )  [virtual]

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

---

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

• itkNumericSeriesFileNames.h

---