Medical Imaging Interaction Toolkit
2024.12.99-0da743f6
Medical Imaging Interaction Toolkit
|
Output descriptor for DICOMFileReader. More...
#include <mitkDICOMImageBlockDescriptor.h>
Public Types | |
typedef std::map< DICOMTagPath, std::string > | AdditionalTagsMapType |
typedef std::function< mitk::BaseProperty::Pointer(const DICOMCachedValueLookupTable &) > | TagLookupTableToPropertyFunctor |
Public Member Functions | |
DICOMImageBlockDescriptor () | |
~DICOMImageBlockDescriptor () override | |
DICOMImageBlockDescriptor (const DICOMImageBlockDescriptor &other) | |
DICOMImageBlockDescriptor & | operator= (const DICOMImageBlockDescriptor &other) |
void | SetImageFrameList (const DICOMImageFrameList &framelist) |
List of frames that constitute the mitk::Image (DICOMImageFrames) More... | |
const DICOMImageFrameList & | GetImageFrameList () const |
List of frames that constitute the mitk::Image (DICOMImageFrames) More... | |
void | SetMitkImage (Image::Pointer image) |
The 3D mitk::Image that is loaded from the DICOM files of a DICOMImageFrameList. More... | |
Image::Pointer | GetMitkImage () const |
the 3D mitk::Image that is loaded from the DICOM files of a DICOMImageFrameList More... | |
ReaderImplementationLevel | GetReaderImplementationLevel () const |
Reader's capability to appropriately load this set of frames. More... | |
void | SetReaderImplementationLevel (const ReaderImplementationLevel &level) |
Reader's capability to appropriately load this set of frames. More... | |
void | SetProperty (const std::string &key, BaseProperty *value) |
Key-value store describing aspects of the image to be loaded. More... | |
BaseProperty * | GetProperty (const std::string &key) const |
Key-value store describing aspects of the image to be loaded. More... | |
std::string | GetPropertyAsString (const std::string &) const |
Convenience function around GetProperty() More... | |
IOVolumeSplitReason::ConstPointer | GetSplitReason () const |
IOVolumeSplitReason::Pointer | GetSplitReason () |
void | SetSplitReason (IOVolumeSplitReason::Pointer reason) |
void | SetFlag (const std::string &key, bool value) |
Convenience function around SetProperty() More... | |
bool | GetFlag (const std::string &key, bool defaultValue) const |
Convenience function around GetProperty() More... | |
void | SetIntProperty (const std::string &key, int value) |
Convenience function around SetProperty() More... | |
int | GetIntProperty (const std::string &key, int defaultValue) const |
Convenience function around GetProperty() More... | |
BaseProperty::ConstPointer | GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override |
Get property by its key. More... | |
std::vector< std::string > | GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override |
Query keys of existing properties. More... | |
std::vector< std::string > | GetPropertyContextNames () const override |
Query names of existing contexts. More... | |
PixelSpacingInterpretation | GetPixelSpacingInterpretation () const |
Describe how the mitk::Image's pixel spacing should be interpreted. More... | |
void | GetDesiredMITKImagePixelSpacing (ScalarType &spacingXinMM, ScalarType &spacingYinMM) const |
Describe the correct x/y pixel spacing of the mitk::Image (which some readers might need to adjust after loading) More... | |
void | SetTiltInformation (const GantryTiltInformation &info) |
Describe the gantry tilt of the acquisition. More... | |
const GantryTiltInformation | GetTiltInformation () const |
Describe the gantry tilt of the acquisition. More... | |
void | SetSOPClassUID (const std::string &uid) |
SOP Class UID of this set of frames. More... | |
std::string | GetSOPClassUID () const |
SOP Class UID of this set of frames. More... | |
std::string | GetSOPClassUIDAsName () const |
SOP Class as human readable name (e.g. "CT Image Storage") More... | |
int | GetNumberOfTimeSteps () const |
int | GetNumberOfFramesPerTimeStep () const |
void | SetTagCache (DICOMTagCache *privateCache) |
void | SetAdditionalTagsOfInterest (const AdditionalTagsMapType &tagMap) |
Set a list of DICOMTagPaths that specify all DICOM-Tags that will be copied into the property of the mitk::Image. More... | |
void | SetTagLookupTableToPropertyFunctor (TagLookupTableToPropertyFunctor) |
Set a functor that defines how the slice-specific tag-values are stored in a Property. More... | |
void | Print (std::ostream &os, bool filenameDetails) const |
Print information about this image block to given stream. More... | |
Public Member Functions inherited from mitk::IPropertyProvider | |
virtual | ~IPropertyProvider () |
Static Public Member Functions | |
static DICOMTagList | GetTagsOfInterest () |
Output descriptor for DICOMFileReader.
As a result of analysis by a mitk::DICOMFileReader, this class describes the properties of a single mitk::Images that could be loaded by the file reader.
The descriptor contains the following information:
Described aspects of an image are:
Definition at line 78 of file mitkDICOMImageBlockDescriptor.h.
typedef std::map<DICOMTagPath, std::string> mitk::DICOMImageBlockDescriptor::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 178 of file mitkDICOMImageBlockDescriptor.h.
typedef std::function<mitk::BaseProperty::Pointer(const DICOMCachedValueLookupTable&) > mitk::DICOMImageBlockDescriptor::TagLookupTableToPropertyFunctor |
Definition at line 192 of file mitkDICOMImageBlockDescriptor.h.
mitk::DICOMImageBlockDescriptor::DICOMImageBlockDescriptor | ( | ) |
|
override |
mitk::DICOMImageBlockDescriptor::DICOMImageBlockDescriptor | ( | const DICOMImageBlockDescriptor & | other | ) |
|
overridevirtual |
Get property by its key.
[in] | propertyKey | Key of property. |
[in] | contextName | Optional, default is empty string (default context). Search in specified context. |
[in] | fallBackOnDefaultContext | Optional, default is true. Also search in default context if property was not found in given context. |
Implements mitk::IPropertyProvider.
void mitk::DICOMImageBlockDescriptor::GetDesiredMITKImagePixelSpacing | ( | ScalarType & | spacingXinMM, |
ScalarType & | spacingYinMM | ||
) | const |
Describe the correct x/y pixel spacing of the mitk::Image (which some readers might need to adjust after loading)
bool mitk::DICOMImageBlockDescriptor::GetFlag | ( | const std::string & | key, |
bool | defaultValue | ||
) | const |
Convenience function around GetProperty()
const DICOMImageFrameList& mitk::DICOMImageBlockDescriptor::GetImageFrameList | ( | ) | const |
List of frames that constitute the mitk::Image (DICOMImageFrames)
int mitk::DICOMImageBlockDescriptor::GetIntProperty | ( | const std::string & | key, |
int | defaultValue | ||
) | const |
Convenience function around GetProperty()
Image::Pointer mitk::DICOMImageBlockDescriptor::GetMitkImage | ( | ) | const |
the 3D mitk::Image that is loaded from the DICOM files of a DICOMImageFrameList
int mitk::DICOMImageBlockDescriptor::GetNumberOfFramesPerTimeStep | ( | ) | const |
return the number of frames that constitute one timestep.
int mitk::DICOMImageBlockDescriptor::GetNumberOfTimeSteps | ( | ) | const |
Convenience method that returns the property timesteps
PixelSpacingInterpretation mitk::DICOMImageBlockDescriptor::GetPixelSpacingInterpretation | ( | ) | const |
Describe how the mitk::Image's pixel spacing should be interpreted.
BaseProperty* mitk::DICOMImageBlockDescriptor::GetProperty | ( | const std::string & | key | ) | const |
Key-value store describing aspects of the image to be loaded.
std::string mitk::DICOMImageBlockDescriptor::GetPropertyAsString | ( | const std::string & | ) | const |
Convenience function around GetProperty()
|
overridevirtual |
|
overridevirtual |
Query keys of existing properties.
[in] | contextName | Optional, default is empty string (default context). Search in specified context. |
[in] | includeDefaultContext | Optional, default is false. Include default context. |
Implements mitk::IPropertyProvider.
ReaderImplementationLevel mitk::DICOMImageBlockDescriptor::GetReaderImplementationLevel | ( | ) | const |
Reader's capability to appropriately load this set of frames.
std::string mitk::DICOMImageBlockDescriptor::GetSOPClassUID | ( | ) | const |
SOP Class UID of this set of frames.
std::string mitk::DICOMImageBlockDescriptor::GetSOPClassUIDAsName | ( | ) | const |
SOP Class as human readable name (e.g. "CT Image Storage")
IOVolumeSplitReason::Pointer mitk::DICOMImageBlockDescriptor::GetSplitReason | ( | ) |
Returns the pointer to the split reason of this block descriptor.
IOVolumeSplitReason::ConstPointer mitk::DICOMImageBlockDescriptor::GetSplitReason | ( | ) | const |
Returns the pointer to the split reason of this block descriptor.
|
static |
const GantryTiltInformation mitk::DICOMImageBlockDescriptor::GetTiltInformation | ( | ) | const |
Describe the gantry tilt of the acquisition.
DICOMImageBlockDescriptor& mitk::DICOMImageBlockDescriptor::operator= | ( | const DICOMImageBlockDescriptor & | other | ) |
void mitk::DICOMImageBlockDescriptor::Print | ( | std::ostream & | os, |
bool | filenameDetails | ||
) | const |
Print information about this image block to given stream.
void mitk::DICOMImageBlockDescriptor::SetAdditionalTagsOfInterest | ( | const AdditionalTagsMapType & | tagMap | ) |
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::DICOMImageBlockDescriptor::SetFlag | ( | const std::string & | key, |
bool | value | ||
) |
Convenience function around SetProperty()
void mitk::DICOMImageBlockDescriptor::SetImageFrameList | ( | const DICOMImageFrameList & | framelist | ) |
List of frames that constitute the mitk::Image (DICOMImageFrames)
void mitk::DICOMImageBlockDescriptor::SetIntProperty | ( | const std::string & | key, |
int | value | ||
) |
Convenience function around SetProperty()
void mitk::DICOMImageBlockDescriptor::SetMitkImage | ( | Image::Pointer | image | ) |
The 3D mitk::Image that is loaded from the DICOM files of a DICOMImageFrameList.
void mitk::DICOMImageBlockDescriptor::SetProperty | ( | const std::string & | key, |
BaseProperty * | value | ||
) |
Key-value store describing aspects of the image to be loaded.
void mitk::DICOMImageBlockDescriptor::SetReaderImplementationLevel | ( | const ReaderImplementationLevel & | level | ) |
Reader's capability to appropriately load this set of frames.
void mitk::DICOMImageBlockDescriptor::SetSOPClassUID | ( | const std::string & | uid | ) |
SOP Class UID of this set of frames.
void mitk::DICOMImageBlockDescriptor::SetSplitReason | ( | IOVolumeSplitReason::Pointer | reason | ) |
Sets the split reason for the block descriptor.
void mitk::DICOMImageBlockDescriptor::SetTagCache | ( | DICOMTagCache * | privateCache | ) |
void mitk::DICOMImageBlockDescriptor::SetTagLookupTableToPropertyFunctor | ( | TagLookupTableToPropertyFunctor | ) |
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.
void mitk::DICOMImageBlockDescriptor::SetTiltInformation | ( | const GantryTiltInformation & | info | ) |
Describe the gantry tilt of the acquisition.