FeatureEllipse¶

class FeatureEllipse(*args, **kwargs)¶

Bases: BasicFeature

Class that defines 2D ellipse visual feature.

Overloaded function.

__init__(self: visp._visp.visual_features.FeatureEllipse) -> None

Default constructor.

__init__(self: visp._visp.visual_features.FeatureEllipse, x: float, y: float, n20: float, n11: float, n02: float) -> None

basic constructor

Methods

`__init__`	Overloaded function.
`buildFrom`	Overloaded function.
`display`	Overloaded function.
`error`	Overloaded function.
`get_n02`	Returns the visual feature corresponding to the second order centered moments of the ellipse normalized by its area \(n_02 = mu_02/a\) .
`get_n11`	Returns the visual feature corresponding to the second order centered moments of the ellipse normalized by its area \(n_11 = mu_11/a\) .
`get_n20`	Returns the visual feature corresponding to the second order centered moments of the ellipse normalized by its area \(n_20 = mu_20/a\) .
`get_x`	Returns the visual feature corresponding to the ellipse centroid coordinate along camera x-axis.
`get_y`	Returns the visual feature corresponding to the ellipse centroid coordinate along camera y-axis.
`init`	Default initialization.
`interaction`	compute the interaction matrix from a subset a the possible features
`print`	Print the name of the feature.
`selectX`	vpBasicFeature method instantiation
`selectY`	Select as visual feature ellipse centroid coordinate along camera y-axis.
`select_n02`	Select as visual feature second order centered moments of the ellipse normalized by its area that corresponds to \(n_02 = mu_02/a\) .
`select_n11`	Select as visual feature second order centered moments of the ellipse normalized by its area that corresponds to \(n_11 = mu_11/a\) .
`select_n20`	Select as visual feature second order centered moments of the ellipse normalized by its area that corresponds to \(n_20 = mu_20/a\) .
`setABC`
`setMoments`	Update visual features corresponding to the second order centered moments of the ellipse normalized by its area (i.e., such that \(n_{ij} = \mu_{ij}/a\) where \(\mu_{ij}\) are the centered moments and a the area).
`set_x`
`set_xy`
`set_y`

Inherited Methods

`user`
`BasicFeatureSelect`	Indicates who should deallocate the feature.
`setFlags`	Set feature flags to true to prevent warning when re-computing the interaction matrix without having updated the feature.
`FEATURE_ALL`
`getDimension`	Get the feature vector dimension.
`getDeallocate`
`dimension_s`	Return the dimension of the feature vector \(\bf s\) .
`setDeallocate`
`selectAll`	Select all the features.
`get_s`	Get the feature vector \(\bf s\) .
`BasicFeatureDeallocatorType`	Indicates who should deallocate the feature.
`vpServo`

Operators

`__doc__`
`__init__`	Overloaded function.
`__module__`

Attributes

`FEATURE_ALL`
`__annotations__`
`user`
`vpServo`

class BasicFeatureDeallocatorType(self, value: int)¶

Bases: pybind11_object

Indicates who should deallocate the feature.

Values:

user
vpServo

__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¶

class BasicFeatureSelect(self, value: int)¶

Bases: pybind11_object

Indicates who should deallocate the feature.

Values:

user
vpServo

__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__(*args, **kwargs)¶

Overloaded function.

__init__(self: visp._visp.visual_features.FeatureEllipse) -> None

Default constructor.

__init__(self: visp._visp.visual_features.FeatureEllipse, x: float, y: float, n20: float, n11: float, n02: float) -> None

basic constructor

buildFrom(*args, **kwargs)¶

Overloaded function.

buildFrom(self: visp._visp.visual_features.FeatureEllipse, x: float, y: float, n20: float, n11: float, n02: float) -> None
buildFrom(self: visp._visp.visual_features.FeatureEllipse, x: float, y: float, n20: float, n11: float, n02: float, A: float, B: float, C: float) -> None

dimension_s(self) → int¶: Return the dimension of the feature vector \(\bf s\) .

display(*args, **kwargs)¶

Overloaded function.

