DisplayPCL¶

class DisplayPCL(*args, **kwargs)¶

Bases: pybind11_object

This class enables real time plotting of 3D point clouds. It relies on the PCL library. To see how to install PCL library, please refer to the soft_tool_pcl section.

Overloaded function.

__init__(self: visp._visp.gui.DisplayPCL, posx: int = 0, posy: int = 0, window_name: str = ) -> None

Default constructor. By default, viewer size is set to 640 x 480.

__init__(self: visp._visp.gui.DisplayPCL, width: int, height: int, posx: int = 0, posy: int = 0, window_name: str = ) -> None

Constructor able to initialize the display window size.

Parameters:

width: Point cloud viewer width.
height: Point cloud viewer height.
posx: Position along X-axis.
posy: Position along Y-axis.
window_name: Window name.

Methods

`__init__`	Overloaded function.
`setPosition`	Set the position of the viewer window.
`setVerbose`	Enable/disable verbose mode.
`setWindowName`	Set the name of the viewer windows.
`startThread`	Overloaded function.
`stop`	Stop the viewer thread and join.

Inherited Methods

Operators

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

Attributes

`__annotations__`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: visp._visp.gui.DisplayPCL, posx: int = 0, posy: int = 0, window_name: str = ) -> None

Default constructor. By default, viewer size is set to 640 x 480.

__init__(self: visp._visp.gui.DisplayPCL, width: int, height: int, posx: int = 0, posy: int = 0, window_name: str = ) -> None

Constructor able to initialize the display window size.

Parameters:

width: Point cloud viewer width.
height: Point cloud viewer height.
posx: Position along X-axis.
posy: Position along Y-axis.
window_name: Window name.

setPosition(self, posx: int, posy: int) → None¶

Set the position of the viewer window. This function has to be called prior startThread() .

Note

See setWindowName()

Parameters:

posx: int¶: Position along x.
posy: int¶: Position along y.

setVerbose(self, verbose: bool) → None¶

Enable/disable verbose mode.

Parameters:

verbose: bool¶: When true verbose mode is enable.

setWindowName(self, window_name: str) → None¶

Set the name of the viewer windows. This function has to be called prior startThread() .

Note

See setPosition()

Parameters:

window_name: str¶: Window name to set.

startThread(*args, **kwargs)¶

Overloaded function.

startThread(self: visp._visp.gui.DisplayPCL, mutex: std::mutex, pointcloud: pcl::PointCloud<pcl::PointXYZ>) -> None

Start the viewer thread able to display a point cloud.

Note

See stop()

Parameters:

mutex: Shared mutex.
pointcloud: Point cloud to display.

startThread(self: visp._visp.gui.DisplayPCL, mutex: std::mutex, pointcloud: pcl::PointCloud<pcl::PointXYZRGB>) -> None

Start the viewer thread able to display a textured point cloud.

Note

See stop()

Parameters:

mutex: Shared mutex.

stop(self) → None¶: Stop the viewer thread and join.