segyio 1.9.13__cp313-cp313-macosx_10_13_x86_64.whl

segyio/segysampleformat.py

@@ -0,0 +1,19 @@
+from . import Enum
+
+class SegySampleFormat(Enum):
+    IBM_FLOAT_4_BYTE = 1
+    SIGNED_INTEGER_4_BYTE = 2
+    SIGNED_SHORT_2_BYTE = 3
+    FIXED_POINT_WITH_GAIN_4_BYTE = 4
+    IEEE_FLOAT_4_BYTE = 5
+    IEEE_FLOAT_8_BYTE = 6
+    SIGNED_CHAR_3_BYTE = 7
+    SIGNED_CHAR_1_BYTE = 8
+    SIGNED_INTEGER_8_BYTE = 9
+    UNSIGNED_INTEGER_4_BYTE = 10
+    UNSIGNED_SHORT_2_BYTE = 11
+    UNSIGNED_INTEGER_8_BYTE = 12
+    UNSIGNED_INTEGER_3_BYTE = 15
+    UNSIGNED_CHAR_1_BYTE = 16
+    NOT_IN_USE_1 = 19
+    NOT_IN_USE_2 = 20

segyio/su/__init__.py

@@ -0,0 +1,2 @@
+from .words import *
+from .file import open

segyio/su/file.py

@@ -0,0 +1,118 @@
+from ..open import infer_geometry
+from ..segy import SegyFile
+from . import words
+
+import numpy
+
+class sufile(SegyFile):
+    def __init__(self, *args, **kwargs):
+        super(sufile, self).__init__(*args, **kwargs)
+
+    @property
+    def text(self):
+        raise NotImplementedError
+
+    @property
+    def bin(self):
+        raise NotImplementedError
+
+    @bin.setter
+    def bin(self, _):
+        raise NotImplementedError
+
+def open(filename, mode = 'r', iline = 189,
+                               xline = 193,
+                               strict = True,
+                               ignore_geometry = False,
+                               endian = 'big' ):
+    """Open a seismic unix file.
+
+    Behaves identically to open(), except it expects the seismic unix format,
+    not SEG-Y.
+
+    Parameters
+    ----------
+    filename : str
+        Path to file to open
+
+    mode : {'r', 'r+'}
+        File access mode, read-only ('r', default) or read-write ('r+')
+
+    iline : int or segyio.TraceField
+        Inline number field in the trace headers. Defaults to 189 as per the
+        SEG-Y rev1 specification
+
+    xline : int or segyio.TraceField
+        Crossline number field in the trace headers. Defaults to 193 as per the
+        SEG-Y rev1 specification
+
+    strict : bool, optional
+        Abort if a geometry cannot be inferred. Defaults to True.
+
+    ignore_geometry : bool, optional
+        Opt out on building geometry information, useful for e.g. shot
+        organised files. Defaults to False.
+
+    endian : {'big', 'msb', 'little', 'lsb'}
+        File endianness, big/msb (default) or little/lsb
+
+    Returns
+    -------
+    file : segyio.su.file
+        An open seismic unix file handle
+
+    Raises
+    ------
+    ValueError
+        If the mode string contains 'w', as it would truncate the file
+
+    See also
+    --------
+    segyio.open : SEG-Y open
+
+    Notes
+    -----
+    .. versionadded:: 1.8
+    """
+
+    if 'w' in mode:
+        problem = 'w in mode would truncate the file'
+        solution = 'use r+ to open in read-write'
+        raise ValueError(', '.join((problem, solution)))
+
+    endians = {
+        'little': 256, # (1 << 8)
+        'lsb': 256,
+        'big': 0,
+        'msb': 0,
+    }
+
+    if endian not in endians:
+        problem = 'unknown endianness, must be one of: '
+        candidates = ' '.join(endians.keys())
+        raise ValueError(problem + candidates)
+
+    from .. import _segyio
+    fd = _segyio.segyiofd(str(filename), mode, endians[endian])
+    fd.suopen()
+    metrics = fd.metrics()
+
+    f = sufile(
+        fd,
+        filename = str(filename),
+        mode = mode,
+        iline = iline,
+        xline = xline,
+    )
+
+    h0 = f.header[0]
+
+    dt = h0[words.dt] / 1000.0
+    t0 = h0[words.delrt]
+    samples = metrics['samplecount']
+    f._samples = (numpy.arange(samples) * dt) + t0
+
+    if ignore_geometry:
+        return f
+
+    return infer_geometry(f, metrics, iline, xline, strict)

