Welcome to PyHyperbolic3D’s documentation!

Indices and tables


Members functions

hyperbolic3d.gyro.changesOfSign(mat, cols=None)

Sometimes, the coordinates of the vertices of a polyhedron are given with changes of sign (with a symbol +/-). This function performs the changes of sign.

Parameters:

  • mat (array) – The matrix for which the changes of sign will be applied.

  • cols (integer list) – The indices of the columns for which the changes of sign are desired. The default, None, to select all columns.

Returns:

A numpy array with the same number of columns as mat.

Return type:

array

hyperbolic3d.gyro.expandgrid(*itrs)

Cartesian product. Reversion is for compatibility with R.

hyperbolic3d.gyro.gyrotriangle(A, B, C, s, depth=5, tol=1e-06)

Hyperbolic triangle.

Parameters:

  • A (points (lists or arrays)) – The vertices of the triangle.

  • B (points (lists or arrays)) – The vertices of the triangle.

  • C (points (lists or arrays)) – The vertices of the triangle.

  • s (positive float) – Curvature parameter.

  • depth (integer) – The number of recursive subdivions. The default is 5.

  • tol (small positive float) – The tolerance used to merge duplicated points in the mesh. The default is 1e-6.

Returns:

A PyVista mesh ready for inclusion in a plotting region.

Return type:

PyVista mesh

hyperbolic3d.gyro.gyrotube(A, B, s, r, npoints=300)

Tubular hyperbolic segment.

Parameters:

  • A (points (lists or arrays)) – The two endpoints of the segment.

  • B (points (lists or arrays)) – The two endpoints of the segment.

  • s (positive float) – Curvature parameter.

  • r (positive float) – Radius of the tube.

  • npoints (integer) – Number of points along the segment. The default is 300.

Returns:

A PyVista mesh ready for inclusion in a plotting region.

Return type:

PyVista mesh