MbtXmlGenericParser

class MbtXmlGenericParser(self, type: int = EDGE_PARSER)

Bases: pybind11_object

Parse an Xml file to extract configuration parameters of a mbtConfig object.

Data parser for the model-based tracker.

Methods

__init__

getAngleAppear

Get the angle to determine if a face appeared.

getAngleDisappear

Get the angle to determine if a face disappeared.

getCameraParameters

getDepthDenseSamplingStepX

Get depth dense sampling step in X.

getDepthDenseSamplingStepY

Get depth dense sampling step in Y.

getDepthNormalFeatureEstimationMethod

Get depth normal feature estimation method.

getDepthNormalPclPlaneEstimationMethod

Get depth normal PCL plane estimation method.

getDepthNormalPclPlaneEstimationRansacMaxIter

Get depth normal PCL maximum number of iterations.

getDepthNormalPclPlaneEstimationRansacThreshold

Get depth normal PCL RANSAC threshold.

getDepthNormalSamplingStepX

Get depth normal sampling step in X.

getDepthNormalSamplingStepY

Get depth normal sampling step in Y.

getEdgeMe

Get moving edge parameters.

getFarClippingDistance

Get the far clipping distance.

getFovClipping

Get if FOV clipping should be used or not.

getKltBlockSize

Get the size of a block.

getKltHarrisParam

Get the Harris free parameter.

getKltMaskBorder

Get the Border of the mask.

getKltMaxFeatures

Get the maximum number of features for the KLT.

getKltMinDistance

Get the minimum distance between KLT points.

getKltPyramidLevels

Get the number of pyramid levels

getKltQuality

Get the quality of the KLT.

getKltWindowSize

Get the size of the window used in the KLT tracker.

getLodMinLineLengthThreshold

Get the minimum line length to track a segment when LOD is enabled.

getLodMinPolygonAreaThreshold

Get the minimum polygon area to track a face when LOD is enabled.

getLodState

Get the state of LOD setting.

getNearClippingDistance

Get the near clipping distance.

getProjectionErrorKernelSize

getProjectionErrorMe

Get ME parameters for projection error computation.

hasFarClippingDistance

Has Far clipping been specified?

hasNearClippingDistance

Has Near clipping been specified?

parse

Parse an XML config file that contains parameters for the Generic Model-Based Tracker.

setAngleAppear

Set the angle to determine if a face appeared.

setAngleDisappear

Set the angle to determine if a face disappeared.

setCameraParameters

Set camera parameters.

setDepthDenseSamplingStepX

Set depth dense sampling step in X.

setDepthDenseSamplingStepY

Set depth dense sampling step in Y.

setDepthNormalFeatureEstimationMethod

Set depth normal feature estimation method.

setDepthNormalPclPlaneEstimationMethod

Set depth normal PCL plane estimation method.

setDepthNormalPclPlaneEstimationRansacMaxIter

Set depth normal PCL RANSAC maximum number of iterations.

setDepthNormalPclPlaneEstimationRansacThreshold

Set depth normal PCL RANSAC threshold.

setDepthNormalSamplingStepX

Set depth normal sampling step in X.

setDepthNormalSamplingStepY

Set depth normal sampling step in Y.

setEdgeMe

Set moving edge parameters.

setFarClippingDistance

Set the far clipping distance.

setKltBlockSize

Set the size of a block.

setKltHarrisParam

Set the Harris free parameter.

setKltMaskBorder

Set the Border of the mask.

setKltMaxFeatures

Set the maximum number of features for the KLT.

setKltMinDistance

Set the minimum distance between KLT points.

setKltPyramidLevels

Set the number of pyramid levels

setKltQuality

Set the quality of the KLT.

setKltWindowSize

Set the size of the window used in the KLT tracker.

setNearClippingDistance

Set the near clipping distance.

setProjectionErrorKernelSize

Set kernel size used for projection error computation.

setProjectionErrorMe

Set ME parameters for projection error computation.

