ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::DICOMSeriesFileNames Class Reference

Generate an ordered sequence of filenames. More...

#include <itkDICOMSeriesFileNames.h>

Inheritance diagram for itk::DICOMSeriesFileNames:
Collaboration diagram for itk::DICOMSeriesFileNames:

List of all members.

Public Types

typedef std::vector< std::string > FileNamesArrayType
typedef SmartPointer< SelfPointer
typedef DICOMSeriesFileNames Self
typedef Object Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
std::string GetFileName (const std::string &instanceUID)
const FileNamesArrayTypeGetFileNames (const std::string &seriesUID, bool recursive=false)
const FileNamesArrayTypeGetFileNames (bool recursive=false)
virtual const char * GetNameOfClass () const
const FileNamesArrayTypeGetSeriesUIDs (bool recursive=false)
void SetDirectory (const std::string &dir)
virtual const char * GetDirectory () const
virtual void SetAscending (bool _arg)
virtual bool GetAscending () const
virtual void AscendingOn ()
virtual void AscendingOff ()
const FileNamesArrayTypeGetSeriesDescriptions ()
const FileNamesArrayTypeGetSeriesBodyParts ()
const FileNamesArrayTypeGetSeriesScanOptions ()

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 DICOMSeriesFileNames ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~DICOMSeriesFileNames ()

Private Member Functions

int CanReadFile (const char *fname)
 DICOMSeriesFileNames (const Self &)
void operator= (const Self &)
void RecurseDirectory (std::string directory, FileNamesArrayType &filenames)

Private Attributes

itkdicomparser::DICOMAppHelper m_AppHelper
bool m_Ascending
FileNamesArrayType m_BodyParts
std::string m_Directory
TimeStamp m_DirectoryScanTime
TimeStamp m_DirectorySetTime
FileNamesArrayType m_FileNames
FileNameSortingOrderType m_FileNameSortingOrder
itkdicomparser::DICOMParser m_Parser
FileNamesArrayType m_ScanOptions
FileNamesArrayType m_SeriesDescriptions
FileNamesArrayType m_SeriesUIDs
enum  FileNameSortingOrderType {
  SortByImageNumber,
  SortBySliceLocation,
  SortByImagePositionPatient
}
virtual void SetFileNameSortingOrder (const FileNameSortingOrderType _arg)
virtual FileNameSortingOrderType GetFileNameSortingOrder () const
void SetFileNameSortingOrderToSortByImageNumber ()
void SetFileNameSortingOrderToSortBySliceLocation ()
void SetFileNameSortingOrderToSortByImagePositionPatient ()

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


Member Typedef Documentation

typedef std::vector< std::string > itk::DICOMSeriesFileNames::FileNamesArrayType

Type of the array used for returning filenames

Definition at line 100 of file itkDICOMSeriesFileNames.h.

Reimplemented from itk::Object.

Definition at line 52 of file itkDICOMSeriesFileNames.h.

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 50 of file itkDICOMSeriesFileNames.h.

Reimplemented from itk::Object.

Definition at line 51 of file itkDICOMSeriesFileNames.h.


Member Enumeration Documentation

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.

Enumerator:
SortByImageNumber 
SortBySliceLocation 
SortByImagePositionPatient 

Definition at line 134 of file itkDICOMSeriesFileNames.h.


Constructor & Destructor Documentation

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

Definition at line 152 of file itkDICOMSeriesFileNames.h.

itk::DICOMSeriesFileNames::DICOMSeriesFileNames ( const Self ) [private]

Member Function Documentation

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

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.

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

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.

int itk::DICOMSeriesFileNames::CanReadFile ( const char *  fname) [private]
virtual::itk::LightObject::Pointer itk::DICOMSeriesFileNames::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

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

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.

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

const FileNamesArrayType& 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.

virtual FileNameSortingOrderType itk::DICOMSeriesFileNames::GetFileNameSortingOrder ( ) const [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 FileNamesArrayType& itk::DICOMSeriesFileNames::GetSeriesBodyParts ( ) [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 FileNamesArrayType& itk::DICOMSeriesFileNames::GetSeriesDescriptions ( ) [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 FileNamesArrayType& itk::DICOMSeriesFileNames::GetSeriesScanOptions ( ) [inline]

Returns a vector containing the Descriptions for each series in the directory. GetSeriesUIDs() should be called before

Definition at line 115 of file itkDICOMSeriesFileNames.h.

const FileNamesArrayType& 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.

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

Method for creation through the object factory.

Reimplemented from itk::Object.

void itk::DICOMSeriesFileNames::operator= ( const Self ) [private]

Mutex lock to protect modification to the reference count

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.

void itk::DICOMSeriesFileNames::RecurseDirectory ( std::string  directory,
FileNamesArrayType filenames 
) [private]
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 71 of file itkDICOMSeriesFileNames.h.

virtual void itk::DICOMSeriesFileNames::SetFileNameSortingOrder ( const 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 137 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 141 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 139 of file itkDICOMSeriesFileNames.h.


Member Data Documentation

itkdicomparser::DICOMAppHelper itk::DICOMSeriesFileNames::m_AppHelper [private]

Definition at line 164 of file itkDICOMSeriesFileNames.h.

Definition at line 166 of file itkDICOMSeriesFileNames.h.

Definition at line 171 of file itkDICOMSeriesFileNames.h.

Definition at line 167 of file itkDICOMSeriesFileNames.h.

Definition at line 177 of file itkDICOMSeriesFileNames.h.

Definition at line 176 of file itkDICOMSeriesFileNames.h.

Definition at line 168 of file itkDICOMSeriesFileNames.h.

Definition at line 174 of file itkDICOMSeriesFileNames.h.

itkdicomparser::DICOMParser itk::DICOMSeriesFileNames::m_Parser [private]

Definition at line 163 of file itkDICOMSeriesFileNames.h.

Definition at line 172 of file itkDICOMSeriesFileNames.h.

Definition at line 170 of file itkDICOMSeriesFileNames.h.

Definition at line 169 of file itkDICOMSeriesFileNames.h.


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