 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/US/ScanConversion3D.h>
Ultrasound scan-conversion for 3D probe data into a volumetric image and vice versa. More...
Inheritance diagram for ScanConversion3D:Ultrasound scan-conversion for 3D probe data into a volumetric image and vice versa.
The size of the output 3D scan is determined by the following parameters: p_outputSpacing, p_outputDimensions, p_useMaxMemory, and p_memoryLimit
p_outputSpacing and p_outputDimensions will force the image to have that spacing or dimensions, with no regards to memory usage. These will set the algorithm status as a memory error if hardware memory is insufficient.
If not set, the output scan will have the same size and spacing as the input data, unless: p_useMaxMemory will limit the output so the conversion will not use all the system memory p_memoryLimit will limit the output so the conversion will not use the specified memory. If both options are selected, the minimum amount between the two will be used. Both cases will favor GPU over CPU, unless p_forceCPU is set, or OpenGL is not available in the system.
The algorithm will set its status to a memory error if the output would require more memory than available.
Public Member Functions | |
| ScanConversion3D (SharedImageSet *imgIn=0) | |
| Constructor with an optional pre-scan-converted ultrasound image set. | |
| 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. | |
| Public Member Functions inherited from 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 Configurable | |
| virtual void | configuration (Properties *p) const |
| Serialize the current object configuration into the given Properties object. | |
| 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=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 | |
| Parameter< double > | p_beamStartDepth {"beamStartDepth", 50.0, this} |
| Axial distance of the first scanline sample along the beam in mm. | |
| Parameter< double > | p_beamEndDepth {"beamEndDepth", 140.0, this} |
| Axial length of the scanline along the beam in mm. | |
| Parameter< double > | p_steeringLateralMin {"steeringLateralMin", -35.0, this} |
| Minimal angular position in degrees. | |
| Parameter< double > | p_steeringLateralSpan {"steeringLateralSpan", 70.0, this} |
| Angular scanning span in degrees. | |
| Parameter< double > | p_steeringElevationalMin {"steeringElevationalMin", -35.0, this} |
| Minimal angular z position in degrees for 3D scans. | |
| Parameter< double > | p_steeringElevationalSpan {"steeringElevationalSpan", 70.0, this} |
| Angular z scanning span in degrees for 3D scans. | |
| Parameter< double > | p_zAxialMin {"zAxialMin", 10.0, this} |
| The z-wobbling offset for 3D scans. | |
| Parameter< std::optional< vec3i > > | p_outputDimensions {"outputDimensions", std::nullopt, this} |
Desired output volume dimensions, takes precedence over p_outputSpacing if non-zero. | |
| Parameter< std::optional< vec3 > > | p_outputSpacing {"outputSpacing", std::nullopt, this} |
| Desired output volume spacing. If zero, spacing is deduced from the input scanlines and configured depth. | |
| Parameter< bool > | p_pyramidMode {"pyramidMode", false, this} |
| If true, the scanlines angles are spaced uniformly in an orthogonal grid (in spherical coordinates), the volume is then the sector of a spherical shell (with spherical rectangular base). | |
| Parameter< bool > | p_ensureInsideAboveZero {"ensureInsideAboveZero", true, this} |
| If true, all the pixel intensities inside the pyramid or spherical shell sector will be incremented to 1 should they happen to be 0, so that a zero-mask can be used for the background. | |
| Parameter< bool > | p_forceCPU {"forceCPU", false, this} |
| If true, the CPU will be used, regardless of whether the input already has GL representation. | |
| Parameter< bool > | p_inverse {"inverse", false, this} |
| If true, the conversion is performed from a scan-converted volume to scanlines. | |
| Parameter< InterpolationMode > | p_interpolationMode {"interpolationMode", InterpolationMode::Linear, this} |
| Interpolation mode for the image value lookup. | |
| Parameter< bool > | p_useMaxMemory {"maxMemory", false, this} |
| Will use (almost) all available memory (GPU or CPU depending on p_forceCPU and OpenGL availability) to perform the scan conversion. | |
| Parameter< std::optional< int > > | p_memoryLimitMB {"memoryLimitMB", 256, this} |
| Memory limit, in MB. This will affect GPU or CPU memory depending on the p_forceCPU and OpenGL availability. | |
| Parameter< bool > | p_useGlApproximation {"useGlApproximation", false, this} |
| If true, an approximate GPU implementation can be used on platforms not supporting the exact GPU implementation. | |
| 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. | |
Additional Inherited Members | |
| 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... | |
| 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 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. | |
|
overridevirtual |
Execute the algorithm.
Implements Algorithm.
|
overridevirtual |
|
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.
| Parameter<bool> p_pyramidMode {"pyramidMode", false, this} |
If true, the scanlines angles are spaced uniformly in an orthogonal grid (in spherical coordinates), the volume is then the sector of a spherical shell (with spherical rectangular base).
If false, the cross-section (on the xy, lateral, elevational plane) of the resulting volume has an hourglass shape.
| Parameter<bool> p_forceCPU {"forceCPU", false, this} |
| Parameter<bool> p_inverse {"inverse", false, this} |
If true, the conversion is performed from a scan-converted volume to scanlines.
If false, the conversion is performed from scanlines to volume.
| Parameter<InterpolationMode> p_interpolationMode {"interpolationMode", InterpolationMode::Linear, this} |
Interpolation mode for the image value lookup.
Automatically determined depending on image type, e.g. Nearest for LABEL
| Parameter<bool> p_useGlApproximation {"useGlApproximation", false, this} |
If true, an approximate GPU implementation can be used on platforms not supporting the exact GPU implementation.
If false, it will fall back to the exact CPU implementation for such platforms.
