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

#include <vtkSortFileNames.h>

Inheritance diagram for vtkSortFileNames:

Collaboration diagram for vtkSortFileNames:

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

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

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. 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)
	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...

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. 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...

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkSortFileNames *	SafeDownCast (vtkObjectBase *o)

static vtkSortFileNames *	New ()

Static Public Member Functions inherited from vtkObject
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 (vtkTypeBool 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 vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

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 ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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 34 of file vtkSortFileNames.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkSortFileNames::Superclass

Definition at line 37 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

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.

◆ GroupingOn()

virtual void vtkSortFileNames::GroupingOn ( )

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.

◆ GroupingOff()

virtual void vtkSortFileNames::GroupingOff ( )

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.

◆ 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

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.

◆ NumericSortOn()

virtual void vtkSortFileNames::NumericSortOn ( )

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.

◆ NumericSortOff()

virtual void vtkSortFileNames::NumericSortOff ( )

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.

◆ 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

Ignore case when sorting.

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

◆ IgnoreCaseOn()

virtual void vtkSortFileNames::IgnoreCaseOn ( )

virtual

Ignore case when sorting.

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

◆ IgnoreCaseOff()

virtual void vtkSortFileNames::IgnoreCaseOff ( )

virtual

Ignore case when sorting.

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

◆ 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

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.

◆ SkipDirectoriesOn()

virtual void vtkSortFileNames::SkipDirectoriesOn ( )

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.

◆ SkipDirectoriesOff()

virtual void vtkSortFileNames::SkipDirectoriesOff ( )

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.

◆ SetInputFileNames()

void vtkSortFileNames::SetInputFileNames ( vtkStringArray * input )

Set a list of file names to group and sort.

◆ GetInputFileNames()

virtual vtkStringArray* vtkSortFileNames::GetInputFileNames ( )

virtual

Set a list of file names to group and sort.

◆ 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 129 of file vtkSortFileNames.h.

◆ IgnoreCase

vtkTypeBool vtkSortFileNames::IgnoreCase

protected

Definition at line 130 of file vtkSortFileNames.h.

◆ Grouping

vtkTypeBool vtkSortFileNames::Grouping

protected

Definition at line 131 of file vtkSortFileNames.h.

◆ SkipDirectories

vtkTypeBool vtkSortFileNames::SkipDirectories

protected

Definition at line 132 of file vtkSortFileNames.h.

◆ UpdateTime

vtkTimeStamp vtkSortFileNames::UpdateTime

protected

Definition at line 134 of file vtkSortFileNames.h.

◆ InputFileNames

vtkStringArray* vtkSortFileNames::InputFileNames

protected

Definition at line 136 of file vtkSortFileNames.h.

◆ FileNames

vtkStringArray* vtkSortFileNames::FileNames

protected

Definition at line 137 of file vtkSortFileNames.h.

◆ Groups

vtkStringArrayVector* vtkSortFileNames::Groups

protected

Definition at line 138 of file vtkSortFileNames.h.

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

IO/Core/vtkSortFileNames.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSortFileNames()

◆ ~vtkSortFileNames()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetGrouping()

◆ GetGrouping()

◆ GroupingOn()

◆ GroupingOff()

◆ SetNumericSort()

◆ GetNumericSort()

◆ NumericSortOn()

◆ NumericSortOff()

◆ SetIgnoreCase()

◆ GetIgnoreCase()

◆ IgnoreCaseOn()

◆ IgnoreCaseOff()

◆ SetSkipDirectories()

◆ GetSkipDirectories()

◆ SkipDirectoriesOn()

◆ SkipDirectoriesOff()

◆ SetInputFileNames()

◆ GetInputFileNames()

◆ GetFileNames()

◆ GetNumberOfGroups()

◆ GetNthGroup()

◆ Update()

◆ Execute()

◆ SortFileNames()

◆ GroupFileNames()

Member Data Documentation

◆ NumericSort

◆ IgnoreCase

◆ Grouping

◆ SkipDirectories

◆ UpdateTime

◆ InputFileNames

◆ FileNames

◆ Groups