obsplus.events_to_df

obsplus.events_to_df = {'_get_event_description': <function _get_event_description>, '_get_event_id': <function _get_event_id>, '_get_author': <function _get_author>, '_get_eve_creation_info': <function _get_eve_creation_info>, '_get_update_time': <function _get_update_time>, '_get_origin_basic': <function _get_origin_basic>, '_get_time': <function _get_time>, '_get_origin_quality': <function _get_origin_quality>, '_get_magnitude_info': <function _get_magnitude_info>}

A class to extract dataframes from nested object trees.

Generally used to construct summary dataframes from nested object structures such as the obspy Catalog.

Parameters:
  • cls – The top-level class the extractor acts on.

  • required_columns – If not None, assert required columns are in dataframe, and order columns the same as required_columns, with extra columns at the end.

  • dtypes – A dict of {column name: required data type}. Can also be specified when registering extractors.

  • pass_dataframe – If True, return dataframes passed to DataFrameExtractor.__call__. This allows the DataFrameExtractor to be idempotent.

  • column_funcs – Columns that are UTCDateTime objects. Will correctly handle UTCDateTime-able objects (like date-time strings, floats, etc).