obspy.core.util.obspy_types.ComplexWithUncertainties

class ComplexWithUncertainties(*args, **kwargs)

Bases: CustomComplex

Complex class which can store uncertainties.

Accepts FloatWithUncertainties and returns FloatWithUncertainties from property methods.

Attributes

imag
lower_uncertainty
real
upper_uncertainty

Public Methods

conjugate

Return the complex conjugate of its argument.

Private Methods

Warning

Private methods are mainly for internal/developer use and their API might change without notice.

static ComplexWithUncertainties._attr(obj, attr)

static ComplexWithUncertainties._uncertainty(value)

Special Methods

ComplexWithUncertainties.__abs__()

abs(self)

ComplexWithUncertainties.__add__(value, /)

Return self+value.

ComplexWithUncertainties.__bool__()

True if self else False

ComplexWithUncertainties.__delattr__(name, /)

Implement delattr(self, name).

ComplexWithUncertainties.__dir__()

Default dir() implementation.

ComplexWithUncertainties.__divmod__(value, /)

Return divmod(self, value).

ComplexWithUncertainties.__eq__(value, /)

Return self==value.

ComplexWithUncertainties.__float__()

float(self)

ComplexWithUncertainties.__floordiv__(value, /)

Return self//value.

ComplexWithUncertainties.__format__() → str

Convert to a string according to format_spec.

ComplexWithUncertainties.__ge__(value, /)

Return self>=value.

ComplexWithUncertainties.__getattribute__(name, /)

Return getattr(self, name).

ComplexWithUncertainties.__getnewargs__()

ComplexWithUncertainties.__gt__(value, /)

Return self>value.

ComplexWithUncertainties.__hash__()

Return hash(self).

ComplexWithUncertainties.__iadd__(other)

ComplexWithUncertainties.__imul__(other)

ComplexWithUncertainties.__init__(*args, **kwargs)

Complex type with optional keywords:

Parameters:

• lower_uncertainty (complex) – Lower uncertainty (aka minusError)

• upper_uncertainty (complex) – Upper uncertainty (aka plusError)

• measurement_method_real (str) – Method used in the measurement of real part.

• measurement_method_imag (str) – Method used in the measurement of imaginary part.

ComplexWithUncertainties.__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

ComplexWithUncertainties.__int__()

int(self)

ComplexWithUncertainties.__le__(value, /)

Return self<=value.

ComplexWithUncertainties.__lt__(value, /)

Return self<value.

ComplexWithUncertainties.__mod__(value, /)

Return self%value.

ComplexWithUncertainties.__mul__(value, /)

Return self*value.

ComplexWithUncertainties.__ne__(value, /)

Return self!=value.

ComplexWithUncertainties.__neg__()

-self

static ComplexWithUncertainties.__new__(cls, *args, **kwargs)

ComplexWithUncertainties.__pos__()

+self

ComplexWithUncertainties.__pow__(value, mod=None, /)

Return pow(self, value, mod).

ComplexWithUncertainties.__radd__(value, /)

Return value+self.

ComplexWithUncertainties.__rdivmod__(value, /)

Return divmod(value, self).

ComplexWithUncertainties.__reduce__()

Helper for pickle.

ComplexWithUncertainties.__reduce_ex__(protocol, /)

Helper for pickle.

ComplexWithUncertainties.__repr__()

Return repr(self).

ComplexWithUncertainties.__rfloordiv__(value, /)

Return value//self.

ComplexWithUncertainties.__rmod__(value, /)

Return value%self.

ComplexWithUncertainties.__rmul__(value, /)

Return value*self.

ComplexWithUncertainties.__rpow__(value, mod=None, /)

Return pow(value, self, mod).

ComplexWithUncertainties.__rsub__(value, /)

Return value-self.

ComplexWithUncertainties.__rtruediv__(value, /)

Return value/self.

ComplexWithUncertainties.__setattr__(name, value, /)

Implement setattr(self, name, value).

ComplexWithUncertainties.__sizeof__()

Size of object in memory, in bytes.

ComplexWithUncertainties.__str__()

Return str(self).

ComplexWithUncertainties.__sub__(value, /)

Return self-value.

ComplexWithUncertainties.__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

ComplexWithUncertainties.__truediv__(value, /)

Return self/value.