ITK
6.0.0
Insight Toolkit
|
#include <itkNumericSeriesFileNames.h>
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.
Definition at line 54 of file itkNumericSeriesFileNames.h.
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 *cmd) 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 |
const char * | GetNameOfClass () const override |
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) const |
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 Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
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 |
void | PrintSelf (std::ostream &os, Indent indent) const override |
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 | PrintSelf (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 {} |
Definition at line 62 of file itkNumericSeriesFileNames.h.
Standard class type aliases.
Definition at line 60 of file itkNumericSeriesFileNames.h.
Definition at line 61 of file itkNumericSeriesFileNames.h.
|
protected |
|
overrideprotecteddefault |
|
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 |
Set the increment of the index of the numeric series. The default value is 1.
|
overridevirtual |
Reimplemented from itk::Object.
|
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 |
Use this method to set the starting index of the numeric series. The default value is 1.
|
static |
Method for creation through the object factory.
|
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 |
Set the end index of the numeric series. The default is 1.
|
virtual |
Set the increment of the index of the numeric series. The default value is 1.
|
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 |
Use this method to set the starting index of the numeric series. The default value is 1.
|
private |
Definition at line 111 of file itkNumericSeriesFileNames.h.
|
private |
Definition at line 117 of file itkNumericSeriesFileNames.h.
|
private |
Definition at line 112 of file itkNumericSeriesFileNames.h.
|
private |
A string for formatting the names of files in the series.
Definition at line 115 of file itkNumericSeriesFileNames.h.
|
private |
Definition at line 110 of file itkNumericSeriesFileNames.h.