display(self: visp._visp.visual_features.FeatureEllipse, cam: visp._visp.core.CameraParameters, I: visp._visp.core.ImageGray, color: visp._visp.core.Color = vpColor::green, thickness: int = 1) -> None

Display ellipse feature.

Parameters:

cam: Camera parameters.
I: Image on which features have to be displayed.
color: Color used to display the feature.
thickness: Thickness of the feature representation.

display(self: visp._visp.visual_features.FeatureEllipse, cam: visp._visp.core.CameraParameters, I: visp._visp.core.ImageRGBa, color: visp._visp.core.Color = vpColor::green, thickness: int = 1) -> None

Display ellipse feature.

Parameters:

cam: Camera parameters.
I: Color image on which features have to be displayed.
color: Color used to display the feature.
thickness: Thickness of the feature representation.

error(*args, **kwargs)¶

Overloaded function.

error(self: visp._visp.visual_features.FeatureEllipse, s_star: visp._visp.visual_features.BasicFeature, select: int = FEATURE_ALL) -> visp._visp.core.ColVector

compute the error between two visual features from a subset a the possible features

error(self: visp._visp.visual_features.BasicFeature, s_star: visp._visp.visual_features.BasicFeature, select: int = FEATURE_ALL) -> visp._visp.core.ColVector

Compute the error between two visual features from a subset of the possible features.

getDeallocate(self) → visp._visp.visual_features.BasicFeature.BasicFeatureDeallocatorType¶

getDimension(self, select: int = FEATURE_ALL) → int¶: Get the feature vector dimension.

get_n02(self) → float¶: Returns the visual feature corresponding to the second order centered moments of the ellipse normalized by its area \(n_02 = mu_02/a\) .

get_n11(self) → float¶: Returns the visual feature corresponding to the second order centered moments of the ellipse normalized by its area \(n_11 = mu_11/a\) .

get_n20(self) → float¶: Returns the visual feature corresponding to the second order centered moments of the ellipse normalized by its area \(n_20 = mu_20/a\) .

get_s(self, select: int = FEATURE_ALL) → visp._visp.core.ColVector¶: Get the feature vector \(\bf s\) .

get_x(self) → float¶: Returns the visual feature corresponding to the ellipse centroid coordinate along camera x-axis.

get_y(self) → float¶: Returns the visual feature corresponding to the ellipse centroid coordinate along camera y-axis.

init(self) → None¶: Default initialization.

interaction(self, select: int = FEATURE_ALL) → visp._visp.core.Matrix¶: compute the interaction matrix from a subset a the possible features

print(self, select: int = FEATURE_ALL) → None¶: Print the name of the feature.

static selectAll() → int¶: Select all the features.

static selectX() → int¶

vpBasicFeature method instantiation

Select as visual feature ellipse centroid coordinate along camera x-axis.

static selectY() → int¶: Select as visual feature ellipse centroid coordinate along camera y-axis.

static select_n02() → int¶: Select as visual feature second order centered moments of the ellipse normalized by its area that corresponds to \(n_02 = mu_02/a\) .

static select_n11() → int¶: Select as visual feature second order centered moments of the ellipse normalized by its area that corresponds to \(n_11 = mu_11/a\) .

static select_n20() → int¶: Select as visual feature second order centered moments of the ellipse normalized by its area that corresponds to \(n_20 = mu_20/a\) .

setABC(self, A: float, B: float, C: float) → None¶

setDeallocate(self, d: visp._visp.visual_features.BasicFeature.BasicFeatureDeallocatorType) → None¶

setFlags(self) → None¶: Set feature flags to true to prevent warning when re-computing the interaction matrix without having updated the feature.

setMoments(self, n20: float, n11: float, n02: float) → None¶

Update visual features corresponding to the second order centered moments of the ellipse normalized by its area (i.e., such that \(n_{ij} = \mu_{ij}/a\) where \(\mu_{ij}\) are the centered moments and a the area).

Parameters:

n20: float¶: Second order centered moments.
n11: float¶: Second order centered moments.
n02: float¶: Second order centered moments.

set_x(self, x: float) → None¶

set_xy(self, x: float, y: float) → None¶

set_y(self, y: float) → None¶