itk::DICOMSeriesFileNames Class Reference
[Input and Output Filters]

Generate an ordered sequence of filenames. More...

#include <itkDICOMSeriesFileNames.h>

Inheritance diagram for itk::DICOMSeriesFileNames:

[legend]Collaboration diagram for itk::DICOMSeriesFileNames:

[legend]List of all members.

[NOHEADER]
enum	FileNameSortingOrderType { SortByImageNumber, SortBySliceLocation, SortByImagePositionPatient }
virtual void	SetFileNameSortingOrder (FileNameSortingOrderType _arg)
virtual FileNameSortingOrderType	GetFileNameSortingOrder ()
void	SetFileNameSortingOrderToSortByImageNumber ()
void	SetFileNameSortingOrderToSortBySliceLocation ()
void	SetFileNameSortingOrderToSortByImagePositionPatient ()
Public Types
typedef DICOMSeriesFileNames	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
Public Member Functions
virtual const char *	GetNameOfClass () const
const std::vector< std::string > &	GetSeriesUIDs (bool recursive=false)
const std::vector< std::string > &	GetFileNames (bool recursive=false)
const std::vector< std::string > &	GetFileNames (const std::string &seriesUID, bool recursive=false)
std::string	GetFileName (const std::string &instanceUID)
void	SetDirectory (const std::string &dir)
virtual const char *	GetDirectory () const
virtual void	SetAscending (bool _arg)
virtual bool	GetAscending ()
virtual void	AscendingOn ()
virtual void	AscendingOff ()
const std::vector< std::string > &	GetSeriesDescriptions ()
const std::vector< std::string > &	GetSeriesBodyParts ()
const std::vector< std::string > &	GetSeriesScanOptions ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	DICOMSeriesFileNames ()
	~DICOMSeriesFileNames ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

Generate an ordered sequence of filenames.

This class generates an ordered sequence of filenames based on the DICOM tags in the files. Files can be sorted based on image number, slice location, or patient position. The files in the specified directory are grouped by SeriesUID. The list of SeriesUIDs can be queried and the filenames for a specific series extracted.

Definition at line 48 of file itkDICOMSeriesFileNames.h.

---

Member Typedef Documentation

typedef SmartPointer<Self> itk::DICOMSeriesFileNames::Pointer

Reimplemented from itk::Object. Definition at line 54 of file itkDICOMSeriesFileNames.h.

typedef DICOMSeriesFileNames itk::DICOMSeriesFileNames::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 52 of file itkDICOMSeriesFileNames.h. Referenced by ~DICOMSeriesFileNames().

typedef Object itk::DICOMSeriesFileNames::Superclass

Reimplemented from itk::Object. Definition at line 53 of file itkDICOMSeriesFileNames.h.

---

Member Enumeration Documentation

enum itk::DICOMSeriesFileNames::FileNameSortingOrderType

Set the filename sorting order to sorting images based on the DICOM field of slice number, the DICOM field of slice location, or the position of the image computed using the ImagePositionPatient and ImageOrientationPatient DICOM fields. Enumeration values: SortByImageNumber  SortBySliceLocation  SortByImagePositionPatient  Definition at line 133 of file itkDICOMSeriesFileNames.h.

---

Constructor & Destructor Documentation

itk::DICOMSeriesFileNames::DICOMSeriesFileNames (   )  [protected]

itk::DICOMSeriesFileNames::~DICOMSeriesFileNames (   )  [inline, protected]

Definition at line 152 of file itkDICOMSeriesFileNames.h. References Self.

---

Member Function Documentation

virtual void itk::DICOMSeriesFileNames::AscendingOff (   )  [virtual]

The sorting order can be ascending or descending. The default sort order is ascending.

virtual void itk::DICOMSeriesFileNames::AscendingOn (   )  [virtual]

The sorting order can be ascending or descending. The default sort order is ascending.

virtual bool itk::DICOMSeriesFileNames::GetAscending (   )  [virtual]

The sorting order can be ascending or descending. The default sort order is ascending.

virtual const char* itk::DICOMSeriesFileNames::GetDirectory (   )  const [virtual]

Get the directory containing the DICOM files.

std::string itk::DICOMSeriesFileNames::GetFileName (  const std::string &  instanceUID  )

Get the filename associated with a specific instance UID. This requires the internal database has already been built via a call to GetFileNames()

