ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::ArchetypeSeriesFileNames Class Reference

#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


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


Definition at line 68 of file itkArchetypeSeriesFileNames.h.

Public Types

typedef std::vector< int > IntVectorType
typedef SmartPointer< SelfPointer
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 SelfConstPointer
typedef SmartPointer< SelfPointer
typedef Object Self
typedef LightObject Superclass
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef LightObject Self

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
virtual const char * GetArchetype () const
const StringVectorTypeGetFileNames (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
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary ()
const MetaDataDictionaryGetMetaDataDictionary () const
virtual ModifiedTimeType GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const override
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int) override
virtual void UnRegister () const noexceptoverride
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 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< StringVectorTypem_Groupings
TimeStamp m_ScanTime

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount

Member Typedef Documentation

Helper types for managing the groups of filenames and their sizes

Definition at line 96 of file itkArchetypeSeriesFileNames.h.

Definition at line 74 of file itkArchetypeSeriesFileNames.h.

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.

Definition at line 73 of file itkArchetypeSeriesFileNames.h.

Definition at line 88 of file itkArchetypeSeriesFileNames.h.

Constructor & Destructor Documentation

itk::ArchetypeSeriesFileNames::ArchetypeSeriesFileNames ( )
itk::ArchetypeSeriesFileNames::~ArchetypeSeriesFileNames ( )

Definition at line 106 of file itkArchetypeSeriesFileNames.h.

itk::ArchetypeSeriesFileNames::ArchetypeSeriesFileNames ( const Self )

Member Function Documentation

virtual::itk::LightObject::Pointer itk::ArchetypeSeriesFileNames::CreateAnother ( ) const

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

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

Method for creation through the object factory.

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

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

Method that actually does the archetype matching/grouping

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

Member Data Documentation

std::string itk::ArchetypeSeriesFileNames::m_Archetype

A string for formatting the names of files in the series.

Definition at line 117 of file itkArchetypeSeriesFileNames.h.

TimeStamp itk::ArchetypeSeriesFileNames::m_ArchetypeMTime

Definition at line 123 of file itkArchetypeSeriesFileNames.h.

StringVectorType itk::ArchetypeSeriesFileNames::m_FileNames

Definition at line 120 of file itkArchetypeSeriesFileNames.h.

std::vector< StringVectorType > itk::ArchetypeSeriesFileNames::m_Groupings

Definition at line 119 of file itkArchetypeSeriesFileNames.h.

TimeStamp itk::ArchetypeSeriesFileNames::m_ScanTime

Definition at line 124 of file itkArchetypeSeriesFileNames.h.

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