Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
mitk::DICOMNullFileReader Class Reference

#include <mitkDICOMNullFileReader.h>

Inheritance diagram for mitk::DICOMNullFileReader:
Collaboration diagram for mitk::DICOMNullFileReader:

Public Member Functions

 mitkClassMacro (DICOMNullFileReader, DICOMFileReader)
 
 mitkCloneMacro (DICOMNullFileReader)
 
void AnalyzeInputFiles () override
 Analyze input files. More...
 
bool LoadImages () override
 
bool CanHandleFile (const std::string &filename) override
 Indicate whether this reader can handle given file. More...
 
bool operator== (const DICOMFileReader &other) const override
 
DICOMTagPathList GetTagsOfInterest () const override
 
void SetTagCache (const DICOMTagCache::Pointer &) override
 A way to provide external knowledge about files and tag values is appreciated. More...
 
- Public Member Functions inherited from mitk::DICOMFileReader
 mitkClassMacroItkParent (DICOMFileReader, itk::Object)
 
void SetInputFiles (const StringList &filenames)
 This input files. More...
 
const StringList & GetInputFiles () const
 This input files. More...
 
unsigned int GetNumberOfOutputs () const
 Number of outputs, only meaningful after calling AnalyzeInputFiles() More...
 
const DICOMImageBlockDescriptor & GetOutput (unsigned int index) const
 Individual outputs, only meaningful after calling AnalyzeInputFiles(). More...
 
void SetConfigurationLabel (const std::string &)
 Short label/name to describe this reader. More...
 
std::string GetConfigurationLabel () const
 Short label/name to describe this reader. More...
 
void SetConfigurationDescription (const std::string &)
 One-sentence description of the reader's loading "strategy". More...
 
std::string GetConfigurationDescription () const
 One-sentence description of the reader's loading "strategy". More...
 
void PrintConfiguration (std::ostream &os) const
 Print configuration description to given stream, for human reader. More...
 
void PrintOutputs (std::ostream &os, bool filenameDetails=false) const
 Print output description to given stream, for human reader. More...
 
virtual void SetAdditionalTagsOfInterest (const AdditionalTagsMapType &tagList)
 Set a list of DICOMTagPaths that specifiy all DICOM-Tags that will be copied into the property of the mitk::Image. More...
 
virtual void SetTagLookupTableToPropertyFunctor (mitk::DICOMImageBlockDescriptor::TagLookupTableToPropertyFunctor functor)
 Set a functor that defines how the slice-specific tag-values are stored in a Property. More...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::DICOMFileReader
static bool IsDICOM (const std::string &filename)
 Test whether a file is DICOM at all. More...
 

Protected Member Functions

 DICOMNullFileReader ()
 
 ~DICOMNullFileReader () override
 
 DICOMNullFileReader (const DICOMNullFileReader &other)
 
DICOMNullFileReader & operator= (const DICOMNullFileReader &other)
 
void InternalPrintConfiguration (std::ostream &os) const override
 Configuration description for human reader, to be implemented by sub-classes. More...
 
- Protected Member Functions inherited from mitk::DICOMFileReader
 DICOMFileReader ()
 
 ~DICOMFileReader () override
 
 DICOMFileReader (const DICOMFileReader &other)
 
DICOMFileReader & operator= (const DICOMFileReader &other)
 
void ClearOutputs ()
 
void SetNumberOfOutputs (unsigned int numberOfOutputs)
 
void SetOutput (unsigned int index, const DICOMImageBlockDescriptor &output)
 
DICOMImageBlockDescriptor & InternalGetOutput (unsigned int index)
 non-const access to the DICOMImageBlockDescriptor More...
 
virtual AdditionalTagsMapType GetAdditionalTagsOfInterest () const
 
mitk::DICOMImageBlockDescriptor::TagLookupTableToPropertyFunctor GetTagLookupTableToPropertyFunctor () const
 

Additional Inherited Members

