Mondaic Documentation
www.mondaic.com
Mondaic
Version:
No results found.
python_api
/
salvus
/
project
/
tools
/
processing
/
processing_templates

salvus.project.tools.processing.processing_templates

salvus.project.tools.processing.processing_templates 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()

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.
SIGNATURE
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,
) -> typing.Callable[
    [
        obspy.Stream,
        simple_config.receiver._BaseReceiver,
        list[simple_config.source._BaseSource],
    ],
    obspy.Stream,
]: ...
ARGUMENTS
Required
min_frequency_in_hertz
Type:float
Description:
Minimum frequency in Hertz.
Required
max_frequency_in_hertz
Type:float
Description:
Maximum frequency in Hertz.
Optional
highpass_corners
Type:int
Default value:3
Description:
Corners for the highpass filter.
Optional
lowpass_corners
Type:int
Default value:3
Description:
Corners for the lowpass filter.
Optional
zerophase
Type:bool
Default value:False
Description:
Zerophase filters on/off.
RETURNS
Return type: typing.Callable[[obspy.Stream, simple_config.receiver._BaseReceiver, list[simple_config.source._BaseSource]], obspy.Stream]
Previous
taper
Next
seismology
We use cookies to analyze our traffic, but won't track you until explicit consent is given. Using our contact form will create relevant cookies and transmit data to third party services to keep track of your request. Read more about how we use personal information in our Privacy Policy.
PAGE CONTENTS