itk::IPLFileNameList Class Reference

-- stores filename+info to be enumerated for IPLCommonImageIO More...

#include <itkIPLFileNameList.h>

List of all members.

Public Types
enum	{   SortGlobalAscend = 0,   SortGlobalDescend = 1,   SortByNameAscend = 2,   SortByNameDescend = 3 }
typedef ListType::iterator	IteratorType
typedef vcl_size_t	ListSizeType
typedef std::vector < IPLFileSortInfo * >	ListType
Public Member Functions
bool	AddElementToList (char const *const filename, const float sliceLocation, const int offset, const int XDim, const int YDim, const int imageNumber, const int Key1, const int Key2)
IteratorType	begin ()
IteratorType	end ()
ListSizeType	GetnumImageInfoStructs () const
	IPLFileNameList ()
	IPLGetMacro (Key2, int)
	IPLGetMacro (Key1, int)
	IPLGetMacro (YDim, int)
	IPLGetMacro (XDim, int)
	IPLSetMacro (SortOrder, int)
	IPLSetMacro (Key2, int)
	IPLSetMacro (Key1, int)
	IPLSetMacro (YDim, int)
	IPLSetMacro (XDim, int)
ListSizeType	NumFiles () const
IPLFileSortInfo *	operator[] (unsigned int __n)
void	RemoveElementFromList (const int ElementToRemove)
void	sortImageList ()
void	sortImageListAscend ()
void	sortImageListDescend ()
virtual	~IPLFileNameList ()

---

Detailed Description

-- stores filename+info to be enumerated for IPLCommonImageIO

Definition at line 101 of file itkIPLFileNameList.h.

---

Member Typedef Documentation

typedef ListType::iterator itk::IPLFileNameList::IteratorType

Definition at line 105 of file itkIPLFileNameList.h.

typedef vcl_size_t itk::IPLFileNameList::ListSizeType

Definition at line 106 of file itkIPLFileNameList.h.

typedef std::vector<IPLFileSortInfo *> itk::IPLFileNameList::ListType

Definition at line 104 of file itkIPLFileNameList.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

SortGlobalAscend
SortGlobalDescend
SortByNameAscend
SortByNameDescend

Definition at line 108 of file itkIPLFileNameList.h.

---

Constructor & Destructor Documentation

itk::IPLFileNameList::IPLFileNameList

(

)

[inline]

Key that must be matched for image to be used, i.e. seriesNumber, extensionkey

Key that must be matched for image to be used, i.e. echoNumber

Definition at line 116 of file itkIPLFileNameList.h.

References SortGlobalAscend.

virtual itk::IPLFileNameList::~IPLFileNameList

(

)

[inline, virtual]

Definition at line 127 of file itkIPLFileNameList.h.

References begin(), and end().

---

Member Function Documentation

bool itk::IPLFileNameList::AddElementToList	(	char const *const	filename,
		const float	sliceLocation,
		const int	offset,
		const int	XDim,
		const int	YDim,
		const int	imageNumber,
		const int	Key1,
		const int	Key2
	)			[inline]

Definition at line 167 of file itkIPLFileNameList.h.

References begin(), and end().

IteratorType itk::IPLFileNameList::begin

(

)

[inline]

Definition at line 138 of file itkIPLFileNameList.h.

Referenced by AddElementToList(), operator[](), and ~IPLFileNameList().

IteratorType itk::IPLFileNameList::end

(

)

[inline]

Definition at line 143 of file itkIPLFileNameList.h.

Referenced by AddElementToList(), operator[](), and ~IPLFileNameList().

ListSizeType itk::IPLFileNameList::GetnumImageInfoStructs

(

)

const [inline]

Definition at line 232 of file itkIPLFileNameList.h.

itk::IPLFileNameList::IPLGetMacro	(	Key2	,
		int
	)

itk::IPLFileNameList::IPLGetMacro	(	Key1	,
		int
	)

itk::IPLFileNameList::IPLGetMacro	(	YDim	,
		int
	)

itk::IPLFileNameList::IPLGetMacro	(	XDim	,
		int
	)

itk::IPLFileNameList::IPLSetMacro	(	SortOrder	,
		int
	)

itk::IPLFileNameList::IPLSetMacro	(	Key2	,
		int
	)

itk::IPLFileNameList::IPLSetMacro	(	Key1	,
		int
	)

itk::IPLFileNameList::IPLSetMacro	(	YDim	,
		int
	)

itk::IPLFileNameList::IPLSetMacro	(	XDim	,
		int
	)

ListSizeType itk::IPLFileNameList::NumFiles

(

)

const [inline]

Definition at line 162 of file itkIPLFileNameList.h.

IPLFileSortInfo* itk::IPLFileNameList::operator[]

(

unsigned int

__n

)

[inline]

Definition at line 148 of file itkIPLFileNameList.h.

References begin(), and end().

void itk::IPLFileNameList::RemoveElementFromList

(

const int

ElementToRemove

)

[inline]

Definition at line 209 of file itkIPLFileNameList.h.

void itk::IPLFileNameList::sortImageList

(

)

void itk::IPLFileNameList::sortImageListAscend

(

)

void itk::IPLFileNameList::sortImageListDescend

(

)

---

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

• itkIPLFileNameList.h