ITK 6.0.0
Insight Toolkit
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Attributes | List of all members
itk::IPLFileNameList Class Reference
Group IO » Module ITKIOIPL

#include <itkIPLFileNameList.h>

Detailed Description

– stores filename+info to be enumerated for IPLCommonImageIO

Definition at line 116 of file itkIPLFileNameList.h.

+ Collaboration diagram for itk::IPLFileNameList:

Public Types

enum  {
  SortGlobalAscend = 0 ,
  SortGlobalDescend = 1 ,
  SortByNameAscend = 2 ,
  SortByNameDescend = 3
}
 
using IteratorType = ListType::iterator
 
using ListSizeType = vcl_size_t
 
using ListType = std::vector<IPLFileSortInfo *>
 

Public Member Functions

bool AddElementToList (const char *const filename, const float sliceLocation, const int offset, const int XDim, const int YDim, const float XRes, const float YRes, const int imageNumber, const int Key1, const int Key2)
 
IteratorType begin ()
 
IteratorType end ()
 
ListSizeType GetnumImageInfoStructs () const
 
 IPLFileNameList ()
 
 IPLGetMacroDeclaration (Key1, int)
 
 IPLGetMacroDeclaration (Key2, int)
 
 IPLGetMacroDeclaration (XDim, int)
 
 IPLGetMacroDeclaration (XRes, float)
 
 IPLGetMacroDeclaration (YDim, int)
 
 IPLGetMacroDeclaration (YRes, float)
 
 IPLSetMacroDeclaration (Key1, int)
 
 IPLSetMacroDeclaration (Key2, int)
 
 IPLSetMacroDeclaration (SortOrder, int)
 
 IPLSetMacroDeclaration (XDim, int)
 
 IPLSetMacroDeclaration (XRes, float)
 
 IPLSetMacroDeclaration (YDim, int)
 
 IPLSetMacroDeclaration (YRes, float)
 
ListSizeType NumFiles () const
 
IPLFileSortInfo * operator[] (unsigned int __n)
 
void RemoveElementFromList (const int ElementToRemove)
 
void sortImageList ()
 
void sortImageListAscend ()
 
void sortImageListDescend ()
 
virtual ~IPLFileNameList ()
 

Private Attributes

int m_Key1 {}
 
int m_Key2 {}
 
ListType m_List {}
 
int m_SortOrder {}
 
int m_XDim {}
 
float m_XRes {}
 
int m_YDim {}
 
float m_YRes {}
 

Member Typedef Documentation

◆ IteratorType

using itk::IPLFileNameList::IteratorType = ListType::iterator

Definition at line 120 of file itkIPLFileNameList.h.

◆ ListSizeType

using itk::IPLFileNameList::ListSizeType = vcl_size_t

Definition at line 121 of file itkIPLFileNameList.h.

◆ ListType

using itk::IPLFileNameList::ListType = std::vector<IPLFileSortInfo *>

Definition at line 119 of file itkIPLFileNameList.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SortGlobalAscend 
SortGlobalDescend 
SortByNameAscend 
SortByNameDescend 

Definition at line 123 of file itkIPLFileNameList.h.

Constructor & Destructor Documentation

◆ IPLFileNameList()

itk::IPLFileNameList::IPLFileNameList ( )
inline

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

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

Definition at line 131 of file itkIPLFileNameList.h.

References m_SortOrder, and SortGlobalAscend.

◆ ~IPLFileNameList()

virtual itk::IPLFileNameList::~IPLFileNameList ( )
virtual

Member Function Documentation

◆ AddElementToList()

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

Definition at line 177 of file itkIPLFileNameList.h.

References begin(), end(), m_Key1, m_Key2, m_List, m_XDim, m_XRes, m_YDim, m_YRes, and itk::Math::NotAlmostEquals().

◆ begin()

IteratorType itk::IPLFileNameList::begin ( )
inline

Definition at line 143 of file itkIPLFileNameList.h.

References m_List.

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

◆ end()

