VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSortFileNames Class Reference

Group and sort a set of filenames. More...

#include <vtkSortFileNames.h>

Inheritance diagram for vtkSortFileNames:
[legend]
Collaboration diagram for vtkSortFileNames:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkSortFileNamesNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetGrouping (vtkTypeBool)
 Sort the file names into groups, according to similarity in filename name and path. More...
 
virtual vtkTypeBool GetGrouping ()
 
virtual void GroupingOn ()
 
virtual void GroupingOff ()
 
virtual void SetNumericSort (vtkTypeBool)
 Sort the files numerically, rather than lexicographically. More...
 
virtual vtkTypeBool GetNumericSort ()
 
virtual void NumericSortOn ()
 
virtual void NumericSortOff ()
 
virtual void SetIgnoreCase (vtkTypeBool)
 Ignore case when sorting. More...
 
virtual vtkTypeBool GetIgnoreCase ()
 
virtual void IgnoreCaseOn ()
 
virtual void IgnoreCaseOff ()
 
virtual void SetSkipDirectories (vtkTypeBool)
 Skip directories. More...
 
virtual vtkTypeBool GetSkipDirectories ()
 
virtual void SkipDirectoriesOn ()
 
virtual void SkipDirectoriesOff ()
 
void SetInputFileNames (vtkStringArray *input)
 Set a list of file names to group and sort. More...
 
virtual vtkStringArrayGetInputFileNames ()
 
virtual vtkStringArrayGetFileNames ()
 Get the full list of sorted filenames. More...
 
virtual int GetNumberOfGroups ()
 Get the number of groups that the names were split into, if grouping is on. More...
 
virtual vtkStringArrayGetNthGroup (int i)
 Get the Nth group of file names. More...
 
virtual void Update ()
 Update the output filenames from the input filenames. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSortFileNamesSafeDownCast (vtkObjectBase *o)
 
static vtkSortFileNamesNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSortFileNames ()
 
 ~vtkSortFileNames () override
 
virtual void Execute ()
 Fill the output. More...
 
virtual void SortFileNames (vtkStringArray *input, vtkStringArray *output)
 Sort the input string array, and append the results to the output. More...
 
virtual void GroupFileNames (vtkStringArray *input, vtkStringArrayVector *output)
 Separate a string array into groups and append them to the output. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTypeBool NumericSort
 
vtkTypeBool IgnoreCase
 
vtkTypeBool Grouping
 
vtkTypeBool SkipDirectories
 
vtkTimeStamp UpdateTime
 
vtkStringArrayInputFileNames
 
vtkStringArrayFileNames
 
vtkStringArrayVector * Groups
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Group and sort a set of filenames.

vtkSortFileNames will take a list of filenames (e.g. from a file load dialog) and sort them into one or more series. If the input list of filenames contains any directories, these can be removed before sorting using the SkipDirectories flag. This class should be used where information about the series groupings can be determined by the filenames, but it might not be successful in cases where the information about the series groupings is stored in the files themselves (e.g DICOM).

See also
vtkImageReader2
Tests:
vtkSortFileNames (Tests)

Definition at line 45 of file vtkSortFileNames.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file vtkSortFileNames.h.

Constructor & Destructor Documentation

◆ vtkSortFileNames()

vtkSortFileNames::vtkSortFileNames ( )
protected

◆ ~vtkSortFileNames()

vtkSortFileNames::~vtkSortFileNames ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkSortFileNames::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkSortFileNames::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkSortFileNames* vtkSortFileNames::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSortFileNames::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkSortFileNames* vtkSortFileNames::NewInstance ( ) const

◆ PrintSelf()

void vtkSortFileNames::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

◆ New()

static vtkSortFileNames* vtkSortFileNames::New ( )
static

◆ SetGrouping()

virtual void vtkSortFileNames::SetGrouping ( vtkTypeBool  )
virtual

Sort the file names into groups, according to similarity in filename name and path.

Files in different directories, or with different extensions, or which do not fit into the same numbered series will be placed into different groups. This is off by default.

◆ GetGrouping()

virtual vtkTypeBool vtkSortFileNames::GetGrouping ( )
virtual

◆ GroupingOn()

virtual void vtkSortFileNames::GroupingOn ( )
virtual

◆ GroupingOff()

virtual void vtkSortFileNames::GroupingOff ( )
virtual

◆ SetNumericSort()

virtual void vtkSortFileNames::SetNumericSort ( vtkTypeBool  )
virtual

Sort the files numerically, rather than lexicographically.

