ITK 6.0.0
Insight Toolkit
 
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::GDCMSeriesFileNames Class Reference
Data Processing Objects » Filters » Input and Output Filters | Group IO » Module ITKIOGDCM

#include <itkGDCMSeriesFileNames.h>

Detailed Description

Generate a sequence of filenames from a DICOM series.

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

  1. Extract Image Orientation & Image Position from DICOM images, and then calculate the ordering based on the 3D coordinate of the slice.
  2. If the geometric ordering fails (duplicate positions, inconsistent orientation), an exception is thrown by default; see FailOnAmbiguousOrdering. When FailOnAmbiguousOrdering is false, the ordering falls back to 'Instance Number' when unique, else to lexicographic filename 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().

Examples
Examples/IO/DicomSeriesReadGaussianImageWrite.cxx, Examples/IO/DicomSeriesReadImageWrite2.cxx, Examples/IO/DicomSeriesReadPrintTags.cxx, and Examples/IO/DicomSeriesReadSeriesWrite.cxx.

Definition at line 60 of file itkGDCMSeriesFileNames.h.

+ Inheritance diagram for itk::GDCMSeriesFileNames:
+ Collaboration diagram for itk::GDCMSeriesFileNames:

Classes

struct  SeriesEntry
 

Public Types

using FileNamesContainerType = FilenamesContainer
 
using Pointer = SmartPointer<Self>
 
using Self = GDCMSeriesFileNames
 
using SeriesUIDContainerType = SerieUIDContainer
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer<const Self>
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector<DataObjectPointer>
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using NameArray = std::vector<DataObjectIdentifierType>
 
using Pointer = SmartPointer<Self>
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer<const Self>
 
using Pointer = SmartPointer<Self>
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer<const Self>
 
using Pointer = SmartPointer<Self>
 
using Self = LightObject
 

Public Member Functions

void AddSeriesRestriction (const std::string &tag)
 
virtual::itk::LightObject::Pointer CreateAnother () const
 
const FileNamesContainerType & GetFileNames (const std::string serie)
 
const FileNamesContainerType & GetInputFileNames ()
 
virtual const char * GetNameOfClass () const
 
const FileNamesContainerType & GetOutputFileNames ()
 
const SeriesUIDContainerType & GetSeriesUIDs ()
 
bool GetUseSeriesDetails () const
 
void SetDirectory (const std::string &name)
 
void SetInputDirectory (const char *name)
 
void SetInputDirectory (const std::string &name)
 
void SetOutputDirectory (const std::string &name)
 
void SetUseSeriesDetails (bool useSeriesDetails)
 
virtual void SetRecursive (bool _arg)
 
virtual bool GetRecursive () const
 
virtual void RecursiveOn ()
 
virtual void RecursiveOff ()
 
virtual void SetFailOnAmbiguousOrdering (bool _arg)
 
virtual bool GetFailOnAmbiguousOrdering () const
 
virtual void FailOnAmbiguousOrderingOn ()
 
virtual void FailOnAmbiguousOrderingOff ()
 
virtual void SetLoadSequences (bool _arg)
 
virtual bool GetLoadSequences () const
 
virtual void LoadSequencesOn ()
 
virtual void LoadSequencesOff ()
 
virtual void SetLoadPrivateTags (bool _arg)
 
virtual bool GetLoadPrivateTags () const
 
virtual void LoadPrivateTagsOn ()
 
virtual void LoadPrivateTagsOff ()
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *output)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderBase * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderBase *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
 itkVirtualSetClampMacro (NumberOfWorkUnits, ThreadIdType, 1, ITK_MAX_THREADS)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 GDCMSeriesFileNames ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GDCMSeriesFileNames () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

void BuildSeriesMap ()
 
void OrderSeries (SeriesEntry &entry)
 

Private Attributes

TimeStamp m_CacheBuildTime {}
 
bool m_FailOnAmbiguousOrdering = true
 
std::string m_InputDirectory = ""
 
