Detailed Definition
===================
This section details what ``SEIS-PROV`` is, what records are part of it, and
how these records are defined.
.. contents::
:local:
:depth: 1
What PROV Records are Considered Part of SEIS-PROV?
---------------------------------------------------
``SEIS-PROV`` is a domain-specific extension of W3C PROV and thus all the
capabilities of W3C PROV can be used. Furthermore a ``SEIS-PROV`` document must
also be a valid W3C PROV document.
It can be understood as an additional set of constraints on top of W3C PROV.
These constraints are currently enforced per record and there are four
possibilities for a record to be considered part of ``SEIS-PROV``:
1. An agent with a **prov:type** equal to **prov:SoftwareAgent** and an id
under the ``SEIS-PROV`` namespace.
2. An agent with a **prov:type** equal to **prov:Person** and an id under the
``SEIS-PROV`` namespace.
3. An entity with a **prov:type** and id under the ``SEIS-PROV`` namespace.
4. An activity with a **prov:type** and id under the ``SEIS-PROV`` namespace.
All other records must just be valid according to the W3C PROV specification.
It is forbidden to use an identifier under the ``SEIS-PROV`` namespace for any
other record.
As soon as a record is considered part of ``SEIS-PROV`` it must fulfill the
additional constraints detailed in the following.
SEIS-PROV IDs
-------------
All ``prov:id``'s living in the ``SEIS-PROV`` namespace must follow a certain
pattern - they have to validate against this regular expression:
``^sp\d{3,5}_[a-z]{2}_[a-z0-9]{7,12}$``
Examples are:
* ``sp001_wf_f84fb9a``
* ``sp027_bs_ea78b46``
An id thus consists of three parts delimited by underscores with the
goal of attaining a fairly short but still slightly descriptive
identifier:
1. A 3 to 5 digit zero padded number prefixed with ``sp``. This is intended
to further illustrate the sequence of processing steps and events.
``001`` for example is the first step in a processing chain, whereas
``017`` is the seventeenth step. This is not enforced anywhere but nice
to have so users are encouraged to adopt this. In case there is no
inherent order to things, feel free to use ``000``. The ``sp`` prefix is
needed to provide a valid qualified name attribute according the XML
specification and stands for ``SEIS-PROV``.
2. A two letter code depending on the type of entity or activity. This
is enforced and part of the ``SEIS-PROV`` definition. Please see the
definition of each node for the corresponding two letter code.
3. A 7 to 12 letter lowercase alphanumeric hash to ensure uniqueness of
ids.
-----
Agents
------
One is free to use any agent as long as they are valid according to the W3C
PROV specification. If an agent is under the ``SEIS-PROV`` namespace, a couple
of additional constraints apply. These are intended to enforce a certain
minimum amount of information.
.. contents::
:local:
:depth: 1
------
Software Agent
^^^^^^^^^^^^^^
This agent describes the software used for a particular task. It requires some attributes to be able to uniquely determine the used software including the version. If you use the development version of a particular software you should reflect that in the version number.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``software_agent``
``prov:label`` ``*``
Two letter ID code: ``sa``
============================ =======
Required Attributes
================ ============== ===================================================
Name Type Description
================ ============== ===================================================
software_name ``xsd:string`` The name of the software.
software_version ``xsd:string`` The version number of the used software.
website ``xsd:anyURI`` The website where one can find further information.
================ ============== ===================================================
Optional Attributes
==== ============== ===============================================
Name Type Description
==== ============== ===============================================
doi ``xsd:string`` The digital object identifier for the software.
==== ============== ===============================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/agents/software_agent.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``software_agent`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``software_agent`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/agents/software_agent_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/agents/software_agent_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/agents/software_agent_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/agents/software_agent_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/agents/software_agent_min.provn
.. raw:: html
**Full Example**
A concrete ``software_agent`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``software_agent`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/agents/software_agent_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/agents/software_agent_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/agents/software_agent_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/agents/software_agent_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/agents/software_agent_max.provn
.. raw:: html
------
Person
^^^^^^
A person is an agent either denoting who is responsible for a certain activity (``wasAssociatedWith``) or who is responsible for the actions of another agent (``actedOnBehalfOf``). This is useful to state who performed a particular task. A person in the ``SEIS-PROV`` namespace must have a name and can have an email address. A person can also have any number of additional attributes in the ``SEIS-PROV`` namespace to describe it in more detail.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``person``
``prov:label`` ``*``
Two letter ID code: ``pp``
============================ =======
Required Attributes
==== ============== =======================
Name Type Description
==== ============== =======================
name ``xsd:string`` The name of the person.
==== ============== =======================
Optional Attributes
===== ============== ================================
Name Type Description
===== ============== ================================
email ``xsd:string`` The email address of the person.
===== ============== ================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/agents/person.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``person`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``person`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/agents/person_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/agents/person_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/agents/person_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/agents/person_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/agents/person_min.provn
.. raw:: html
**Full Example**
A concrete ``person`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``person`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/agents/person_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/agents/person_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/agents/person_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/agents/person_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/agents/person_max.provn
.. raw:: html
------
Organization
^^^^^^^^^^^^
An agent denoting an organization. This is useful to describe who is associated with what organization (``wasAssociatedWith``). An organization can also have any number of additional attributes in the ``SEIS-PROV`` namespace to describe it in more detail.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``organization``
``prov:label`` ``*``
Two letter ID code: ``og``
============================ =======
Required Attributes
==== ============== =============================
Name Type Description
==== ============== =============================
name ``xsd:string`` The name of the organization.
==== ============== =============================
Optional Attributes
======= ============== ================================
Name Type Description
======= ============== ================================
website ``xsd:anyURI`` The website of the organization.
======= ============== ================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/agents/organization.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``organization`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``organization`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/agents/organization_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/agents/organization_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/agents/organization_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/agents/organization_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/agents/organization_min.provn
.. raw:: html
**Full Example**
A concrete ``organization`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``organization`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/agents/organization_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/agents/organization_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/agents/organization_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/agents/organization_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/agents/organization_max.provn
.. raw:: html
-----
Entities
--------
``SEIS-PROV`` determines the type of an entity via the ``prov:type`` attribute.
The following entities are currently available. Further types will be added as
requested by the community.
.. contents::
:local:
:depth: 1
------
Waveform Trace
^^^^^^^^^^^^^^
Represents a continuous, equally sampled observed or synthetic waveform trace. Most attributes are optional and can be used to describe either very detailed or fairly general provenance information.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``waveform_trace``
``prov:label`` ``Waveform Trace``
Two letter ID code: ``wf``
============================ =======
Required Attributes
*None*
Optional Attributes
================= ======================= =============================================================================================================================================================================
Name Type Description
================= ======================= =============================================================================================================================================================================
seed_id ``xsd:string`` The SEED id of the recording station.
description ``xsd:string`` An optional description of the waveform trace. This has no technical meaning but serves to make the provenance documents easier to understand.
component ``xsd:string`` The component of the recording. Many algorithms require a specific component and this attribute enables the description of these algorithms without using a specific SEED id.
start_time ``xsd:dateTime`` The time of the first sample in UTC.
number_of_samples ``xsd:positiveInteger`` The number of samples in the waveform trace.
sampling_rate ``xsd:double`` The sampling rate of the data.
units ``xsd:string`` Units of the waveform data in a common abbreviation, e.g. `m`, `m/s`, `nm/s^2`, ...
azimuth ``xsd:double`` Azimuth of the component in degrees from north, clockwise, same definition as in StationXML.
dip ``xsd:double`` Dip of the component in degrees, down from horizontal, same definition as in StationXML.
================= ======================= =============================================================================================================================================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/entities/waveform_trace.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``waveform_trace`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``waveform_trace`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/entities/waveform_trace_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/waveform_trace_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/waveform_trace_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/waveform_trace_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/waveform_trace_min.provn
.. raw:: html
**Full Example**
A concrete ``waveform_trace`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``waveform_trace`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/entities/waveform_trace_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/waveform_trace_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/waveform_trace_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/waveform_trace_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/waveform_trace_max.provn
.. raw:: html
------
Input Parameters
^^^^^^^^^^^^^^^^
The input parameters for a program like a waveform solvers as a list of key, value pairs. Each key can live in the ``SEIS-PROV`` namespace.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``input_parameters``
``prov:label`` ``Input Parameters``
Two letter ID code: ``in``
============================ =======
Required Attributes
*None*
Optional Attributes
*None*
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/entities/input_parameters.json
:language: json
.. raw:: html
**Example**
A concrete ``input_parameters`` node example is illustrated here as a graph, in code, and in various representations.
.. raw:: html
.. graphviz:: _generated/dot/entities/input_parameters_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/input_parameters_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/input_parameters_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/input_parameters_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/input_parameters_max.provn
.. raw:: html
------
File
^^^^
In some cases arbitrary files are needed to describe the provenance of something. Examples are special source code files who's information cannot be represented in the ``Input Parameter`` entity. This entity allows to refer to arbitrary files. Each file is represented by a filename, a location, and a location type. The location might be a URL; then provenance discovery is simple. It might also be a filename or a path in a container format. Users are responsible to either ship the files alongside the provenance information or provide access by other means.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``file``
``prov:label`` ``File``
Two letter ID code: ``fi``
============================ =======
Required Attributes
============= ============== ==========================================================================================================
Name Type Description
============= ============== ==========================================================================================================
filename ``xsd:string`` The name of the file.
location ``xsd:string`` The location of the file in a way that can be discovered. Can be a URL, a file path, or something similar.
location_type ``xsd:string`` The type of location. Examples include ``Filename``, ``URL``, ``HDF5 Data Set``, ``SFTP Address``, ...
============= ============== ==========================================================================================================
Optional Attributes
*None*
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/entities/file.json
:language: json
.. raw:: html
**Example**
A concrete ``file`` node example is illustrated here as a graph, in code, and in various representations.
.. raw:: html
.. graphviz:: _generated/dot/entities/file_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/file_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/file_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/file_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/file_max.provn
.. raw:: html
------
Earth Model
^^^^^^^^^^^
An earth model. Its main use is to illustrate the origin of synthetic seismograms.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``earth_model``
``prov:label`` ``Earth Model``
Two letter ID code: ``em``
============================ =======
Required Attributes
========== ============== =======================================================================================================
Name Type Description
========== ============== =======================================================================================================
model_name ``xsd:string`` The name of the model.
model_type ``xsd:string`` The type of model as a short, descriptive string, e.g. ``'1D'``, ``'3D'``, ``'axially symmetric'``, ...
========== ============== =======================================================================================================
Optional Attributes
=========== ============== =============================================
Name Type Description
=========== ============== =============================================
doi ``xsd:string`` A DOI pointing to a publication of the model.
website ``xsd:anyURI`` URL to a website with more information.
description ``xsd:string`` A short description of the model.
=========== ============== =============================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/entities/earth_model.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``earth_model`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``earth_model`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/entities/earth_model_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/earth_model_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/earth_model_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/earth_model_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/earth_model_min.provn
.. raw:: html
**Full Example**
A concrete ``earth_model`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``earth_model`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/entities/earth_model_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/earth_model_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/earth_model_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/earth_model_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/earth_model_max.provn
.. raw:: html
------
Cross Correlation Stack
^^^^^^^^^^^^^^^^^^^^^^^
A stack of cross correlations.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``cross_correlation_stack``
``prov:label`` ``Cross Correlation Stack``
Two letter ID code: ``cs``
============================ =======
Required Attributes
*None*
Optional Attributes
================= ======================= ===============================================================================================================================================================================================================
Name Type Description
================= ======================= ===============================================================================================================================================================================================================
correlation_type ``xsd:string`` The type of performed cross correlations as a string. Only useful if the same for all cross correlations, otherwise that information must be stored in the provenance records of the single cross correlations.
correlation_count ``xsd:positiveInteger`` The number of cross correlations used to calculate the stack.
stacking_method ``xsd:string`` The method used to create the stack.
seed_id_a ``xsd:string`` The SEED identifier of station A.
seed_id_b ``xsd:string`` The SEED identifier of station B.
================= ======================= ===============================================================================================================================================================================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/entities/cross_correlation_stack.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``cross_correlation_stack`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``cross_correlation_stack`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/entities/cross_correlation_stack_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/cross_correlation_stack_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/cross_correlation_stack_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/cross_correlation_stack_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/cross_correlation_stack_min.provn
.. raw:: html
**Full Example**
A concrete ``cross_correlation_stack`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``cross_correlation_stack`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/entities/cross_correlation_stack_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/cross_correlation_stack_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/cross_correlation_stack_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/cross_correlation_stack_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/cross_correlation_stack_max.provn
.. raw:: html
------
Cross Correlation
^^^^^^^^^^^^^^^^^
A cross correlation between two stations A and B. Station metadata is not recorded here as it is part of either SEED or StationXML files. Any previously applied processing is also not part of the entity but rather of the entity used by the activity generating this one.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``cross_correlation``
``prov:label`` ``Cross Correlation``
Two letter ID code: ``cc``
============================ =======
Required Attributes
================ ============== ====================================================
Name Type Description
================ ============== ====================================================
correlation_type ``xsd:string`` The type of performed cross correlation as a string.
================ ============== ====================================================
Optional Attributes
=========================== ============== ============================================================
Name Type Description
=========================== ============== ============================================================
max_lag_time_in_sec ``xsd:double`` The maximum lag time used during the calculation in seconds.
max_correlation_coefficient ``xsd:double`` The maximum correlation coefficient
seed_id_a ``xsd:string`` The SEED identifier of station A.
seed_id_b ``xsd:string`` The SEED identifier of station B.
=========================== ============== ============================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/entities/cross_correlation.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``cross_correlation`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``cross_correlation`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/entities/cross_correlation_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/cross_correlation_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/cross_correlation_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/cross_correlation_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/cross_correlation_min.provn
.. raw:: html
**Full Example**
A concrete ``cross_correlation`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``cross_correlation`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/entities/cross_correlation_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/cross_correlation_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/cross_correlation_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/cross_correlation_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/cross_correlation_max.provn
.. raw:: html
------
Adjoint Source
^^^^^^^^^^^^^^
One component of an adjoint source used in adjoint simulations. The location can be specified either in geographical coordinates (WGS84) or as the SEED identifier of the corresponding station. The definition of geographic coordinates is the same as in StationXML. Any processing applied to the data before the adjoint source has been calculated (window picking, filtering, ...) has to be described by provenance records on the waveform entities.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``adjoint_source``
``prov:label`` ``Adjoint Source``
Two letter ID code: ``as``
============================ =======
Required Attributes
=================== ============== =============================================
Name Type Description
=================== ============== =============================================
adjoint_source_type ``xsd:string`` A string denoting the type of adjoint source.
=================== ============== =============================================
Optional Attributes
======================= ======================= ===============================================================================================================================================================================
Name Type Description
======================= ======================= ===============================================================================================================================================================================
latitude ``xsd:double`` The latitude of the station in WGS84.
longitude ``xsd:double`` The longitude of the station in WGS84.
elevation_in_m ``xsd:double`` The elevation of the station in meter above the null level on WGS84.
local_depth_in_m ``xsd:double`` The burial of the station in meter.
orientation ``xsd:string`` The orientation of the adjoint source, either N (north), E (east), Z (up), T (transverse), or R (radial). If that is not sufficient, please use the dip and azimuth attributes.
dip ``xsd:double`` Dip of the component in degrees, down from horizontal, same definition as in StationXML.
azimuth ``xsd:double`` Azimuth of the component in degrees from north, clockwise, same definition as in StationXML.
station_id ``xsd:string`` The id of the recording station.
number_of_samples ``xsd:positiveInteger`` The number of samples in the trace.
sampling_rate ``xsd:double`` The sampling rate of the data.
units ``xsd:string`` Units of the adjoint source as a common abbreviation, e.g. m, m/s, nm/s^2, ...
adjoint_source_type_uri ``xsd:anyURI`` A URI pointing to a detailed description of the adjoint source, for example a DOI link to a publication.
misfit_value ``xsd:double`` The calculation of many types of adjoint sources will automatically yield a misfit value denoting the similarity of usually observed and synthetic seismograms.
======================= ======================= ===============================================================================================================================================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/entities/adjoint_source.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``adjoint_source`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``adjoint_source`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/entities/adjoint_source_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/adjoint_source_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/adjoint_source_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/adjoint_source_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/adjoint_source_min.provn
.. raw:: html
**Full Example**
A concrete ``adjoint_source`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``adjoint_source`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/entities/adjoint_source_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/entities/adjoint_source_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/entities/adjoint_source_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/entities/adjoint_source_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/entities/adjoint_source_max.provn
.. raw:: html
-----
Activities
----------
``SEIS-PROV`` determines the type of an activity via the ``prov:type``
attribute. The following activities are currently available. Further types
will be added as requested by the community.
.. contents::
:local:
:depth: 1
------
Waveform Simulation
^^^^^^^^^^^^^^^^^^^
Generate data by running some numerical or analytic code. Must be associated with one or more agents and use some entities to achieve a useful description.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``waveform_simulation``
``prov:label`` ``Waveform Simulation``
Two letter ID code: ``ws``
============================ =======
Required Attributes
*None*
Optional Attributes
*None*
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/waveform_simulation.json
:language: json
.. raw:: html
**Example**
A concrete ``waveform_simulation`` node example is illustrated here as a graph, in code, and in various representations.
.. raw:: html
.. graphviz:: _generated/dot/activities/waveform_simulation_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/waveform_simulation_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/waveform_simulation_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/waveform_simulation_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/waveform_simulation_max.provn
.. raw:: html
------
Taper
^^^^^
Apply a taper window to the data.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``taper``
``prov:label`` ``Taper``
Two letter ID code: ``tp``
============================ =======
Required Attributes
=========== ============== ================================================================
Name Type Description
=========== ============== ================================================================
window_type ``xsd:string`` The type applied window.
taper_width ``xsd:double`` The width of the taper at each end. Must be between 0.0 and 0.5.
side ``xsd:string`` `'left'`, `'right'`, or `'both'`
=========== ============== ================================================================
Optional Attributes
*None*
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/taper.json
:language: json
.. raw:: html
**Example**
A concrete ``taper`` node example is illustrated here as a graph, in code, and in various representations.
.. raw:: html
.. graphviz:: _generated/dot/activities/taper_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/taper_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/taper_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/taper_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/taper_max.provn
.. raw:: html
------
Stack Cross Correlations
^^^^^^^^^^^^^^^^^^^^^^^^
Stack a number of cross correlations.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``stack_cross_correlations``
``prov:label`` ``Stack Cross Correlations``
Two letter ID code: ``sc``
============================ =======
Required Attributes
=============== ============== ========================================================
Name Type Description
=============== ============== ========================================================
stacking_method ``xsd:string`` A string describing the method used to create the stack.
=============== ============== ========================================================
Optional Attributes
*None*
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/stack_cross_correlations.json
:language: json
.. raw:: html
**Example**
A concrete ``stack_cross_correlations`` node example is illustrated here as a graph, in code, and in various representations.
.. raw:: html
.. graphviz:: _generated/dot/activities/stack_cross_correlations_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/stack_cross_correlations_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/stack_cross_correlations_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/stack_cross_correlations_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/stack_cross_correlations_max.provn
.. raw:: html
------
Simulate Response
^^^^^^^^^^^^^^^^^
Add an instrument’s response.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``simulate_response``
``prov:label`` ``Simulate Response``
Two letter ID code: ``sr``
============================ =======
Required Attributes
*None*
Optional Attributes
============ ============== ================================================================================================================================================
Name Type Description
============ ============== ================================================================================================================================================
description ``xsd:string`` Textual description of the added response. If more details are needed, then this activity should use an entity that points to the used response.
input_units ``xsd:string`` Units of the input data in a common abbreviation, e.g. `m`, `m/s`, `nm/s^2`, ...
output_units ``xsd:string`` Units of the output data in a common abbreviation, e.g. `m`, `m/s`, `nm/s^2`, ...
============ ============== ================================================================================================================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/simulate_response.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``simulate_response`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``simulate_response`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/simulate_response_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/simulate_response_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/simulate_response_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/simulate_response_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/simulate_response_min.provn
.. raw:: html
**Full Example**
A concrete ``simulate_response`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``simulate_response`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/simulate_response_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/simulate_response_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/simulate_response_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/simulate_response_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/simulate_response_max.provn
.. raw:: html
------
Rotate
^^^^^^
Rotate multi-component data. The precise rotation angles could be inferred by comparing the dip and azimuth of inputs and outputs. Alternatively the rotation method can be specified.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``rotate``
``prov:label`` ``Rotate``
Two letter ID code: ``rt``
============================ =======
Required Attributes
*None*
Optional Attributes
====== ============== ====================
Name Type Description
====== ============== ====================
method ``xsd:string`` The rotation method.
====== ============== ====================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/rotate.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``rotate`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``rotate`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/rotate_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/rotate_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/rotate_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/rotate_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/rotate_min.provn
.. raw:: html
**Full Example**
A concrete ``rotate`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``rotate`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/rotate_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/rotate_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/rotate_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/rotate_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/rotate_max.provn
.. raw:: html
------
Resample
^^^^^^^^
Resample the data in the frequency domain.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``resample``
``prov:label`` ``Resample``
Two letter ID code: ``rs``
============================ =======
Required Attributes
================= ============== ==========================================
Name Type Description
================= ============== ==========================================
new_sampling_rate ``xsd:double`` The sampling rate after the interpolation.
================= ============== ==========================================
Optional Attributes
======================= ======================= ============================================================
Name Type Description
======================= ======================= ============================================================
frequency_domain_window ``xsd:string`` The window applied to the signal in the Fourier domain.
new_start_time ``xsd:dateTime`` The time of the first sample in UTC after the interpolation.
new_number_of_samples ``xsd:positiveInteger`` The number of samples after the interpolation.
======================= ======================= ============================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/resample.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``resample`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``resample`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/resample_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/resample_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/resample_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/resample_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/resample_min.provn
.. raw:: html
**Full Example**
A concrete ``resample`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``resample`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/resample_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/resample_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/resample_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/resample_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/resample_max.provn
.. raw:: html
------
Remove Response
^^^^^^^^^^^^^^^
Remove an instrument's response.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``remove_response``
``prov:label`` ``Remove Response``
Two letter ID code: ``rr``
============================ =======
Required Attributes
*None*
Optional Attributes
============ ============== =================================================================================
Name Type Description
============ ============== =================================================================================
water_level ``xsd:double`` The applied water level in dB.
input_units ``xsd:string`` Units of the input data in a common abbreviation, e.g. `m`, `m/s`, `nm/s^2`, ...
output_units ``xsd:string`` Units of the output data in a common abbreviation, e.g. `m`, `m/s`, `nm/s^2`, ...
============ ============== =================================================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/remove_response.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``remove_response`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``remove_response`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/remove_response_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/remove_response_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/remove_response_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/remove_response_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/remove_response_min.provn
.. raw:: html
**Full Example**
A concrete ``remove_response`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``remove_response`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/remove_response_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/remove_response_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/remove_response_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/remove_response_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/remove_response_max.provn
.. raw:: html
------
Pad
^^^
Pad the data resulting in a longer trace.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``pad``
``prov:label`` ``Pad``
Two letter ID code: ``pd``
============================ =======
Required Attributes
========== ================================ ========================================================
Name Type Description
========== ================================ ========================================================
fill_value ``xsd:decimal``, ``xsd:integer`` The value that will be used to fill missing values with.
========== ================================ ========================================================
Optional Attributes
============== ================ =====================================================
Name Type Description
============== ================ =====================================================
new_start_time ``xsd:dateTime`` The time of the first sample in UTC after padding it.
new_end_time ``xsd:dateTime`` The time of the last sample in UTC after padding it.
============== ================ =====================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/pad.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``pad`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``pad`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/pad_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/pad_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/pad_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/pad_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/pad_min.provn
.. raw:: html
**Full Example**
A concrete ``pad`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``pad`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/pad_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/pad_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/pad_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/pad_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/pad_max.provn
.. raw:: html
------
Normalize
^^^^^^^^^
Normalize the data.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``normalize``
``prov:label`` ``Normalize``
Two letter ID code: ``nm``
============================ =======
Required Attributes
==================== ============== ==============================
Name Type Description
==================== ============== ==============================
normalization_method ``xsd:string`` The used normalization method.
==================== ============== ==============================
Optional Attributes
*None*
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/normalize.json
:language: json
.. raw:: html
**Example**
A concrete ``normalize`` node example is illustrated here as a graph, in code, and in various representations.
.. raw:: html
.. graphviz:: _generated/dot/activities/normalize_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/normalize_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/normalize_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/normalize_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/normalize_max.provn
.. raw:: html
------
Multiply
^^^^^^^^
Multiply each value of the data with a certain factor. This is implied by many operations but sometimes useful to capture in its own right.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``multiply``
``prov:label`` ``Multiply``
Two letter ID code: ``mp``
============================ =======
Required Attributes
====== ============== ================================
Name Type Description
====== ============== ================================
factor ``xsd:double`` The factor by which to multiply.
====== ============== ================================
Optional Attributes
*None*
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/multiply.json
:language: json
.. raw:: html
**Example**
A concrete ``multiply`` node example is illustrated here as a graph, in code, and in various representations.
.. raw:: html
.. graphviz:: _generated/dot/activities/multiply_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/multiply_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/multiply_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/multiply_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/multiply_max.provn
.. raw:: html
------
Merge
^^^^^
Merge several traces into one. This is very implementation dependent and thus the activity should be associated with a software agent.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``merge``
``prov:label`` ``Merge``
Two letter ID code: ``mg``
============================ =======
Required Attributes
================ ============== =================================================
Name Type Description
================ ============== =================================================
merging_strategy ``xsd:string`` A string describing the applied merging strategy.
================ ============== =================================================
Optional Attributes
*None*
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/merge.json
:language: json
.. raw:: html
**Example**
A concrete ``merge`` node example is illustrated here as a graph, in code, and in various representations.
.. raw:: html
.. graphviz:: _generated/dot/activities/merge_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/merge_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/merge_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/merge_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/merge_max.provn
.. raw:: html
------
Lowpass Filter
^^^^^^^^^^^^^^
Lowpass the data.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``lowpass_filter``
``prov:label`` ``Lowpass Filter``
Two letter ID code: ``lp``
============================ =======
Required Attributes
=========== ============== ===================================================================================
Name Type Description
=========== ============== ===================================================================================
filter_type ``xsd:string`` The type of filter, e.g. `Butterworth`, `FIR`, `Chebyshev Type I/II`, `Bessel`, ...
=========== ============== ===================================================================================
Optional Attributes
============================ ======================= ============================================================
Name Type Description
============================ ======================= ============================================================
corner_frequency ``xsd:double`` The corner frequency of the filter if applicable in Hz
filter_order ``xsd:positiveInteger`` The order of the filter if applicable.
number_of_passes ``xsd:positiveInteger`` The number of filter passes if applicable.
chebychev_transition_bw ``xsd:double`` The transition band width in the case of a Chebychev filter.
chebychev_attenuation_factor ``xsd:double`` The attenuation factor in the case of a Chebychev filter.
============================ ======================= ============================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/lowpass_filter.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``lowpass_filter`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``lowpass_filter`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/lowpass_filter_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/lowpass_filter_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/lowpass_filter_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/lowpass_filter_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/lowpass_filter_min.provn
.. raw:: html
**Full Example**
A concrete ``lowpass_filter`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``lowpass_filter`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/lowpass_filter_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/lowpass_filter_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/lowpass_filter_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/lowpass_filter_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/lowpass_filter_max.provn
.. raw:: html
------
Interpolate
^^^^^^^^^^^
Interpolate the data to new sampling points.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``interpolate``
``prov:label`` ``Interpolate``
Two letter ID code: ``ip``
============================ =======
Required Attributes
==================== ============== ======================================================================================================================================================================================================================
Name Type Description
==================== ============== ======================================================================================================================================================================================================================
interpolation_method ``xsd:string`` The method used to interpolate the samples. ``weighted average slopes`` is the interpolation method use by SAC and detailed in a 1976 paper by Wiggins. This is in wide use and thus offered as a special option here.
new_sampling_rate ``xsd:double`` The sampling rate after the interpolation.
==================== ============== ======================================================================================================================================================================================================================
Optional Attributes
===================== ======================= ============================================================
Name Type Description
===================== ======================= ============================================================
new_start_time ``xsd:dateTime`` The time of the first sample in UTC after the interpolation.
new_number_of_samples ``xsd:positiveInteger`` The number of samples after the interpolation.
===================== ======================= ============================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/interpolate.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``interpolate`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``interpolate`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/interpolate_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/interpolate_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/interpolate_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/interpolate_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/interpolate_min.provn
.. raw:: html
**Full Example**
A concrete ``interpolate`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``interpolate`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/interpolate_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/interpolate_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/interpolate_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/interpolate_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/interpolate_max.provn
.. raw:: html
------
Integrate
^^^^^^^^^
Integrate the data with respect to time.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``integrate``
``prov:label`` ``Integrate``
Two letter ID code: ``ig``
============================ =======
Required Attributes
===== ======================= ===========================================================
Name Type Description
===== ======================= ===========================================================
order ``xsd:positiveInteger`` The order of the integration, e.g. the nth anti-derivative.
===== ======================= ===========================================================
Optional Attributes
================== ============== =================================================================================
Name Type Description
================== ============== =================================================================================
integration_method ``xsd:string`` The integration method.
input_units ``xsd:string`` Units of the input data in a common abbreviation, e.g. `m`, `m/s`, `nm/s^2`, ...
output_units ``xsd:string`` Units of the output data in a common abbreviation, e.g. `m`, `m/s`, `nm/s^2`, ...
================== ============== =================================================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/integrate.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``integrate`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``integrate`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/integrate_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/integrate_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/integrate_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/integrate_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/integrate_min.provn
.. raw:: html
**Full Example**
A concrete ``integrate`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``integrate`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/integrate_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/integrate_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/integrate_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/integrate_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/integrate_max.provn
.. raw:: html
------
Highpass Filter
^^^^^^^^^^^^^^^
Highpass the data.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``highpass_filter``
``prov:label`` ``Highpass Filter``
Two letter ID code: ``hp``
============================ =======
Required Attributes
=========== ============== ===================================================================================
Name Type Description
=========== ============== ===================================================================================
filter_type ``xsd:string`` The type of filter, e.g. `Butterworth`, `FIR`, `Chebyshev Type I/II`, `Bessel`, ...
=========== ============== ===================================================================================
Optional Attributes
============================ ======================= ============================================================
Name Type Description
============================ ======================= ============================================================
corner_frequency ``xsd:double`` The corner frequency of the filter if applicable in Hz
filter_order ``xsd:positiveInteger`` The order of the filter if applicable.
number_of_passes ``xsd:positiveInteger`` The number of filter passes if applicable.
chebychev_transition_bw ``xsd:double`` The transition band width in the case of a Chebychev filter.
chebychev_attenuation_factor ``xsd:double`` The attenuation factor in the case of a Chebychev filter.
============================ ======================= ============================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/highpass_filter.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``highpass_filter`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``highpass_filter`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/highpass_filter_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/highpass_filter_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/highpass_filter_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/highpass_filter_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/highpass_filter_min.provn
.. raw:: html
**Full Example**
A concrete ``highpass_filter`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``highpass_filter`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/highpass_filter_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/highpass_filter_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/highpass_filter_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/highpass_filter_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/highpass_filter_max.provn
.. raw:: html
------
Divide
^^^^^^
Divide each value of the data by a certain factor. This is implied by many operations but sometimes useful to capture in its own right.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``divide``
``prov:label`` ``Divide``
Two letter ID code: ``dv``
============================ =======
Required Attributes
======= ============== ==============================
Name Type Description
======= ============== ==============================
divisor ``xsd:double`` The factor by which to divide.
======= ============== ==============================
Optional Attributes
*None*
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/divide.json
:language: json
.. raw:: html
**Example**
A concrete ``divide`` node example is illustrated here as a graph, in code, and in various representations.
.. raw:: html
.. graphviz:: _generated/dot/activities/divide_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/divide_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/divide_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/divide_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/divide_max.provn
.. raw:: html
------
Differentiate
^^^^^^^^^^^^^
Differentiate the data with respect to time.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``differentiate``
``prov:label`` ``Differentiate``
Two letter ID code: ``df``
============================ =======
Required Attributes
===== ======================= =====================================================
Name Type Description
===== ======================= =====================================================
order ``xsd:positiveInteger`` The order of the derivative, e.g. the nth derivative.
===== ======================= =====================================================
Optional Attributes
====================== ============== =================================================================================
Name Type Description
====================== ============== =================================================================================
differentiation_method ``xsd:string`` The differentiation method.
input_units ``xsd:string`` Units of the input data in a common abbreviation, e.g. `m`, `m/s`, `nm/s^2`, ...
output_units ``xsd:string`` Units of the output data in a common abbreviation, e.g. `m`, `m/s`, `nm/s^2`, ...
====================== ============== =================================================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/differentiate.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``differentiate`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``differentiate`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/differentiate_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/differentiate_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/differentiate_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/differentiate_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/differentiate_min.provn
.. raw:: html
**Full Example**
A concrete ``differentiate`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``differentiate`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/differentiate_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/differentiate_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/differentiate_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/differentiate_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/differentiate_max.provn
.. raw:: html
------
Detrend
^^^^^^^
Remove trend from the data.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``detrend``
``prov:label`` ``Detrend``
Two letter ID code: ``dt``
============================ =======
Required Attributes
================= ============== ==============================================================================================================================================================================================================
Name Type Description
================= ============== ==============================================================================================================================================================================================================
detrending_method ``xsd:string`` The method used to remove the trend from the data. ``detrend`` means substracting the best fitting linear line, ``demean`` removes the mean, and ``simple`` subtracts a line through the first and last point.
================= ============== ==============================================================================================================================================================================================================
Optional Attributes
*None*
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/detrend.json
:language: json
.. raw:: html
**Example**
A concrete ``detrend`` node example is illustrated here as a graph, in code, and in various representations.
.. raw:: html
.. graphviz:: _generated/dot/activities/detrend_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/detrend_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/detrend_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/detrend_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/detrend_max.provn
.. raw:: html
------
Decimate
^^^^^^^^
Downsample the waveform data by an integer factor. Any applied anti-alias filtering has to be described by a filtering activity.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``decimate``
``prov:label`` ``Decimate``
Two letter ID code: ``dc``
============================ =======
Required Attributes
====== ======================= =====================
Name Type Description
====== ======================= =====================
factor ``xsd:positiveInteger`` The decimation factor
====== ======================= =====================
Optional Attributes
*None*
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/decimate.json
:language: json
.. raw:: html
**Example**
A concrete ``decimate`` node example is illustrated here as a graph, in code, and in various representations.
.. raw:: html
.. graphviz:: _generated/dot/activities/decimate_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/decimate_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/decimate_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/decimate_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/decimate_max.provn
.. raw:: html
------
Cut
^^^
Cut the data resulting in a shorter trace.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``cut``
``prov:label`` ``Cut``
Two letter ID code: ``ct``
============================ =======
Required Attributes
*None*
Optional Attributes
============== ================ =====================================================
Name Type Description
============== ================ =====================================================
new_start_time ``xsd:dateTime`` The time of the first sample in UTC after cutting it.
new_end_time ``xsd:dateTime`` The time of the last sample in UTC after cutting it.
============== ================ =====================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/cut.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``cut`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``cut`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/cut_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/cut_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/cut_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/cut_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/cut_min.provn
.. raw:: html
**Full Example**
A concrete ``cut`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``cut`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/cut_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/cut_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/cut_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/cut_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/cut_max.provn
.. raw:: html
------
Cross Correlate
^^^^^^^^^^^^^^^
Cross correlate data of two stations. This does not contain information about the used data as that is captured by the incoming entities.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``cross_correlate``
``prov:label`` ``Cross Correlate``
Two letter ID code: ``co``
============================ =======
Required Attributes
================ ============== ====================================================
Name Type Description
================ ============== ====================================================
correlation_type ``xsd:string`` The type of performed cross correlation as a string.
================ ============== ====================================================
Optional Attributes
=================== ============== ====================================================
Name Type Description
=================== ============== ====================================================
max_lag_time_in_sec ``xsd:double`` The type of performed cross correlation as a string.
=================== ============== ====================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/cross_correlate.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``cross_correlate`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``cross_correlate`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/cross_correlate_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/cross_correlate_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/cross_correlate_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/cross_correlate_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/cross_correlate_min.provn
.. raw:: html
**Full Example**
A concrete ``cross_correlate`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``cross_correlate`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/cross_correlate_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/cross_correlate_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/cross_correlate_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/cross_correlate_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/cross_correlate_max.provn
.. raw:: html
------
Calculate Adjoint Source
^^^^^^^^^^^^^^^^^^^^^^^^
Calculate an adjoint source.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``calculate_adjoint_source``
``prov:label`` ``Calculate Adjoint Source``
Two letter ID code: ``ca``
============================ =======
Required Attributes
=================== ============== =============================================
Name Type Description
=================== ============== =============================================
adjoint_source_type ``xsd:string`` A string denoting the type of adjoint source.
=================== ============== =============================================
Optional Attributes
======================= ============== ========================================================================================================
Name Type Description
======================= ============== ========================================================================================================
adjoint_source_type_uri ``xsd:anyURI`` A URI pointing to a detailed description of the adjoint source, for example a DOI link to a publication.
======================= ============== ========================================================================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/calculate_adjoint_source.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``calculate_adjoint_source`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``calculate_adjoint_source`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/calculate_adjoint_source_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/calculate_adjoint_source_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/calculate_adjoint_source_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/calculate_adjoint_source_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/calculate_adjoint_source_min.provn
.. raw:: html
**Full Example**
A concrete ``calculate_adjoint_source`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``calculate_adjoint_source`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/calculate_adjoint_source_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/calculate_adjoint_source_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/calculate_adjoint_source_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/calculate_adjoint_source_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/calculate_adjoint_source_max.provn
.. raw:: html
------
Bandstop Filter
^^^^^^^^^^^^^^^
Bandstop the data.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``bandstop_filter``
``prov:label`` ``Bandstop Filter``
Two letter ID code: ``bs``
============================ =======
Required Attributes
=========== ============== ===================================================================================
Name Type Description
=========== ============== ===================================================================================
filter_type ``xsd:string`` The type of filter, e.g. `Butterworth`, `FIR`, `Chebyshev Type I/II`, `Bessel`, ...
=========== ============== ===================================================================================
Optional Attributes
============================ ======================= ============================================================
Name Type Description
============================ ======================= ============================================================
lower_corner_frequency ``xsd:double`` The lower corner frequency of the filter if applicable in Hz
uppoer_corner_frequency ``xsd:double`` The upper corner frequency of the filter if applicable in Hz
filter_order ``xsd:positiveInteger`` The order of the filter if applicable.
number_of_passes ``xsd:positiveInteger`` The number of filter passes if applicable.
chebychev_transition_bw ``xsd:double`` The transition band width in the case of a Chebychev filter.
chebychev_attenuation_factor ``xsd:double`` The attenuation factor in the case of a Chebychev filter.
============================ ======================= ============================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/bandstop_filter.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``bandstop_filter`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``bandstop_filter`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/bandstop_filter_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/bandstop_filter_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/bandstop_filter_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/bandstop_filter_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/bandstop_filter_min.provn
.. raw:: html
**Full Example**
A concrete ``bandstop_filter`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``bandstop_filter`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/bandstop_filter_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/bandstop_filter_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/bandstop_filter_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/bandstop_filter_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/bandstop_filter_max.provn
.. raw:: html
------
Bandpass Filter
^^^^^^^^^^^^^^^
A Bandpass filter. There is a huge variety of bandpass filters out there and this activity cannot capture them all in full detail.
.. raw:: html
Properties
============================ =======
Name Value
============================ =======
``prov:id`` ``bandpass_filter``
``prov:label`` ``Bandpass Filter``
Two letter ID code: ``bp``
============================ =======
Required Attributes
=========== ============== =======================================================================================================================================================================================================================================================================================================
Name Type Description
=========== ============== =======================================================================================================================================================================================================================================================================================================
filter_type ``xsd:string`` The type of filter, one of ``Butterworth``, ``FIR``, ``IIR``, ``Bessel``, ``Cosine SAC Taper``. Please give some more information with one or more of the other attributes. ``Cosine SAC Taper`` describes the frequency domain taper the SAC software package employs during instrument deconvolution.
=========== ============== =======================================================================================================================================================================================================================================================================================================
Optional Attributes
================================= ======================= ===========================================================================================
Name Type Description
================================= ======================= ===========================================================================================
lower_corner_frequency ``xsd:double`` The lower corner frequency of the filter if applicable in Hz.
upper_corner_frequency ``xsd:double`` The upper corner frequency of the filter if applicable in Hz.
filter_order ``xsd:positiveInteger`` The order of the filter if applicable.
number_of_passes ``xsd:positiveInteger`` The number of filter passes if applicable.
sac_cosine_taper_frequency_limits ``xsd:string`` The frequency limits of the SAC frequency domain cosine taper in Hz from lowest to highest.
================================= ======================= ===========================================================================================
.. raw:: html
This shows the JSON that is used to generate the rest of the definition.
.. literalinclude:: definitions/activities/bandpass_filter.json
:language: json
.. raw:: html
**Minimal Example**
A concrete ``bandpass_filter`` node example is illustrated here as a graph, in code, and in various representations. This is a minimal but valid ``bandpass_filter`` node. See below for a full example.
.. raw:: html
.. graphviz:: _generated/dot/activities/bandpass_filter_min.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/bandpass_filter_min.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/bandpass_filter_min.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/bandpass_filter_min.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/bandpass_filter_min.provn
.. raw:: html
**Full Example**
A concrete ``bandpass_filter`` node example is illustrated here as a graph, in code, and in various representations. This is a full ``bandpass_filter`` node containing the maximum amount of information.
.. raw:: html
.. graphviz:: _generated/dot/activities/bandpass_filter_max.dot
.. raw:: html
Python code utilizing the `prov `_ package.
.. literalinclude:: _generated/py/activities/bandpass_filter_max.py
:language: python
.. raw:: html
In the `PROV-XML `_ serialization.
.. literalinclude:: _generated/xml/activities/bandpass_filter_max.xml
:language: xml
.. raw:: html
In the
`PROV-JSON `_
serialization.
.. literalinclude:: _generated/json/activities/bandpass_filter_max.json
:language: json
.. raw:: html
In `PROV-N `_ notation.
.. literalinclude:: _generated/provn/activities/bandpass_filter_max.provn
.. raw:: html