 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/Seg/LineToIsosurfaceIntersectionAlgorithm.h>
Finds the intersection between a ray and the first isosurface. More...
Inheritance diagram for LineToIsosurfaceIntersectionAlgorithm:Finds the intersection between a ray and the first isosurface.
The algorithm finds the first intersection of a line (or more precisely a ray) with the first encountered isoline for the same volume. The volume is examined from the starting point of the line along its direction, up to the image boundary.
For performance reasons, no segmentation or isoline is computed for the whole volume, but the values of the pixels encountered on the path are considered. The first time that the encountered values go below (or above) the given threshold is considered as the result. For robustness, it is possible to specify the number of consecutive voxels below (or above) the given threshold that are required to considered the hit valid.
The line must be set by the controller through the dedicated method (commonly it should be extracted by some point-based annotation in the controller). The output of the algorithm also cannot be passed through the standard output() method, but must be retrieved through the dedicated functionality.
Classes | |
| struct | IntersectionCylindricalCoordinates |
Public Types | |
| enum class | ThresholdingMode { AboveThenBelow , BelowThenAbove } |
| Specifies the direction of the gradient expected at the isosurface. More... | |
| 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 | |
| LineToIsosurfaceIntersectionAlgorithm (SharedImageSet &ct) | |
| void | setLineInPixelCoordinates (const Geometry::LineBase &l) |
| Sets the input line. | |
| void | setLineInWorldCoordinates (const Geometry::LineBase &l) |
| Sets the input line. | |
| std::optional< vec3 > | getIntersectionInPixelCoordinates () |
| Gets the 3D coordinates of the intersection The result is a point lying on the input line, and within the last voxel (from the starting point to the end of the line) which is above (or below) the specified threshold. | |
| std::optional< vec3 > | getIntersectionInWorldCoordinates () |
| Gets the 3D coordinates of the intersection The result is a point lying on the input line, and within the last voxel (from the starting point to the end of the line) which is above (or below) the specified threshold. | |
| std::optional< IntersectionCylindricalCoordinates > | getIntersectionCylindricalCoordinates () |
| void | compute () override |
| Execute the algorithm. | |
| SharedImageSet & | dataRef () |
| Reference to the input data. | |
| 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 | configure (const Properties *p) |
| Configure this object instance by de-serializing the given Properties. | |
| 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< int > | p_minConsecutiveVoxels = {"minConsecutiveVoxels", 1, this} |
| Scalar value used as threshold to find the intersection (default: skin/air barrier in CT) | |
| Parameter< double > | p_threshold = {"threshold", -950.0, this} |
| Direction of the gradient required at the intersection. | |
| Parameter< ThresholdingMode > | p_thresholdingMode = {"thresholdingMode", ThresholdingMode::AboveThenBelow, 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. | |
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. | |
| 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. | |
|
strong |
| void setLineInPixelCoordinates | ( | const Geometry::LineBase & | l | ) |
Sets the input line.
The starting point is used as start for the search. If the start lies outside the volume, the first point on the line within the volume is used as starting point. If the line is line segment, the intersection calculation is limited to the line extent, otherwise to the volume extent.
| void setLineInWorldCoordinates | ( | const Geometry::LineBase & | l | ) |
Sets the input line.
The starting point is used as start for the search. If the start lies outside the volume, the first point on the line within the volume is used as starting point. If the line is line segment, the intersection calculation is limited to the line extent, otherwise to the volume extent.
| std::optional< vec3 > getIntersectionInPixelCoordinates | ( | ) |
Gets the 3D coordinates of the intersection The result is a point lying on the input line, and within the last voxel (from the starting point to the end of the line) which is above (or below) the specified threshold.
Or none, if no intersection with an isosurface of the specified value and gradient was found.
| std::optional< vec3 > getIntersectionInWorldCoordinates | ( | ) |
Gets the 3D coordinates of the intersection The result is a point lying on the input line, and within the last voxel (from the starting point to the end of the line) which is above (or below) the specified threshold.
Or none, if no intersection with an isosurface of the specified value and gradient was found.
|
overridevirtual |
Execute the algorithm.
Implements Algorithm.
|
inline |
Reference to the input data.
Number of required consecutive voxels below/above the threshold to consider the hit valid (default: 1)
