ImFusion C++ SDK 4.4.0
ImFusion::Dicom::GeneralEquipmentExtension Class Reference

#include <ImFusion/Dicom/GeneralEquipmentExtension.h>

General Equipment Module (PS 3.3 C.7.5) Only considers tags that are part of the GeneralEquipmentModuleDataComponent. More...

Inheritance diagram for ImFusion::Dicom::GeneralEquipmentExtension:

Detailed Description

Classes

class  GeneralEquipment

Public Member Functions

std::unique_ptr< Extensionclone () const override
 Return a clone this object Usually the implementation will look like this:
std::string name () const override
 Return a unique display string for this extension.
std::vector< std::unique_ptr< Data > > load (const FrameDescriptor &frame, SharedImageSet &sis) const override
 Loads the relevant tags into a GeneralEquipmentModuleDataComponent.
void save (const FrameDescriptor &frame, const SharedImageSet &sis) const override
 Save data from the given SharedImageSet to DICOM.
Public Member Functions inherited from ImFusion::Dicom::Extension
bool enabled () const
void setEnabled (bool enable=true)
virtual bool showInWriterUI () const
 Whether this extension will show up in the UI and can be enabled/disabled by the user.
Public Member Functions inherited from ImFusion::Dicom::ErrorRecorder
virtual void * registerErrorHandler (ErrorCallback handler)
 Registers a new handler callback function.
virtual void unregisterErrorHandler (void *handler)
 Removes a previously registered handler again.
void * forwardErrors (const ErrorRecorder *otherRecorder)
 Convenient function to forward all errors registered to this recorder to another recorder.
virtual void registerError (const Error &error) const
 Sends the given error to all error handler callbacks.
void registerError (Error::Code code, Error::Type type, const std::string &details, TagProxy tag=TagProxy()) const

Additional Inherited Members

Public Types inherited from ImFusion::Dicom::ErrorRecorder
using ErrorCallback = std::function<void(const Error&)>
 Alias for a function to call for each error recorded.

Member Function Documentation

◆ clone()

std::unique_ptr< Extension > ImFusion::Dicom::GeneralEquipmentExtension::clone ( ) const
inlineoverridevirtual

Return a clone this object Usually the implementation will look like this:

T make_unique(T... args)

Implements ImFusion::Dicom::Extension.

◆ name()

std::string ImFusion::Dicom::GeneralEquipmentExtension::name ( ) const
overridevirtual

Return a unique display string for this extension.

Implements ImFusion::Dicom::Extension.

◆ load()

std::vector< std::unique_ptr< Data > > ImFusion::Dicom::GeneralEquipmentExtension::load ( const FrameDescriptor & frame,
SharedImageSet & sis ) const
overridevirtual

Loads the relevant tags into a GeneralEquipmentModuleDataComponent.

Tags are only taken from the very first frame (frame.sharedImageIndex and .sliceIndex are 0). Empty string or 0 is used for any field in the DataComponent when the corresponding tag is missing in the dataset.

Implements ImFusion::Dicom::Extension.

◆ save()

void ImFusion::Dicom::GeneralEquipmentExtension::save ( const FrameDescriptor & frame,
const SharedImageSet & sis ) const
overridevirtual

Save data from the given SharedImageSet to DICOM.

This method will be called once for each frame of the SharedImageSet. Use FrameDescriptor::iod to access the DICOM tags and FrameDescriptor::sharedImageIndex/sliceIndex to figure out which frame data should be saved. The matrix parameters of frame should be ignored. Use the matrix of the SharedImageSet instead.

Implements ImFusion::Dicom::Extension.


The documentation for this class was generated from the following file:
  • ImFusion/Dicom/GeneralEquipmentExtension.h
Search Tab / S to search, Esc to close