obspy.core.event.Catalog¶
-
class
Catalog
(events=None, **kwargs)[source]¶ Bases:
object
This class serves as a container for Event objects.
Parameters: - events (list of
Event
, optional) – List of events - resource_id (
ResourceIdentifier
) – Resource identifier of the catalog. - description (str, optional) – Description string that can be assigned to the earthquake catalog, or collection of events.
- comments (list of
Comment
, optional) – Additional comments. - creation_info (
CreationInfo
, optional) – Creation information used to describe author, version, and creation time.
Note
For handling additional information not covered by the QuakeML standard and how to output it to QuakeML see the ObsPy Tutorial.
Attributes
__dict__
__doc__
__hash__
__module__
__weakref__
list of weak references to the object (if defined) creation_info
resource_id
Public Methods
append
Appends a single Event object to the current Catalog object. clear
Clears event list (convenient method). copy
Returns a deepcopy of the Catalog object. count
Returns the number of Events in the Catalog object. extend
Extends the current Catalog object with a list of Event objects. filter
Returns a new Catalog object only containing Events which match the specified filter rules. plot
Creates preview map of all events in current Catalog object. write
Saves catalog into a file. Private Methods
Warning
Private methods are mainly for internal/developer use and their API might change without notice.
_get_creation_info
_get_resource_id
_repr_pretty_
_set_creation_info
_set_resource_id
Special Methods
__add__
Method to add two catalogs. __delitem__
Passes on the __delitem__ method to the underlying list of traces. __dir__
Default dir() implementation. __eq__
__eq__ method of the Catalog object. __format__
Default object formatter. __getitem__
__getitem__ method of the Catalog object. __getslice__
__getslice__ method of the Catalog object. __iadd__
Method to add two catalog with self += other. __init__
Initialize self. __init_subclass__
This method is called when a class is subclassed. __iter__
Return a robust iterator for Events of current Catalog. __len__
Returns the number of Events in the Catalog object. __ne__
Return self!=value. __new__
Create and return a new object. __reduce__
Helper for pickle. __reduce_ex__
Helper for pickle. __setitem__
__setitem__ method of the Catalog object. __sizeof__
Size of object in memory, in bytes. __str__
Returns short summary string of the current catalog. __subclasshook__
Abstract classes can override this to customize issubclass(). - events (list of