 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/Base/DistanceVolumeAlgorithm.h>
Algorithm to create a distance-volume from a mesh. More...
Inheritance diagram for DistanceVolumeAlgorithm:Algorithm to create a distance-volume from a mesh.
This algorithm provides an optional GPU implementation, which requires OpenGL 4.3. CPU and GPU versions may yield slightly different results (including the dimensions of the result) due to numerical precision.
Public Member Functions | |
| DistanceVolumeAlgorithm (const Mesh *mesh) | |
| void | compute () override |
| Execute the algorithm. | |
| virtual OwningDataList | takeOutput () override |
| Return any new Data that was created by the Algorithm during the last call to compute(). | |
| Algorithm::Status | computeDistanceVolumeGPU (const Mesh &mesh, SharedImage &outputIntegerBuffer, SharedImage &distanceVolumeOut, bool signedDistance=true, bool extendApproximate=false, std::optional< size_t > remainingMemoryMB=std::nullopt) |
| Computes a volume of sub-voxel precise distances to the Mesh on the GPU Requires OpenGL 4.3. | |
| std::unique_ptr< SharedImage > | computeDistanceVolumeGPU (const Mesh &mesh, const ImageDescriptorWorld &idw, bool signedDistance=true, bool extendApproximate=false, std::optional< size_t > remainingMemoryMB=std::nullopt) |
| Computes a volume of sub-voxel precise distances to the Mesh on the GPU Requires OpenGL 4.3. | |
| 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 | 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=nullptr) |
| 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_marginPx = {"marginPx", 10, this} |
| Margin in pixels (sum of front and back margin) For technical reasons, this should be greater than or equal to 3. | |
| Parameter< double > | p_preciseRegionWidthPx = {"preciseRegionWidthPx", 10, this} |
| Width of region (in pixels) around mesh in each direction where sub-voxel precise distances are computed. | |
| Parameter< bool > | p_useGPU = {"useGPU", true, this} |
| Run on GPU if possible (requires OpenGL 4.3, falls back to CPU if unavailable) | |
| Parameter< bool > | p_forceGPU = {"forceGPU", false, this} |
| Abort processing instead of using the slow CPU mode. | |
| Parameter< double > | p_distVolResolution = Parameter<double>{"distanceVolumeResolution", 1.0, this} |
| Spacing of the output image. | |
| Parameter< bool > | p_usePixelDistances = Parameter<bool>{"usePixelDistances", true, this} |
| Whether to use pixel coordinates for distance. | |
| Parameter< std::optional< size_t > > | p_memoryLimitMB = {"memoryLimitMB", std::nullopt, this} |
| Maximum memory in MB of distance volume. | |
| Parameter< bool > | p_signedDistance = {"signedDistance", true, this} |
| Whether to use signed distance. | |
| 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 |
| Algorithm::Status computeDistanceVolumeGPU | ( | const Mesh & | mesh, |
| SharedImage & | outputIntegerBuffer, | ||
| SharedImage & | distanceVolumeOut, | ||
| bool | signedDistance = true, | ||
| bool | extendApproximate = false, | ||
| std::optional< size_t > | remainingMemoryMB = std::nullopt ) |
Computes a volume of sub-voxel precise distances to the Mesh on the GPU Requires OpenGL 4.3.
This function only computes a distance volume, unlike compute() which may perform rescaling, fill holes etc. Uses 16-bit fixed-point rounding internally. Sub-voxel precision is only used in a region of size p_preciseRegionWidth around the mesh.
| mesh | The mesh to compute the distance volume for. |
| outputIntegerBuffer | A buffer of of the same shape as distanceVolumeOut with type R32UI that is used internally for computing the distance volume. Passing this buffer here avoids the need to reallocate it on each call to this function. |
| distanceVolumeOut | The output distance volume. Must be of type R32F. |
| signedDistance | if true, the distance volume is signed, i.e. negative inside the mesh. |
| extendApproximate | if true, the final distance volume includes an extension of the precise distance by some approximate distance, such as the chamfer distance. This may be done on the CPU. |
| remainingMemoryMB | Maximum amount of memory to allocate for images. This is often sensible to set because large meshes may lead to very large bounding volumes being allocated. Processing is aborted before more is allocated. If remainingMemoryMB is not set, remainingMemoryMB is set to p_memoryLimitMB. than the provided value. |
| std::unique_ptr< SharedImage > computeDistanceVolumeGPU | ( | const Mesh & | mesh, |
| const ImageDescriptorWorld & | idw, | ||
| bool | signedDistance = true, | ||
| bool | extendApproximate = false, | ||
| std::optional< size_t > | remainingMemoryMB = std::nullopt ) |
Computes a volume of sub-voxel precise distances to the Mesh on the GPU Requires OpenGL 4.3.
This function only computes a distance volume, unlike compute() which may perform rescaling, fill holes etc. Uses 16-bit fixed-point rounding internally. Sub-voxel precision is only used in a region of size p_preciseRegionWidth around the mesh.
| mesh | The mesh to compute the distance volume for. |
| idw | ImageDescriptorWorld describing the desired shape of the output volume. |
| signedDistance | if true, the distance volume is signed, i.e. negative inside the mesh. |
| extendApproximate | if true, the final distance volume includes an extension of the precise distance by some approximate distance, such as the chamfer distance. This may be done on the CPU. |
| remainingMemoryMB | Maximum amount of memory to allocate for images. This is often sensible to set because large meshes may lead to very large bounding volumes being allocated. Processing is aborted before more is allocated. If remainingMemoryMB is not set, remainingMemoryMB is set to p_memoryLimitMB. |
Whether to use pixel coordinates for distance.
true