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

osdu_models/workproductcomponent/seismic_field_trace_data/v1_0_0.py

@@ -0,0 +1,272 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/seismic_field_trace_data/v1_0_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_1_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
+    ) = Field(None, title='Processing Parameter Type ID')
+    """
+    Processing Parameter Type
+    """
+    ProcessingParameterValue: str | None = Field(
+        None, title='Processing Parameter Value'
+    )
+    """
+    The quantity for the processing parameter. May include units, ordering, and other descriptions.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for SeismicFieldTraceData 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    LiveTraceOutline: v1_1_0.AbstractSpatialLocation | None = Field(
+        None, title='Live Trace Outline'
+    )
+    """
+    Polygon showing the coverage of live traces in the trace dataset
+    """
+    HorizontalCRSID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Horizontal CRS ID')
+    """
+    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.
+    """
+    PrincipalAcquisitionProjectID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-SeismicAcquisitionSurvey:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Principal Acquisition Project ID')
+    """
+    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).
+    """
+    SeismicTraceDataDimensionalityTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicTraceDataDimensionalityType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Seismic Trace Data Dimensionality Type ID')
+    """
+    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
+    ) = Field(None, title='Seismic Domain Type ID')
+    """
+    ID of the nature of the vertical axis in the trace data set, usually Depth or Time.
+    """
+    Seismic2DName: str | None = Field(None, title='Seismic 2D Name')
+    """
+    2D line name or survey name for the 2D group
+    """
+    SeismicAttributeTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicAttributeType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Seismic Attribute Type ID')
+    """
+    ID of the Seismic Trace Data Type
+    """
+    SeismicFilteringTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicFilteringType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Seismic Filtering Type ID')
+    """
+    ID of the Seismic Filtering Type
+    """
+    SeismicPhaseID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicPhase:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Seismic Phase ID')
+    """
+    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, title='Seismic Polarity ID')
+    """
+    Reflection polarity of embedded wavelet.  Normal, Reverse, Plus 90, Minus 90 according to SEG standard.
+    """
+    SampleInterval: float | None = Field(None, title='Sample Interval')
+    """
+    Vertical sampling interval of data.
+    """
+    SampleCount: int | None = Field(None, title='Sample Count')
+    """
+    Number of samples in the vertical direction.
+    """
+    Difference: bool | None = Field(None, title='Difference')
+    """
+    Indicates if the volume is a product of the difference between 4D surveys
+    """
+    StartTime: float | None = Field(None, title='Start Time')
+    """
+    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 = Field(None, title='End Time')
+    """
+    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 = Field(None, title='Start Depth')
+    """
+    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 = Field(None, title='End Depth')
+    """
+    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 = Field(None, title='Trace Count')
+    """
+    How many traces are in the volume
+    """
+    TraceLength: float | None = Field(None, title='Trace Length')
+    """
+    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
+    ) = Field(None, title='Trace Domain UOM')
+    """
+    UOM for vertical trace domain values
+    """
+    FirstShotPoint: float | None = Field(None, title='First Shot Point')
+    """
+    The shotpoint that came before all others
+    """
+    LastShotPoint: float | None = Field(None, title='Last Shot Point')
+    """
+    The last shotpoint represented by the data
+    """
+    VerticalDatumOffset: float | None = Field(None, title='Vertical Datum Offset')
+    """
+    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
+    ) = Field(None, title='Vertical Measurement Type ID')
+    """
+    Identifies a vertical reference datum type. E.g. mean sea level, ground level, mudline.
+    """
+    ShiftApplied: float | None = Field(None, title='Shift Applied')
+    """
+    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 = Field(
+        None, title='Processing Parameters'
+    )
+    """
+    Processing Parameters to simply capture process history until full provenance model can be implemented.
+    """
+    TextualFileHeader: list[str] | None = Field(None, title='Textual File Header')
+    """
+    Character metadata from headers inside file, such as the EBCDIC header of SEGD.  This is an array to capture each stanza separately.
+    """
+    RangeAmplitudeMax: float | None = Field(None, title='Range Amplitude Maximum')
+    """
+    The actual maximum amplitude value found in the dataset.
+    """
+    RangeAmplitudeMin: float | None = Field(None, title='Range Amplitude Minimum')
+    """
+    The actual minimum amplitude value found in the dataset.
+    """
+    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).
+    """
+    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')
+    """
+    The type of gathers in this dataset.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/seismic_field_trace_data/v1_1_0.py

