 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/US/SweepPropertiesAlgorithm.h>
Algorithm to change properties of one or two ultrasound sweeps. More...
Inheritance diagram for SweepPropertiesAlgorithm:Algorithm to change properties of one or two ultrasound sweeps.
Note that this algorithm directly modifies/returns the sweep properties in configure/configuration. This algorithm serves two purposes: 1) To allow configuring a sweep (and its tracking sequences) from a workspace, and 2) as a dummy algorithm to launch the corresponding controller with the properties dialog. SDK users should directly modify the TrackingSequence.
Public Types | |
| enum | FanMode { NONE = 0 , ADD_MASK = 1 , CROP = 2 , SET_BACKGROUND_TO_ZERO = 3 } |
| Different modes how the fan geometry can be applied on a sweep. More... | |
| Public Types inherited from TrackedSharedImageSetPropertiesAlgorithm | |
| enum class | SampleTimeoutCriteria { NoCriteria = 0 , Average , Median , UserDefined } |
| Set sample timeout criteria (0=None, 1=Average, 2=Median, 3=UserDefined) The timeout criteria is used define the operation that should be performed to the TrackedImageSharedSet timestamps in order to calculate the corresponding timeout between samples. | |
| Public Types inherited from Algorithm | |
| enum | Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 } |
| Status codes. More... | |
Public Member Functions | |
| SweepPropertiesAlgorithm (UltrasoundSweep *us, UltrasoundSweep *us2=0) | |
| Constructor with pointer to ultrasound sweep and a second optional one. | |
| SweepPropertiesAlgorithm (const std::vector< UltrasoundSweep * > &sweeps) | |
| Constructor with an arbitrary number of ultrasound sweeps. | |
| void | applyFan (FanMode mode) |
| Apply the fan geometry on the sweep with one of the supported modes. | |
| UltrasoundSweep * | sweep () const |
| Return the first ultrasound sweep (convenience static cast of base class' image() | |
| const std::vector< UltrasoundSweep * > & | sweeps () const |
| Return vector of all ultrasound sweeps. | |
| void | applyVerticalStretch (double stretchFactor) |
| Updates vertical size and calibration of sweeps using. | |
| void | applyCalibrationHeightShift (double offset_mm) |
| Updates calibration matrices of all sweeps according to height shift from the current calibration. | |
| Public Member Functions inherited from TrackedSharedImageSetPropertiesAlgorithm | |
| TrackedSharedImageSetPropertiesAlgorithm (TrackedSharedImageSet *tsis1, TrackedSharedImageSet *tsis2=0) | |
| Constructor with pointer to image set and a second optional one. | |
| TrackedSharedImageSetPropertiesAlgorithm (const std::vector< TrackedSharedImageSet * > &tsis) | |
| Constructor with an arbitrary number of image sets. | |
| TrackedSharedImageSetPropertiesAlgorithm (TrackingSequence *ts) | |
| Constructor with single TrackingSequence, will be wrapped in temporary TrackedSharedImageSet. | |
| ~TrackedSharedImageSetPropertiesAlgorithm () override | |
| Destructor, cleans up temporary TrackedSharedImageSet if used with TrackingSequence. | |
| void | clearMetadata () |
| Clear all meta data. | |
| bool | hasTrackingGaps (TrackedSharedImageSet *tsis=nullptr) const |
| Checks whether at least one tracking sequence has gaps based on its timestamps. | |
| void | resampleTracking () |
| Resample tracking with equi-distant timestamps. | |
| bool | hasBothTimestamps () const |
| Checks if both images and tracking have a time series data component. | |
| void | setSampleTimeoutCriteria (int val) |
| SampleTimeoutCriteria | sampleTiomeoutCriteria () const |
| void | setUseMaxTimestepBetweenSamples (bool allSequences, std::optional< double > val=std::nullopt) const |
| Denote the criteria that should be used to set the max timestep between samples (average or median), and set the max timestep between samples for the current (or all) tracking sequence(s) | |
| bool | usesArrivalTimestamps () const |
| Checks if arrival timestamps are used (only applicable when hasBothTimestamps()) | |
| void | applyTimestampsFromSeries (bool arrival) |
| Applies device or arrival timestamps from data component. | |
| TrackedSharedImageSet * | image () const |
| Return the first SharedImageSet. | |
| const std::vector< TrackedSharedImageSet * > & | images () const |
| Return vector of all SharedImageSets. | |
| void | compute () override |
| Performs the tracking resampling, if enabled. | |
| 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. | |
| Public Member Functions inherited from Algorithm | |
| Algorithm () | |
| Default constructor will registers a single "compute" action that calls compute() and returns status(). | |
| virtual OwningDataList | takeOutput () |
| Return any new Data that was created by the Algorithm during the last call to compute(). | |
| 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 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 |
Methods implementing the Algorithm interface | |
| void | compute () override |
| The fan geometry masking/cropping is applied here, if enabled. | |
| static bool | createCompatible (const DataList &data, Algorithm **a=0) |
Methods implementing the Configurable interface | |
| 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. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from TrackedSharedImageSetPropertiesAlgorithm | |
| static double | avgTimestepBetweenImageFrames (const std::vector< double > ×tamps) |
| Caclulate average timestep between frames. | |
| static double | medianTimestepBetweenImageFrames (const std::vector< double > ×tamps) |
| Calculate median timestep between frames. | |
| static bool | createCompatible (const DataList &data, Algorithm **a=0) |
| Static Public Member Functions inherited from 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 inherited from 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 Configurable | |
| Signal | signalParametersChanged |
Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
| Protected Member Functions inherited from 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 TrackedSharedImageSetPropertiesAlgorithm | |
| TrackedSharedImageSet *const | m_tsis |
| Pointer to the first image set. | |
| std::vector< TrackedSharedImageSet * > | m_tsisAll |
| Vector of all image sets. | |
| bool | m_resampleTracking |
| Initiates tracking timestamp resampling. | |
| bool | m_clearMetadata |
| Clears meta data (data components) | |
| SampleTimeoutCriteria | m_sampleTimeoutCriteria |
| Timeout criteria to calculate the maxTimestepBetweenSamples. | |
| Protected Attributes inherited from 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 Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
| enum FanMode |
|
overridevirtual |
The fan geometry masking/cropping is applied here, if enabled.
Implements 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 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 Configurable.
| void applyVerticalStretch | ( | double | stretchFactor | ) |
Updates vertical size and calibration of sweeps using.
| stretchFactor | ratio |
| void applyCalibrationHeightShift | ( | double | offset_mm | ) |
Updates calibration matrices of all sweeps according to height shift from the current calibration.
| depthOffset | Height difference from the current calibration in mm |
