salvus.project.configuration.processing.seismology

class BasicBandpassProcessingConfiguration(
    salvus.project.configuration.processing.seismology.SeismologyProcessingConfiguration
):
    def __init__(
        self,
        name: str,
        data_source_name: str,
        bandpass_minimum_frequency: float,
        bandpass_maximum_frequency: float,
        bandpass_filter_corners: int = 0,
        highpass_filter_corners: int = 4,
        lowpass_filter_corners: int = 4,
        taper_percentage: float = 0.05,
        zerophase: bool = False,
    ): ...

Keeps track of the initial arguments passed to an objects and can later on serialize them to JSON document.

It will only consider whatever is passed in the init.

Basic processing that detrends, tapers, and filters.

def from_json(d: builtins.dict) -> Any: ...

def to_json(
    self,
    external_file_hash: str | None = None,
    timer: Timer | None = None,
    log_to_logger: bool = False,
    comm: int | None = None,
) -> dict: ...

class BasicBandpassRemoveResponseProcessingConfiguration(
    salvus.project.configuration.processing.seismology.SeismologyProcessingConfiguration
):
    def __init__(
        self,
        name: str,
        data_source_name: str,
        bandpass_minimum_frequency: float,
        bandpass_maximum_frequency: float,
        units: str,
        bandpass_filter_corners: int = 0,
        highpass_filter_corners: int = 0,
        lowpass_filter_corners: int = 0,
        pre_filter: tuple[float, float, float, float],
        water_level: int = 200,
        taper_percentage: float = 0.05,
        zerophase: bool = False,
    ): ...

Keeps track of the initial arguments passed to an objects and can later on serialize them to JSON document.

It will only consider whatever is passed in the init.

Basic processing which removes the response and applies a Butterworth bandpass filter.

def from_json(d: builtins.dict) -> Any: ...

def to_json(
    self,
    external_file_hash: str | None = None,
    timer: Timer | None = None,
    log_to_logger: bool = False,
    comm: int | None = None,
) -> dict: ...

class CustomSeismologyProcessingConfiguration(
    salvus.project.configuration.processing.seismology.SeismologyProcessingConfiguration
):
    def __init__(
        self,
        name: str,
        data_source_name: str,
        processing_function: str | typing.Callable,
    ): ...

Keeps track of the initial arguments passed to an objects and can later on serialize them to JSON document.

It will only consider whatever is passed in the init.

Custom processing function. Any function with a suitable signature is acceptable.

The function must take the following arguments:

• st: An obspy.Stream object with the data.
• receiver: The receiver object for the receiver.
• sources: All sources for the event.

In the case of seismological data it can also optionally take:

• inv: An obspy.Inventory object for the station in case it is stored in an ASDF file. Might be None.

The function must return the processed obspy.Stream object which must contain exactly the same number of traces.

def from_json(d: builtins.dict) -> Any: ...

def to_json(
    self,
    external_file_hash: str | None = None,
    timer: Timer | None = None,
    log_to_logger: bool = False,
    comm: int | None = None,
) -> dict: ...

class SeismologyProcessingConfiguration(
    salvus.project.configuration.processing.ProcessingConfiguration
):
    def __init__(
        self,
        name: str,
        data_source_name: str,
        processing_function: str | typing.Callable,
    ): ...

Keeps track of the initial arguments passed to an objects and can later on serialize them to JSON document.

It will only consider whatever is passed in the init.

Define processing within SalvusProject with a function. Any function with a suitable signature is acceptable.

For block processing, the function must take the following arguments:

• data_array: An xarray.DataArray object with the data.
• event: The corresponding event.

Or, if the processing should be applied per receiver:

• st: An obspy.Stream object with the data.
• receiver: The receiver object for the receiver.
• sources: All sources for the event.

In the case of seismological data it can also optionally take:

• inv: An obspy.Inventory object for the station in case it is stored in an ASDF file. Might be None.

The function must return the processed xarray.DataArray or obspy.Stream object which must contain exactly the same number of traces.

def from_json(d: builtins.dict) -> Any: ...

def to_json(
    self,
    external_file_hash: str | None = None,
    timer: Timer | None = None,
    log_to_logger: bool = False,
    comm: int | None = None,
) -> dict: ...