Sphere¶
-
class
sisl.shape.
Sphere
(radius, center=None)[source]¶ 3D Sphere
Parameters: - r : float
radius of the sphere
Attributes
center
The geometric center of the shape radius
Return the radius of the Sphere Methods
__init__
(radius[, center])Initialize self. copy
()expand
(radius)Expand sphere by a constant radius scale
(scale)Return a new sphere with a larger radius set_center
(center)Change the center of the object toCuboid
()Return a cuboid with side lengths equal to the diameter of each ellipsoid vectors toEllipsoid
()Convert this sphere into an ellipsoid toSphere
()Return a copy of it-self volume
()Return the volume of the sphere within
(other)Return True
if other is fully within selfwithin_index
(other)Return indices of the points that are within the shape -
center
¶ The geometric center of the shape
-
expand
(radius)[source]¶ Expand sphere by a constant radius
Parameters: - radius : float
the extension in Ang per ellipsoid radial vector
-
radius
¶ Return the radius of the Sphere
-
scale
(scale)[source]¶ Return a new sphere with a larger radius
Parameters: - scale : float
the scale parameter for the radius
-
set_center
(center)¶ Change the center of the object
-
toCuboid
()¶ Return a cuboid with side lengths equal to the diameter of each ellipsoid vectors
-
within
(other)¶ Return
True
if other is fully within selfIf other is an array, an array will be returned for each of these.
Parameters: - other : array_like
the array/object that is checked for containment
-
within_index
(other)¶ Return indices of the points that are within the shape