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

Generate a sequence of filenames from a DICOM series. More...

#include <itkGDCMSeriesFileNames.h>

Inheritance diagram for itk::GDCMSeriesFileNames:

[legend]Collaboration diagram for itk::GDCMSeriesFileNames:

[legend]List of all members.

Public Types
typedef GDCMSeriesFileNames	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
Public Member Functions
virtual const char *	GetNameOfClass () const
void	SetInputDirectory (std::string const &name)
void	SetDirectory (std::string const &name)
const FilenamesContainer &	GetInputFileNames ()
const FilenamesContainer &	GetOutputFileNames ()
const FilenamesContainer &	GetFileNames (const std::string serie)
const SerieUIDContainer &	GetSeriesUIDs ()
bool	GetUseSeriesDetails (void)
gdcm::SerieHelper *	GetSeriesHelper (void)
void	SetInputDirectory (const char *name)
void	SetOutputDirectory (std::string const &name)
void	SetUseSeriesDetails (bool useSeriesDetails)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	GDCMSeriesFileNames ()
	~GDCMSeriesFileNames ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

Generate a sequence of filenames from a DICOM series.

This class generate a sequence of files whose filenames points to a DICOM file. The ordering is based on the following strategy: Read all images in the directory (assuming there is only one study/serie)

1. Extract Image Orientation & Image Position from DICOM images, and then calculate the ordering based on the 3D coordinate of the slice 2. If for some reason this information is not found or failed, another strategy is used: the ordering is based on 'Image Number' 3. If this strategy also failed, then the filenames are ordered by lexicographical order.

If multiple volumes are being grouped as a single series for your dicom objects, you may want to try calling ->SetUseSeriesDetails(true) prior to calling SetDirectory().

Definition at line 52 of file itkGDCMSeriesFileNames.h.

---

Member Typedef Documentation

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

Reimplemented from itk::Object. Definition at line 58 of file itkGDCMSeriesFileNames.h.

typedef GDCMSeriesFileNames itk::GDCMSeriesFileNames::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 56 of file itkGDCMSeriesFileNames.h.

typedef Object itk::GDCMSeriesFileNames::Superclass

Reimplemented from itk::Object. Definition at line 57 of file itkGDCMSeriesFileNames.h.

---

Constructor & Destructor Documentation

itk::GDCMSeriesFileNames::GDCMSeriesFileNames (   )  [protected]

itk::GDCMSeriesFileNames::~GDCMSeriesFileNames (   )  [protected]

---

Member Function Documentation

const FilenamesContainer& itk::GDCMSeriesFileNames::GetFileNames (  const std::string  serie  )

Returns a vector containing the series' file names. The file names are ordered by the strategy define in header. All DICOM files have the same exact UID equal to the one user's specified. An extended UID may be returned/used if SetUseSeriesDetails(true) has been called.

const FilenamesContainer& itk::GDCMSeriesFileNames::GetInputFileNames (   )

Returns a vector containing the series' file names. The file names are ordered by the strategy define in header. No sorting is done based on UID

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

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

const FilenamesContainer& itk::GDCMSeriesFileNames::GetOutputFileNames (   )

Returns a vector containing the series' file names. The file names are ordered in the same extact order as the input one. This could be dangerous if the writting has change 3d position or some other DICOM tag in the header

gdcm::SerieHelper* itk::GDCMSeriesFileNames::GetSeriesHelper (  void   )  [inline]

Returns a pointer to the SeriesHelper class. This access allows the files as gdcm dicom objects in a series to be queried for dicom tag values prior to reading the series. Such querying is useful to determine which series should be read - e.g., to determine which is the T2 scan, etc. Definition at line 150 of file itkGDCMSeriesFileNames.h.

const SerieUIDContainer& itk::GDCMSeriesFileNames::GetSeriesUIDs (   )

Returns a vector containing all the UIDs found when parsing the direcory specified via SetDirectory. If no direcory is specified return an empty vector. An extended UID may be returned/used if SetUseSeriesDetails(true) has been called.

bool itk::GDCMSeriesFileNames::GetUseSeriesDetails (  void   )  [inline]

Returns true if using additional series information such as ProtocolName and SeriesName to identify when a single SeriesUID contains multiple 3D volumes - as can occur with perfusion and DTI imaging Definition at line 139 of file itkGDCMSeriesFileNames.h.

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

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

void itk::GDCMSeriesFileNames::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::GDCMSeriesFileNames::SetDirectory (  std::string const &  name  )  [inline]

Set the directory that contains the DICOM series. Definition at line 84 of file itkGDCMSeriesFileNames.h.

void itk::GDCMSeriesFileNames::SetInputDirectory (  std::string const &  name  )

Set the directory that contains the DICOM series.

void itk::GDCMSeriesFileNames::SetInputDirectory (  const char *  name  )  [inline]

Set the directory that contains the DICOM series. Definition at line 69 of file itkGDCMSeriesFileNames.h. References itkExceptionMacro.

void itk::GDCMSeriesFileNames::SetOutputDirectory (  std::string const &  name  )  [inline]

Set the directory where the output DICOM serie should be written. Definition at line 95 of file itkGDCMSeriesFileNames.h.

void itk::GDCMSeriesFileNames::SetUseSeriesDetails (  bool  useSeriesDetails  )  [inline]

Use additional series information such as ProtocolName and SeriesName to identify when a single SeriesUID contains multiple 3D volumes - as can occur with perfusion and DTI imaging Definition at line 128 of file itkGDCMSeriesFileNames.h.

---

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

• itkGDCMSeriesFileNames.h

---