- Public Types inherited from mitk::DICOMFileReader
typedef DICOMImageBlockDescriptor::AdditionalTagsMapType AdditionalTagsMapType
 

Detailed Description

Definition at line 21 of file mitkDICOMNullFileReader.h.

Constructor & Destructor Documentation

◆ DICOMNullFileReader() [1/2]

mitk::DICOMNullFileReader::DICOMNullFileReader ( )
protected

Definition at line 16 of file mitkDICOMNullFileReader.cpp.

References ~DICOMNullFileReader().

Referenced by SetTagCache(), and ~DICOMNullFileReader().

◆ ~DICOMNullFileReader()

mitk::DICOMNullFileReader::~DICOMNullFileReader ( )
overrideprotected

Definition at line 22 of file mitkDICOMNullFileReader.cpp.

References DICOMNullFileReader().

Referenced by DICOMNullFileReader(), and SetTagCache().

◆ DICOMNullFileReader() [2/2]

mitk::DICOMNullFileReader::DICOMNullFileReader ( const DICOMNullFileReader &  other)
protected

Definition at line 27 of file mitkDICOMNullFileReader.cpp.

References operator=().

Member Function Documentation

◆ AnalyzeInputFiles()

◆ CanHandleFile()

bool mitk::DICOMNullFileReader::CanHandleFile ( const std::string &  filename)
overridevirtual

Indicate whether this reader can handle given file.

Implements mitk::DICOMFileReader.

Definition at line 94 of file mitkDICOMNullFileReader.cpp.

Referenced by LoadImages().

◆ GetTagsOfInterest()

DICOMTagPathList mitk::DICOMNullFileReader::GetTagsOfInterest ( ) const
inlineoverridevirtual

Implements mitk::DICOMFileReader.

Definition at line 38 of file mitkDICOMNullFileReader.h.

◆ InternalPrintConfiguration()

void mitk::DICOMNullFileReader::InternalPrintConfiguration ( std::ostream &  os) const
overrideprotectedvirtual

Configuration description for human reader, to be implemented by sub-classes.

Implements mitk::DICOMFileReader.

Definition at line 51 of file mitkDICOMNullFileReader.cpp.

References AnalyzeInputFiles().

Referenced by operator==(), and SetTagCache().

◆ LoadImages()

bool mitk::DICOMNullFileReader::LoadImages ( )
overridevirtual

Load the mitk::Images in our outputs, the DICOMImageBlockDescriptor. To be called only after AnalyzeInputFiles(). Take care of potential exceptions!

Implements mitk::DICOMFileReader.

Definition at line 86 of file mitkDICOMNullFileReader.cpp.

References CanHandleFile().

Referenced by AnalyzeInputFiles().

◆ mitkClassMacro()

mitk::DICOMNullFileReader::mitkClassMacro ( DICOMNullFileReader  ,
DICOMFileReader   
)

◆ mitkCloneMacro()

mitk::DICOMNullFileReader::mitkCloneMacro ( DICOMNullFileReader  )

◆ New()

static Pointer mitk::DICOMNullFileReader::New ( )
static

Referenced by mitkDICOMFileReaderTest().

◆ operator=()

mitk::DICOMNullFileReader & mitk::DICOMNullFileReader::operator= ( const DICOMNullFileReader &  other)
protected

◆ operator==()

bool mitk::DICOMNullFileReader::operator== ( const DICOMFileReader &  other) const
overridevirtual

Implements mitk::DICOMFileReader.

Definition at line 45 of file mitkDICOMNullFileReader.cpp.

References InternalPrintConfiguration().

Referenced by operator=().

◆ SetTagCache()

void mitk::DICOMNullFileReader::SetTagCache ( const DICOMTagCache::Pointer &  )
inlineoverridevirtual

A way to provide external knowledge about files and tag values is appreciated.

Implements mitk::DICOMFileReader.

Definition at line 39 of file mitkDICOMNullFileReader.h.

References DICOMNullFileReader(), InternalPrintConfiguration(), operator=(), and ~DICOMNullFileReader().


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