Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add quick start example with plot #371

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,31 @@ start your favourite Python interpreter and type `help(segyio)`, which should
integrate well with IDLE, pycharm and other Python tools.

### Quick start ###

Two examples on how to use segyio:

Integrate with numpy to filter for a given treshold value
```python
import segyio
import numpy as np
threshold = 1e-2
with segyio.open('file.sgy') as f:
for trace in f.trace:
filtered = trace[np.where(trace < 1e-2)]
filtered = trace[np.where(trace < threshold)]
```

Visualize the first inline slice in a seismic volume:

```python
import segyio
import matplotlib.pyplot as plt

filename = 'file.sgy'
with segyio.open(filename) as f:
inline_number = f.ilines[0]
inline_slice = f.iline[inline_number]
plt.imshow(inline_slice.T)
plt.show()
```

See the [examples](#examples) for more.
Expand Down