1. Home
  2. Data and Services
  3. EIDA
  4. Webservices
  5. WFCatalog

EIDAWS WFCatalog Waveform Metadata Webservice

The WFCatalog Webservice provides detailed information on the contents of waveform data including quality control parameters. Information can be included on sample metrics, record header flags, and timing quality. The WFCatalog can serve as an index for data discovery as it has support for range filtering on all available metrics.

eidaws/wfcatalog/1/query

This service is an implementation of the EIDA web service specification version 1. For a complete service description refer to the WFCatalog specification document.

Making a GET request

Waveform metadata can be downloaded from ORFEUS EIDA using GET request by contacting the webservice address with specific request options inside the URL query. Webservice requests are generally formatted as follows:

http://webservice-address/label?options

Example! Copy the following URL

http://www.orfeus-eu.org/eidaws/wfcatalog/1/query?network=NL&include=sample&start=2017-01-01&end=2017-01-07

This request will return waveform metadata documents with a daily granularity from network NL between 2017-01-01T00:00:00 and 2017-01-07T00:00:00 including sample metrics from ORFEUS Data Center.

Description of request parameters

The webservice supports the following parameters that can be used to fine-tune your request.

Option Example Value Description Default Type
Temporal Constraints
starttime 2010-02-27T06:30:00 Starttime for time window ISO-8601
endtime 2010-02-27T10:30:00 Endtime for time window ISO-8601
SEED Identifiers
network NL SEED Network code String
station HGN SEED Station code String
location 00 SEED Location code. Use -- for blank location identifiers String
channel BHZ SEED Channel code String
Request Options
csegments true Include continuous segments false Boolean
format json Response (json) json String
granularity day Granularity of metrics (day) day String
include sample Level of detail (default, sample, header, all) default String
longestonly true Limit to single continuous segment that is the longest false Boolean
minimumlength 3600.0 Limit to continuous segment longer than this length 0.0 Float
Record Options
encoding STEIM2 Waveform data encoding String
num_records 1000 Number of records in document Integer
quality D SEED Quality code (D, R, Q, M) String
record_length 4096 Record length Integer
sample_rate 40 Number of samples per second Float
Sample Metric Options
max_gap 0 Maximum gap length in seconds Float
max_overlap 0 Maximum overlap length in seconds Float
num_gaps 0 Number of gaps Integer
num_overlaps 0 Number of overlaps Integer
num_samples 86400 Number of samples Integer
percent_availability 100 Percentage of available data Percentage
sample_max 100 Maximum sample value Integer
sample_min -100 Minimum sample value Integer
sample_mean 0 Mean sample value Integer
sample_rms 0 Quadratic mean of samples Float
sample_stdev 0 Standard deviation of samples Float
sample_lower_quartile 0 25th percentile of samples Float
sample_median 0 50th percentile of samples Float
sample_upper_quartile 0 75th percentile of samples Float
sum_gaps 0 Sum of data gaps in seconds Float
sum_overlaps 0 Sum of data overlaps in seconds Float
Header Flag Options
amplifier_saturation 0 Data with quality flags bit 0 set Percentage
calibration_signal 0 Data with activity flags bit 0 set Percentage
clock_locked 0 Data with io-and-clock flags bit 5 set Percentage
digital_filter_charging 0 Data with data quality flags bit 6 set Percentage
digitizer_clipping 0 Data with data quality flags bit 1 set Percentage
start_time_series 0 Data with io-and-clock flags bit 3 set Percentage
end_time_series 0 Data with io-and-clock flags bit 4 set Percentage
event_begin 0 Data with activity flags bit 2 set Percentage
event_end 0 Data with activity flags bit 3 set Percentage
event_in_progress 0 Data with activity flags bit 6 set Percentage
glitches 0 Data with data quality flags bit 3 set Percentage
long_record_read 0 Data with io-and-clock flags bit 1 set Percentage
missing_padded_data 0 Data with data quality flags bit 4 set Percentage
positive_leap 0 Data with activity flags bit 4 set Percentage
short_record_read 0 Data with io-and-clock flags bit 2 set Percentage
spikes 0 Data with data quality flags bit 2 set Percentage
station_volume 0 Data with io-and-clock flags bit 0 set Percentage
suspect_time_tag 0 Data with data quality flags bit 7 set Percentage
telemetry_sync_error 0 Data with data quality flags bit 5 set Percentage
time_correction_applied 0 Data with activity flags bit 1 set Percentage
Timing Quality Options
timing_correction 0 Data with header field 16 to non-zero Percentage
timing_quality_max 0 Maximum timing quality value Float
timing_quality_min 0 Minimum timing quality value Float
timing_quality_mean 0 Mean timing quality value Float
timing_quality_median 0 50th percentile of timing quality values Float
timing_quality_lower_quartile 0 25th percentile of timing quality values Float
timing_quality_upper_quartile 0 75th percentile of timing quality values Float

Metric Filtering

Request options under Sample Metrics, Header Flag, and Timing Quality can be filtered by appending a range filtering syntax to the end of the option.

  • _eq - Equal to
  • _gt - Greater than
  • _ge - Greater or equal to
  • _lt - Less than
  • _le - Less or equal to
  • _ne - Not equal to

Waveform metadata documents with an availability above 95 percent can thus be found using percentage_availability_gt=95.

Wildcards and Lists

A question mark represents a single character, while an asterisk represents zero or more characters. Multiple items may also be retrieved using a comma separated list. SEED identifiers support wildcards and lists.

Time Formats

Times must be specified in the ISO-8601 format (e.g. 2017-01-01T00:00:00 or 2017-01-01) and are assumed to be in UTC.

Simple user interface

A Swagger made User Interface is available for the EIDA WFCatalog Webservice here.