API reference
This page provides an auto-generated summary of the segysak
package API.
For more details
and examples, refer to the relevant chapters in the main part of the
documentation.
SEG-Y Files
Inspecting SEG-Y data files
|
Scape all data from segy trace headers |
|
Scrape binary header |
|
Perform a scan of the segy file headers and return ranges. |
|
Return the ebcidc |
Loading & Converting SEG-Y data files
|
Load SEG-Y file into xarray.Dataset |
|
Freeform loader for SEG-Y data. |
|
Convert SEG-Y data to NetCDF4 File |
|
Return common bytes position kwargs_dict for segy_loader and segy_converter. |
Modifying and Creating Text Headers
|
|
|
Returns a simple default textual header dictionary. |
Writing SEG-Y files
|
Convert siesnc format (NetCDF4) to SEGY. |
|
Convert siesnc format (NetCDF4) to SEG-Y. |
|
Return common bytes position variable_dict for segy_writer. |
SEISNC Operations
Opening and Saving seisnc Files
|
Load from netcdf4 with seisnc specs. |
Functions which operate on seisnc objects
|
From an xarray seisnc quickly create iline and xline df. |
Creating empty seisnc volumes
|
Create a regular 3D seismic dataset from basic grid geometry with optional offset dimension for pre-stack data. |
|
Create a regular 2D seismic dataset from basic geometry. |
|
Create a blank seismic dataset by setting the dimension sizes (d#) or by passing arrays for known dimensions. |
Xarray Accessor modules
Accessor modules are accessed as namespaces within the Xarray.Dataset objects
created by SEGY-SAK. When segysak
is imported, all xarray.Dataset
objects will
contain the .seis
and .seisio
namespaces.
segysak xarray accessor modules
|
|
|
SeisIO
Access via xarray.Dataset.seisio
|
Output to netcdf4 with specs for seisnc. |
SeisGeom
Access via xarray.Dataset.seis
Returns True if the dataset is 2D peformant else False |
|
Returns True if the dataset is 2D peformant and has offset or angle else False |
|
Returns True if the dataset is 3D peformant else False |
|
Returns True if the dataset is 3D peformant and has offset or angle else False |
|
Check if seisnc volume is in twt |
|
Check if seisnc volume is in depth |
|
Check if empty |
|
Create a new dataset with the same attributes and coordinates and dimensions but with data filled by zeros. |
|
Return measurement_system if present, else None |
|
Fills NaN cdp locations by fitting known cdp x and y values to the local grid using a planar surface relationshipt. |
seisnc
data tools
Create a new dataset with the same attributes and coordinates and dimensions but with data filled by zeros. |
|
Calculate the corner points of the geometry or end points of a 2D line. |
seisnc
sampling operations
|
Select data at x and y coordinates |
|
Select data at x and y coordinates |
|
Sample a 2D point set with an attribute (like Z) to the seisnc geometry using interpolation. |
seisnc
plotting functions
|
Plot survey bbounding box to a new or existing axis |
Calculate the forward iline/xline -> cdp_x, cdp_y Affine transform for Matplotlib using corner point geometry. |
ZGY Files
Reading and Writing from ZGY
Experimental