 |
ImFusion C++ SDK 4.5.0
|
|
ImFusion C++ SDK 4.5.0
|
#include <ImFusion/US/ProcessUltrasoundClip.h>
Processes a 2D ultrasound clip frame by frame using ProcessUltrasound. More...
Processes a 2D ultrasound clip frame by frame using ProcessUltrasound.
The algorithm takes a non-empty 2D SharedImageSet, optionally together with a TrackingSequence, and applies the common ultrasound preprocessing steps configured through ProcessUltrasoundParameters: cropping to the frame geometry, masking, depth-based spacing correction, Doppler color removal, optional inpainting during masking, and duplicate-frame suppression.
Only selected frames are processed. If no selection is present, all input frames are used. With p_createNewImage enabled, the processed frames are written to a new output SharedImageSet and the input remains unchanged. Otherwise the selected frames replace the input frames in place and takeOutput() returns no data.
When p_convertToSweep is enabled, a newly created output image set is converted to an UltrasoundSweep. The optional TrackingSequence passed to the constructor is used for this conversion. If the processed data already is an UltrasoundSweep, the processed frame geometry is stored on the sweep. For tracked data, cropping and optional frame-geometry calibration correction update the calibration matrices so image coordinates remain spatially consistent after processing.
Public Member Functions | |
| ProcessUltrasoundClip (SharedImageSet &inImgSet, TrackingSequence *ts=nullptr) | |
| Constructs an algorithm for processing the frames of the input image set. | |
| SharedImageSet & | inputDataRef () |
| Returns the input image set processed by this algorithm. | |
| OwningDataList | takeOutput () override |
| Return any new Data that was created by the Algorithm during the last call to compute(). | |
| void | compute () override |
| Execute the algorithm. | |
| void | configure (const Properties *p) override |
| Configure this object instance by de-serializing the given Properties. | |
| void | configuration (Properties *p) const override |
| Serialize the current object configuration into the given Properties object. | |
| void | init () |
| Processes the first frame once so the processed frame geometry is available for GUI visualization. | |
| std::optional< ProcessUltrasoundParameters > | currentProcessingParameters () |
| Returns the current ProcessUltrasound parameters. | |
| void | initGeometry () |
| Initializes the processing geometry from the input data. | |
| bool | detectGeometry () |
| Detects an ultrasound frame geometry from selected input frames. | |
| void | setGeometryToWholeImage () |
| Sets the processing geometry to cover the whole input image. | |
| void | updateGeometry (std::unique_ptr< US::FrameGeometry > newGeometry) |
| Replaces the processing geometry. | |
| Public Member Functions inherited from ImFusion::Algorithm | |
| Algorithm () | |
| Default constructor will registers a single "compute" action that calls compute() and returns status(). | |
| virtual void | setProgress (Progress *progress) |
| Sets a Progress interface the algorithm can use to notify observers about its computing progress. | |
| Progress * | progress () const |
| Returns the progress interface if set. | |
| virtual int | status () const |
| Indicates the status of the last call to compute(). | |
| virtual bool | survivesDataDeletion (const Data *) const |
| Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list. | |
| const FactoryInfo & | factoryInfo () const |
| Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| void | setFactoryInfo (const FactoryInfo &value) |
| Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| Status | runAction (const std::string &id) |
| Run the action with name id if it exists. | |
| const std::vector< Action > & | actions () |
| Get a mapping from Action id to Action as registered in this algorithm. | |
| Public Member Functions inherited from ImFusion::Configurable | |
| virtual void | configureDefaults () |
| Retrieve the properties of this object, replaces values with their defaults and sets it again. | |
| void | registerParameter (ParameterBase *param) |
| Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration(). | |
| void | unregisterParameter (const ParameterBase *param) |
| Remove the given Parameter or SubProperty from the list of registered parameters. | |
| Configurable (const Configurable &rhs) | |
| Configurable (Configurable &&rhs) noexcept | |
| Configurable & | operator= (const Configurable &) |
| Configurable & | operator= (Configurable &&) noexcept |
Static Public Member Functions | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| Static Public Member Functions inherited from ImFusion::Algorithm | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| Factory function to check algorithm compatibility with input data and optionally instantiate it. | |
Public Attributes | |
| Parameter< bool > | p_createNewImage {"createNewImage", true, this} |
| If true, compute() writes processed frames to a new output image set. | |
| Parameter< bool > | p_convertToSweep {"convertToSweep", true, this} |
| If true and p_createNewImage is enabled, convert the processed output image set to an UltrasoundSweep. | |
| Parameter< bool > | p_frameGeometryCalibCorrection {"frameGeometryCalibCorrection", false, this} |
| If true and the input is an UltrasoundSweep with tracking, each tracking calibration matrix is post-multiplied by a 2D translation that corrects for the difference between the sweep's stored frame geometry and the geometry used for processing (including depth scaling when applyDepth is enabled), so probe poses stay consistent with the processed images. | |
| Public Attributes inherited from ImFusion::Algorithm | |
| Signal | signalOutputChanged |
| Signal should be emitted by Algorithms when their output/result has changed. | |
| Signal | signalParametersChanged |
| Signal should be emitted by Algorithms when their parameter configuration has changed. | |
| Public Attributes inherited from ImFusion::Configurable | |
| Signal | signalParametersChanged |
| Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
Additional Inherited Members | |
| Public Types inherited from ImFusion::Algorithm | |
| enum | Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 } |
| Status codes. More... | |
| Protected Member Functions inherited from ImFusion::Algorithm | |
| void | loadDefaults () |
| void | registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action) |
| Register an action to be run via runAction. | |
| template<typename D> | |
| void | registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void)) |
| Template version of runAction that can be used with a pointer to a member function. | |
| void | registerAction (const Action &action) |
| Register an action. | |
| Protected Attributes inherited from ImFusion::Algorithm | |
| std::string | m_name |
| Algorithm name. | |
| Progress * | m_progress = nullptr |
| Non-owing pointer to a progress interface. May be a nullptr. | |
| FactoryInfo | m_factoryInfo = {} |
| Record describing how this algorithm was instantiated by the AlgorithmFactory. | |
| int | m_status = Status::Unknown |
| Algorithm status after last call to compute(). | |
| std::vector< Action > | m_actions |
| Map of key given by the id of the action, of the available actions of this algorithm. | |
| Protected Attributes inherited from ImFusion::Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
|
explicit |
Constructs an algorithm for processing the frames of the input image set.
| inImgSet | Non-empty input image set containing 2D ultrasound frames. |
| ts | Optional tracking sequence used when p_convertToSweep converts a newly created output image set to an UltrasoundSweep. |
|
overridevirtual |
Return any new Data that was created by the Algorithm during the last call to compute().
The default implementation will return an empty list.
Reimplemented from ImFusion::Algorithm.
|
overridevirtual |
Execute the algorithm.
Implements ImFusion::Algorithm.
|
overridevirtual |
Configure this object instance by de-serializing the given Properties.
The default implementation will do so automatically for all registered Parameter and SubProperty instances.
Reimplemented from ImFusion::Configurable.
|
overridevirtual |
Serialize the current object configuration into the given Properties object.
The default implementation will do so automatically for all registered Parameter and SubProperty instances.
Reimplemented from ImFusion::Configurable.
| void ImFusion::US::ProcessUltrasoundClip::initGeometry | ( | ) |
Initializes the processing geometry from the input data.
If the input contains FrameGeometryMetadata, the existing sweep geometry is converted to pixels and used. Otherwise a default geometry is initialized from the first image descriptor.
| bool ImFusion::US::ProcessUltrasoundClip::detectGeometry | ( | ) |
Detects an ultrasound frame geometry from selected input frames.
Uses up to eight selected frames, or the first frames if no selection is present. On success, the detected geometry replaces the current ProcessUltrasound geometry.
| void ImFusion::US::ProcessUltrasoundClip::updateGeometry | ( | std::unique_ptr< US::FrameGeometry > | newGeometry | ) |
Replaces the processing geometry.
| newGeometry | Geometry of the unprocessed input images. Ownership is transferred to the internal ProcessUltrasound. |
| Parameter<bool> ImFusion::US::ProcessUltrasoundClip::p_createNewImage {"createNewImage", true, this} |
If true, compute() writes processed frames to a new output image set.
If false, selected input frames are replaced in place and takeOutput() returns no data.
| Parameter<bool> ImFusion::US::ProcessUltrasoundClip::p_frameGeometryCalibCorrection {"frameGeometryCalibCorrection", false, this} |
If true and the input is an UltrasoundSweep with tracking, each tracking calibration matrix is post-multiplied by a 2D translation that corrects for the difference between the sweep's stored frame geometry and the geometry used for processing (including depth scaling when applyDepth is enabled), so probe poses stay consistent with the processed images.
When applyCrop is enabled, a separate translation is always applied for the crop origin; this flag only adds the geometry-offset correction described above.