const std::vector<std::string>& itk::DICOMSeriesFileNames::GetFileNames (  const std::string &  seriesUID, bool  recursive = false )

Returns a vector containing the file names for a specified series UID. The file names are sorted based on the current sorting mode. If parameter "recursive" is true, subdirectories will be scanned.

const std::vector<std::string>& itk::DICOMSeriesFileNames::GetFileNames (  bool  recursive = false  )

Returns a vector containing the series' file names. The file names are sorted based on the current sorting mode. If parameter "recursive" is true, subdirectories will be scanned.

virtual FileNameSortingOrderType itk::DICOMSeriesFileNames::GetFileNameSortingOrder (   )  [virtual]

Set the filename sorting order to sorting images based on the DICOM field of slice number, the DICOM field of slice location, or the position of the image computed using the ImagePositionPatient and ImageOrientationPatient DICOM fields.

virtual const char* itk::DICOMSeriesFileNames::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

const std::vector<std::string>& itk::DICOMSeriesFileNames::GetSeriesBodyParts (   )  [inline]

Returns a vector containing the Descriptions for each series in the directory. GetSeriesUIDs() should be called before Definition at line 113 of file itkDICOMSeriesFileNames.h.

const std::vector<std::string>& itk::DICOMSeriesFileNames::GetSeriesDescriptions (   )  [inline]

Returns a vector containing the Descriptions for each series in the directory. GetSeriesUIDs() should be called before Definition at line 112 of file itkDICOMSeriesFileNames.h.

const std::vector<std::string>& itk::DICOMSeriesFileNames::GetSeriesScanOptions (   )  [inline]

Returns a vector containing the Descriptions for each series in the directory. GetSeriesUIDs() should be called before Definition at line 114 of file itkDICOMSeriesFileNames.h.

const std::vector<std::string>& itk::DICOMSeriesFileNames::GetSeriesUIDs (  bool  recursive = false  )

Returns a vector containing the UIDs for each series in the directory. If parameter "recursive" is true, subdirectories will be scanned.

Pointer itk::DICOMSeriesFileNames::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

void itk::DICOMSeriesFileNames::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, 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 itk::Object.

virtual void itk::DICOMSeriesFileNames::SetAscending (  bool  _arg  )  [virtual]

The sorting order can be ascending or descending. The default sort order is ascending.

void itk::DICOMSeriesFileNames::SetDirectory (  const std::string &  dir  )  [inline]

Set the directory containing the DICOM files. DICOMSeriesFileNames caches information about filenames and series UIDs. Calling SetDirectory() causes this information to be cleared. This is the behavior even if SetDirectory() is called with the same directory as the previous call. In this case, a second call to SetDirectory() with the same directory name forces the directory to be rescanned. This is useful if DICOM files have been added to a directory since the last time the directory was scanned. Definition at line 73 of file itkDICOMSeriesFileNames.h.

virtual void itk::DICOMSeriesFileNames::SetFileNameSortingOrder (  FileNameSortingOrderType  _arg  )  [virtual]

Set the filename sorting order to sorting images based on the DICOM field of slice number, the DICOM field of slice location, or the position of the image computed using the ImagePositionPatient and ImageOrientationPatient DICOM fields.

void itk::DICOMSeriesFileNames::SetFileNameSortingOrderToSortByImageNumber (   )  [inline]

Set the filename sorting order to sorting images based on the DICOM field of slice number, the DICOM field of slice location, or the position of the image computed using the ImagePositionPatient and ImageOrientationPatient DICOM fields. Definition at line 136 of file itkDICOMSeriesFileNames.h.

void itk::DICOMSeriesFileNames::SetFileNameSortingOrderToSortByImagePositionPatient (   )  [inline]

Set the filename sorting order to sorting images based on the DICOM field of slice number, the DICOM field of slice location, or the position of the image computed using the ImagePositionPatient and ImageOrientationPatient DICOM fields. Definition at line 140 of file itkDICOMSeriesFileNames.h.

void itk::DICOMSeriesFileNames::SetFileNameSortingOrderToSortBySliceLocation (   )  [inline]

Set the filename sorting order to sorting images based on the DICOM field of slice number, the DICOM field of slice location, or the position of the image computed using the ImagePositionPatient and ImageOrientationPatient DICOM fields. Definition at line 138 of file itkDICOMSeriesFileNames.h.

---

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

• itkDICOMSeriesFileNames.h

---