 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/US/VolumeReslicingAlgorithm.h>
Reslices a volume at the frame positions of an ultrasound sweep. More...
Inheritance diagram for VolumeReslicingAlgorithm:Reslices a volume at the frame positions of an ultrasound sweep.
Resamples a 3D volume along the trajectory of an ultrasound sweep, producing 2D slices. Supports different interpolation modes .
Additional settings can be configured using configure.
Public Types | |
| enum class | InterpolationMode : int { NearestNeighbor = 0 , Linear = 1 , Cubic = 2 } |
| 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 | |
| VolumeReslicingAlgorithm (SharedImageSet *inVolume, const UltrasoundSweep *refSweep) | |
| 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 | compute () override |
| Execute the algorithm. | |
| OwningDataList | takeOutput () override |
| Return any new Data that was created by the Algorithm during the last call to compute(). | |
| 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 | 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 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< InterpolationMode > | p_interpolationMode = {"Interpolation mode", InterpolationMode::Linear, *this} |
| 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 Attributes | |
| SharedImageSet * | m_inVolume |
| Input volume, e.g. CT or MRI. | |
| const UltrasoundSweep * | m_refSweep |
| Reference US sweep defining frame locations and sizes. | |
| std::unique_ptr< UltrasoundSweep > | m_outSweep |
| Output sweep generated by compute() if m_numberOfSlicesPerFrame = 1. | |
| std::unique_ptr< SharedImageSet > | m_outSlabs |
| Output sweep generated by compute() if m_numberOfSlicesPerFrame > 1. | |
| double | m_backgroundIntensity |
| Intensity of the background in the range [0, 1]. | |
| bool | m_useDisplayOptions2d |
| Whether the DisplayOptions2d from the volume should be baked in. | |
| int | m_numberOfSlicesPerFrame |
| For slab reslicing, defines the amount of slices per input US frame. | |
| double | m_sliceSpacing |
| If m_numberOfSlicesPerFrame > 1, defines the spacing between the slices of a slab. | |
| 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. | |
Additional Inherited Members | |
| 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. | |
|
strong |
| VolumeReslicingAlgorithm | ( | SharedImageSet * | inVolume, |
| const UltrasoundSweep * | refSweep ) |
| refSweep | is the reference ultrasound sweep, which pose matrices will be used to reslice the volume |
| inVolume | is the volume to reslice. |
|
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.
|
overridevirtual |
Execute the algorithm.
Implements Algorithm.
|
overridevirtual |
|
protected |
Intensity of the background in the range [0, 1].
Is configurable by the parameter name "Background Intensity"
|
protected |
Whether the DisplayOptions2d from the volume should be baked in.
Is configurable by the parameter name "Use 2D display options"
|
protected |
|
protected |
If m_numberOfSlicesPerFrame > 1, defines the spacing between the slices of a slab.
Is configurable by the parameter name "Slice spacing"
