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

#include <itkDICOMSeriesFileNames.h>

Inheritance diagram for itk::DICOMSeriesFileNames:

[legend]

Collaboration diagram for itk::DICOMSeriesFileNames:

[legend]

List of all members.

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.


enum	FileNameSortingOrderType { SortByImageNumber, SortBySliceLocation, SortByImagePositionPatient }
	itkGetEnumMacro (FileNameSortingOrder, FileNameSortingOrderType)
	itkSetEnumMacro (FileNameSortingOrder, FileNameSortingOrderType)
void	SetFileNameSortingOrderToSortByImageNumber ()
void	SetFileNameSortingOrderToSortByImagePositionPatient ()
void	SetFileNameSortingOrderToSortBySliceLocation ()
Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef DICOMSeriesFileNames	Self
typedef Object	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
std::string	GetFileName (const std::string &instanceUID)
const std::vector< std::string > &	GetFileNames (const std::string &seriesUID, bool recursive=false)
const std::vector< std::string > &	GetFileNames (bool recursive=false)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
const std::vector< std::string > &	GetSeriesUIDs (bool recursive=false)
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

virtual void	AscendingOff ()
virtual void	AscendingOn ()
virtual bool	GetAscending ()
virtual const char *	GetDirectory () const
virtual void	SetAscending (bool _arg)
void	SetDirectory (const std::string &dir)

const std::vector< std::string > &	GetSeriesBodyParts ()
const std::vector< std::string > &	GetSeriesDescriptions ()
const std::vector< std::string > &	GetSeriesScanOptions ()
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
	DICOMSeriesFileNames ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
	~DICOMSeriesFileNames ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

typedef SmartPointer<const Self> itk::Object::ConstPointer [inherited]

Reimplemented from itk::LightObject.

Definition at line 51 of file itkObject.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

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.

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.

Enumerator:

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.

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

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

Get the directory containing the DICOM files.

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

Get the directory containing the DICOM files.

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

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

Get the directory containing the DICOM files.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

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.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

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.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

itk::DICOMSeriesFileNames::itkGetEnumMacro	(	FileNameSortingOrder	,
		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.

itk::DICOMSeriesFileNames::itkSetEnumMacro	(	FileNameSortingOrder	,
		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.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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

Method for creation through the object factory.

Reimplemented from itk::Object.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print(), and itk::SmartPointer< itk::MutualInformationImageToImageMetric >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

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::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

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

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

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

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.

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.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Referenced by itk::SmartPointer< itk::MutualInformationImageToImageMetric >::operator=().

Member Data Documentation

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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

itkDICOMSeriesFileNames.h

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

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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