Cuboid¶
-
class
sisl.shape.
Cuboid
(v, center=None)[source]¶ A cuboid/rectangular prism (P4)
Parameters: - v : float or (3,) or (3, 3)
vectors describing the cuboid, if only 3 the cuboid will be along the Euclidean vectors.
- center : (3,), optional
the center of the cuboid. Defaults to the origo.
Examples
>>> shape = Cuboid([2, 2.2, 2]) >>> shape.within([0, 2.1, 0]) False >>> shape.within([0, 1.1, 0]) True
Attributes
center
The geometric center of the shape edge_length
The lengths of each of the vector that defines the cuboid origo
Return the origin of the Cuboid (lower-left corner) Methods
__init__
(v[, center])Initialize self. copy
()expand
(length)Expand the cuboid by a constant value along side vectors scale
(scale)Scale the cuboid box size (center is retained) set_center
(center)Re-setting the center can sometimes be necessary set_origo
(origo)Re-setting the origo can sometimes be necessary toCuboid
()Return a copy of itself toEllipsoid
()Return an ellipsoid that encompass this cuboid toSphere
()Return a sphere that encompass this cuboid volume
()Return volume of Cuboid within
(other)Return True
if other is fully within selfwithin_index
(other)Return indices of the other object which are contained in the shape -
center
¶ The geometric center of the shape
-
edge_length
¶ The lengths of each of the vector that defines the cuboid
-
expand
(length)[source]¶ Expand the cuboid by a constant value along side vectors
Parameters: - length : float or (3,)
the extension in Ang per cuboid vector.
-
origo
¶ Return the origin of the Cuboid (lower-left corner)
-
scale
(scale)[source]¶ Scale the cuboid box size (center is retained)
Parameters: - scale : float or (3,)
the scale parameter for each of the vectors defining the
Cuboid
-
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