Figure

class Qiber3D.Figure(network)

Bases: object

Generate matplotlib figures

Parameters

network – a Qiber3D.Network

directions(out_path='.', overwrite=False, grid=True, color_map='RdYlGn', mode='fine', bins=None)

Plot the dominat directions of a Qiber3D.Network

Parameters
  • out_path (str, Path) – file or folder path where to save the network, if None show the plot.

  • overwrite (bool) – allow file overwrite

  • grid (bool) – show a grid

  • color_map (str) – name of a matplotlib color map

  • mode (str) – ‘fine’: use the vectors between every point, ‘main’: use the vectors between the start and end point of a segment

  • bins (int) – number of bins

Returns

path to saved file

Return type

Path

histogram(out_path='.', overwrite=False, attribute='length', bins=None)

Plot a histogram for a specific attribute of Qiber3D.Fiber.

Parameters
  • out_path (str, Path) – file or folder path where to save the network, if None show the plot.

  • overwrite (bool) – allow file overwrite

  • attribute (str) – one of [‘length’, ‘volume’, ‘average_diameter’, ‘average_radius’, ‘cylinder_radius’]

  • bins (int) – number of bins

Returns

path to saved file

Return type

Path

z_drop(out_path='.', overwrite=False)

Plot the z_drop correction.

Parameters
  • out_path (str, Path) – file or folder path where to save the network, if None show the plot.

  • overwrite (bool) – allow file overwrite

Returns

path to saved file

Return type

Path