ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <itkNumericSeriesFileNames.h>
Public Types | |
typedef SmartPointer< Self > | Pointer |
typedef NumericSeriesFileNames | Self |
typedef Object | Superclass |
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) 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 |
Static Public Member Functions | |
static Pointer | New () |
Protected Member Functions | |
NumericSeriesFileNames () | |
void | PrintSelf (std::ostream &os, Indent indent) const |
~NumericSeriesFileNames () | |
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 |
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.
Definition at line 53 of file itkNumericSeriesFileNames.h.
typedef SmartPointer< Self > itk::NumericSeriesFileNames::Pointer |
Reimplemented from itk::Object.
Definition at line 59 of file itkNumericSeriesFileNames.h.
Standard class typedefs.
Reimplemented from itk::Object.
Definition at line 57 of file itkNumericSeriesFileNames.h.
Reimplemented from itk::Object.
Definition at line 58 of file itkNumericSeriesFileNames.h.
itk::NumericSeriesFileNames::NumericSeriesFileNames | ( | ) | [protected] |
itk::NumericSeriesFileNames::~NumericSeriesFileNames | ( | ) | [inline, protected] |
Definition at line 101 of file itkNumericSeriesFileNames.h.
itk::NumericSeriesFileNames::NumericSeriesFileNames | ( | const Self & | ) | [private] |
virtual::itk::LightObject::Pointer itk::NumericSeriesFileNames::CreateAnother | ( | void | ) | 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.
Reimplemented from itk::Object.
void itk::NumericSeriesFileNames::operator= | ( | const Self & | ) | [private] |
Mutex lock to protect modification to the reference count
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 | ( | 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.
Definition at line 109 of file itkNumericSeriesFileNames.h.
std::vector< std::string > itk::NumericSeriesFileNames::m_FileNames [private] |
Definition at line 115 of file itkNumericSeriesFileNames.h.
Definition at line 110 of file itkNumericSeriesFileNames.h.
std::string itk::NumericSeriesFileNames::m_SeriesFormat [private] |
A string for formatting the names of files in the series.
Definition at line 113 of file itkNumericSeriesFileNames.h.
Definition at line 108 of file itkNumericSeriesFileNames.h.