itk::RegularExpressionSeriesFileNames Class Reference
[Input and Output Filters]

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

#include <itkRegularExpressionSeriesFileNames.h>

Inheritance diagram for itk::RegularExpressionSeriesFileNames:

[legend]Collaboration diagram for itk::RegularExpressionSeriesFileNames:

[legend]List of all members.

Public Types
typedef RegularExpressionSeriesFileNames	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
Public Member Functions
virtual const char *	GetClassName () const
std::string	GetSubMatch (unsigned int)
const std::vector< std::string > &	GetFileNames ()
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 ()
virtual void	SetNumericSort (bool _arg)
virtual bool	GetNumericSort ()
virtual void	NumericSortOn ()
virtual void	NumericSortOff ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	RegularExpressionSeriesFileNames ()
	~RegularExpressionSeriesFileNames ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

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 any character in range on either side of a dash

* Matches preceding pattern zero or more times

+ Matches preceding pattern one or more times

? 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 72 of file itkRegularExpressionSeriesFileNames.h.

---

Member Typedef Documentation

typedef SmartPointer<Self> itk::RegularExpressionSeriesFileNames::Pointer

Reimplemented from itk::Object. Definition at line 78 of file itkRegularExpressionSeriesFileNames.h.

typedef RegularExpressionSeriesFileNames itk::RegularExpressionSeriesFileNames::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 76 of file itkRegularExpressionSeriesFileNames.h. Referenced by ~RegularExpressionSeriesFileNames().

typedef Object itk::RegularExpressionSeriesFileNames::Superclass

Reimplemented from itk::Object. Definition at line 77 of file itkRegularExpressionSeriesFileNames.h.

---

Constructor & Destructor Documentation

itk::RegularExpressionSeriesFileNames::RegularExpressionSeriesFileNames (   )  [inline, protected]

Definition at line 119 of file itkRegularExpressionSeriesFileNames.h.

itk::RegularExpressionSeriesFileNames::~RegularExpressionSeriesFileNames (   )  [inline, protected]

Definition at line 125 of file itkRegularExpressionSeriesFileNames.h. References Self.

---

Member Function Documentation

virtual const char* itk::RegularExpressionSeriesFileNames::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

virtual const char* itk::RegularExpressionSeriesFileNames::GetDirectory (   )  const [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.

virtual bool itk::RegularExpressionSeriesFileNames::GetNumericSort (   )  [virtual]

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

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

The RegularExpression. Refer to the description for valid expressions

std::string itk::RegularExpressionSeriesFileNames::GetSubMatch (  unsigned  int  )

Return the SubMatch of the specified index.

virtual unsigned int itk::RegularExpressionSeriesFileNames::GetSubMatch (   )  [virtual]

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

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

Method for creation through the object factory. Reimplemented from itk::Object.

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

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

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.

void itk::RegularExpressionSeriesFileNames::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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 void itk::RegularExpressionSeriesFileNames::SetDirectory (  const char *  _arg  )  [virtual]

The directory containing the files.

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.

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

The RegularExpression. Refer to the description for valid expressions

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

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

---

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

• itkRegularExpressionSeriesFileNames.h

---