sknano.utils.geometric_shapes.Spheroid¶

class sknano.utils.geometric_shapes.Spheroid(center=None, a=None, c=None)[source][source]¶

Abstract data structure representing a spheroid.

New in version 0.3.0.

The general spheroid is a quadratic surface with is given in Cartesian coordinates by:

\[\frac{x^2 + y^2}{a^2} + \frac{z^2}{c^2} = 1\]

Parameters:

Parameters:	center : sequence, optional Either a 3-tuple of floats or an instance of the `Point` class specifying the \((x,y,z)\) coordinates of the `Spheroid` center. a, c : float, optional Semi-axes \(a, c\) of axis-aligned `Spheroid` with symmetry axis along \(z\) axis.

center : sequence, optional

Either a 3-tuple of floats or an instance of the Point class specifying the \((x,y,z)\) coordinates of the Spheroid center.

a, c : float, optional

Semi-axes \(a, c\) of axis-aligned Spheroid with symmetry axis along \(z\) axis.

Attributes

Methods

`contains_point`([point])	Check if point is contained within volume of `Spheroid`.
`rotate`([angle, rot_axis, anchor_point, ...])	Rotate `GeometricRegion` Points and Vectors.
`translate`(t[, fix_anchor_points])	Translate `GeometricRegion`s Points and Vectors by `Vector` t.
`update_region_limits`()