setVerbose

Set verbose mode (print tracker configuration in the standard output if set).

Inherited Methods

Operators

__doc__

__init__

__module__

Attributes

DEPTH_DENSE_PARSER

DEPTH_NORMAL_PARSER

EDGE_PARSER

KLT_PARSER

PROJECTION_ERROR_PARSER

__annotations__

class ParserType(self, value: int)

Bases: pybind11_object

Values:

  • EDGE_PARSER: Parser for model-based tracking using moving edges features.

  • KLT_PARSER: Parser for model-based tracking using KLT features.

  • DEPTH_NORMAL_PARSER: Parser for model-based tracking using depth normal features.

  • DEPTH_DENSE_PARSER: Parser for model-based tracking using depth dense features.

  • PROJECTION_ERROR_PARSER: Parser for projection error computation parameters.

__and__(self, other: object) object
__eq__(self, other: object) bool
__ge__(self, other: object) bool
__getstate__(self) int
__gt__(self, other: object) bool
__hash__(self) int
__index__(self) int
__init__(self, value: int)
__int__(self) int
__invert__(self) object
__le__(self, other: object) bool
__lt__(self, other: object) bool
__ne__(self, other: object) bool
__or__(self, other: object) object
__rand__(self, other: object) object
__ror__(self, other: object) object
__rxor__(self, other: object) object
__setstate__(self, state: int) None
__xor__(self, other: object) object
property name : str
__init__(self, type: int = EDGE_PARSER)
getAngleAppear(self) float

Get the angle to determine if a face appeared.

getAngleDisappear(self) float

Get the angle to determine if a face disappeared.

getCameraParameters(self, cam: visp._visp.core.CameraParameters) None
getDepthDenseSamplingStepX(self) int

Get depth dense sampling step in X.

getDepthDenseSamplingStepY(self) int

Get depth dense sampling step in Y.

getDepthNormalFeatureEstimationMethod(self) visp._visp.mbt.MbtFaceDepthNormal.FeatureEstimationType

Get depth normal feature estimation method.

getDepthNormalPclPlaneEstimationMethod(self) int

Get depth normal PCL plane estimation method.

getDepthNormalPclPlaneEstimationRansacMaxIter(self) int

Get depth normal PCL maximum number of iterations.

getDepthNormalPclPlaneEstimationRansacThreshold(self) float

Get depth normal PCL RANSAC threshold.

getDepthNormalSamplingStepX(self) int

Get depth normal sampling step in X.

getDepthNormalSamplingStepY(self) int

Get depth normal sampling step in Y.

getEdgeMe(self, ecm: visp._visp.me.Me) None

Get moving edge parameters.

getFarClippingDistance(self) float

Get the far clipping distance.

getFovClipping(self) bool

Get if FOV clipping should be used or not.

getKltBlockSize(self) int

Get the size of a block.

getKltHarrisParam(self) float

Get the Harris free parameter.

getKltMaskBorder(self) int

Get the Border of the mask.

getKltMaxFeatures(self) int

Get the maximum number of features for the KLT.

getKltMinDistance(self) float

Get the minimum distance between KLT points.

getKltPyramidLevels(self) int

Get the number of pyramid levels

getKltQuality(self) float

Get the quality of the KLT.

getKltWindowSize(self) int

Get the size of the window used in the KLT tracker.

getLodMinLineLengthThreshold(self) float

Get the minimum line length to track a segment when LOD is enabled.

getLodMinPolygonAreaThreshold(self) float

Get the minimum polygon area to track a face when LOD is enabled.

getLodState(self) bool

Get the state of LOD setting.

getNearClippingDistance(self) float

Get the near clipping distance.

getProjectionErrorKernelSize(self) int
getProjectionErrorMe(self, me: visp._visp.me.Me) None

Get ME parameters for projection error computation.

hasFarClippingDistance(self) bool

Has Far clipping been specified?

Returns:

True if yes, False otherwise.

hasNearClippingDistance(self) bool