For filenames that contain numbers, this means the order will be ["file8.dat", "file9.dat", "file10.dat"] instead of the usual alphabetic sorting order ["file10.dat" "file8.dat", "file9.dat"]. NumericSort is off by default.

◆ GetNumericSort()

virtual vtkTypeBool vtkSortFileNames::GetNumericSort ( )
virtual

◆ NumericSortOn()

virtual void vtkSortFileNames::NumericSortOn ( )
virtual

◆ NumericSortOff()

virtual void vtkSortFileNames::NumericSortOff ( )
virtual

◆ SetIgnoreCase()

virtual void vtkSortFileNames::SetIgnoreCase ( vtkTypeBool  )
virtual

Ignore case when sorting.

This flag is honored by both the sorting and the grouping. This is off by default.

◆ GetIgnoreCase()

virtual vtkTypeBool vtkSortFileNames::GetIgnoreCase ( )
virtual

◆ IgnoreCaseOn()

virtual void vtkSortFileNames::IgnoreCaseOn ( )
virtual

◆ IgnoreCaseOff()

virtual void vtkSortFileNames::IgnoreCaseOff ( )
virtual

◆ SetSkipDirectories()

virtual void vtkSortFileNames::SetSkipDirectories ( vtkTypeBool  )
virtual

Skip directories.

If this flag is set, any input item that is a directory rather than a file will not be included in the output. This is off by default.

◆ GetSkipDirectories()

virtual vtkTypeBool vtkSortFileNames::GetSkipDirectories ( )
virtual

◆ SkipDirectoriesOn()

virtual void vtkSortFileNames::SkipDirectoriesOn ( )
virtual

◆ SkipDirectoriesOff()

virtual void vtkSortFileNames::SkipDirectoriesOff ( )
virtual

◆ SetInputFileNames()

void vtkSortFileNames::SetInputFileNames ( vtkStringArray input)

Set a list of file names to group and sort.

◆ GetInputFileNames()

virtual vtkStringArray* vtkSortFileNames::GetInputFileNames ( )
virtual

◆ GetFileNames()

virtual vtkStringArray* vtkSortFileNames::GetFileNames ( )
virtual

Get the full list of sorted filenames.

◆ GetNumberOfGroups()

virtual int vtkSortFileNames::GetNumberOfGroups ( )
virtual

Get the number of groups that the names were split into, if grouping is on.

The filenames are automatically split into groups, where the filenames in each group will be identical except for their series numbers. If grouping is not on, this method will return zero.

◆ GetNthGroup()

virtual vtkStringArray* vtkSortFileNames::GetNthGroup ( int  i)
virtual

Get the Nth group of file names.

This method should only be used if grouping is on. If grouping is off, it will always return null.

◆ Update()

virtual void vtkSortFileNames::Update ( )
virtual

Update the output filenames from the input filenames.

This method is called automatically by GetFileNames() and GetNumberOfGroups() if the input names have changed.

◆ Execute()

virtual void vtkSortFileNames::Execute ( )
protectedvirtual

Fill the output.

◆ SortFileNames()

virtual void vtkSortFileNames::SortFileNames ( vtkStringArray input,
vtkStringArray output 
)
protectedvirtual

Sort the input string array, and append the results to the output.

◆ GroupFileNames()

virtual void vtkSortFileNames::GroupFileNames ( vtkStringArray input,
vtkStringArrayVector *  output 
)
protectedvirtual

Separate a string array into groups and append them to the output.

Member Data Documentation

◆ NumericSort

vtkTypeBool vtkSortFileNames::NumericSort
protected

Definition at line 141 of file vtkSortFileNames.h.

◆ IgnoreCase

vtkTypeBool vtkSortFileNames::IgnoreCase
protected

Definition at line 142 of file vtkSortFileNames.h.

◆ Grouping

vtkTypeBool vtkSortFileNames::Grouping
protected

Definition at line 143 of file vtkSortFileNames.h.

◆ SkipDirectories

vtkTypeBool vtkSortFileNames::SkipDirectories
protected

Definition at line 144 of file vtkSortFileNames.h.

◆ UpdateTime

vtkTimeStamp vtkSortFileNames::UpdateTime
protected

Definition at line 146 of file vtkSortFileNames.h.

◆ InputFileNames

vtkStringArray* vtkSortFileNames::InputFileNames
protected

Definition at line 148 of file vtkSortFileNames.h.

◆ FileNames

vtkStringArray* vtkSortFileNames::FileNames
protected

Definition at line 149 of file vtkSortFileNames.h.

◆ Groups

vtkStringArrayVector* vtkSortFileNames::Groups
protected

Definition at line 150 of file vtkSortFileNames.h.


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