 |
ImFusion C++ SDK 4.5.0
|
|
ImFusion C++ SDK 4.5.0
|
#include <ImFusion/US/SyntheticUltrasoundSweepAlgorithm.h>
Algorithm to create an ultrasound sweep without image content from two splines. More...
Algorithm to create an ultrasound sweep without image content from two splines.
It generates a sequence of empty ultrasound images (frames) distributed along the transducer spline, with each frame's orientation determined by the selected reference spline (center or direction). The frames are positioned and oriented according to the geometry and alignment parameters, and are timestamped to simulate a sweep over time. The resulting sweep contains only geometry and mask information, not real image data.
Public Types | |
| enum class | FrameGeometryType { Linear , Convex } |
| FrameGeometryType for the synthetic sweep. More... | |
| enum class | SliceReferenceSpline { Center , Direction } |
| Reference spline for slice orientation. More... | |
| 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... | |
Public Member Functions | |
| SyntheticUltrasoundSweepAlgorithm (SharedImageSet *referenceImage=nullptr) | |
| Constructs the algorithm. | |
| void | compute () override |
| Execute the algorithm. | |
| OwningDataList | takeOutput () override |
| Return any new Data that was created by the Algorithm during the last call to compute(). | |
| 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 | setTransducerSpline (const Spline *centerline) |
| Sets the centerline spline defining the path of the probe tip. | |
| void | setDirectionSpline (const Spline *direction) |
| Sets the spline defining the direction of the central scanline. | |
| SharedImageSet * | referenceImage () |
| Returns the reference image set, if provided. | |
| 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) |
| 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< int > | p_frameCount {"frameCount", 10, this} |
| Number of frames to generate in the sweep. | |
| Parameter< bool > | p_slicesPerpendicular {"slicesPerpendicular", true, this} |
| If true, slices are perpendicular to the reference spline; if false, they are parallel. | |
| Parameter< SliceReferenceSpline > | p_sliceReference {"sliceReference", SliceReferenceSpline::Center, this} |
| Selects which spline to use as reference for slice orientation. | |
| Parameter< FrameGeometryType > | p_frameGeometry {"frameGeometry", FrameGeometryType::Linear, this} |
| FrameGeometryType (linear or convex). | |
| Parameter< double > | p_depth {"depth", 50.0, this} |
| Depth of each frame in mm. | |
| Parameter< double > | p_probeWidth {"probeWidth", 50.0, this} |
| Ultrasound probe width in mm (chord length for convex probes). | |
| Parameter< double > | p_angle {"angle", 40.0, this} |
| Opening angle in degrees (for convex geometries only). | |
| 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. | |
Advanced parameters not exposed in the controller | |
| Parameter< double > | p_sweepDuration {"sweepDuration", 2.0, this} |
| Sweep duration in seconds (used for timestamp generation). | |
| Parameter< int > | p_pixelsX {"pixelsX", 128, this} |
| Number of pixels in X direction for each frame. | |
| Parameter< int > | p_pixelsY {"pixelsY", 150, this} |
| Number of pixels in Y direction for each frame. | |
Additional Inherited Members | |
| 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. | |
|
strong |
FrameGeometryType for the synthetic sweep.
| Enumerator | |
|---|---|
| Linear | |
| Convex | |
|
strong |
Reference spline for slice orientation.
Slices are orthogonal or parallel (depending on the parameter p_slicesPerpendicular) to the center transducer spline or the direction spline.
| ImFusion::US::SyntheticUltrasoundSweepAlgorithm::SyntheticUltrasoundSweepAlgorithm | ( | SharedImageSet * | referenceImage = nullptr | ) |
Constructs the algorithm.
| referenceImage | Optional reference image. Used by the corresponding controller. If given, spline annotations are added to this reference. |
|
overridevirtual |
Execute the algorithm.
Implements ImFusion::Algorithm.
|
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 |
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.
|
inline |
Sets the centerline spline defining the path of the probe tip.
| centerline | Pointer to the spline (not owned, must remain valid during compute()). |
|
inline |
Sets the spline defining the direction of the central scanline.
| direction | Pointer to the spline (not owned, must remain valid during compute()). |
|
inline |
Returns the reference image set, if provided.
| Parameter<int> ImFusion::US::SyntheticUltrasoundSweepAlgorithm::p_frameCount {"frameCount", 10, this} |
Number of frames to generate in the sweep.
Must be at least 2.