@@ -0,0 +1,272 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/seismic_field_trace_data/v1_1_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
+    ) = Field(None, title='Processing Parameter Type ID')
+    """
+    Processing Parameter Type
+    """
+    ProcessingParameterValue: str | None = Field(
+        None, title='Processing Parameter Value'
+    )
+    """
+    The quantity for the processing parameter. May include units, ordering, and other descriptions.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for SeismicFieldTraceData 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    LiveTraceOutline: v1_1_0.AbstractSpatialLocation | None = Field(
+        None, title='Live Trace Outline'
+    )
+    """
+    Polygon showing the coverage of live traces in the trace dataset
+    """
+    HorizontalCRSID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Horizontal CRS ID')
+    """
+    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.
+    """
+    PrincipalAcquisitionProjectID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-SeismicAcquisitionSurvey:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Principal Acquisition Project ID')
+    """
+    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).
+    """
+    SeismicTraceDataDimensionalityTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicTraceDataDimensionalityType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Seismic Trace Data Dimensionality Type ID')
+    """
+    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
+    ) = Field(None, title='Seismic Domain Type ID')
+    """
+    ID of the nature of the vertical axis in the trace data set, usually Depth or Time.
+    """
+    Seismic2DName: str | None = Field(None, title='Seismic 2D Name')
+    """
+    2D line name or survey name for the 2D group
+    """
+    SeismicAttributeTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicAttributeType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Seismic Attribute Type ID')
+    """
+    ID of the Seismic Trace Data Type
+    """
+    SeismicFilteringTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicFilteringType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Seismic Filtering Type ID')
+    """
+    ID of the Seismic Filtering Type
+    """
+    SeismicPhaseID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicPhase:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Seismic Phase ID')
+    """
+    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, title='Seismic Polarity ID')
+    """
+    Reflection polarity of embedded wavelet.  Normal, Reverse, Plus 90, Minus 90 according to SEG standard.
+    """
+    SampleInterval: float | None = Field(None, title='Sample Interval')
+    """
+    Vertical sampling interval of data.
+    """
+    SampleCount: int | None = Field(None, title='Sample Count')
+    """
+    Number of samples in the vertical direction.
+    """
+    Difference: bool | None = Field(None, title='Difference')
+    """
+    Indicates if the volume is a product of the difference between 4D surveys
+    """
+    StartTime: float | None = Field(None, title='Start Time')
+    """
+    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 = Field(None, title='End Time')
+    """
+    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 = Field(None, title='Start Depth')
+    """
+    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 = Field(None, title='End Depth')
+    """
+    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 = Field(None, title='Trace Count')
+    """
+    How many traces are in the volume
+    """
+    TraceLength: float | None = Field(None, title='Trace Length')
+    """
+    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
+    ) = Field(None, title='Trace Domain UOM')
+    """
+    UOM for vertical trace domain values
+    """
+    FirstShotPoint: float | None = Field(None, title='First Shot Point')
+    """
+    The shotpoint that came before all others
+    """
+    LastShotPoint: float | None = Field(None, title='Last Shot Point')
+    """
+    The last shotpoint represented by the data
+    """
+    VerticalDatumOffset: float | None = Field(None, title='Vertical Datum Offset')
+    """
+    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
+    ) = Field(None, title='Vertical Measurement Type ID')
+    """
+    Identifies a vertical reference datum type. E.g. mean sea level, ground level, mudline.
+    """
+    ShiftApplied: float | None = Field(None, title='Shift Applied')
+    """
+    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 = Field(
+        None, title='Processing Parameters'
+    )
+    """
+    Processing Parameters to simply capture process history until full provenance model can be implemented.
+    """
+    TextualFileHeader: list[str] | None = Field(None, title='Textual File Header')
+    """
+    Character metadata from headers inside file, such as the EBCDIC header of SEGD.  This is an array to capture each stanza separately.
+    """
+    RangeAmplitudeMax: float | None = Field(None, title='Range Amplitude Maximum')
+    """
+    The actual maximum amplitude value found in the dataset.
+    """
+    RangeAmplitudeMin: float | None = Field(None, title='Range Amplitude Minimum')
+    """
+    The actual minimum amplitude value found in the dataset.
+    """
+    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).
+    """
+    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')
+    """
+    The type of gathers in this dataset.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/seismic_horizon/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4