IteratorType itk::IPLFileNameList::end ( )
inline

Definition at line 149 of file itkIPLFileNameList.h.

References m_List.

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

◆ GetnumImageInfoStructs()

ListSizeType itk::IPLFileNameList::GetnumImageInfoStructs ( ) const
inlinenodiscard

Definition at line 257 of file itkIPLFileNameList.h.

References m_List.

◆ IPLGetMacroDeclaration() [1/6]

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

◆ IPLGetMacroDeclaration() [2/6]

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

◆ IPLGetMacroDeclaration() [3/6]

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

◆ IPLGetMacroDeclaration() [4/6]

itk::IPLFileNameList::IPLGetMacroDeclaration ( XRes ,
float  )

◆ IPLGetMacroDeclaration() [5/6]

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

◆ IPLGetMacroDeclaration() [6/6]

itk::IPLFileNameList::IPLGetMacroDeclaration ( YRes ,
float  )

◆ IPLSetMacroDeclaration() [1/7]

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

◆ IPLSetMacroDeclaration() [2/7]

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

◆ IPLSetMacroDeclaration() [3/7]

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

◆ IPLSetMacroDeclaration() [4/7]

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

◆ IPLSetMacroDeclaration() [5/7]

itk::IPLFileNameList::IPLSetMacroDeclaration ( XRes ,
float  )

◆ IPLSetMacroDeclaration() [6/7]

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

◆ IPLSetMacroDeclaration() [7/7]

itk::IPLFileNameList::IPLSetMacroDeclaration ( YRes ,
float  )

◆ NumFiles()

ListSizeType itk::IPLFileNameList::NumFiles ( ) const
inlinenodiscard

Definition at line 171 of file itkIPLFileNameList.h.

References m_List.

◆ operator[]()

IPLFileSortInfo * itk::IPLFileNameList::operator[] ( unsigned int __n)
inline

Definition at line 155 of file itkIPLFileNameList.h.

References begin(), and end().

◆ RemoveElementFromList()

void itk::IPLFileNameList::RemoveElementFromList ( const int ElementToRemove)
inline

Definition at line 228 of file itkIPLFileNameList.h.

References m_List.

◆ sortImageList()

void itk::IPLFileNameList::sortImageList ( )

◆ sortImageListAscend()

void itk::IPLFileNameList::sortImageListAscend ( )

◆ sortImageListDescend()

void itk::IPLFileNameList::sortImageListDescend ( )

Member Data Documentation

◆ m_Key1

int itk::IPLFileNameList::m_Key1 {}
private

Definition at line 282 of file itkIPLFileNameList.h.

Referenced by AddElementToList().

◆ m_Key2

int itk::IPLFileNameList::m_Key2 {}
private

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

Definition at line 284 of file itkIPLFileNameList.h.

Referenced by AddElementToList().

◆ m_List

ListType itk::IPLFileNameList::m_List {}
private

Definition at line 277 of file itkIPLFileNameList.h.

Referenced by AddElementToList(), begin(), end(), GetnumImageInfoStructs(), NumFiles(), and RemoveElementFromList().

◆ m_SortOrder

int itk::IPLFileNameList::m_SortOrder {}
private

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

Definition at line 286 of file itkIPLFileNameList.h.

Referenced by IPLFileNameList().

◆ m_XDim

int itk::IPLFileNameList::m_XDim {}
private

Definition at line 278 of file itkIPLFileNameList.h.

Referenced by AddElementToList().

◆ m_XRes

float itk::IPLFileNameList::m_XRes {}
private

Definition at line 280 of file itkIPLFileNameList.h.

Referenced by AddElementToList().

◆ m_YDim

int itk::IPLFileNameList::m_YDim {}
private

Definition at line 279 of file itkIPLFileNameList.h.

Referenced by AddElementToList().

◆ m_YRes

float itk::IPLFileNameList::m_YRes {}
private

Definition at line 281 of file itkIPLFileNameList.h.

Referenced by AddElementToList().

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