Parametric Objects¶

The following functions can be used to create parametric surfaces. To see what these functions create, check out the example: Parametric Geometric Objects.

pyvista.ParametricBohemianDome(a=None, **kwargs)¶

Generate a Bohemian dome surface.

Parameters: a (float, optional) – Bohemian dome surface parameter.
Returns: surf – ParametricBohemianDome surface.
Return type: pyvista.PolyData

Examples

Create a ParametricBohemianDome mesh.

>>> import pyvista
>>> mesh = pyvista.ParametricBohemianDome()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricBour(**kwargs)¶

Generate Bour’s minimal surface.

Returns: surf – ParametricBour surface.
Return type: pyvista.PolyData

Examples

Create a ParametricBour mesh.

>>> import pyvista
>>> mesh = pyvista.ParametricBour()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricBoy(zscale=None, **kwargs)¶

Generate Boy’s surface.

This is a model of the projective plane without singularities. It was found by Werner Boy on assignment from David Hilbert.

For further information about this surface, please consult the technical description “Parametric surfaces” in the “VTK Technical Documents” section in the VTK.org web pages.

Parameters: zscale (float, optional) – The scale factor for the z-coordinate.
Returns: surf – ParametricBoy surface.
Return type: pyvista.PolyData

Examples

Create a ParametricBoy mesh

>>> import pyvista
>>> mesh = pyvista.ParametricBoy()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricDini(a=None, b=None, **kwargs)¶

Generate Dini’s surface.

ParametricDini generates Dini’s surface. Dini’s surface is a surface that possesses constant negative Gaussian curvature

Parameters

a (float, optional) – The scale factor. See the definition in Parametric surfaces referred to above. Default is 1.
b (float, optional) – The scale factor. See the definition in Parametric surfaces referred to above. Default is 0.2

Returns

surf – ParametricDini surface

Return type

pyvista.PolyData

Examples

Create a ParametricDini mesh

>>> import pyvista
>>> mesh = pyvista.ParametricDini()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricEllipsoid(xradius=None, yradius=None, zradius=None, **kwargs)¶

Generate an ellipsoid.

ParametricEllipsoid generates an ellipsoid. If all the radii are the same, we have a sphere. An oblate spheroid occurs if RadiusX = RadiusY > RadiusZ. Here the Z-axis forms the symmetry axis. To a first approximation, this is the shape of the earth. A prolate spheroid occurs if RadiusX = RadiusY < RadiusZ.

Parameters

xradius (float, optional) – The scaling factor for the x-axis. Default is 1.
yradius (float, optional) – The scaling factor for the y-axis. Default is 1.
zradius (float, optional) – The scaling factor for the z-axis. Default is 1.

Returns

surf – ParametricEllipsoid surface

Return type

pyvista.PolyData

Examples

Create a ParametricEllipsoid mesh

>>> import pyvista
>>> mesh = pyvista.ParametricEllipsoid()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricEnneper(**kwargs)¶

Generate Enneper’s surface.

ParametricEnneper generates Enneper’s surface. Enneper’s surface is a self-intersecting minimal surface possessing constant negative Gaussian curvature.

Returns: surf – ParametricEnneper surface
Return type: pyvista.PolyData

Examples

Create a ParametricEnneper mesh

>>> import pyvista
>>> mesh = pyvista.ParametricEnneper()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricFigure8Klein(radius=None, **kwargs)¶

Generate a figure-8 Klein bottle.

ParametricFigure8Klein generates a figure-8 Klein bottle. A Klein bottle is a closed surface with no interior and only one surface. It is unrealisable in 3 dimensions without intersecting surfaces.

Parameters: radius (float, optional) – The radius of the bottle. Default is 1.
Returns: surf – ParametricFigure8Klein surface.
Return type: pyvista.PolyData

Examples

Create a ParametricFigure8Klein mesh

>>> import pyvista
>>> mesh = pyvista.ParametricFigure8Klein()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricHenneberg(**kwargs)¶

Generate Henneberg’s minimal surface.

Returns: surf – ParametricHenneberg surface
Return type: pyvista.PolyData

Examples

Create a ParametricHenneberg mesh

>>> import pyvista
>>> mesh = pyvista.ParametricHenneberg()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricKlein(**kwargs)¶

Generate a “classical” representation of a Klein bottle.

