This API reference is not for the latest stable Salvus version.

`salvus.project.tools.processing.processing_templates`

Contains a few function generates to create function that are suitable for processing data.

Functions

`get_bandpass_filter_processing_function()`

def get_bandpass_filter_processing_function(
    min_frequency_in_hertz: float,
    max_frequency_in_hertz: float,
    highpass_corners: int = 3,
    lowpass_corners: int = 3,
    zerophase: bool = False,
) -> Callable[
    [
        obspy.core.stream.Stream,
        salvus.flow.simple_config.receiver._BaseReceiver,
        List[salvus.flow.simple_config.source._BaseSource],
    ],
    obspy.core.stream.Stream,
]:
    ...

Generate a processing function for use in SalvusProject.

The generated function here applies a simple Butterworth highpass filter followed by a lowpass filter. The steps performed here are compatible with Salvus’ FilteredHeaviside source time function.

Parameters

min_frequency_in_hertz float — Minimum frequency in Hertz.
max_frequency_in_hertz float — Maximum frequency in Hertz.
highpass_corners int — Corners for the highpass filter.
lowpass_corners int — Corners for the lowpass filter.
zerophase bool — Zerophase filters on/off.

Returns Callable[[obspy.core.stream.Stream, salvus.flow.simple_config.receiver._BaseReceiver, List[salvus.flow.simple_config.source._BaseSource]], obspy.core.stream.Stream]