sisl.shape.Cuboid¶
- class sisl.shape.Cuboid(v, center=None)¶
Bases:
sisl.shape.PureShape
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
Methods
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
Return an ellipsoid that encompass this cuboid
toSphere
()Return a sphere that encompass this cuboid
volume
()Return volume of Cuboid
within
(other, *args, **kwargs)Return
True
if other is fully within selfwithin_index
(other[, tol])Return indices of the other object which are contained in the shape
The geometric center of the shape
The lengths of each of the vector that defines the cuboid
Return the origin of the Cuboid (lower-left corner)
- property center¶
The geometric center of the shape
- property 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.
- property origo¶
Return the origin of the Cuboid (lower-left corner)
- within(other, *args, **kwargs)¶
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
*args – passed directly to
within_index
**kwargs – passed directly to
within_index