Medical Imaging Interaction Toolkit
2024.12.99-0da743f6
Medical Imaging Interaction Toolkit
|
Interface for DICOM readers that produce mitk::Images. More...
#include <mitkDICOMFileReader.h>
Public Types | |
typedef DICOMImageBlockDescriptor::AdditionalTagsMapType | AdditionalTagsMapType |
Public Member Functions | |
mitkClassMacroItkParent (DICOMFileReader, itk::Object) | |
virtual bool | CanHandleFile (const std::string &filename)=0 |
Indicate whether this reader can handle given file. More... | |
void | SetInputFiles (const StringList &filenames) |
This input files. More... | |
const StringList & | GetInputFiles () const |
This input files. More... | |
virtual void | AnalyzeInputFiles ()=0 |
Analyze 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... | |
virtual bool | LoadImages ()=0 |
virtual DICOMTagPathList | GetTagsOfInterest () const =0 |
virtual void | SetTagCache (const DICOMTagCache::Pointer &)=0 |
A way to provide external knowledge about files and tag values is appreciated. 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 bool | operator== (const DICOMFileReader &other) const =0 |
virtual void | SetAdditionalTagsOfInterest (const AdditionalTagsMapType &tagList) |
Set a list of DICOMTagPaths that specify 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 bool | IsDICOM (const std::string &filename) |
Test whether a file is DICOM at all. More... | |
Protected Member Functions | |
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 void | InternalPrintConfiguration (std::ostream &os) const =0 |
Configuration description for human reader, to be implemented by sub-classes. More... | |
virtual AdditionalTagsMapType | GetAdditionalTagsOfInterest () const |
mitk::DICOMImageBlockDescriptor::TagLookupTableToPropertyFunctor | GetTagLookupTableToPropertyFunctor () const |
Interface for DICOM readers that produce mitk::Images.
As described in The DICOM Module, this class structures the reader's part in the process of analyzing a set of DICOM files and selecting the most appropriate reader.
The overall loading process is as follows:
Sub-classes are required to implement a number of methods that reflect above structure. See mitk::DICOMITKSeriesGDCMReader for an example.
To help applications in describing different readers to the user, each reader brings a number of methods that describe its configuration/specifics by means of a short label and a (longer) description.
Definition at line 55 of file mitkDICOMFileReader.h.
typedef DICOMImageBlockDescriptor::AdditionalTagsMapType mitk::DICOMFileReader::AdditionalTagsMapType |
Type specifies additional tags of interest. Key is the tag path of interest. The value is an optional user defined name for the property that should be used to store the tag value(s). Empty value is default and will imply to use the found DICOMTagPath as property name.
Definition at line 108 of file mitkDICOMFileReader.h.
|
protected |
|
overrideprotected |
|
protected |
|
pure virtual |
Analyze input files.
Implemented in mitk::DICOMITKSeriesGDCMReader.
|
pure virtual |
Indicate whether this reader can handle given file.
Implemented in mitk::DICOMITKSeriesGDCMReader.
|
protected |
|
protectedvirtual |
std::string mitk::DICOMFileReader::GetConfigurationDescription | ( | ) | const |
One-sentence description of the reader's loading "strategy".
std::string mitk::DICOMFileReader::GetConfigurationLabel | ( | ) | const |
Short label/name to describe this reader.
const StringList& mitk::DICOMFileReader::GetInputFiles | ( | ) | const |
This input files.
unsigned int mitk::DICOMFileReader::GetNumberOfOutputs | ( | ) | const |
Number of outputs, only meaningful after calling AnalyzeInputFiles()
const DICOMImageBlockDescriptor& mitk::DICOMFileReader::GetOutput | ( | unsigned int | index | ) | const |
Individual outputs, only meaningful after calling AnalyzeInputFiles().
std::invalid_argument |
|
protected |
|
pure virtual |
Implemented in mitk::DICOMITKSeriesGDCMReader.
|
protected |
non-const access to the DICOMImageBlockDescriptor
|
protectedpure virtual |
Configuration description for human reader, to be implemented by sub-classes.
Implemented in mitk::DICOMITKSeriesGDCMReader.
|
static |
Test whether a file is DICOM at all.
|
pure virtual |
Load the mitk::Images in our outputs, the DICOMImageBlockDescriptor. To be called only after AnalyzeInputFiles(). Take care of potential exceptions!
Implemented in mitk::DICOMITKSeriesGDCMReader, and mitk::ThreeDnTDICOMSeriesReader.
mitk::DICOMFileReader::mitkClassMacroItkParent | ( | DICOMFileReader | , |
itk::Object | |||
) |
|
protected |
|
pure virtual |
Implemented in mitk::DICOMITKSeriesGDCMReader, mitk::ClassicDICOMSeriesReader, and mitk::ThreeDnTDICOMSeriesReader.
void mitk::DICOMFileReader::PrintConfiguration | ( | std::ostream & | os | ) | const |
Print configuration description to given stream, for human reader.
void mitk::DICOMFileReader::PrintOutputs | ( | std::ostream & | os, |
bool | filenameDetails = false |
||
) | const |
Print output description to given stream, for human reader.
|
virtual |
Set a list of DICOMTagPaths that specify all DICOM-Tags that will be copied into the property of the mitk::Image.
This method can be used to specify a list of DICOM-tags that shall be available after the loading. The value in the tagMap is an optional user defined name for the property key that should be used when storing the property). Empty value is default and will imply to use the found DICOMTagPath as property key. By default the content of the DICOM tags will be stored in a StringLookupTable on the mitk::Image. This behaviour can be changed by setting a different TagLookupTableToPropertyFunctor via SetTagLookupTableToPropertyFunctor().
void mitk::DICOMFileReader::SetConfigurationDescription | ( | const std::string & | ) |
One-sentence description of the reader's loading "strategy".
void mitk::DICOMFileReader::SetConfigurationLabel | ( | const std::string & | ) |
Short label/name to describe this reader.
void mitk::DICOMFileReader::SetInputFiles | ( | const StringList & | filenames | ) |
This input files.
|
protected |
|
protected |
|
pure virtual |
A way to provide external knowledge about files and tag values is appreciated.
Implemented in mitk::DICOMITKSeriesGDCMReader.
|
virtual |
Set a functor that defines how the slice-specific tag-values are stored in a Property.
This method sets a functor that is given a StringLookupTable that contains the values of one DICOM tag mapped to the slice index. The functor is supposed to store these values in an mitk Property.
By default, the StringLookupTable is stored in a StringLookupTableProperty except if all values are identical. In this case, the unique value is stored only once in a StringProperty.