ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::ArchetypeSeriesFileNames Class Reference
Data Processing Objects » Filters » Input and Output Filters | Group IO » Module ITKIOImageBase

#include <itkArchetypeSeriesFileNames.h>

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.

+ Inheritance diagram for itk::ArchetypeSeriesFileNames:
+ Collaboration diagram for itk::ArchetypeSeriesFileNames:

Public Types

using IntVectorType = std::vector< int >
 
using Pointer = SmartPointer< Self >
 
using Self = ArchetypeSeriesFileNames
 
using StringVectorType = std::vector< std::string >
 
using Superclass = Object
 
using VectorSizeType = vcl_size_t
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual const char * GetArchetype () const
 
const StringVectorType & GetFileNames (VectorSizeType group=0)
 
const char * GetNameOfClass () const override
 
VectorSizeType GetNumberOfGroupings ()
 
void SetArchetype (const std::string &archetype)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 ArchetypeSeriesFileNames ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void Scan ()
 
 ~ArchetypeSeriesFileNames () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

std::string m_Archetype {}
 
TimeStamp m_ArchetypeMTime {}
 
StringVectorType m_FileNames {}
 
std::vector< StringVectorType > m_Groupings {}
 
TimeStamp m_ScanTime {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ IntVectorType

using itk::ArchetypeSeriesFileNames::IntVectorType = std::vector<int>

Helper types for managing the groups of filenames and their sizes

Definition at line 100 of file itkArchetypeSeriesFileNames.h.

◆ Pointer

using itk::ArchetypeSeriesFileNames::Pointer = SmartPointer<Self>

Definition at line 76 of file itkArchetypeSeriesFileNames.h.

◆ Self

using itk::ArchetypeSeriesFileNames::Self = ArchetypeSeriesFileNames

Standard class type aliases.

Definition at line 74 of file itkArchetypeSeriesFileNames.h.

◆ StringVectorType

using itk::ArchetypeSeriesFileNames::StringVectorType = std::vector<std::string>

Definition at line 101 of file itkArchetypeSeriesFileNames.h.

◆ Superclass

using itk::ArchetypeSeriesFileNames::Superclass = Object

Definition at line 75 of file itkArchetypeSeriesFileNames.h.

◆ VectorSizeType

using itk::ArchetypeSeriesFileNames::VectorSizeType = vcl_size_t

Definition at line 93 of file itkArchetypeSeriesFileNames.h.

Constructor & Destructor Documentation

◆ ArchetypeSeriesFileNames()

itk::ArchetypeSeriesFileNames::ArchetypeSeriesFileNames ( )
protected

◆ ~ArchetypeSeriesFileNames()

itk::ArchetypeSeriesFileNames::~ArchetypeSeriesFileNames ( )
overrideprotecteddefault

Member Function Documentation

◆ GetArchetype()

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

◆ GetFileNames()

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.

◆ GetNameOfClass()

const char * itk::ArchetypeSeriesFileNames::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetNumberOfGroupings()

VectorSizeType itk::ArchetypeSeriesFileNames::GetNumberOfGroupings ( )

Get the number of groupings that match the Archetype

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

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.

◆ Scan()

void itk::ArchetypeSeriesFileNames::Scan ( )
protected

Method that actually does the archetype matching/grouping

◆ SetArchetype()

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

Member Data Documentation

◆ m_Archetype

std::string itk::ArchetypeSeriesFileNames::m_Archetype {}
private

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

Definition at line 121 of file itkArchetypeSeriesFileNames.h.

◆ m_ArchetypeMTime

TimeStamp itk::ArchetypeSeriesFileNames::m_ArchetypeMTime {}
private

Definition at line 127 of file itkArchetypeSeriesFileNames.h.

◆ m_FileNames

StringVectorType itk::ArchetypeSeriesFileNames::m_FileNames {}
private

Definition at line 124 of file itkArchetypeSeriesFileNames.h.

◆ m_Groupings

std::vector<StringVectorType> itk::ArchetypeSeriesFileNames::m_Groupings {}
private

Definition at line 123 of file itkArchetypeSeriesFileNames.h.

◆ m_ScanTime

TimeStamp itk::ArchetypeSeriesFileNames::m_ScanTime {}
private

Definition at line 128 of file itkArchetypeSeriesFileNames.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3