plotly_3d module#

This module provides helper functions for plotly (https://plotly.com/python/) for HomCloud.

homcloud.plotly_3d.Bitmap3d(bitmap, color=None, name='', offsets=[0, 0, 0])[source]#

Returns a plotly’s trace object for a 3D bitmap.

Parameters:

  • bitmap (np.array) – 3D boolean bitmap

  • color (string or None) – The name of color

  • name (string) – The name of pointcloud

Returns:

Plotly’s trace object for the visualization of the pointcloud

Return type:

plotly.graph_objects.Mesh3d

homcloud.plotly_3d.PointCloud(array, color=None, size=1, name='')[source]#

Returns a plotly’s trace object for a pointcloud.

Parameters:

  • array (np.array) – 3D pointcloud

  • color (string or None) – The name of color

  • size (int) – The size of each point

  • name (string) – The name of pointcloud

Returns:

Plotly’s trace object for the visualization of the pointcloud

Return type:

plotly.graph_objects.Scatter3d

homcloud.plotly_3d.SimpleScene(xrange=None, yrange=None, zrange=None)[source]#

Returns a plotly’s graph_object.layout.Scene object to remove x/y/z axes.

You can use xrange/yrange/zrange to cut off the visualization area

Parameters:

  • xrange ((float, float) or None) – The range of X axis to be visualized

  • yrange ((float, float) or None) – The range of Y axis to be visualized

  • zrange ((float, float) or None) – The range of Z axis to be visualized

Returns:

Plotly’s scene object

Return type:

plotly.graph_objects.layout.Scene