#include <itkArchetypeSeriesFileNames.h>

Inheritance diagram for itk::ArchetypeSeriesFileNames:

Collaboration diagram for itk::ArchetypeSeriesFileNames:

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 68 of file itkArchetypeSeriesFileNames.h.

Public Types
typedef std::vector< int >	IntVectorType

typedef SmartPointer< Self >	Pointer

typedef ArchetypeSeriesFileNames	Self

typedef std::vector< std::string >	StringVectorType

typedef Object	Superclass

typedef vcl_size_t	VectorSizeType

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const char *	GetArchetype () const

const StringVectorType &	GetFileNames (VectorSizeType group=0)

virtual const char *	GetNameOfClass () const

VectorSizeType	GetNumberOfGroupings ()

void	SetArchetype (const std::string &archetype)

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

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

Protected Member Functions
	ArchetypeSeriesFileNames ()

virtual void	PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE

void	Scan ()

	~ArchetypeSeriesFileNames ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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

Private Member Functions
	ArchetypeSeriesFileNames (const Self &)

void	operator= (const Self &)

Private Attributes
std::string	m_Archetype

TimeStamp	m_ArchetypeMTime

StringVectorType	m_FileNames

std::vector< StringVectorType >	m_Groupings

TimeStamp	m_ScanTime

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

typedef std::vector< int > itk::ArchetypeSeriesFileNames::IntVectorType

Helper types for managing the groups of filenames and their sizes

Definition at line 96 of file itkArchetypeSeriesFileNames.h.

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

Definition at line 74 of file itkArchetypeSeriesFileNames.h.

typedef ArchetypeSeriesFileNames itk::ArchetypeSeriesFileNames::Self

Standard class typedefs.

Definition at line 72 of file itkArchetypeSeriesFileNames.h.

typedef std::vector< std::string > itk::ArchetypeSeriesFileNames::StringVectorType

Definition at line 97 of file itkArchetypeSeriesFileNames.h.

typedef Object itk::ArchetypeSeriesFileNames::Superclass

Definition at line 73 of file itkArchetypeSeriesFileNames.h.

typedef vcl_size_t itk::ArchetypeSeriesFileNames::VectorSizeType

Definition at line 88 of file itkArchetypeSeriesFileNames.h.

Constructor & Destructor Documentation

itk::ArchetypeSeriesFileNames::ArchetypeSeriesFileNames ( )

protected

itk::ArchetypeSeriesFileNames::~ArchetypeSeriesFileNames ( )

inlineprotected

Definition at line 106 of file itkArchetypeSeriesFileNames.h.

itk::ArchetypeSeriesFileNames::ArchetypeSeriesFileNames ( const Self & )

private

Member Function Documentation

virtual::itk::LightObject::Pointer itk::ArchetypeSeriesFileNames::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::ArchetypeSeriesFileNames::GetArchetype ( ) const

virtual

const StringVectorType& itk::ArchetypeSeriesFileNames::GetFileNames ( VectorSizeType 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.

VectorSizeType itk::ArchetypeSeriesFileNames::GetNumberOfGroupings ( )

Get the number of groupings that match the Archetype

static Pointer itk::ArchetypeSeriesFileNames::New ( )

static

Method for creation through the object factory.

void itk::ArchetypeSeriesFileNames::operator= ( const Self & )

private

virtual void itk::ArchetypeSeriesFileNames::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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 )