CCCoreLib 31 May 2022
CloudCompare Core algorithms
Public Member Functions | Public Attributes | List of all members
CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams Struct Reference

Cloud-to-cloud 'nearest neighbors' distances computation parameters. More...

#include <DistanceComputationTools.h>

Collaboration diagram for CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams:
Collaboration graph
[legend]

Public Member Functions

 Cloud2CloudDistancesComputationParams ()
 Default constructor/initialization.
 

Public Attributes

unsigned char octreeLevel
 Level of subdivision of the octree at witch to apply the distance computation algorithm. More...
 
ScalarType maxSearchDist
 Maximum search distance (true distance won't be computed if greater) More...
 
bool multiThread
 Whether to use multi-thread or single thread mode. More...
 
int maxThreadCount
 Maximum number of threads to use (0 = max)
 
LOCAL_MODEL_TYPES localModel
 Type of local 3D modeling to use. More...
 
bool useSphericalSearchForLocalModel
 Whether to use a fixed number of neighbors or a (sphere) radius for nearest neighbors search. More...
 
unsigned kNNForLocalModel
 Number of neighbors for nearest neighbors search (local model) More...
 
ScalarType radiusForLocalModel
 Radius for nearest neighbors search (local model) More...
 
bool reuseExistingLocalModels
 Whether to use an approximation for local model computation. More...
 
ReferenceCloudCPSet
 Container of (references to) points to store the "Closest Point Set". More...
 
ScalarFieldsplitDistances [3]
 Split distances (one scalar field per dimension: X, Y and Z)
 
bool resetFormerDistances
 Whether to keep the existing distances as is (if any) or not. More...
 

Detailed Description

Cloud-to-cloud 'nearest neighbors' distances computation parameters.

Member Data Documentation

◆ CPSet

ReferenceCloud* CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams::CPSet

Container of (references to) points to store the "Closest Point Set".

The Closest Point Set corresponds to (the reference to) each compared point's closest neighbor.

Warning
Not compatible with max search distance (see maxSearchDist)

◆ kNNForLocalModel

unsigned CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams::kNNForLocalModel

Number of neighbors for nearest neighbors search (local model)

For local models only (i.e. ignored if localModel = NO_MODEL). Ignored if useSphericalSearchForLocalModel is true.

◆ localModel

LOCAL_MODEL_TYPES CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams::localModel

Type of local 3D modeling to use.

Default: NO_MODEL. Otherwise see CC_LOCAL_MODEL_TYPES.

◆ maxSearchDist

ScalarType CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams::maxSearchDist

Maximum search distance (true distance won't be computed if greater)

Set to -1 to deactivate (default).

Warning
Not compatible with closest point set determination (see CPSet)

◆ multiThread

bool CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams::multiThread

Whether to use multi-thread or single thread mode.

If maxSearchDist > 0, single thread mode will be forced.

◆ octreeLevel

unsigned char CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams::octreeLevel

Level of subdivision of the octree at witch to apply the distance computation algorithm.

If set to 0 (default) the algorithm will try to guess the best level automatically.

◆ radiusForLocalModel

ScalarType CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams::radiusForLocalModel

Radius for nearest neighbors search (local model)

For local models only (i.e. ignored if localModel = NO_MODEL). Ignored if useSphericalSearchForLocalModel is true.

◆ resetFormerDistances

bool CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams::resetFormerDistances

Whether to keep the existing distances as is (if any) or not.

By default, any previous distances/scalar values stored in the 'enabled' scalar field will be reset before computing them again.

◆ reuseExistingLocalModels

bool CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams::reuseExistingLocalModels

Whether to use an approximation for local model computation.

For local models only (i.e. ignored if localModel = NO_MODEL). Computation is much faster but less "controlled".

◆ useSphericalSearchForLocalModel

bool CCCoreLib::DistanceComputationTools::Cloud2CloudDistancesComputationParams::useSphericalSearchForLocalModel

Whether to use a fixed number of neighbors or a (sphere) radius for nearest neighbors search.

For local models only (i.e. ignored if localModel = NO_MODEL).


The documentation for this struct was generated from the following file: