ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::NumericSeriesFileNames Class Reference

#include <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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
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 ()
 
SizeValueType m_StartIndex { 1 }
 
SizeValueType m_EndIndex { 1 }
 
SizeValueType m_IncrementIndex { 1 }
 
std::string m_SeriesFormat
 
std::vector< std::string > m_FileNames
 
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
 
const std::vector< std::string > & GetFileNames ()
 
 NumericSeriesFileNames ()
 
 ~NumericSeriesFileNames () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

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

Definition at line 54 of file itkNumericSeriesFileNames.h.

Member Typedef Documentation

◆ Pointer

Definition at line 62 of file itkNumericSeriesFileNames.h.

◆ Self

Standard class type aliases.

Definition at line 60 of file itkNumericSeriesFileNames.h.

◆ Superclass

Definition at line 61 of file itkNumericSeriesFileNames.h.

Constructor & Destructor Documentation

◆ NumericSeriesFileNames()

itk::NumericSeriesFileNames::NumericSeriesFileNames ( )
protected

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

◆ ~NumericSeriesFileNames()

itk::NumericSeriesFileNames::~NumericSeriesFileNames ( )
overrideprotecteddefault

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

Member Function Documentation

◆ CreateAnother()

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.

◆ GetEndIndex()

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

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

◆ 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

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

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

◆ GetSeriesFormat()

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

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

◆ GetStartIndex()

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

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

◆ New()

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

◆ PrintSelf()

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

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

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

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

Definition at line 111 of file itkNumericSeriesFileNames.h.

◆ m_FileNames

std::vector<std::string> itk::NumericSeriesFileNames::m_FileNames
private

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

Definition at line 117 of file itkNumericSeriesFileNames.h.

◆ m_IncrementIndex

SizeValueType itk::NumericSeriesFileNames::m_IncrementIndex { 1 }
private

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

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

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

Definition at line 110 of file itkNumericSeriesFileNames.h.


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