Ellipsoid

class sisl.shape.Ellipsoid(v, center=None)

Bases: sisl.shape.PureShape

3D Ellipsoid shape

Parameters

• v (float or (3,) or (3, 3)) – radius/vectors defining the ellipsoid. For 3 values it corresponds to a Cartesian oriented ellipsoid. If the vectors are non-orthogonal they will be orthogonalized. I.e. the first vector is considered a principal axis, then the second vector will be orthogonalized onto the first, and this is the second principal axis. And so on.

• center ((3,), optional) – the center of the ellipsoid. Defaults to the origo.

Examples

>>> shape = Ellipsoid([2, 2.2, 2])
>>> shape.within([0, 2, 0])
True

Attributes

__doc__
__module__
__slots__
_center
_iv
_v
center	The geometric center of the shape
radius	Return the radius of the Ellipsoid

Methods

__add__(other)
__and__(other)
__contains__(other)	Checks whether all of other is within the shape
__delattr__	Implement delattr(self, name).
__dir__	Default dir() implementation.
__eq__	Return self==value.
__format__	Default object formatter.
__ge__	Return self>=value.
__getattribute__	Return getattr(self, name).
__gt__	Return self>value.
__hash__	Return hash(self).
__init__(v[, center])	Initialize self.
__init_subclass__	This method is called when a class is subclassed.
__le__	Return self<=value.
__lt__	Return self<value.
__ne__	Return self!=value.
__new__	Create and return a new object.
__or__(other)
__reduce__	Helper for pickle.
__reduce_ex__	Helper for pickle.
__repr__	Return repr(self).
__setattr__	Implement setattr(self, name, value).
__sizeof__	Size of object in memory, in bytes.
__str__()	Return str(self).
__sub__(other)
__subclasshook__	Abstract classes can override this to customize issubclass().
__xor__(other)
copy()
expand(radius)	Expand ellipsoid by a constant value along each radial vector
scale(scale)	Return a new shape with a larger corresponding to scale
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()	Return an ellipsoid that encompass this shape (a copy)
toSphere()	Return a sphere with a radius equal to the largest radial vector
volume()	Return the volume of the shape
within(other, *args, **kwargs)	Return True if other is fully within self
within_index(other[, tol])	Return indices of the points that are within the shape

property center

The geometric center of the shape

copy()

expand(radius)

Expand ellipsoid by a constant value along each radial vector

Parameters

radius (float or (3,)) – the extension in Ang per ellipsoid radial vector

property radius

Return the radius of the Ellipsoid

scale(scale)

Return a new shape with a larger corresponding to scale

Parameters

scale (float or (3,)) – the scale parameter for each of the vectors defining the Ellipsoid

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()

Return an ellipsoid that encompass this shape (a copy)

toSphere()

Return a sphere with a radius equal to the largest radial vector

volume()

Return the volume of the shape

within(other, *args, **kwargs)

Return True if other is fully within self

If 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

within_index(other, tol=1e-08)

Return indices of the points that are within the shape

Parameters

• other (array_like) – the object that is checked for containment

• tol (float, optional) – absolute tolerance for boundaries