ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::RegularExpressionSeriesFileNames Class Reference
Data Processing Objects » Filters » Input and Output FiltersGroup IO » | Module ITKIOImageBase

#include <itkRegularExpressionSeriesFileNames.h>

Detailed Description

Generate an ordered sequence of filenames that match a regular expression.

This class generates an ordered sequence of files whose filenames match a regular expression. The file names are sorted using a sub expression match selected by SubMatch. Regular expressions are a powerful, compact mechanism for parsing strings. Expressions consist of the following metacharacters:

^ Matches at beginning of a line

$ Matches at end of a line

. Matches any single character

[ ] Matches any character(s) inside the brackets

[^ ] Matches any character(s) not inside the brackets

? Matches preceding pattern zero or once only

() Saves a matched expression and uses it in a later match

Note that more than one of these metacharacters can be used in a single regular expression in order to create complex search patterns. For example, the pattern [^ab1-9] says to match any character sequence that does not begin with the characters "ab" followed by numbers in the series one through nine.

Examples
Examples/IO/ImageSeriesReadWrite2.cxx.

Definition at line 71 of file itkRegularExpressionSeriesFileNames.h.

+ Inheritance diagram for itk::RegularExpressionSeriesFileNames:
+ Collaboration diagram for itk::RegularExpressionSeriesFileNames:

Public Types

using Pointer = SmartPointer< Self >
 
using Self = RegularExpressionSeriesFileNames
 
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 SetDirectory (const char *_arg)
 
virtual const char * GetDirectory () const
 
virtual void SetRegularExpression (const char *_arg)
 
virtual const char * GetRegularExpression () const
 
virtual void SetSubMatch (unsigned int _arg)
 
virtual unsigned int GetSubMatch () const
 
virtual void SetNumericSort (bool _arg)
 
virtual bool GetNumericSort () const
 
virtual void NumericSortOn ()
 
- 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
 
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 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

void PrintSelf (std::ostream &os, Indent indent) const override
 
 RegularExpressionSeriesFileNames ()
 
 ~RegularExpressionSeriesFileNames () 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

std::string m_Directory {}
 
std::vector< std::string > m_FileNames {}
 
bool m_NumericSort { false }
 
std::string m_RegularExpression {}
 
unsigned int m_SubMatch { 1 }
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ Pointer

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

Definition at line 79 of file itkRegularExpressionSeriesFileNames.h.

◆ Self

using itk::RegularExpressionSeriesFileNames::Self = RegularExpressionSeriesFileNames

Standard class type aliases.

Definition at line 77 of file itkRegularExpressionSeriesFileNames.h.

◆ Superclass

using itk::RegularExpressionSeriesFileNames::Superclass = Object

Definition at line 78 of file itkRegularExpressionSeriesFileNames.h.

Constructor & Destructor Documentation

◆ RegularExpressionSeriesFileNames()

itk::RegularExpressionSeriesFileNames::RegularExpressionSeriesFileNames ( )
inlineprotected

Definition at line 118 of file itkRegularExpressionSeriesFileNames.h.

◆ ~RegularExpressionSeriesFileNames()

itk::RegularExpressionSeriesFileNames::~RegularExpressionSeriesFileNames ( )
overrideprotecteddefault

Member Function Documentation

◆ GetDirectory()

virtual const char* itk::RegularExpressionSeriesFileNames::GetDirectory ( ) const
virtual

The directory containing the files.

◆ GetFileNames()

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

Returns a vector containing the series' file names. The file names are sorted by the sub expression selected by the SubMatch id.

◆ GetNameOfClass()

const char* itk::RegularExpressionSeriesFileNames::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetNumericSort()

virtual bool itk::RegularExpressionSeriesFileNames::GetNumericSort ( ) const
virtual

NumericSortOn changes the sort of the submatch field to a numeric sort. NumericSortOff is the default, and sorts the submatch alphabetically.

◆ GetRegularExpression()

virtual const char* itk::RegularExpressionSeriesFileNames::GetRegularExpression ( ) const
virtual

The RegularExpression. Refer to the description for valid expressions

◆ GetSubMatch()

virtual unsigned int itk::RegularExpressionSeriesFileNames::GetSubMatch ( ) const
virtual

The index of the submatch that will be used to sort the matches.

◆ New()

static Pointer itk::RegularExpressionSeriesFileNames::New ( )
static

Method for creation through the object factory.

◆ NumericSortOn()

virtual void itk::RegularExpressionSeriesFileNames::NumericSortOn ( )
virtual

NumericSortOn changes the sort of the submatch field to a numeric sort. NumericSortOff is the default, and sorts the submatch alphabetically.

◆ PrintSelf()

void itk::RegularExpressionSeriesFileNames::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.

◆ SetDirectory()

virtual void itk::RegularExpressionSeriesFileNames::SetDirectory ( const char *  _arg)
virtual

The directory containing the files.

◆ SetNumericSort()

virtual void itk::RegularExpressionSeriesFileNames::SetNumericSort ( bool  _arg)
virtual

NumericSortOn changes the sort of the submatch field to a numeric sort. NumericSortOff is the default, and sorts the submatch alphabetically.

◆ SetRegularExpression()

virtual void itk::RegularExpressionSeriesFileNames::SetRegularExpression ( const char *  _arg)
virtual

The RegularExpression. Refer to the description for valid expressions

◆ SetSubMatch()

virtual void itk::RegularExpressionSeriesFileNames::SetSubMatch ( unsigned int  _arg)
virtual

The index of the submatch that will be used to sort the matches.

Member Data Documentation

◆ m_Directory

std::string itk::RegularExpressionSeriesFileNames::m_Directory {}
private

Definition at line 127 of file itkRegularExpressionSeriesFileNames.h.

◆ m_FileNames

std::vector<std::string> itk::RegularExpressionSeriesFileNames::m_FileNames {}
private

Definition at line 132 of file itkRegularExpressionSeriesFileNames.h.

◆ m_NumericSort

bool itk::RegularExpressionSeriesFileNames::m_NumericSort { false }
private

Definition at line 129 of file itkRegularExpressionSeriesFileNames.h.

◆ m_RegularExpression

std::string itk::RegularExpressionSeriesFileNames::m_RegularExpression {}
private

Definition at line 130 of file itkRegularExpressionSeriesFileNames.h.

◆ m_SubMatch

unsigned int itk::RegularExpressionSeriesFileNames::m_SubMatch { 1 }
private

Definition at line 128 of file itkRegularExpressionSeriesFileNames.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16