osdu-python-models 0.5.0__py3-none-any.whl

osdu_models/workproductcomponent/seismic_trace_data/v1_5_0.py

@@ -0,0 +1,515 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/seismic_trace_data/v1_5_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_spatial_location import v1_1_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Precision(BaseModel):
+    """
+    Sample data format in terms of sample value precision 8bit Integer, 16bit Floating Point etc.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WordFormat: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WordFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    SRN of a reference value for binary data types, such as INT, UINT, FLOAT, IBM_FLOAT, ASCII, EBCDIC.
+    """
+    WordWidth: int | None = None
+    """
+    Size of the word in bytes.
+    """
+
+
+class ProcessingParameter(BaseModel):
+    """
+    Processing Parameters to simply capture process history until full provenance model can be implemented.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ProcessingParameterTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ProcessingParameterType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Processing Parameter Type
+    """
+    ProcessingParameterValue: str | None = None
+    """
+    The quantity for the processing parameter. May include units, ordering, and other descriptions.
+    """
+
+
+class StackAngleRange(BaseModel):
+    """
+    A range container carrying minimum/maximum angle values.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Minimum: float | None = Field(None, title='Minimum Angle')
+    """
+    The minimum angle value.
+    """
+    Maximum: float | None = Field(None, title='Maximum Angle')
+    """
+    The maximum angle value.
+    """
+
+
+class StackAzimuthRange(BaseModel):
+    """
+    A range container carrying minimum/maximum angle values.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Minimum: float | None = Field(None, title='Minimum Angle')
+    """
+    The minimum angle value.
+    """
+    Maximum: float | None = Field(None, title='Maximum Angle')
+    """
+    The maximum angle value.
+    """
+
+
+class StackOffsetRange(BaseModel):
+    """
+    A range container carrying minimum/maximum angle values.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Minimum: float | None = Field(None, title='Minimum Length')
+    """
+    The minimum length value.
+    """
+    Maximum: float | None = Field(None, title='Maximum Length')
+    """
+    The maximum length value.
+    """
+
+
+class TimeLapse(BaseModel):
+    """
+    The contents positions the SeismicTraceData record in context of a time series. This is to be used for time lapse or 4D SeismicTraceData. This structure is optional and absent for SeismicTraceData not part of a time series.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    TimeSeriesID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-TimeSeries:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Time Series ID')
+    """
+    The relationship to a TimeSeries work-product-component.
+    """
+    TimeIndex: int | None = Field(None, title='Time Index')
+    """
+    The index into the TimeSeriesID's data.UTCDateTimeValues[] or data.GeologicTimeValues[] arrays.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for SeismicTraceData 1.5.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    LiveTraceOutline: v1_1_0.AbstractSpatialLocation | None = None
+    """
+    Polygon showing the coverage of live traces in the trace dataset
+    """
+    BinGridID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-SeismicBinGrid:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Reference to the WPC which describes the node positions of the processed bin centers.  These are indexed from the trace file using inline and crossline.
+    """
+    HorizontalCRSID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Coordinate reference system of positions in trace header, which matches what is described in BinGrid but is repeated here for convenience and in case bin grid is not defined.  In case of conflict with Bin Grid, this value applies to the coordinates as written into CMPX, CMPY headers. Nevertheless, Bin Grid should be used for mapping purposes.
+    """
+    SeismicLineGeometryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-SeismicLineGeometry:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Reference to Seismic Line Geometry for 2D seismic processing which describes the node positions of the processed bin centers.  These are indexed from the trace file using CMP (not trace number).
+    """
+    TraceRelationFileID: (
+        constr(pattern=r'^[\w\-\.]+:dataset\-\-[\w\-\.]+:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = None
+    """
+    The SRN of a file within the WPC that shows the relationship between trace index and CMP number if the trace data file CMP header is unreliable (for 2D).
+    """
+    PrincipalAcquisitionProjectID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-SeismicAcquisitionSurvey:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    For most datasets, the acquisition project that generated the underlying field data.  For merges, probably absent (see processing project for set of acquisition projects used in processing this dataset).
+    """
+    ProcessingProjectID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-SeismicProcessingProject:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The processing project from which this trace dataset was produced.  Absent for field data.
+    """
+    Preferred3DInterpretationSetID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-Seismic3DInterpretationSet:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    For a 3D volume (including linear subsets), the id of the Seismic3DInterpretationSet which can be considered the master for the area and of which this trace dataset is a privileged member.  It defines the set of trace datasets of a particular bin grid that form the best set for interpretation (not an acquisition survey).
+    """
+    Preferred2DInterpretationSetID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-Seismic2DInterpretationSet:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    For a 2D line section, SRN of the Seismic2DInterpretationSet which can be considered the master for the area and of which this trace dataset is a privileged member.  It defines the set of trace datasets of a particular cohesive set of 2D processing geometries in a survey area that form the best set for interpretation (not an acquisition survey).
+    """
+    SeismicTraceDataDimensionalityTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicTraceDataDimensionalityType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The dimensionality of trace data sets (not as acquired but as in the dataset), such as 2D, 3D, 4D.
+    """
+    SeismicDomainTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicDomainType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of the nature of the vertical axis in the trace data set, usually Depth or Time.
+    """
+    Seismic2DName: str | None = None
+    """
+    2D line name or survey name for the 2D group
+    """
+    SeismicMigrationTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicMigrationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of the Seismic Migration Data Type
+    """
+    SeismicStackingTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicStackingType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of the Seismic Stacking Type
+    """
+    SeismicAttributeTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicAttributeType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of the Seismic Trace Data Type
+    """
+    SeismicFilteringTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicFilteringType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of the Seismic Filtering Type
+    """
+    Phase: str | None = None
+    """
+    DEPRECATED: Please use SeismicPhaseID for better interoperability. Amount of phase rotation applied to data
+    """
+    Polarity: str | None = None
+    """
+    DEPRECATED: Please use SeismicPolarityID for better interoperability.  Reflection polarity of embedded wavelet.  Normal, Reverse, Plus 90, Minus 90 according to SEG standard.
+    """
+    SeismicPhaseID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicPhase:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, examples=['namespace:reference-data--SeismicPhase:ZeroPhase:'])
+    """
+    Reference to the reference-data--SeismicPhase value describing the wavelet phase as estimated/processed for this SeismicTraceData instance.
+    """
+    SeismicPolarityID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicPolarity:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, examples=['namespace:reference-data--SeismicPolarity:PositiveSEG:'])
+    """
+    Reference to the reference-data--SeismicPolarity value describing the polarity for this SeismicTraceData instance.
+    """
+    SeismicProcessingStageTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicProcessingStageType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    It specifies if the seismic is as acquired, or has been manipulated by a process or workflow before arriving at its current state.
+    """
+    SampleInterval: float | None = None
+    """
+    Vertical sampling interval of data.
+    """
+    SampleCount: int | None = None
+    """
+    Number of samples in the vertical direction.
+    """
+    Difference: bool | None = None
+    """
+    Indicates if the volume is a product of the difference between 4D surveys
+    """
+    StartTime: float | None = None
+    """
+    The sample axis value in the vertical dimension at which Time formatted data starts. Use SeismicDomainType to know which of time or depth pairs is the actual range vs. what is estimated.
+    """
+    EndTime: float | None = None
+    """
+    The sample axis value in the vertical dimension at which Time formatted data starts. Use SeismicDomainType to know which of time or depth pairs is the actual range vs. what is estimated.
+    """
+    StartDepth: float | None = None
+    """
+    The sample axis value in the vertical dimension at which Depth formatted data starts. Use SeismicDomainType to know which of time or depth pairs is the actual range vs. what is estimated.
+    """
+    EndDepth: float | None = None
+    """
+    The sample axis value in the vertical dimension at which Depth formatted data ends. Use SeismicDomainType to know which of time or depth pairs is the actual range vs. what is estimated.
+    """
+    TraceCount: int | None = None
+    """
+    How many traces are in the volume
+    """
+    TraceLength: float | None = None
+    """
+    Maximum trace length calculated using depth or time start and end points as appropriate according to SeismicDomainType.
+    """
+    TraceDomainUOM: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    UOM for vertical trace domain values
+    """
+    FirstShotPoint: float | None = None
+    """
+    The shotpoint that came before all others
+    """
+    LastShotPoint: float | None = None
+    """
+    The last shotpoint represented by the data
+    """
+    FirstCMP: float | None = None
+    """
+    First Common Mid Point
+    """
+    LastCMP: float | None = None
+    """
+    Last Common Mid Point
+    """
+    InlineMin: float | None = None
+    """
+    Smallest Inline/Line/Track value
+    """
+    InlineMax: float | None = None
+    """
+    Largest Inline/Line/Track value
+    """
+    CrosslineMin: float | None = None
+    """
+    Smallest Xline/Cross line/Bin Value
+    """
+    CrosslineMax: float | None = None
+    """
+    Largest Xline/Cross line/Bin Value
+    """
+    InlineIncrement: float | None = None
+    """
+    Sampling interval of inlines in this dataset (difference in labels between neighboring inlines).
+    """
+    CrosslineIncrement: float | None = None
+    """
+    Sampling interval of crosslines in this dataset (difference in labels between neighboring crosslines).
+    """
+    VerticalDatumOffset: float | None = None
+    """
+    Datum value, the elevation of zero time/depth on the vertical axis in the domain of SeismicDomainType relative to the vertical reference datum used (usually MSL). Positive is upward from zero elevation to seismic datum).
+    """
+    VerticalMeasurementTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-VerticalMeasurementType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Identifies a vertical reference datum type. E.g. mean sea level, ground level, mudline.
+    """
+    ReplacementVelocity: float | None = None
+    """
+    Value used to produce vertical static shifts in data
+    """
+    ShiftApplied: float | None = None
+    """
+    Indicates how much the data has been shifted from the Vertical Datum (seismic reference datum) in the domain and units of SeismicDomainType and in the sense that a positive number causes a sample to move downward in physical space (lower elevation).
+    """
+    Precision_1: Precision | None = Field(None, alias='Precision', title='Precision')
+    """
+    Sample data format in terms of sample value precision 8bit Integer, 16bit Floating Point etc.
+    """
+    ProcessingParameters: list[ProcessingParameter] | None = None
+    """
+    Processing Parameters to simply capture process history until full provenance model can be implemented.
+    """
+    CoveragePercent: float | None = None
+    """
+    Actual nominal fold of the trace data set as processed, expressed as the mode in percentage points (60 fold = 6000%).
+    """
+    TextualFileHeader: list[str] | None = None
+    """
+    Character metadata from headers inside file, such as the EBCDIC header of SEGY.  This is an array to capture each stanza separately.
+    """
+    RangeAmplitudeMax: float | None = None
+    """
+    The actual maximum amplitude value found in the dataset.
+    """
+    RangeAmplitudeMin: float | None = None
+    """
+    The actual minimum amplitude value found in the dataset.
+    """
+    StackAngleRangeMax: float | None = None
+    """
+    Post-stack: The stacking angle range maximum used during processing of this trace data set.
+    """
+    StackAngleRangeMin: float | None = None
+    """
+    Post-stack: The stacking angle range minimum used during processing of this trace data set.
+    """
+    StackAzimuthRangeMax: float | None = None
+    """
+    Post-stack: The stacking azimuth range maximum used during processing of this trace data set.
+    """
+    StackAzimuthRangeMin: float | None = None
+    """
+    Post-stack: The stacking azimuth range minimum used during processing of this trace data set.
+    """
+    StackOffsetRangeMax: float | None = None
+    """
+    Post-stack: The stacking offset range maximum used during processing of this trace data set.
+    """
+    StackOffsetRangeMin: float | None = None
+    """
+    Post-stack: The stacking offset range minimum used during processing of this trace data set.
+    """
+    SeismicWaveTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicWaveType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Seismic Wave Type ID')
+    """
+    The observed wave mode type in this trace data set (P, Sv, etc).
+    """
+    StackAngleRanges: list[StackAngleRange] | None = Field(
+        None, title='Stack Angle Ranges'
+    )
+    """
+    Pre-stack: Sets of trace angle ranges contained within this data set.
+    """
+    StackAzimuthRanges: list[StackAzimuthRange] | None = Field(
+        None, title='Stack Azimuth Ranges'
+    )
+    """
+    Pre-stack: Sets of trace azimuth ranges contained within this data set.
+    """
+    StackOffsetRanges: list[StackOffsetRange] | None = Field(
+        None, title='Stack Offset Ranges'
+    )
+    """
+    Pre-stack: Sets of trace offset ranges contained within this data set.
+    """
+    SortOrderID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicTraceSortOrder:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Sort Order ID')
+    """
+    Defines the sorting order of the trace data as stored in the file(s).
+    """
+    GatherTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicGatherType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Gather Type ID')
+    """
+    Pre-stack: the type of gathers in this dataset.
+    """
+    TimeLapse_1: TimeLapse | None = Field(None, alias='TimeLapse', title='Time Lapse')
+    """
+    The contents positions the SeismicTraceData record in context of a time series. This is to be used for time lapse or 4D SeismicTraceData. This structure is optional and absent for SeismicTraceData not part of a time series.
+    """
+    ExtensionProperties: dict[str, Any] | None = None