FeatureDisplay

class FeatureDisplay

Bases: pybind11_object

Interface with the image for feature display.

Methods

__init__

displayCylinder

Overloaded function.

displayEllipse

Overloaded function.

displayLine

Overloaded function.

displayPoint

Overloaded function.

Inherited Methods

Operators

__doc__

__init__

__module__

Attributes

__annotations__

__init__(*args, **kwargs)
static displayCylinder(*args, **kwargs)

Overloaded function.

  1. displayCylinder(rho1: float, theta1: float, rho2: float, theta2: float, cam: visp._visp.core.CameraParameters, I: visp._visp.core.ImageGray, color: visp._visp.core.Color = vpColor::green, thickness: int = 1) -> None

Display cylinder limbs as two 2D lines with coordinates \((\rho, \theta)\) expressed in the image plane. These coordinates are obtained after perspective projection of the cylinder.

Parameters:
rho1

Cylinder first limb parameters \((\rho, \theta)\) expressed in the image plane.

theta1

Cylinder first limb parameters \((\rho, \theta)\) expressed in the image plane.

rho2

Cylinder second limb parameters \((\rho, \theta)\) expressed in the image plane.

theta2

Cylinder second limb parameters \((\rho, \theta)\) expressed in the image plane.

cam

Camera intrinsic parameters.

I

Image.

color

Color to use to display the feature.

thickness

Thickness of the feature representation.

  1. displayCylinder(rho1: float, theta1: float, rho2: float, theta2: float, cam: visp._visp.core.CameraParameters, I: visp._visp.core.ImageRGBa, color: visp._visp.core.Color = vpColor::green, thickness: int = 1) -> None

Display cylinder limbs as two 2D lines with coordinates \((\rho, \theta)\) expressed in the image plane. These coordinates are obtained after perspective projection of the cylinder.

Parameters:
rho1

Cylinder first limb parameters \((\rho, \theta)\) expressed in the image plane.

theta1

Cylinder first limb parameters \((\rho, \theta)\) expressed in the image plane.

rho2

Cylinder second limb parameters \((\rho, \theta)\) expressed in the image plane.

theta2

Cylinder second limb parameters \((\rho, \theta)\) expressed in the image plane.

cam

Camera intrinsic parameters.

I

Image.

color

Color to use to display the feature.

thickness

Thickness of the feature representation.

static displayEllipse(*args, **kwargs)

Overloaded function.

  1. displayEllipse(x: float, y: float, n20: float, n11: float, n02: float, cam: visp._visp.core.CameraParameters, I: visp._visp.core.ImageGray, color: visp._visp.core.Color = vpColor::green, thickness: int = 1) -> None

Display an ellipse with parameters \((x, y, n_{20}, n_{11}, n_{02})\) expressed in the image plane. These parameters are obtained after perspective projection of a 3D circle (see vpCircle ) or a sphere (see vpSphere ).

Note

See vpDisplay::displayEllipse()

Parameters:
x

Ellipse parameters where:

  • \((x,y)\) are the normalized coordinates of the ellipse center, respectively along the horizontal and vertical axis in the image plane.

  • \(n_{20}, n_{11}, n_{02}\) are 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) expressed in the image plane.

y

Ellipse parameters where:

  • \((x,y)\) are the normalized coordinates of the ellipse center, respectively along the horizontal and vertical axis in the image plane.

  • \(n_{20}, n_{11}, n_{02}\) are 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) expressed in the image plane.

n20

Ellipse parameters where:

  • \((x,y)\) are the normalized coordinates of the ellipse center, respectively along the horizontal and vertical axis in the image plane.

  • \(n_{20}, n_{11}, n_{02}\) are 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) expressed in the image plane.

n11

Ellipse parameters where:

  • \((x,y)\) are the normalized coordinates of the ellipse center, respectively along the horizontal and vertical axis in the image plane.

  • \(n_{20}, n_{11}, n_{02}\) are 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) expressed in the image plane.

n02

Ellipse parameters where:

  • \((x,y)\) are the normalized coordinates of the ellipse center, respectively along the horizontal and vertical axis in the image plane.

  • \(n_{20}, n_{11}, n_{02}\) are 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) expressed in the image plane.

cam

Camera intrinsic parameters.

I

Image.

color

Color to use to display the feature.

thickness

