sbpio 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
sbpio/__init__.py ADDED
@@ -0,0 +1,87 @@
1
+ """
2
+ sbpio — Sub-Bottom Profiler I/O and Processing Toolkit
3
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4
+
5
+ Read, process, and write sub-bottom profiler (SBP) seismic data
6
+ in SEG-Y format.
7
+
8
+ Quick start::
9
+
10
+ from sbpio import sbp
11
+
12
+ data = sbp("profile.segy")
13
+ data.show()
14
+
15
+ data.write_processed(
16
+ "output.segy",
17
+ correct_delay=True,
18
+ tvg={"method": 3, "kwargs": {"n": 0.2}},
19
+ recoverable_penetration=200,
20
+ out_projection="EPSG:32618",
21
+ )
22
+ """
23
+ import warnings
24
+ # This suppresses all warnings
25
+ warnings.filterwarnings("ignore")
26
+
27
+ from .core import nav, sbp
28
+ from .utils import (
29
+ apply_tvg,
30
+ clear_multiples,
31
+ clear_water,
32
+ decode_nav,
33
+ degrees_minutes_seconds_to_decimal_degrees,
34
+ enhance,
35
+ extract_seafloor,
36
+ find_line_polygon_intersection_indices,
37
+ get_delay_recording_time,
38
+ get_water_depth,
39
+ mfv_fltr,
40
+ non_duplicates,
41
+ plot_sec,
42
+ power_gain_1,
43
+ power_gain_2,
44
+ power_gain_3,
45
+ samples_after_delay,
46
+ scale_to_range,
47
+ tv_gamma,
48
+ utm_to_decimal_degrees,
49
+ water_depth_to_time,
50
+ )
51
+
52
+ __version__ = "0.1.0"
53
+ __author__ = "Ali Mohamed"
54
+ __license__ = "MIT"
55
+
56
+ __all__ = [
57
+ # Classes
58
+ "sbp",
59
+ "nav",
60
+ # Visualisation
61
+ "enhance",
62
+ "plot_sec",
63
+ # Navigation
64
+ "decode_nav",
65
+ "degrees_minutes_seconds_to_decimal_degrees",
66
+ "utm_to_decimal_degrees",
67
+ "find_line_polygon_intersection_indices",
68
+ # SEG-Y helpers
69
+ "samples_after_delay",
70
+ "get_delay_recording_time",
71
+ "get_water_depth",
72
+ "non_duplicates",
73
+ # Time / depth
74
+ "water_depth_to_time",
75
+ # Gain functions
76
+ "apply_tvg",
77
+ "tv_gamma",
78
+ "power_gain_1",
79
+ "power_gain_2",
80
+ "power_gain_3",
81
+ # Masking
82
+ "clear_water",
83
+ "clear_multiples",
84
+ # Filters
85
+ "mfv_fltr",
86
+ "scale_to_range",
87
+ ]