VTK
9.1.0
|
Group and sort a set of filenames. More...
#include <vtkSortFileNames.h>
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... | |
vtkSortFileNames * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual vtkStringArray * | GetFileNames () |
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 vtkStringArray * | GetNthGroup (int i) |
Get the Nth group of file names. More... | |
virtual void | Update () |
Update the output filenames from the input filenames. More... | |
virtual void | SetGrouping (vtkTypeBool) |
Sort the file names into groups, according to similarity in filename name and path. More... | |
virtual vtkTypeBool | GetGrouping () |
Sort the file names into groups, according to similarity in filename name and path. More... | |
virtual void | GroupingOn () |
Sort the file names into groups, according to similarity in filename name and path. More... | |
virtual void | GroupingOff () |
Sort the file names into groups, according to similarity in filename name and path. More... | |
virtual void | SetNumericSort (vtkTypeBool) |
Sort the files numerically, rather than lexicographically. More... | |
virtual vtkTypeBool | GetNumericSort () |
Sort the files numerically, rather than lexicographically. More... | |
virtual void | NumericSortOn () |
Sort the files numerically, rather than lexicographically. More... | |
virtual void | NumericSortOff () |
Sort the files numerically, rather than lexicographically. More... | |
virtual void | SetIgnoreCase (vtkTypeBool) |
Ignore case when sorting. More... | |
virtual vtkTypeBool | GetIgnoreCase () |
Ignore case when sorting. More... | |
virtual void | IgnoreCaseOn () |
Ignore case when sorting. More... | |
virtual void | IgnoreCaseOff () |
Ignore case when sorting. More... | |
virtual void | SetSkipDirectories (vtkTypeBool) |
Skip directories. More... | |
virtual vtkTypeBool | GetSkipDirectories () |
Skip directories. More... | |
virtual void | SkipDirectoriesOn () |
Skip directories. More... | |
virtual void | SkipDirectoriesOff () |
Skip directories. More... | |
void | SetInputFileNames (vtkStringArray *input) |
Set a list of file names to group and sort. More... | |
virtual vtkStringArray * | GetInputFileNames () |
Set a list of file names to group and sort. More... | |
![]() | |
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... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
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) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
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) |
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, 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) |
This method invokes an event and return whether the event was aborted or not. More... | |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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 | 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... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkSortFileNames * | SafeDownCast (vtkObjectBase *o) |
static vtkSortFileNames * | New () |
![]() | |
static vtkObject * | New () |
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 () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
![]() | |
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 vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More... | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () 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... | |
![]() | |
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 () |
These methods allow a command to exclusively grab all events. More... | |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkTypeBool | NumericSort |
vtkTypeBool | IgnoreCase |
vtkTypeBool | Grouping |
vtkTypeBool | SkipDirectories |
vtkTimeStamp | UpdateTime |
vtkStringArray * | InputFileNames |
vtkStringArray * | FileNames |
vtkStringArrayVector * | Groups |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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).
Definition at line 42 of file vtkSortFileNames.h.
Definition at line 45 of file vtkSortFileNames.h.
|
protected |
|
overrideprotected |
|
static |
|
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.
|
static |
|
protectedvirtual |
vtkSortFileNames * vtkSortFileNames::NewInstance | ( | ) | const |
|
overridevirtual |
|
static |
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
virtual |
Ignore case when sorting.
This flag is honored by both the sorting and the grouping. This is off by default.
|
virtual |
Ignore case when sorting.
This flag is honored by both the sorting and the grouping. This is off by default.
|
virtual |
Ignore case when sorting.
This flag is honored by both the sorting and the grouping. This is off by default.
|
virtual |
Ignore case when sorting.
This flag is honored by both the sorting and the grouping. This is off by default.
|
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.
|
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.
|
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.
|
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.
void vtkSortFileNames::SetInputFileNames | ( | vtkStringArray * | input | ) |
Set a list of file names to group and sort.
|
virtual |
Set a list of file names to group and sort.
|
virtual |
Get the full list of sorted filenames.
|
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.
|
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.
|
virtual |
Update the output filenames from the input filenames.
This method is called automatically by GetFileNames() and GetNumberOfGroups() if the input names have changed.
|
protectedvirtual |
Fill the output.
|
protectedvirtual |
Sort the input string array, and append the results to the output.
|
protectedvirtual |
Separate a string array into groups and append them to the output.
|
protected |
Definition at line 137 of file vtkSortFileNames.h.
|
protected |
Definition at line 138 of file vtkSortFileNames.h.
|
protected |
Definition at line 139 of file vtkSortFileNames.h.
|
protected |
Definition at line 140 of file vtkSortFileNames.h.
|
protected |
Definition at line 142 of file vtkSortFileNames.h.
|
protected |
Definition at line 144 of file vtkSortFileNames.h.
|
protected |
Definition at line 145 of file vtkSortFileNames.h.
|
protected |
Definition at line 146 of file vtkSortFileNames.h.