FileNamesContainerType m_InputFileNames {}
 
std::map< std::string, std::string > m_InstanceNumbers {}
 
bool m_LoadPrivateTags = false
 
bool m_LoadSequences = false
 
std::string m_OutputDirectory = ""
 
FileNamesContainerType m_OutputFileNames {}
 
bool m_Recursive = false
 
std::map< std::string, SeriesEntry > m_SeriesFiles {}
 
SeriesUIDContainerType m_SeriesUIDs {}
 
std::vector< std::pair< unsigned short, unsigned short > > m_UserRefineTags {}
 
bool m_UseSeriesDetails = false
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject>
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ FileNamesContainerType

using itk::GDCMSeriesFileNames::FileNamesContainerType = FilenamesContainer

Type of the container that holds the file names in the series.

Definition at line 71 of file itkGDCMSeriesFileNames.h.

◆ Pointer

using itk::GDCMSeriesFileNames::Pointer = SmartPointer<Self>

Definition at line 68 of file itkGDCMSeriesFileNames.h.

◆ Self

using itk::GDCMSeriesFileNames::Self = GDCMSeriesFileNames

Standard class type aliases.

Definition at line 66 of file itkGDCMSeriesFileNames.h.

◆ SeriesUIDContainerType

using itk::GDCMSeriesFileNames::SeriesUIDContainerType = SerieUIDContainer

Type of the container that holds the UID's for the series.

Definition at line 74 of file itkGDCMSeriesFileNames.h.

◆ Superclass

using itk::GDCMSeriesFileNames::Superclass = ProcessObject

Definition at line 67 of file itkGDCMSeriesFileNames.h.

Constructor & Destructor Documentation

◆ GDCMSeriesFileNames()

itk::GDCMSeriesFileNames::GDCMSeriesFileNames ( )
protected

Referenced by GetNameOfClass().

◆ ~GDCMSeriesFileNames()

itk::GDCMSeriesFileNames::~GDCMSeriesFileNames ( )
overrideprotected

Member Function Documentation

◆ AddSeriesRestriction()

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

Add more restriction on the selection of a Series. This follows the same approach as SetUseSeriesDetails, but allows a user to add even more DICOM tags to take into account for subrefining a set of DICOM files into multiple series. The tag format is "group|element" of a DICOM tag. Call order relative to SetUseSeriesDetails does not matter.

Warning
UseSeriesDetails needs to be set to true.

◆ BuildSeriesMap()

void itk::GDCMSeriesFileNames::BuildSeriesMap ( )
private

Parse the input directory into the per-series file-name map.

◆ CreateAnother()

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

◆ FailOnAmbiguousOrderingOff()

virtual void itk::GDCMSeriesFileNames::FailOnAmbiguousOrderingOff ( )
virtual

Throw an exception when a series cannot be ordered geometrically by gdcm::IPPSorter (duplicate ImagePositionPatient, inconsistent orientation). When false, fall back to the legacy SerieHelper heuristics: Instance Number when unique, else lexicographic filename order. The fallback is not DICOM-standards conforming and its output should not be trusted; it exists only for backward compatibility.

◆ FailOnAmbiguousOrderingOn()

virtual void itk::GDCMSeriesFileNames::FailOnAmbiguousOrderingOn ( )
virtual

Throw an exception when a series cannot be ordered geometrically by gdcm::IPPSorter (duplicate ImagePositionPatient, inconsistent orientation). When false, fall back to the legacy SerieHelper heuristics: Instance Number when unique, else lexicographic filename order. The fallback is not DICOM-standards conforming and its output should not be trusted; it exists only for backward compatibility.

◆ GetFailOnAmbiguousOrdering()

virtual bool itk::GDCMSeriesFileNames::GetFailOnAmbiguousOrdering ( ) const
virtual

Throw an exception when a series cannot be ordered geometrically by gdcm::IPPSorter (duplicate ImagePositionPatient, inconsistent orientation). When false, fall back to the legacy SerieHelper heuristics: Instance Number when unique, else lexicographic filename order. The fallback is not DICOM-standards conforming and its output should not be trusted; it exists only for backward compatibility.

