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

Generate an ordered sequence of filenames. More...

#include <itkArchetypeSeriesFileNames.h>

Inheritance diagram for itk::ArchetypeSeriesFileNames:

[legend]Collaboration diagram for itk::ArchetypeSeriesFileNames:

[legend]List of all members.

Public Types
typedef ArchetypeSeriesFileNames	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
Public Member Functions
virtual const char *	GetNameOfClass () const
void	SetArchetype (const std::string &archetype)
virtual const char *	GetArchetype () const
unsigned int	GetNumberOfGroupings ()
const std::vector< std::string > &	GetFileNames (unsigned int group=0)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ArchetypeSeriesFileNames ()
	~ArchetypeSeriesFileNames ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	Scan ()

---

Detailed Description

Generate an ordered sequence of filenames.

This class generates an ordered sequence of files based on an archetypical filename. From the archetypical filename, a set of regular expressions is created to group filenames based on numeric substrings. There can be multiple numeric substrings in the archetype. When this occurs, ArchetypeSeriesFileNames can not determine which numeric substring refers to the "image number" and which numeric substring refers to the "series" or "study". By default, the ArchetypeSeriesFileNames assumes the rightmost numeric substring refers to the image number, and this is the group of filenames returned by default. However, the other groupings of filenames can also be queried by passing in a group number to the GetFileNames() method. Groups are numbered by the numeric substrings from right to left in the archetype.

For example, if a directory contains the files

foo_5_1.png foo_5_2.png foo_5_3.png foo_6_1.png foo_6_2.png foo_6_3.png

and specifying an archetypical file foo_5_1.png, the filename list will contain

foo_5_1.png foo_5_2.png foo_5_3.png

Definition at line 71 of file itkArchetypeSeriesFileNames.h.

---

Member Typedef Documentation

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

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

typedef ArchetypeSeriesFileNames itk::ArchetypeSeriesFileNames::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 75 of file itkArchetypeSeriesFileNames.h.

typedef Object itk::ArchetypeSeriesFileNames::Superclass

Reimplemented from itk::Object. Definition at line 76 of file itkArchetypeSeriesFileNames.h.

---

Constructor & Destructor Documentation

itk::ArchetypeSeriesFileNames::ArchetypeSeriesFileNames (   )  [protected]

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

Definition at line 103 of file itkArchetypeSeriesFileNames.h.

---

Member Function Documentation

virtual const char* itk::ArchetypeSeriesFileNames::GetArchetype (   )  const [virtual]

const std::vector<std::string>& itk::ArchetypeSeriesFileNames::GetFileNames (  unsigned int  group = 0  )

Returns a vector containing the series' file names. The file names are ordered by Index. Defaults to returning the filenames to the rightmost grouping.

virtual const char* itk::ArchetypeSeriesFileNames::GetNameOfClass (   )  const [virtual]

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

unsigned int itk::ArchetypeSeriesFileNames::GetNumberOfGroupings (   )

Get the number of groupings that match the Archetype

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

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

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

void itk::ArchetypeSeriesFileNames::Scan (   )  [protected]

Method that actually does the archetype matching/grouping

void itk::ArchetypeSeriesFileNames::SetArchetype (  const std::string &  archetype  )

---

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

• itkArchetypeSeriesFileNames.h

---