itk::RegularExpressionSeriesFileNames Class Reference

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

#include <itkRegularExpressionSeriesFileNames.h>

Inheritance diagram for itk::RegularExpressionSeriesFileNames:

Collaboration diagram for itk::RegularExpressionSeriesFileNames:

List of all members.

Public Types
typedef SmartPointer< Self >	Pointer
typedef RegularExpressionSeriesFileNames	Self
typedef Object	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const std::vector< std::string > &	GetFileNames ()
virtual const char *	GetNameOfClass () const
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 ()
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	RegularExpressionSeriesFileNames ()
	~RegularExpressionSeriesFileNames ()
Private Member Functions
void	operator= (const Self &)
	RegularExpressionSeriesFileNames (const Self &)
Private Attributes
std::string	m_Directory
std::vector< std::string >	m_FileNames
bool	m_NumericSort
std::string	m_RegularExpression
unsigned int	m_SubMatch

---

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

---

Member Typedef Documentation

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

Reimplemented from itk::Object.

Definition at line 76 of file itkRegularExpressionSeriesFileNames.h.

typedef RegularExpressionSeriesFileNames itk::RegularExpressionSeriesFileNames::Self

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 74 of file itkRegularExpressionSeriesFileNames.h.

typedef Object itk::RegularExpressionSeriesFileNames::Superclass

Reimplemented from itk::Object.

Definition at line 75 of file itkRegularExpressionSeriesFileNames.h.

---

Constructor & Destructor Documentation

itk::RegularExpressionSeriesFileNames::RegularExpressionSeriesFileNames

(

)

[inline, protected]

Definition at line 114 of file itkRegularExpressionSeriesFileNames.h.

itk::RegularExpressionSeriesFileNames::~RegularExpressionSeriesFileNames

(

)

[inline, protected]

Definition at line 120 of file itkRegularExpressionSeriesFileNames.h.

itk::RegularExpressionSeriesFileNames::RegularExpressionSeriesFileNames

(

const Self &

)

[private]

---

Member Function Documentation

virtual::itk::LightObject::Pointer itk::RegularExpressionSeriesFileNames::CreateAnother

(

void

)

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.

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 const char* itk::RegularExpressionSeriesFileNames::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Object.

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.

virtual const char* itk::RegularExpressionSeriesFileNames::GetRegularExpression

(

)

const [virtual]

The RegularExpression. Refer to the description for valid expressions

virtual unsigned int itk::RegularExpressionSeriesFileNames::GetSubMatch

(

)

const [virtual]

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

static 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::operator=

(

const Self &

)

[private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

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.

---

Member Data Documentation

std::string itk::RegularExpressionSeriesFileNames::m_Directory [private]

Definition at line 127 of file itkRegularExpressionSeriesFileNames.h.

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

Definition at line 132 of file itkRegularExpressionSeriesFileNames.h.

bool itk::RegularExpressionSeriesFileNames::m_NumericSort [private]

Definition at line 129 of file itkRegularExpressionSeriesFileNames.h.

std::string itk::RegularExpressionSeriesFileNames::m_RegularExpression [private]

Definition at line 130 of file itkRegularExpressionSeriesFileNames.h.

unsigned int itk::RegularExpressionSeriesFileNames::m_SubMatch [private]

Definition at line 128 of file itkRegularExpressionSeriesFileNames.h.

---

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

• itkRegularExpressionSeriesFileNames.h