pyvista.SphereSource

Contents

pyvista.SphereSource#

class SphereSource(
radius: float = 0.5,
center: VectorLike[float] | None = None,
theta_resolution: int = 30,
phi_resolution: int = 30,
start_theta: float = 0.0,
end_theta: float = 360.0,
start_phi: float = 0.0,
end_phi: float = 180.0,
)[source]#

Sphere source algorithm class.

Added in version 0.44.0.

Parameters:
radiusfloat, default: 0.5

Sphere radius.

centersequence[float], default: (0.0, 0.0, 0.0)

Center coordinate vector in [x, y, z].

theta_resolutionint, default: 30

Set the number of points in the azimuthal direction (ranging from start_theta to end_theta).

phi_resolutionint, default: 30

Set the number of points in the polar direction (ranging from start_phi to end_phi).

start_thetafloat, default: 0.0

Starting azimuthal angle in degrees [0, 360].

end_thetafloat, default: 360.0

Ending azimuthal angle in degrees [0, 360].

start_phifloat, default: 0.0

Starting polar angle in degrees [0, 180].

end_phifloat, default: 180.0

Ending polar angle in degrees [0, 180].

See also

pyvista.Icosphere

Sphere created from projection of icosahedron.

pyvista.SolidSphere

Sphere that fills 3D space.

Examples

Create a sphere using default parameters.

>>> import pyvista as pv
>>> sphere = pv.SphereSource()
>>> sphere.output.plot(show_edges=True)
../../../_images/pyvista-SphereSource-1_00_00.png

Create a quarter sphere by setting end_theta.

>>> sphere = pv.SphereSource(end_theta=90)
>>> out = sphere.output.plot(show_edges=True)
../../../_images/pyvista-SphereSource-1_01_00.png

Create a hemisphere by setting end_phi.

>>> sphere = pv.SphereSource(end_phi=90)
>>> out = sphere.output.plot(show_edges=True)
../../../_images/pyvista-SphereSource-1_02_00.png

Methods

Attributes

SphereSource.center

Get the center in [x, y, z].

SphereSource.end_phi

Get ending polar angle in degrees [0, 360].

SphereSource.end_theta

Get ending azimuthal angle in degrees [0, 360].

SphereSource.output

Get the output data object for a port on this algorithm.

SphereSource.phi_resolution

Get the number of points in the polar direction.

SphereSource.radius

Get sphere radius.

SphereSource.start_phi

Get starting polar angle in degrees [0, 360].

SphereSource.start_theta

Get starting azimuthal angle in degrees [0, 360].

SphereSource.theta_resolution

Get the number of points in the azimuthal direction.