obspy.core.event.base.CompositeTime

class CompositeTime(*args, **kwargs)[source]

Bases: AbstractEventType

Focal times differ significantly in their precision. While focal times of instrumentally located earthquakes are estimated precisely down to seconds, historic events have only incomplete time descriptions. Sometimes, even contradictory information about the rupture time exist. The CompositeTime type allows for such complex descriptions. If the specification is given with no greater accuracy than days (i.e., no time components are given), the date refers to local time. However, if time components are given, they have to refer to UTC.

Parameters:

  • year (int) – Year or range of years of the event’s focal time.

  • year_errors (QuantityError) – AttribDict containing error quantities.

  • month (int) – Month or range of months of the event’s focal time.

  • month_errors (QuantityError) – AttribDict containing error quantities.

  • day (int) – Day or range of days of the event’s focal time.

  • day_errors (QuantityError) – AttribDict containing error quantities.

  • hour (int) – Hour or range of hours of the event’s focal time.

  • hour_errors (QuantityError) – AttribDict containing error quantities.

  • minute (int) – Minute or range of minutes of the event’s focal time.

  • minute_errors (QuantityError) – AttribDict containing error quantities.

  • second (float) – Second and fraction of seconds or range of seconds with fraction of the event’s focal time.

  • second_errors (QuantityError) – AttribDict containing error quantities.

>>> print(CompositeTime(2011, 1, 1))
CompositeTime(year=2011, month=1, day=1)
>>> # Can also be instantiated with the uncertainties.
>>> print(CompositeTime(year=2011, year_errors={"uncertainty":1}))
CompositeTime(year=2011 [uncertainty=1])

Note

For handling additional information not covered by the QuakeML standard and how to output it to QuakeML see the ObsPy Tutorial.

Attributes

defaults

do_not_warn_on

item

key

readonly

warn_on_non_default_key

Public Methods

clear

Clear the class :return:

copy

get

items

keys

pop

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem

as a 2-tuple; but raise KeyError if D is empty.

setdefault

update

values

Private Methods

Warning

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

CompositeTime._cast_type(key, value)

Cast type of value to type required in _types dict.

Parameters:

  • key (str) – The key from __setattr__.

  • value – The value being set to key.

Returns:

value cast to correct type.

CompositeTime._pretty_str(priorized_keys=[], min_label_length=16)

Return better readable string representation of AttribDict object.

Parameters:

  • priorized_keys (list[str], optional) – Keywords of current AttribDict which will be shown before all other keywords. Those keywords must exists otherwise an exception will be raised. Defaults to empty list.

  • min_label_length (int, optional) – Minimum label length for keywords. Defaults to 16.

Returns:

String representation of current AttribDict object.

CompositeTime._repr_pretty_(p, cycle)

Special Methods

CompositeTime.__bool__()
classmethod CompositeTime.__class_getitem__()

Represent a PEP 585 generic type

E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).

CompositeTime.__contains__(key)
CompositeTime.__delattr__(name)
CompositeTime.__delitem__(name)
CompositeTime.__dir__()

Default dir() implementation.

CompositeTime.__eq__(other)

Two instances are considered equal if all attributes and all lists are identical.

CompositeTime.__format__(format_spec, /)

Default object formatter.

CompositeTime.__ge__(value, /)

Return self>=value.

CompositeTime.__getattr__(name, default=None)

Py3k hasattr() expects an AttributeError no KeyError to be raised if the attribute is not found.

CompositeTime.__getattribute__(name, /)

Return getattr(self, name).

CompositeTime.__getitem__(name, default=None)
CompositeTime.__gt__(value, /)

Return self>value.

CompositeTime.__init__(*args, **kwargs)
CompositeTime.__init_subclass__()

This method is called when a class is subclassed.

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

CompositeTime.__iter__()
CompositeTime.__le__(value, /)

Return self<=value.

CompositeTime.__len__()
CompositeTime.__lt__(value, /)

Return self<value.

CompositeTime.__ne__(other)
CompositeTime.__new__(**kwargs)
CompositeTime.__reduce__()

Helper for pickle.

CompositeTime.__reduce_ex__(protocol, /)

Helper for pickle.

CompositeTime.__repr__()
CompositeTime.__setattr__(name, value)

Custom property implementation that works if the class is inheriting from AttribDict.

CompositeTime.__setitem__(key, value)
CompositeTime.__sizeof__()

Size of object in memory, in bytes.

CompositeTime.__str__(force_one_line=False)

Fairly extensive in an attempt to cover several use cases. It is always possible to change it in the child class.

classmethod CompositeTime.__subclasshook__(C)