segyio/su/words.py

@@ -0,0 +1,284 @@
+"""Seismic Unix aliases
+
+Seismic Unix style aliases for binary and trace header fields.
+
+Notes
+-----
+
+.. versionadded: 1.1
+
+Seismic Unix does not have names for all possible fields, as it came
+around during an early revision of SEG-Y, and names for these fields
+are created by segyio in their absence. If Seismic Unix starts
+providing names for these fields, they will be added to these alies,
+and in conflicts take presedence after some time. If there are no
+conflicts, segyio names are considered for deprecation on a
+case-by-case basis, but will most likely be supported along with the
+Seismic Unix name.
+"""
+
+from ..tracefield import TraceField as tf
+from ..binfield import BinField as bf
+
+# the wonky #: before every line is so that sphinx' autodoc picks it up, and includes the constants in the documentation
+
+#:
+tracl  = tf.TRACE_SEQUENCE_LINE
+#:
+tracr  = tf.TRACE_SEQUENCE_FILE
+#:
+fldr   = tf.FieldRecord
+#:
+tracf  = tf.TraceNumber
+#:
+ep     = tf.EnergySourcePoint
+#:
+cdp    = tf.CDP
+#:
+cdpt   = tf.CDP_TRACE
+#:
+trid   = tf.TraceIdentificationCode
+#:
+nvs    = tf.NSummedTraces
+#:
+nhs    = tf.NStackedTraces
+#:
+duse   = tf.DataUse
+#:
+offset = tf.offset
+#:
+gelev  = tf.ReceiverGroupElevation
+#:
+selev  = tf.SourceSurfaceElevation
+#:
+sdepth = tf.SourceDepth
+#:
+gdel   = tf.ReceiverDatumElevation
+#:
+sdel   = tf.SourceDatumElevation
+#:
+swdep  = tf.SourceWaterDepth
+#:
+gwdep  = tf.GroupWaterDepth
+#:
+scalel = tf.ElevationScalar
+#:
+scalco = tf.SourceGroupScalar
+#:
+sx     = tf.SourceX
+#:
+sy     = tf.SourceY
+#:
+gx     = tf.GroupX
+#:
+gy     = tf.GroupY
+#:
+counit = tf.CoordinateUnits
+#:
+wevel  = tf.WeatheringVelocity
+#:
+swevel = tf.SubWeatheringVelocity
+#:
+sut    = tf.SourceUpholeTime
+#:
+gut    = tf.GroupUpholeTime
+#:
+sstat  = tf.SourceStaticCorrection
+#:
+gstat  = tf.GroupStaticCorrection
+#:
+tstat  = tf.TotalStaticApplied
+#:
+laga   = tf.LagTimeA
+#:
+lagb   = tf.LagTimeB
+#:
+delrt  = tf.DelayRecordingTime
+#:
+muts   = tf.MuteTimeStart
+#:
+mute   = tf.MuteTimeEND
+#:
+ns     = tf.TRACE_SAMPLE_COUNT
+#:
+dt     = tf.TRACE_SAMPLE_INTERVAL
+#:
+gain   = tf.GainType
+#:
+igc    = tf.InstrumentGainConstant
+#:
+igi    = tf.InstrumentInitialGain
+#:
+corr   = tf.Correlated
+#:
+sfs    = tf.SweepFrequencyStart
+#:
+sfe    = tf.SweepFrequencyEnd
+#:
+slen   = tf.SweepLength
+#:
+styp   = tf.SweepType
+#:
+stat   = tf.SweepTraceTaperLengthStart
+#:
+stae   = tf.SweepTraceTaperLengthEnd
+#:
+tatyp  = tf.TaperType
+#:
+afilf  = tf.AliasFilterFrequency
+#:
+afils  = tf.AliasFilterSlope
+#:
+nofilf = tf.NotchFilterFrequency
+#:
+nofils = tf.NotchFilterSlope
+#:
+lcf    = tf.LowCutFrequency
+#:
+hcf    = tf.HighCutFrequency
+#:
+lcs    = tf.LowCutSlope
+#:
+hcs    = tf.HighCutSlope
+#:
+year   = tf.YearDataRecorded
+#:
+day    = tf.DayOfYear
+#:
+hour   = tf.HourOfDay
+#:
+minute = tf.MinuteOfHour
+#:
+sec    = tf.SecondOfMinute
+#:
+timbas = tf.TimeBaseCode
+#:
+trwf   = tf.TraceWeightingFactor
+#:
+grnors = tf.GeophoneGroupNumberRoll1
+#:
+grnofr = tf.GeophoneGroupNumberFirstTraceOrigField
+#:
+grnlof = tf.GeophoneGroupNumberLastTraceOrigField
+#:
+gaps   = tf.GapSize
+#:
+otrav  = tf.OverTravel
+#:
+cdpx   = tf.CDP_X
+#:
+cdpy   = tf.CDP_Y
+#:
+iline  = tf.INLINE_3D
+#:
+xline  = tf.CROSSLINE_3D
+#:
+sp     = tf.ShotPoint
+#:
+scalsp = tf.ShotPointScalar
+#:
+trunit = tf.TraceValueMeasurementUnit
+#:
+tdcm   = tf.TransductionConstantMantissa
+#:
+tdcp   = tf.TransductionConstantPower
+#:
+tdunit = tf.TransductionUnit
+#:
+triden = tf.TraceIdentifier
+#:
+sctrh  = tf.ScalarTraceHeader
+#:
+stype  = tf.SourceType
+#:
+sedm   = tf.SourceEnergyDirectionMantissa
+#:
+sede   = tf.SourceEnergyDirectionExponent
+#:
+smm    = tf.SourceMeasurementMantissa
+#:
+sme    = tf.SourceMeasurementExponent
+#:
+smunit = tf.SourceMeasurementUnit
+#:
+uint1  = tf.UnassignedInt1
+#:
+uint2  = tf.UnassignedInt2
+
+# binary
+#:
+jobid  = bf.JobID
+#:
+lino   = bf.LineNumber
+#:
+reno   = bf.ReelNumber
+#:
+ntrpr  = bf.Traces
+#:
+nart   = bf.AuxTraces
+#:
+hdt    = bf.Interval
+#:
+dto    = bf.IntervalOriginal
+#:
+hns    = bf.Samples
+#:
+nso    = bf.SamplesOriginal
+#:
+format = bf.Format
+#:
+fold   = bf.EnsembleFold
+#:
+tsort  = bf.SortingCode
+#:
+vscode = bf.VerticalSum
+#:
+hsfs   = bf.SweepFrequencyStart
+#:
+hsfe   = bf.SweepFrequencyEnd
+#:
+hslen  = bf.SweepLength
+#:
+hstyp  = bf.Sweep
+#:
+schn   = bf.SweepChannel
+#:
+hstas  = bf.SweepTaperStart
+#:
+hstae  = bf.SweepTaperEnd
+#:
+htatyp = bf.Taper
+#:
+hcorr  = bf.CorrelatedTraces
+#:
+bgrcv  = bf.BinaryGainRecovery
+#:
+rcvm   = bf.AmplitudeRecovery
+#:
+mfeet  = bf.MeasurementSystem
+#:
+polyt  = bf.ImpulseSignalPolarity
+#:
+vpol   = bf.VibratoryPolarity
+#:
+unas1  = bf.Unassigned1
+#:
+extntrpr  = bf.ExtTraces
+#:
+extnart   = bf.ExtAuxTraces
+#:
+exthns    = bf.ExtSamples
+#:
+extnso    = bf.ExtSamplesOriginal
+#:
+extfold   = bf.ExtEnsembleFold
+#:
+rev    = bf.SEGYRevision
+#:
+revmin = bf.SEGYRevisionMinor
+#:
+trflag = bf.TraceFlag
+#:
+exth   = bf.ExtendedHeaders
+#:
+unas2  = bf.Unassigned2