FeatureLuminance¶

class FeatureLuminance(*args, **kwargs)¶

Bases: BasicFeature

Class that defines the image luminance visual feature.

For more details see [6] .

Overloaded function.

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

Default constructor that build a visual feature.

__init__(self: visp._visp.visual_features.FeatureLuminance, f: visp._visp.visual_features.FeatureLuminance) -> None

Copy constructor.

Methods

`__init__`	Overloaded function.
`buildFrom`	Build a luminance feature directly from the image
`display`	Overloaded function.
`error`	Overloaded function.
`getBorder`
`get_Z`	Get the value of \(Z\) which represents the depth in the 3D camera frame.
`init`	Overloaded function.
`interaction`	Overloaded function.
`print`	Not implemented.
`setCameraParameters`
`set_Z`	Set the value of \(Z\) which represents the depth in the 3D camera frame.

Inherited Methods

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

Operators

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

Attributes

`DEFAULT_BORDER`
`FEATURE_ALL`
`__annotations__`
`cam`
`deallocate`
`dim_s`
`nbParameters`
`s`
`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.FeatureLuminance) -> None

Default constructor that build a visual feature.

__init__(self: visp._visp.visual_features.FeatureLuminance, f: visp._visp.visual_features.FeatureLuminance) -> None

Copy constructor.

buildFrom(self, I: visp._visp.core.ImageGray) → visp._visp.visual_features.FeatureLuminance¶: Build a luminance feature directly from the image

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

display(*args, **kwargs)¶

Overloaded function.

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

Not implemented.

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

Not implemented.

error(*args, **kwargs)¶

Overloaded function.

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

Compute the error \((I-I^*)\) between the current and the desired

Parameters:

s_star: Desired visual feature.
select: Not used.

error(self: visp._visp.visual_features.FeatureLuminance, s_star: visp._visp.visual_features.BasicFeature, e: visp._visp.core.ColVector) -> None

Compute the error \((I-I^*)\) between the current and the desired

Parameters:

s_star: Desired visual feature.
e: Error between the current and the desired 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.

getBorder(self) → int¶

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

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

get_Z(self) → float¶

Get the value of \(Z\) which represents the depth in the 3D camera frame.

Returns:: The value of \(Z\) .

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

init(*args, **kwargs)¶

Overloaded function.

init(self: visp._visp.visual_features.FeatureLuminance, _nbr: int, _nbc: int, _Z: float) -> None
init(self: visp._visp.visual_features.FeatureLuminance) -> None

Initialize the memory space requested for vpFeatureLuminance visual feature.

interaction(*args, **kwargs)¶

Overloaded function.

interaction(self: visp._visp.visual_features.FeatureLuminance, select: int = FEATURE_ALL) -> visp._visp.core.Matrix

Compute and return the interaction matrix \(L_I\) . The computation is made thanks to the values of the luminance features \(I\)

interaction(self: visp._visp.visual_features.FeatureLuminance, L: visp._visp.core.Matrix) -> None

Compute and return the interaction matrix \(L_I\) . The computation is made thanks to the values of the luminance features \(I\)

print(self, select: int = FEATURE_ALL) → None¶: Not implemented.

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

setCameraParameters(self, _cam: visp._visp.core.CameraParameters) → 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.

set_Z(self, Z: float) → None¶: Set the value of \(Z\) which represents the depth in the 3D camera frame.