ParametricKlein generates a “classical” representation of a Klein bottle. A Klein bottle is a closed surface with no interior and only one surface. It is unrealisable in 3 dimensions without intersecting surfaces.

Returns: surf – ParametricKlein surface
Return type: pyvista.PolyData

Examples

Create a ParametricKlein mesh

>>> import pyvista
>>> mesh = pyvista.ParametricKlein()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricKuen(deltav0=None, **kwargs)¶

Generate Kuens’ surface.

ParametricKuen generates Kuens’ surface. This surface has a constant negative gaussian curvature.

Parameters: deltav0 (float, optional) – The value to use when V == 0. Default is 0.05, giving the best appearance with the default settings. Setting it to a value less than 0.05 extrapolates the surface towards a pole in the -z direction. Setting it to 0 retains the pole whose z-value is -inf.
Returns: surf – ParametricKuen surface
Return type: pyvista.PolyData

Examples

Create a ParametricKuen mesh

>>> import pyvista
>>> mesh = pyvista.ParametricKuen()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricMobius(radius=None, **kwargs)¶

Generate a Mobius strip.

Parameters: radius (float, optional) – The radius of the Mobius strip. Default is 1.
Returns: surf – ParametricMobius surface
Return type: pyvista.PolyData

Examples

Create a ParametricMobius mesh

>>> import pyvista
>>> mesh = pyvista.ParametricMobius()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricPluckerConoid(n=None, **kwargs)¶

Generate Plucker’s conoid surface.

ParametricPluckerConoid generates Plucker’s conoid surface parametrically. Plucker’s conoid is a ruled surface, named after Julius Plucker. It is possible to set the number of folds in this class via the parameter ‘N’.

Parameters

n (int, optional) – This is the number of folds in the conoid.
vtkGetMacro(N –
int); –

Returns

surf – ParametricPluckerConoid surface

Return type

pyvista.PolyData

Examples

Create a ParametricPluckerConoid mesh

>>> import pyvista
>>> mesh = pyvista.ParametricPluckerConoid()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricPseudosphere(**kwargs)¶

Generate a pseudosphere.

ParametricPseudosphere generates a parametric pseudosphere. The pseudosphere is generated as a surface of revolution of the tractrix about it’s asymptote, and is a surface of constant negative Gaussian curvature.

Returns: surf – ParametricPseudosphere surface
Return type: pyvista.PolyData

Examples

Create a ParametricPseudosphere mesh

>>> import pyvista
>>> mesh = pyvista.ParametricPseudosphere()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricRandomHills(numberofhills=None, hillxvariance=None, hillyvariance=None, hillamplitude=None, randomseed=None, xvariancescalefactor=None, yvariancescalefactor=None, amplitudescalefactor=None, **kwargs)¶

Generate a surface covered with randomly placed hills.

ParametricRandomHills generates a surface covered with randomly placed hills. Hills will vary in shape and height since the presence of nearby hills will contribute to the shape and height of a given hill. An option is provided for placing hills on a regular grid on the surface. In this case the hills will all have the same shape and height.

Parameters

numberofhills (int, optional) – The number of hills. Default is 30.
hillxvariance (float, optional) – The hill variance in the x-direction. Default is 2.5.
hillyvariance (float, optional) – The hill variance in the y-direction. Default is 2.5.
hillamplitude (float, optional) – The hill amplitude (height). Default is 2.
randomseed (int, optional) – The Seed for the random number generator, a value of 1 will initialize the random number generator, a negative value will initialize it with the system time. Default is 1.
xvariancescalefactor (float, optional) – The scaling factor for the variance in the x-direction. Default is 13.
yvariancescalefactor (float, optional) – The scaling factor for the variance in the y-direction. Default is 13.
amplitudescalefactor (float, optional) – The scaling factor for the amplitude. Default is 13.

Returns

surf – ParametricRandomHills surface

Return type

pyvista.PolyData

Examples

Create a ParametricRandomHills mesh

>>> import pyvista
>>> mesh = pyvista.ParametricRandomHills()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricRoman(radius=None, **kwargs)¶

Generate Steiner’s Roman Surface.

Parameters: radius (float, optional) – The radius. Default is 1.
Returns: surf – ParametricRoman surface
Return type: pyvista.PolyData

Examples

Create a ParametricRoman mesh

>>> import pyvista
>>> mesh = pyvista.ParametricRoman()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricSuperEllipsoid(xradius=None, yradius=None, zradius=None, n1=None, n2=None, **kwargs)¶

