#include <itkGDCMSeriesFileNames.h>

Inheritance diagram for itk::GDCMSeriesFileNames:

Collaboration diagram for itk::GDCMSeriesFileNames:

Public Types
typedef SmartPointer< Self >	Pointer
typedef GDCMSeriesFileNames	Self
typedef ProcessObject	Superclass
Public Member Functions
void	AddSeriesRestriction (const std::string &tag)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const FilenamesContainer &	GetFileNames (const std::string serie)
const FilenamesContainer &	GetInputFileNames ()
virtual const char *	GetNameOfClass () const
const FilenamesContainer &	GetOutputFileNames ()
gdcm::SerieHelper *	GetSeriesHelper (void)
const SerieUIDContainer &	GetSeriesUIDs ()
bool	GetUseSeriesDetails (void)
void	SetDirectory (std::string const &name)
void	SetInputDirectory (const char *name)
void	SetInputDirectory (std::string const &name)
void	SetUseSeriesDetails (bool useSeriesDetails)

void	SetOutputDirectory (std::string const &name)

virtual void	SetRecursive (bool _arg)
virtual bool	GetRecursive () const
virtual void	RecursiveOn ()
virtual void	RecursiveOff ()

virtual void	SetLoadSequences (bool _arg)
virtual bool	GetLoadSequences () const
virtual void	LoadSequencesOn ()
virtual void	LoadSequencesOff ()
Static Public Member Functions
static Pointer	New ()
Private Member Functions
	GDCMSeriesFileNames (const Self &)
void	operator= (const Self &)
Private Attributes
std::string	m_InputDirectory
FilenamesContainer	m_InputFileNames
bool	m_LoadPrivateTags
bool	m_LoadSequences
std::string	m_OutputDirectory
FilenamesContainer	m_OutputFileNames
bool	m_Recursive
gdcm::SerieHelper *	m_SerieHelper
SerieUIDContainer	m_SeriesUIDs
bool	m_UseSeriesDetails
virtual void	SetLoadPrivateTags (bool _arg)
virtual bool	GetLoadPrivateTags () const
virtual void	LoadPrivateTagsOn ()
virtual void	LoadPrivateTagsOff ()
	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 53 of file itkGDCMSeriesFileNames.h.

Member Typedef Documentation

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

Reimplemented from itk::ProcessObject.

Definition at line 59 of file itkGDCMSeriesFileNames.h.

typedef GDCMSeriesFileNames itk::GDCMSeriesFileNames::Self

Standard class typedefs.

Reimplemented from itk::ProcessObject.

Definition at line 57 of file itkGDCMSeriesFileNames.h.

typedef ProcessObject itk::GDCMSeriesFileNames::Superclass

Reimplemented from itk::ProcessObject.

Definition at line 58 of file itkGDCMSeriesFileNames.h.

Constructor & Destructor Documentation

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

Parse any private tags in the DICOM file. Defaults to false to skip private tags. This makes loading DICOM files faster when private tags are not needed.

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

Parse any private tags in the DICOM file. Defaults to false to skip private tags. This makes loading DICOM files faster when private tags are not needed.

itk::GDCMSeriesFileNames::GDCMSeriesFileNames ( const Self & ) [private]

Member Function Documentation

void itk::GDCMSeriesFileNames::AddSeriesRestriction ( const std::string & tag ) [inline]

Add more restriction on the selection of a Series. This follow the same approach as SetUseSeriesDetails, but allow a user to add even more DICOM tags to take into account for subrefining a set of DICOM files into multiple series. Format for tag is "group|element" of a DICOM tag.

Warning:: User need to set SetUseSeriesDetails(true)

Definition at line 154 of file itkGDCMSeriesFileNames.h.

virtual::itk::LightObject::Pointer itk::GDCMSeriesFileNames::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.

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 bool itk::GDCMSeriesFileNames::GetLoadPrivateTags ( ) const [virtual]

Parse any private tags in the DICOM file. Defaults to false to skip private tags. This makes loading DICOM files faster when private tags are not needed.

virtual bool itk::GDCMSeriesFileNames::GetLoadSequences ( ) const [virtual]

Parse any sequences in the DICOM file. Defaults to false to skip sequences. This makes loading DICOM files faster when sequences are not needed.

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

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

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 writing has changed 3rd position or some other DICOM tag in the header

virtual bool itk::GDCMSeriesFileNames::GetRecursive ( ) const [virtual]

Recursively parse the input directory

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 143 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 132 of file itkGDCMSeriesFileNames.h.

virtual void itk::GDCMSeriesFileNames::LoadPrivateTagsOff ( ) [virtual]

Parse any private tags in the DICOM file. Defaults to false to skip private tags. This makes loading DICOM files faster when private tags are not needed.

virtual void itk::GDCMSeriesFileNames::LoadPrivateTagsOn ( ) [virtual]

Parse any private tags in the DICOM file. Defaults to false to skip private tags. This makes loading DICOM files faster when private tags are not needed.

virtual void itk::GDCMSeriesFileNames::LoadSequencesOff ( ) [virtual]

Parse any sequences in the DICOM file. Defaults to false to skip sequences. This makes loading DICOM files faster when sequences are not needed.

virtual void itk::GDCMSeriesFileNames::LoadSequencesOn ( ) [virtual]

Parse any sequences in the DICOM file. Defaults to false to skip sequences. This makes loading DICOM files faster when sequences are not needed.

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

Method for creation through the object factory.

Reimplemented from itk::Object.

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

Time when GenerateOutputInformation was last called.

Reimplemented from itk::ProcessObject.

void itk::GDCMSeriesFileNames::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

Parse any private tags in the DICOM file. Defaults to false to skip private tags. This makes loading DICOM files faster when private tags are not needed.

Reimplemented from itk::ProcessObject.

virtual void itk::GDCMSeriesFileNames::RecursiveOff ( ) [virtual]

Recursively parse the input directory

virtual void itk::GDCMSeriesFileNames::RecursiveOn ( ) [virtual]

Recursively parse the input directory

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

Set the directory that contains the DICOM series.

Definition at line 76 of file itkGDCMSeriesFileNames.h.

void itk::GDCMSeriesFileNames::SetInputDirectory ( const char * name )

Set the directory that contains the DICOM series.

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

Set the directory that contains the DICOM series.

virtual void itk::GDCMSeriesFileNames::SetLoadPrivateTags ( bool _arg ) [virtual]

Parse any private tags in the DICOM file. Defaults to false to skip private tags. This makes loading DICOM files faster when private tags are not needed.

virtual void itk::GDCMSeriesFileNames::SetLoadSequences ( bool _arg ) [virtual]

Parse any sequences in the DICOM file. Defaults to false to skip sequences. This makes loading DICOM files faster when sequences are not needed.

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

Set the directory where the output DICOM serie should be written.

Definition at line 87 of file itkGDCMSeriesFileNames.h.

virtual void itk::GDCMSeriesFileNames::SetRecursive ( bool _arg ) [virtual]

Recursively parse the input directory

void itk::GDCMSeriesFileNames::SetUseSeriesDetails ( bool useSeriesDetails )

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