Has Near clipping been specified?

Returns:

True if yes, False otherwise.

parse(self, filename: str) None

Parse an XML config file that contains parameters for the Generic Model-Based Tracker.

Parameters:
filename: str

Document to parse.

setAngleAppear(self, aappear: float) None

Set the angle to determine if a face appeared.

Parameters:
aappear: float

New angleAppear

setAngleDisappear(self, adisappear: float) None

Set the angle to determine if a face disappeared.

Parameters:
adisappear: float

New angleDisappear

setCameraParameters(self, cam: visp._visp.core.CameraParameters) None

Set camera parameters.

Parameters:
cam: visp._visp.core.CameraParameters

New camera parameters

setDepthDenseSamplingStepX(self, stepX: int) None

Set depth dense sampling step in X.

Parameters:
stepX: int

New sampling step

setDepthDenseSamplingStepY(self, stepY: int) None

Set depth dense sampling step in Y.

Parameters:
stepY: int

New sampling step

setDepthNormalFeatureEstimationMethod(self, method: visp._visp.mbt.MbtFaceDepthNormal.FeatureEstimationType) None

Set depth normal feature estimation method.

Parameters:
method: visp._visp.mbt.MbtFaceDepthNormal.FeatureEstimationType

New feature estimation method

setDepthNormalPclPlaneEstimationMethod(self, method: int) None

Set depth normal PCL plane estimation method.

Parameters:
method: int

New PCL plane estimation method

setDepthNormalPclPlaneEstimationRansacMaxIter(self, maxIter: int) None

Set depth normal PCL RANSAC maximum number of iterations.

Parameters:
maxIter: int

New maximum number of iterations

setDepthNormalPclPlaneEstimationRansacThreshold(self, threshold: float) None

Set depth normal PCL RANSAC threshold.

Parameters:
threshold: float

New RANSAC threshold

setDepthNormalSamplingStepX(self, stepX: int) None

Set depth normal sampling step in X.

Parameters:
stepX: int

New sampling step

setDepthNormalSamplingStepY(self, stepY: int) None

Set depth normal sampling step in Y.

Parameters:
stepY: int

New sampling step

setEdgeMe(self, ecm: visp._visp.me.Me) None

Set moving edge parameters.

setFarClippingDistance(self, fclip: float) None

Set the far clipping distance.

Parameters:
fclip: float

New farClipping

setKltBlockSize(self, bs: int) None

Set the size of a block.

Parameters:
bs: int

New blockSize

setKltHarrisParam(self, hp: float) None

Set the Harris free parameter.

Parameters:
hp: float

New harrisParam

setKltMaskBorder(self, mb: int) None

Set the Border of the mask.

Parameters:
mb: int

= new maskBorder

setKltMaxFeatures(self, mF: int) None

Set the maximum number of features for the KLT.

Parameters:
mF: int

New maxFeatures

setKltMinDistance(self, mD: float) None

Set the minimum distance between KLT points.

Parameters:
mD: float

New minDist

setKltPyramidLevels(self, pL: int) None

Set the number of pyramid levels

Parameters:
pL: int

New pyramidLevels

setKltQuality(self, q: float) None

Set the quality of the KLT.

Parameters:
q: float

New quality

setKltWindowSize(self, w: int) None

Set the size of the window used in the KLT tracker.

Parameters:
w: int

New winSize

setNearClippingDistance(self, nclip: float) None

Set the near clipping distance.

Parameters:
nclip: float

New nearClipping

setProjectionErrorKernelSize(self, size: int) None

Set kernel size used for projection error computation.

Parameters:
size: int

Kernel size computed as kernel_size = size*2 + 1

setProjectionErrorMe(self, me: visp._visp.me.Me) None

Set ME parameters for projection error computation.

Parameters:
me: visp._visp.me.Me

ME parameters

setVerbose(self, verbose: bool) None

Set verbose mode (print tracker configuration in the standard output if set).

Parameters:
verbose: bool

verbose flag