MeshLib Python Docs
Loading...
Searching...
No Matches
mrmeshpy.ICPProperties Class Reference

Public Member Functions

None __init__ (self)
 
None __init__ (self, ICPProperties arg0)
 
None __init__ (self, ICPMethod method, float p2plAngleLimit, float p2plScaleLimit, float cosThreshold, float distThresholdSq, float farDistFactor, ICPMode icpMode, Vector3f fixedRotationAxis, int iterLimit, int badIterStopCount, float exitVal, bool mutualClosest)
 
int badIterStopCount (self)
 
None badIterStopCount (self, int arg1)
 
float cosThreshold (self)
 
None cosThreshold (self, float arg1)
 
float distThresholdSq (self)
 
None distThresholdSq (self, float arg1)
 
float exitVal (self)
 
None exitVal (self, float arg1)
 
float farDistFactor (self)
 
None farDistFactor (self, float arg1)
 
Vector3f fixedRotationAxis (self)
 
None fixedRotationAxis (self, Vector3f arg1)
 
ICPMode icpMode (self)
 
None icpMode (self, ICPMode arg1)
 
int iterLimit (self)
 
None iterLimit (self, int arg1)
 
ICPMethod method (self)
 
None method (self, ICPMethod arg1)
 
bool mutualClosest (self)
 
None mutualClosest (self, bool arg1)
 
float p2plAngleLimit (self)
 
None p2plAngleLimit (self, float arg1)
 
float p2plScaleLimit (self)
 
None p2plScaleLimit (self, float arg1)
 

Static Public Member Functions

None __init__ (*args, **kwargs)
 
ICPProperties operator (*args, **kwargs)
 
ICPProperties operator (*args, **kwargs)
 

Static Protected Attributes

typing _offsetof_badIterStopCount = 44
 
typing _offsetof_cosThreshold = 12
 
typing _offsetof_distThresholdSq = 16
 
typing _offsetof_exitVal = 48
 
typing _offsetof_farDistFactor = 20
 
typing _offsetof_fixedRotationAxis = 28
 
typing _offsetof_icpMode = 24
 
typing _offsetof_iterLimit = 40
 
typing _offsetof_method = 0
 
typing _offsetof_mutualClosest = 52
 
typing _offsetof_p2plAngleLimit = 4
 
typing _offsetof_p2plScaleLimit = 8
 

Detailed Description

Generated from:  MR::ICPProperties

parameters of ICP algorithm

Constructor & Destructor Documentation

◆ __init__() [1/4]

None mrmeshpy.ICPProperties.__init__ ( * args,
** kwargs )
static

◆ __init__() [2/4]

None mrmeshpy.ICPProperties.__init__ ( self)

◆ __init__() [3/4]

None mrmeshpy.ICPProperties.__init__ ( self,
ICPProperties arg0 )
Implicit copy constructor.

◆ __init__() [4/4]

None mrmeshpy.ICPProperties.__init__ ( self,
ICPMethod method,
float p2plAngleLimit,
float p2plScaleLimit,
float cosThreshold,
float distThresholdSq,
float farDistFactor,
ICPMode icpMode,
Vector3f fixedRotationAxis,
int iterLimit,
int badIterStopCount,
float exitVal,
bool mutualClosest )
Implicit aggregate constructor.

Member Function Documentation

◆ badIterStopCount() [1/2]

int mrmeshpy.ICPProperties.badIterStopCount ( self)
The algorithm will stop before making all (iterLimit) iterations, if there were
consecutive (badIterStopCount) iterations, during which the average distance between points in active pairs did not diminish.

◆ badIterStopCount() [2/2]

None mrmeshpy.ICPProperties.badIterStopCount ( self,
int arg1 )

◆ cosThreshold() [1/2]

float mrmeshpy.ICPProperties.cosThreshold ( self)
in [-1,1]

◆ cosThreshold() [2/2]

None mrmeshpy.ICPProperties.cosThreshold ( self,
float arg1 )

◆ distThresholdSq() [1/2]

float mrmeshpy.ICPProperties.distThresholdSq ( self)
[distance^2]

◆ distThresholdSq() [2/2]

None mrmeshpy.ICPProperties.distThresholdSq ( self,
float arg1 )

◆ exitVal() [1/2]

float mrmeshpy.ICPProperties.exitVal ( self)
[distance]

◆ exitVal() [2/2]

None mrmeshpy.ICPProperties.exitVal ( self,
float arg1 )

◆ farDistFactor() [1/2]

float mrmeshpy.ICPProperties.farDistFactor ( self)
dimensionless

◆ farDistFactor() [2/2]

None mrmeshpy.ICPProperties.farDistFactor ( self,
float arg1 )

◆ fixedRotationAxis() [1/2]

Vector3f mrmeshpy.ICPProperties.fixedRotationAxis ( self)
Additional parameter for ICPMode::OrthogonalAxis and ICPMode::FixedAxis transformation groups.

◆ fixedRotationAxis() [2/2]

None mrmeshpy.ICPProperties.fixedRotationAxis ( self,
Vector3f arg1 )

◆ icpMode() [1/2]

ICPMode mrmeshpy.ICPProperties.icpMode ( self)
Selects the group of transformations, where to find a solution (e.g. with scaling or without, with rotation or without, ...).
See the description of each option in ICPMode.

◆ icpMode() [2/2]

None mrmeshpy.ICPProperties.icpMode ( self,
ICPMode arg1 )

◆ iterLimit() [1/2]

int mrmeshpy.ICPProperties.iterLimit ( self)
The maximum number of iterations that the algorithm can perform.
Increase this parameter if you need a higher precision or if initial approximation is not very precise.

◆ iterLimit() [2/2]

None mrmeshpy.ICPProperties.iterLimit ( self,
int arg1 )

◆ method() [1/2]

ICPMethod mrmeshpy.ICPProperties.method ( self)
The method how to update transformation from point pairs, see description of each option in ICPMethod

◆ method() [2/2]

None mrmeshpy.ICPProperties.method ( self,
ICPMethod arg1 )

◆ mutualClosest() [1/2]

bool mrmeshpy.ICPProperties.mutualClosest ( self)
A pair of points is activated only if both points in the pair are mutually closest (reciprocity test passed),
some papers recommend this mode for filtering out wrong pairs, but it can be too aggressive and deactivate (almost) all pairs.

◆ mutualClosest() [2/2]

None mrmeshpy.ICPProperties.mutualClosest ( self,
bool arg1 )

◆ operator() [1/2]

ICPProperties mrmeshpy.ICPProperties.operator ( * args,
** kwargs )
static

◆ operator() [2/2]

ICPProperties mrmeshpy.ICPProperties.operator ( * args,
** kwargs )
static

◆ p2plAngleLimit() [1/2]

float mrmeshpy.ICPProperties.p2plAngleLimit ( self)
[radians]

◆ p2plAngleLimit() [2/2]

None mrmeshpy.ICPProperties.p2plAngleLimit ( self,
float arg1 )

◆ p2plScaleLimit() [1/2]

float mrmeshpy.ICPProperties.p2plScaleLimit ( self)
Scaling during one iteration of ICPMethod::PointToPlane will be limited by this value.
This is to reduce possible instability.

◆ p2plScaleLimit() [2/2]

None mrmeshpy.ICPProperties.p2plScaleLimit ( self,
float arg1 )

Member Data Documentation

◆ _offsetof_badIterStopCount

typing mrmeshpy.ICPProperties._offsetof_badIterStopCount = 44
staticprotected

◆ _offsetof_cosThreshold

typing mrmeshpy.ICPProperties._offsetof_cosThreshold = 12
staticprotected

◆ _offsetof_distThresholdSq

typing mrmeshpy.ICPProperties._offsetof_distThresholdSq = 16
staticprotected

◆ _offsetof_exitVal

typing mrmeshpy.ICPProperties._offsetof_exitVal = 48
staticprotected

◆ _offsetof_farDistFactor

typing mrmeshpy.ICPProperties._offsetof_farDistFactor = 20
staticprotected

◆ _offsetof_fixedRotationAxis

typing mrmeshpy.ICPProperties._offsetof_fixedRotationAxis = 28
staticprotected

◆ _offsetof_icpMode

typing mrmeshpy.ICPProperties._offsetof_icpMode = 24
staticprotected

◆ _offsetof_iterLimit

typing mrmeshpy.ICPProperties._offsetof_iterLimit = 40
staticprotected

◆ _offsetof_method

typing mrmeshpy.ICPProperties._offsetof_method = 0
staticprotected

◆ _offsetof_mutualClosest

typing mrmeshpy.ICPProperties._offsetof_mutualClosest = 52
staticprotected

◆ _offsetof_p2plAngleLimit

typing mrmeshpy.ICPProperties._offsetof_p2plAngleLimit = 4
staticprotected

◆ _offsetof_p2plScaleLimit

typing mrmeshpy.ICPProperties._offsetof_p2plScaleLimit = 8
staticprotected

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