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

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

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
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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 ()
 
std::string m_Directory
 
unsigned int m_SubMatch { 1 }
 
bool m_NumericSort { false }
 
std::string m_RegularExpression
 
std::vector< std::string > m_FileNames
 
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 ()
 
virtual void NumericSortOff ()
 
const std::vector< std::string > & GetFileNames ()
 
 RegularExpressionSeriesFileNames ()
 
 ~RegularExpressionSeriesFileNames () 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 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.

Member Typedef Documentation

◆ Pointer

Definition at line 79 of file itkRegularExpressionSeriesFileNames.h.

◆ Self

Standard class type aliases.

Definition at line 77 of file itkRegularExpressionSeriesFileNames.h.

◆ Superclass

Definition at line 78 of file itkRegularExpressionSeriesFileNames.h.

Constructor & Destructor Documentation

◆ RegularExpressionSeriesFileNames()

itk::RegularExpressionSeriesFileNames::RegularExpressionSeriesFileNames ( )
inlineprotected

The directory containing the files.

Definition at line 118 of file itkRegularExpressionSeriesFileNames.h.

◆ ~RegularExpressionSeriesFileNames()

itk::RegularExpressionSeriesFileNames::~RegularExpressionSeriesFileNames ( )
overrideprotecteddefault

The directory containing the files.

Member Function Documentation

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::RegularExpressionSeriesFileNames::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.

◆ 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()

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

◆ GetNumericSort()

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

The directory containing the files.

◆ GetRegularExpression()

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

The directory containing the files.

◆ GetSubMatch()

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

The directory containing the files.

◆ New()

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

Method for creation through the object factory.

◆ NumericSortOff()

virtual void itk::RegularExpressionSeriesFileNames::NumericSortOff ( )
virtual

The directory containing the files.

◆ NumericSortOn()

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

The directory containing the files.

◆ PrintSelf()

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

The directory containing the files.

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

The directory containing the files.

Definition at line 127 of file itkRegularExpressionSeriesFileNames.h.

◆ m_FileNames

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

The directory containing the files.

Definition at line 132 of file itkRegularExpressionSeriesFileNames.h.

◆ m_NumericSort

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

The directory containing the files.

Definition at line 129 of file itkRegularExpressionSeriesFileNames.h.

◆ m_RegularExpression

std::string itk::RegularExpressionSeriesFileNames::m_RegularExpression
private

The directory containing the files.

Definition at line 130 of file itkRegularExpressionSeriesFileNames.h.

◆ m_SubMatch

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

The directory containing the files.

Definition at line 128 of file itkRegularExpressionSeriesFileNames.h.


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