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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkSortFileNames *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkStringArray *	GetFileNames ()

virtual int	GetNumberOfGroups ()

virtual vtkStringArray *	GetNthGroup (int i)

virtual void	Update ()


virtual void	SetGrouping (int)

virtual int	GetGrouping ()

virtual void	GroupingOn ()

virtual void	GroupingOff ()


virtual void	SetNumericSort (int)

virtual int	GetNumericSort ()

virtual void	NumericSortOn ()

virtual void	NumericSortOff ()


virtual void	SetIgnoreCase (int)

virtual int	GetIgnoreCase ()

virtual void	IgnoreCaseOn ()

virtual void	IgnoreCaseOff ()


virtual void	SetSkipDirectories (int)

virtual int	GetSkipDirectories ()

virtual void	SkipDirectoriesOn ()

virtual void	SkipDirectoriesOff ()


void	SetInputFileNames (vtkStringArray *input)

virtual vtkStringArray *	GetInputFileNames ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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

static vtkSortFileNames *	SafeDownCast (vtkObjectBase *o)

static vtkSortFileNames *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSortFileNames ()

	~vtkSortFileNames ()

virtual void	Execute ()

virtual void	SortFileNames (vtkStringArray input, vtkStringArray output)


virtual void	GroupFileNames (vtkStringArray input, vtkStringArrayVector output)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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

int	IgnoreCase

int	Grouping

int	SkipDirectories

vtkTimeStamp	UpdateTime

vtkStringArray *	InputFileNames

vtkStringArray *	FileNames

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

Member Typedef Documentation

typedef vtkObject vtkSortFileNames::Superclass

Definition at line 50 of file vtkSortFileNames.h.

Constructor & Destructor Documentation

vtkSortFileNames::vtkSortFileNames ( )

protected

vtkSortFileNames::~vtkSortFileNames ( )

protected

Member Function Documentation

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

static

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

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

static

virtual vtkObjectBase* vtkSortFileNames::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkSortFileNames* vtkSortFileNames::NewInstance ( ) const

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

virtual

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.

static vtkSortFileNames* vtkSortFileNames::New ( )

static

virtual void vtkSortFileNames::SetGrouping ( int )

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

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.

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.

virtual void vtkSortFileNames::SetNumericSort ( int )

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

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.

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.

virtual void vtkSortFileNames::SetIgnoreCase ( int )

virtual

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

virtual int vtkSortFileNames::GetIgnoreCase ( )

virtual

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

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.

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.

virtual void vtkSortFileNames::SetSkipDirectories ( int )

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

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.

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.

void vtkSortFileNames::SetInputFileNames ( vtkStringArray * input )

Set a list of file names to group and sort.

virtual vtkStringArray* vtkSortFileNames::GetInputFileNames ( )

virtual

Set a list of file names to group and sort.

virtual vtkStringArray* vtkSortFileNames::GetFileNames ( )

virtual

Get the full list of sorted filenames.

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.

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.

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.

virtual void vtkSortFileNames::Execute ( )

protectedvirtual

Fill the output.

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

protectedvirtual

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

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

protectedvirtual

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

Member Data Documentation

int vtkSortFileNames::NumericSort

protected

Definition at line 120 of file vtkSortFileNames.h.

int vtkSortFileNames::IgnoreCase

protected

Definition at line 121 of file vtkSortFileNames.h.

int vtkSortFileNames::Grouping

protected

Definition at line 122 of file vtkSortFileNames.h.

int vtkSortFileNames::SkipDirectories

protected

Definition at line 123 of file vtkSortFileNames.h.

vtkTimeStamp vtkSortFileNames::UpdateTime

protected

Definition at line 125 of file vtkSortFileNames.h.

vtkStringArray* vtkSortFileNames::InputFileNames

protected

Definition at line 127 of file vtkSortFileNames.h.

vtkStringArray* vtkSortFileNames::FileNames

protected

Definition at line 128 of file vtkSortFileNames.h.

vtkStringArrayVector* vtkSortFileNames::Groups

protected

Definition at line 129 of file vtkSortFileNames.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Core/vtkSortFileNames.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation