ITK
6.0.0
Insight Toolkit
|
#include <itkRegularExpressionSeriesFileNames.h>
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.
Definition at line 71 of file itkRegularExpressionSeriesFileNames.h.
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 |
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 | |
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 |
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 | |
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 {} |
Definition at line 79 of file itkRegularExpressionSeriesFileNames.h.
Standard class type aliases.
Definition at line 77 of file itkRegularExpressionSeriesFileNames.h.
Definition at line 78 of file itkRegularExpressionSeriesFileNames.h.
|
inlineprotected |
Definition at line 118 of file itkRegularExpressionSeriesFileNames.h.
|
overrideprotecteddefault |
|
virtual |
The directory containing the files.
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.
|
overridevirtual |
Reimplemented from itk::Object.
|
virtual |
NumericSortOn changes the sort of the submatch field to a numeric sort. NumericSortOff is the default, and sorts the submatch alphabetically.
|
virtual |
The RegularExpression. Refer to the description for valid expressions
|
virtual |
The index of the submatch that will be used to sort the matches.
|
static |
Method for creation through the object factory.
|
virtual |
NumericSortOn changes the sort of the submatch field to a numeric sort. NumericSortOff is the default, and sorts the submatch alphabetically.
|
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 |
The directory containing the files.
|
virtual |
NumericSortOn changes the sort of the submatch field to a numeric sort. NumericSortOff is the default, and sorts the submatch alphabetically.
|
virtual |
The RegularExpression. Refer to the description for valid expressions
|
virtual |
The index of the submatch that will be used to sort the matches.
|
private |
Definition at line 127 of file itkRegularExpressionSeriesFileNames.h.
|
private |
Definition at line 132 of file itkRegularExpressionSeriesFileNames.h.
|
private |
Definition at line 129 of file itkRegularExpressionSeriesFileNames.h.
|
private |
Definition at line 130 of file itkRegularExpressionSeriesFileNames.h.
|
private |
Definition at line 128 of file itkRegularExpressionSeriesFileNames.h.