segpy.dataset module

class segpy.dataset.Dataset

Bases: object

binary_reel_header

The binary reel header.

data_sample_format

The data type of the samples in machine-readable form. One of the values from datatypes.DATA_SAMPLE_FORMAT.

data_sample_format_description

A descriptive human-readable description of the data sample format

dimensionality

The spatial dimensionality of the data: 3 for 3D seismic volumes, 2 for 2D seismic lines, 1 for a single trace_samples, otherwise 0.

extended_textual_header
num_traces()

The number of traces.

textual_reel_header

The textual real header as an immutable sequence of forty Unicode strings each 80 characters long.

trace_header(trace_index)

The trace header for a given trace index.

Parameters:trace_index – An integer in the range zero to num_traces() - 1
Returns:A TraceHeader corresponding to the requested trace_samples.
trace_indexes()

An iterator over zero-based trace_samples indexes.

Returns:An iterator which yields integers in the range zero to num_traces - 1
trace_samples(trace_index, start=None, stop=None)

The trace samples for a given trace index.

Parameters:
  • trace_index – An integer in the range zero to num_traces - 1
  • start – Optional zero-based start sample index. The default is to read from the first (i.e. zeroth) sample.
  • stop – Optional zero-based stop sample index. Following Python slice convention this is one beyond the end.
Returns:

A sequence of numeric trace_samples samples.

class segpy.dataset.DelegatingDataset(source_dataset)

Bases: segpy.dataset.Dataset

A Dataset which by default forwards to a source Dataset.

This base class is useful if you only want to override a few methods to perform transformations.

binary_reel_header
dimensionality
encoding
endian
extended_textual_header
num_traces()

The number of traces.

source
textual_reel_header
trace_header(trace_index)
trace_indexes()
trace_samples(trace_index, start=None, stop=None)