treams.PhysicsArray

class treams.PhysicsArray(arr, ann=(), /, **kwargs)

Physics-aware array.

A physics aware array is a special type of :class`~treams.util.AnnotatedArray`. Additionally to keeping track of the annotations, it is enhanced by the ability to create suiting linear operators to perform tasks like rotations, translations, or expansions into different basis sets and by applying special rules for the physical properties of PhysicsDict upon matrix multiplications, see also __matmul__().

Attributes

T	Transpose.
ann	Array annotations.
bfield
changepoltype	Polarization change matrix, see also treams.operators.ChangePoltype.
dfield
efield
expand	Expansion matrix, see also treams.operators.Expand.
expandlattice	Lattice expansion matrix, see also treams.operators.ExpandLattice.
ffield	Field evaluation matrix, see also treams.operators.EField.
gfield
hfield
imag	Imaginary part of the array.
ndim	Number of array dimensions.
permute	Permutation matrix, see also treams.operators.Permute.
real	Real part of the array.
rotate	Rotation matrix, see also treams.operators.Rotate.
shape	Array shape.
size	Array size.
translate	Translation matrix, see also treams.operators.Translate.

Methods

__abs__()
__add__(other)
__and__(other)
__array__([dtype])	Convert to an numpy array.
__array_function__(func, types, args, kwargs)	Function calls on the array.
__array_ufunc__(ufunc, method, *inputs, **kwargs)	Implement ufunc API.
__divmod__(other)
__eq__(other)	Return self==value.
__floordiv__(other)
__ge__(other)	Return self>=value.
__getitem__(key)	Get an item from the AnnotatedArray.
__gt__(other)	Return self>value.
__invert__()
__le__(other)	Return self<=value.
__len__()
__lshift__(other)
__lt__(other)	Return self<value.
__matmul__(other)
__mod__(other)
__mul__(other)
__ne__(other)	Return self!=value.
__neg__()
__or__(other)	Return self|value.
__pos__()
__pow__(other)
__repr__()	String representation.
__rshift__(other)
__setitem__(key, value)	Set values.
__str__()	String of the array itself.
__sub__(other)
__truediv__(other)
__xor__(other)
all([axis, dtype, out, keepdims, where])	Test if all elements (along an axis) are True.
any([axis, dtype, out, keepdims, where])	Test if any element (along an axis) is True.
astype(*args, **kwargs)	Return array as given type.
conj(*args, **kwargs)	Complex conjugate elementwise.
conjugate(*args, **kwargs)	Complex conjugate elementwise.
cumprod([axis, dtype, out])	Cumulative product of elements (along an axis).
cumsum([axis, dtype, out])	Cumulative sum of elements (along an axis).
diagonal([offset, axis1, axis2])	Get the diagonal of the array.
flatten([order])	Flatten array to one dimension.
max([axis, out, keepdims, initial, where])	Maximum (along an axis).
min([axis, out, keepdims, initial, where])	Minimum (along an axis).
prod([axis, dtype, out, keepdims, initial, ...])	Product of elements (along an axis).
relax(*args[, mro])	Try creating AnnotatedArray subclasses if possible.
sum([axis, dtype, out, keepdims, initial, where])	Sum of elements (along an axis).
swapaxes(axis1, axis2)
trace([offset, axis1, axis2, dtype, out])	Trace of an array.
transpose([axes])	Transpose array dimensions.
__le__(other)	Return self<=value.
__abs__()
__array__([dtype])	Convert to an numpy array.
__and__(other)
__ge__(other)	Return self>=value.
__mul__(other)
__mod__(other)
__pos__()
__neg__()
__str__()	String of the array itself.
__rshift__(other)
__xor__(other)
__floordiv__(other)
__gt__(other)	Return self>value.
__sub__(other)
__or__(other)	Return self|value.
__array_function__(func, types, args, kwargs)	Function calls on the array.
__invert__()
__ne__(other)	Return self!=value.
__truediv__(other)
__getitem__(key)	Get an item from the AnnotatedArray.
__lt__(other)	Return self<value.
__divmod__(other)
__lshift__(other)
__add__(other)
__matmul__(other)
__len__()
__pow__(other)
__eq__(other)	Return self==value.
__setitem__(key, value)	Set values.