◆ GetFileNames()

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

◆ GetInputFileNames()

const FileNamesContainerType & 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

◆ GetLoadPrivateTags()

virtual bool itk::GDCMSeriesFileNames::GetLoadPrivateTags ( ) const
virtual

No effect with the gdcm::Scanner backend (retained for source compatibility). Series enumeration reads only the grouping and ordering tags, so private tags are never parsed during the scan.

◆ GetLoadSequences()

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

No effect with the gdcm::Scanner backend (retained for source compatibility). Series enumeration reads only the grouping and ordering tags, so sequences are never parsed during the scan.

◆ GetNameOfClass()

virtual const char * itk::GDCMSeriesFileNames::GetNameOfClass ( ) const
virtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

References GDCMSeriesFileNames().

◆ GetOutputFileNames()

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

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

◆ GetRecursive()

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

Recursively parse the input directory. Must be set before the call to SetInputDirectory().

◆ GetSeriesUIDs()

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

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

◆ GetUseSeriesDetails()

bool itk::GDCMSeriesFileNames::GetUseSeriesDetails ( ) const
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 160 of file itkGDCMSeriesFileNames.h.

References m_UseSeriesDetails.

◆ LoadPrivateTagsOff()

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

No effect with the gdcm::Scanner backend (retained for source compatibility). Series enumeration reads only the grouping and ordering tags, so private tags are never parsed during the scan.

◆ LoadPrivateTagsOn()

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

No effect with the gdcm::Scanner backend (retained for source compatibility). Series enumeration reads only the grouping and ordering tags, so private tags are never parsed during the scan.

◆ LoadSequencesOff()

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

No effect with the gdcm::Scanner backend (retained for source compatibility). Series enumeration reads only the grouping and ordering tags, so sequences are never parsed during the scan.

◆ LoadSequencesOn()

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

No effect with the gdcm::Scanner backend (retained for source compatibility). Series enumeration reads only the grouping and ordering tags, so sequences are never parsed during the scan.

◆ New()

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

Method for creation through the object factory.

◆ OrderSeries()

void itk::GDCMSeriesFileNames::OrderSeries ( SeriesEntry & entry)
private

Order one series geometrically, or apply the legacy fallback / throw per FailOnAmbiguousOrdering.

◆ PrintSelf()

void itk::GDCMSeriesFileNames::PrintSelf ( std::ostream & os,
Indent indent ) const
overrideprotectedvirtual

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

◆ RecursiveOff()

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

Recursively parse the input directory. Must be set before the call to SetInputDirectory().

◆ RecursiveOn()

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

Recursively parse the input directory. Must be set before the call to SetInputDirectory().

◆ SetDirectory()

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

Set the directory that contains the DICOM series.

Definition at line 94 of file itkGDCMSeriesFileNames.h.

References SetInputDirectory().

◆ SetFailOnAmbiguousOrdering()

virtual void itk::GDCMSeriesFileNames::SetFailOnAmbiguousOrdering ( bool _arg)
virtual

Throw an exception when a series cannot be ordered geometrically by gdcm::IPPSorter (duplicate ImagePositionPatient, inconsistent orientation). When false, fall back to the legacy SerieHelper heuristics: Instance Number when unique, else lexicographic filename order. The fallback is not DICOM-standards conforming and its output should not be trusted; it exists only for backward compatibility.

◆ SetInputDirectory() [1/2]

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

Set the directory that contains the DICOM series.

Referenced by SetDirectory().

◆ SetInputDirectory() [2/2]

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

Set the directory that contains the DICOM series.

◆ SetLoadPrivateTags()

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

No effect with the gdcm::Scanner backend (retained for source compatibility). Series enumeration reads only the grouping and ordering tags, so private tags are never parsed during the scan.

◆ SetLoadSequences()

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