Thickness of the feature representation.

  1. displayEllipse(x: float, y: float, n20: float, n11: float, n02: float, cam: visp._visp.core.CameraParameters, I: visp._visp.core.ImageRGBa, color: visp._visp.core.Color = vpColor::green, thickness: int = 1) -> None

Display an ellipse with parameters \((x, y, n_{20}, n_{11}, n_{02})\) expressed in the image plane. These parameters are obtained after perspective projection of a 3D circle (see vpCircle ) or a sphere (see vpSphere ).

Note

See vpDisplay::displayEllipse()

Parameters:
x

Ellipse parameters where:

  • \((x,y)\) are the normalized coordinates of the ellipse center, respectively along the horizontal and vertical axis in the image plane.

  • \(n_{20}, n_{11}, n_{02}\) are 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) expressed in the image plane.

y

Ellipse parameters where:

  • \((x,y)\) are the normalized coordinates of the ellipse center, respectively along the horizontal and vertical axis in the image plane.

  • \(n_{20}, n_{11}, n_{02}\) are 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) expressed in the image plane.

n20

Ellipse parameters where:

  • \((x,y)\) are the normalized coordinates of the ellipse center, respectively along the horizontal and vertical axis in the image plane.

  • \(n_{20}, n_{11}, n_{02}\) are 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) expressed in the image plane.

n11

Ellipse parameters where:

  • \((x,y)\) are the normalized coordinates of the ellipse center, respectively along the horizontal and vertical axis in the image plane.

  • \(n_{20}, n_{11}, n_{02}\) are 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) expressed in the image plane.

n02

Ellipse parameters where:

  • \((x,y)\) are the normalized coordinates of the ellipse center, respectively along the horizontal and vertical axis in the image plane.

  • \(n_{20}, n_{11}, n_{02}\) are 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) expressed in the image plane.

cam

Camera intrinsic parameters.

I

Image.

color

Color to use to display the feature.

thickness

Thickness of the feature representation.

static displayLine(*args, **kwargs)

Overloaded function.

  1. displayLine(rho: float, theta: float, cam: visp._visp.core.CameraParameters, I: visp._visp.core.ImageGray, color: visp._visp.core.Color = vpColor::green, thickness: int = 1) -> None

Display a 2D line with coordinates \((\rho, \theta)\) expressed in the image plane. These coordinates are obtained after perspective projection of the line.

Parameters:
rho

Line parameters \((\rho, \theta)\) expressed in the image plane.

theta

Line parameters \((\rho, \theta)\) expressed in the image plane.

cam

Camera intrinsic parameters.

I

Image.

color

Color to use to display the feature.

thickness

Thickness of the feature representation.

  1. displayLine(rho: float, theta: float, cam: visp._visp.core.CameraParameters, I: visp._visp.core.ImageRGBa, color: visp._visp.core.Color = vpColor::green, thickness: int = 1) -> None

Display a 2D line with coordinates \((\rho, \theta)\) expressed in the image plane. These coordinates are obtained after perspective projection of the line.

Parameters:
rho

Line parameters \((\rho, \theta)\) expressed in the image plane.

theta

Line parameters \((\rho, \theta)\) expressed in the image plane.

cam

Camera intrinsic parameters.

I

Image.

color

Color to use to display the feature.

thickness

Thickness of the feature representation.

static displayPoint(*args, **kwargs)

Overloaded function.

  1. displayPoint(x: float, y: float, cam: visp._visp.core.CameraParameters, I: visp._visp.core.ImageGray, color: visp._visp.core.Color = vpColor::green, thickness: int = 1) -> None

Display a 2D point with coordinates (x, y) expressed in the image plane. These coordinates are obtained after perspective projection of the point.

Parameters:
x

Point coordinates in the image plane.

y

Point coordinates in the image plane.

cam

Camera intrinsic parameters.

I

Image.

color

Color to use to display the feature.

thickness

Thickness of the feature representation.

  1. displayPoint(x: float, y: float, cam: visp._visp.core.CameraParameters, I: visp._visp.core.ImageRGBa, color: visp._visp.core.Color = vpColor::green, thickness: int = 1) -> None

Display a 2D point with coordinates (x, y) expressed in the image plane. These coordinates are obtained after perspective projection of the point.

Parameters:
x

Point coordinates in the image plane.

y

Point coordinates in the image plane.

cam

Camera intrinsic parameters.

I

Image.

color

Color to use to display the feature.

thickness

Thickness of the feature representation.