Generate a superellipsoid.

ParametricSuperEllipsoid generates a superellipsoid. A superellipsoid is a versatile primitive that is controlled by two parameters n1 and n2. As special cases it can represent a sphere, square box, and closed cylindrical can.

Parameters

xradius (float, optional) – The scaling factor for the x-axis. Default is 1.
yradius (float, optional) – The scaling factor for the y-axis. Default is 1.
zradius (float, optional) – The scaling factor for the z-axis. Default is 1.
n1 (float, optional) – The “squareness” parameter in the z axis. Default is 1.
n2 (float, optional) – The “squareness” parameter in the x-y plane. Default is 1.

Returns

surf – ParametricSuperEllipsoid surface

Return type

pyvista.PolyData

Examples

Create a ParametricSuperEllipsoid mesh

>>> import pyvista
>>> mesh = pyvista.ParametricSuperEllipsoid()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricSuperToroid(ringradius=None, crosssectionradius=None, xradius=None, yradius=None, zradius=None, n1=None, n2=None, **kwargs)¶

Generate a supertoroid.

ParametricSuperToroid generates a supertoroid. Essentially a supertoroid is a torus with the sine and cosine terms raised to a power. A supertoroid is a versatile primitive that is controlled by four parameters r0, r1, n1 and n2. r0, r1 determine the type of torus whilst the value of n1 determines the shape of the torus ring and n2 determines the shape of the cross section of the ring. It is the different values of these powers which give rise to a family of 3D shapes that are all basically toroidal in shape.

Parameters

ringradius (float, optional) – The radius from the center to the middle of the ring of the supertoroid. Default is 1.
crosssectionradius (float, optional) – The radius of the cross section of ring of the supertoroid. Default = 0.5.
xradius (float, optional) – The scaling factor for the x-axis. Default is 1.
yradius (float, optional) – The scaling factor for the y-axis. Default is 1.
zradius (float, optional) – The scaling factor for the z-axis. Default is 1.
n1 (float, optional) – The shape of the torus ring. Default is 1.
n2 (float, optional) – The shape of the cross section of the ring. Default is 1.

Returns

surf – ParametricSuperToroid surface

Return type

pyvista.PolyData

Examples

Create a ParametricSuperToroid mesh

>>> import pyvista
>>> mesh = pyvista.ParametricSuperToroid()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

pyvista.ParametricTorus(ringradius=None, crosssectionradius=None, **kwargs)¶

Generate a torus.

Parameters

ringradius (float, optional) – The radius from the center to the middle of the ring of the torus. Default is 1.0.
crosssectionradius (float, optional) – The radius of the cross section of ring of the torus. Default is 0.5.

Returns

surf – ParametricTorus surface

Return type

pyvista.PolyData

Examples

Create a ParametricTorus mesh

>>> import pyvista
>>> mesh = pyvista.ParametricTorus()
>>> cpos = mesh.plot(color='w', smooth_shading=True)

These functions support building parametric surfaces:

pyvista.parametric_keywords(parametric_function, min_u=0, max_u=6.283185307179586, min_v=0.0, max_v=6.283185307179586, join_u=False, join_v=False, twist_u=False, twist_v=False, clockwise=True)¶

Apply keyword arguments to a parametric function.

Parameters

min_u (float, optional) – The minimum u-value.
max_u (float, optional) – The maximum u-value.
min_v (float, optional) – The minimum v-value.
max_v (float, optional) – The maximum v-value.
join_u (bool, optional) – Joins the first triangle strip to the last one with a twist in the u direction.
join_v (bool, optional) – Joins the first triangle strip to the last one with a twist in the v direction.
twist_u (bool, optional) – Joins the first triangle strip to the last one with a twist in the u direction.
twist_v (bool, optional) – Joins the first triangle strip to the last one with a twist in the v direction.
clockwise (bool, optional) – Determines the ordering of the vertices forming the triangle strips.

pyvista.surface_from_para(parametric_function, u_res=100, v_res=100, w_res=100)¶

Construct a mesh from a parametric function.

Parameters

parametric_function (vtk.vtkParametricFunction) – Parametric function to generate mesh from.
u_res (int, optional) – Resolution in the u direction.
v_res (int, optional) – Resolution in the v direction.
w_res (int, optional) – Resolution in the w direction.