No effect with the gdcm::Scanner backend (retained for source compatibility). Series enumeration reads only the grouping and ordering tags, so sequences are never parsed during the scan.

◆ SetOutputDirectory()

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

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

Definition at line 107 of file itkGDCMSeriesFileNames.h.

References m_OutputDirectory, and itk::Object::Modified().

◆ SetRecursive()

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

Recursively parse the input directory. Must be set before the call to SetInputDirectory().

◆ SetUseSeriesDetails()

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. Off by default: series are identified by their SeriesInstanceUID (0020,000e) alone, per the DICOM information model.

Member Data Documentation

◆ m_CacheBuildTime

TimeStamp itk::GDCMSeriesFileNames::m_CacheBuildTime {}
private

Modified time of the last directory parse; the cache is rebuilt only when the object has been Modified() since.

Definition at line 252 of file itkGDCMSeriesFileNames.h.

◆ m_FailOnAmbiguousOrdering

bool itk::GDCMSeriesFileNames::m_FailOnAmbiguousOrdering = true
private

Definition at line 258 of file itkGDCMSeriesFileNames.h.

◆ m_InputDirectory

std::string itk::GDCMSeriesFileNames::m_InputDirectory = ""
private

Contains the input directory where the DICOM series is found

Definition at line 214 of file itkGDCMSeriesFileNames.h.

◆ m_InputFileNames

FileNamesContainerType itk::GDCMSeriesFileNames::m_InputFileNames {}
private

Internal structure to keep the list of input/output filenames

Definition at line 220 of file itkGDCMSeriesFileNames.h.

◆ m_InstanceNumbers

std::map<std::string, std::string> itk::GDCMSeriesFileNames::m_InstanceNumbers {}
private

Instance Number (0020,0013) per scanned file, for the legacy fallback.

Definition at line 243 of file itkGDCMSeriesFileNames.h.

◆ m_LoadPrivateTags

bool itk::GDCMSeriesFileNames::m_LoadPrivateTags = false
private

Definition at line 261 of file itkGDCMSeriesFileNames.h.

◆ m_LoadSequences

bool itk::GDCMSeriesFileNames::m_LoadSequences = false
private

Definition at line 260 of file itkGDCMSeriesFileNames.h.

◆ m_OutputDirectory

std::string itk::GDCMSeriesFileNames::m_OutputDirectory = ""
private

Contains the output directory where the DICOM series should be written

Definition at line 217 of file itkGDCMSeriesFileNames.h.

Referenced by SetOutputDirectory().

◆ m_OutputFileNames

FileNamesContainerType itk::GDCMSeriesFileNames::m_OutputFileNames {}
private

Definition at line 221 of file itkGDCMSeriesFileNames.h.

◆ m_Recursive

bool itk::GDCMSeriesFileNames::m_Recursive = false
private

Definition at line 259 of file itkGDCMSeriesFileNames.h.

◆ m_SeriesFiles

std::map<std::string, SeriesEntry> itk::GDCMSeriesFileNames::m_SeriesFiles {}
private

File names per distinct series identifier.

Definition at line 240 of file itkGDCMSeriesFileNames.h.

◆ m_SeriesUIDs

SeriesUIDContainerType itk::GDCMSeriesFileNames::m_SeriesUIDs {}
private

Internal structure to keep the list of series UIDs

Definition at line 255 of file itkGDCMSeriesFileNames.h.

◆ m_UserRefineTags

std::vector<std::pair<unsigned short, unsigned short> > itk::GDCMSeriesFileNames::m_UserRefineTags {}
private

User (group,element) tags from AddSeriesRestriction, appended to the series identifier (after the default detail tags) when UseSeriesDetails is enabled.

Definition at line 248 of file itkGDCMSeriesFileNames.h.

◆ m_UseSeriesDetails

bool itk::GDCMSeriesFileNames::m_UseSeriesDetails = false
private

Definition at line 257 of file itkGDCMSeriesFileNames.h.

Referenced by GetUseSeriesDetails().

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