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

osdu_models/dataset/file_collection_segy/v1_2_0.py

@@ -0,0 +1,464 @@
+# generated by datamodel-codegen:
+#   filename:  dataset/file_collection_segy/v1_2_0.json
+
+from __future__ import annotations
+from enum import Enum
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_file_source_info import v1_0_0
+from typing import Any
+from ...abstract.abstract_seismic_precision import v1_0_0 as v1_0_0_1
+
+
+class Endian(Enum):
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+
+    BIG = 'BIG'
+    LITTLE = 'LITTLE'
+
+
+class DatasetProperties(BaseModel):
+    """
+    The dataset properties for a file collection.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FileCollectionPath: str = Field(
+        ...,
+        examples=['s3://default_bucket/opendes/data/vds-dataset/'],
+        title='File Collection Path',
+    )
+    """
+    The mandatory path to the file collection. A FileCollectionPath should represent folder level access to a set of files.
+    """
+    IndexFilePath: str | None = Field(
+        None,
+        examples=['s3://default_bucket/opendes/data/vds-dataset/vds-dataset.index'],
+        title='Index File Path',
+    )
+    """
+    An optional path to an index file.
+    """
+    FileSourceInfos: list[v1_0_0.AbstractFileSourceInfo] | None = Field(
+        None,
+        examples=[
+            [
+                {
+                    'FileSource': 's3://default_bucket/opendes/data/vds-dataset/vds-file-1',
+                    'PreloadFilePath': 's3://staging-area/r7/raw-data/provided/documents/vds-file-1',
+                    'Name': 'vds-file-1',
+                    'PreloadFileCreateUser': 'somebody@acme.org',
+                    'PreloadFileCreateDate': '2019-12-16T11:46:20.163Z',
+                    'PreloadFileModifyUser': 'somebody.else@acme.org',
+                    'PreloadFileModifyDate': '2019-12-20T17:20:05.356Z',
+                    'FileSize': '439452464',
+                    'Checksum': 'd41d8cd98f00b204e9800998ecf8427e',
+                    'ChecksumAlgorithm': 'MD5',
+                },
+                {
+                    'FileSource': 's3://default_bucket/opendes/data/vds-dataset/vds-file-2',
+                    'PreloadFilePath': 's3://staging-area/r7/raw-data/provided/documents/vds-file-2',
+                    'Name': 'vds-file-2',
+                    'PreloadFileCreateUser': 'somebody@acme.org',
+                    'PreloadFileCreateDate': '2019-12-16T11:50:40.321Z',
+                    'PreloadFileModifyUser': 'somebody.else@acme.org',
+                    'PreloadFileModifyDate': '2019-12-20T17:59:03.456Z',
+                    'FileSize': '433645463',
+                    'Checksum': '204e9800998ecf8427ed41d8cd98f00b',
+                    'ChecksumAlgorithm': 'MD5',
+                },
+            ]
+        ],
+        title='File Source Info Array',
+    )
+    """
+    Array of file collection members as FileSourceInfo.
+    """
+    Checksum: constr(pattern=r'^[0-9a-fA-F]{32}') | None = Field(
+        None, examples=['d41d8cd98f00b204e9800998ecf8427e'], title='MD5 Checksum'
+    )
+    """
+    MD5 checksum of file bytes - a 32 byte hexadecimal number.
+    """
+
+
+class ScalarIndicator(Enum):
+    """
+    Enumerated string indicating whether to use the normal scalar field for scaling this field (STANDARD), no scaling (NOSCALE), or override scalar (OVERRIDE).  Default is current STANDARD (such as SEG-Y rev2).
+    """
+
+    STANDARD = 'STANDARD'
+    NOSCALE = 'NOSCALE'
+    OVERRIDE = 'OVERRIDE'
+
+
+class VectorHeaderMappingItem(BaseModel):
+    """
+    Array of objects which define the meaning and format of a tabular structure used in a binary file as a header.  The initial use case is the trace headers of a SEG-Y file.  Note that some of this information may be repeated in the SEG-Y EBCDIC header.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    KeyName: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Key Name')
+    """
+    Relationship to a reference value for a name of a property header such as INLINE, CDPX.
+    """
+    WordFormat: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WordFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Word Format')
+    """
+    Relationship to a reference value for binary data types, such as INT, UINT, FLOAT, IBM_FLOAT, ASCII, EBCDIC.
+    """
+    WordWidth: int | None = Field(None, title='Word Width')
+    """
+    Size of the word in bytes.
+    """
+    Position: int | None = None
+    """
+    Beginning byte position of header value, 1 indexed.
+    """
+    UoM: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Unit of Measure')
+    """
+    Relationship to units of measure reference if header standard is not followed.
+    """
+    ScalarIndicator_1: ScalarIndicator | None = Field(
+        None, alias='ScalarIndicator', title='Scalar Indicator'
+    )
+    """
+    Enumerated string indicating whether to use the normal scalar field for scaling this field (STANDARD), no scaling (NOSCALE), or override scalar (OVERRIDE).  Default is current STANDARD (such as SEG-Y rev2).
+    """
+    ScalarOverride: float | None = Field(None, title='Scalar Override')
+    """
+    Scalar value (as defined by standard) when a value present in the header needs to be overwritten for this value.
+    """
+
+
+class Operator1(Enum):
+    """
+    The operator 1, an enumeration with permitted values of Plus, Minus, DivideBy, DivideByInteger, MultiplyBy,  Modulo, Equals.
+    """
+
+    Plus = 'Plus'
+    Minus = 'Minus'
+    DivideBy = 'DivideBy'
+    DivideByInteger = 'DivideByInteger'
+    MultiplyBy = 'MultiplyBy'
+    Modulo = 'Modulo'
+    Equals = 'Equals'
+
+
+class Operator2(Enum):
+    """
+    The operator 2, an enumeration with permitted values of Plus, Minus, DivideBy, DivideByInteger, MultiplyBy,  Modulo, Equals.
+    """
+
+    Plus = 'Plus'
+    Minus = 'Minus'
+    DivideBy = 'DivideBy'
+    DivideByInteger = 'DivideByInteger'
+    MultiplyBy = 'MultiplyBy'
+    Modulo = 'Modulo'
+    Equals = 'Equals'
+
+
+class OverrideByExpression(BaseModel):
+    """
+    An expression, potentially in a sequence, allowing the computation of a value or intermediate value.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Input: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Input')
+    """
+    The input variable given by the HeaderKeyName.
+    """
+    Operator1_1: Operator1 | None = Field(None, alias='Operator1', title='Operator 1')
+    """
+    The operator 1, an enumeration with permitted values of Plus, Minus, DivideBy, DivideByInteger, MultiplyBy,  Modulo, Equals.
+    """
+    Operand1Constant: float | None = Field(None, title='Operand 1 Constant')
+    """
+    The constant operand 1 value.  If populated, Operand1Variable must be absent.
+    """
+    Operand1Variable: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Operand 1 Variable')
+    """
+    The operand 1 variable given by the HeaderKeyName, where to obtain the value. If populated, Operand1Constant must be absent.
+    """
+    Operator2_1: Operator2 | None = Field(None, alias='Operator2', title='Operator 2')
+    """
+    The operator 2, an enumeration with permitted values of Plus, Minus, DivideBy, DivideByInteger, MultiplyBy,  Modulo, Equals.
+    """
+    Operand2Constant: float | None = Field(None, title='Operand 2 Constant')
+    """
+    The constant operand 2 value. If populated, Operand2Variable must be absent.
+    """
+    Operand2Variable: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Operand 2 Variable')
+    """
+    The operand 2 variable given by the HeaderKeyName, where to obtain the value. If populated, Operand2Constant must be absent.
+    """
+    Remark: str | None = Field(None, title='Remark')
+    """
+    An optional remark explaining the intention or purpose of this expression.
+    """
+
+
+class TraceHeaderOverride(BaseModel):
+    """
+    An object defining an override condition  for a vector header value, e.g. SEG-Y trace header value.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    KeyName: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Key Name')
+    """
+    Relationship to a reference value for a name of a property header such as INLINE, CDPX.
+    """
+    OverrideByConstant: float | None = Field(None, title='Override by Constant')
+    """
+    The constant value to be assigned to the position. If populated, the OverrideByExpressions must be empty.
+    """
+    OverrideByExpressions: list[OverrideByExpression] | None = Field(
+        None, title='Override by Expressions'
+    )
+    """
+    The value to be overridden is computed by evaluating the sequence of expressions. If populated, the OverrideByConstant must be empty.
+    """
+
+
+class BinaryHeaderOverride(BaseModel):
+    """
+    An object defining an override condition  for a vector header value, e.g. SEG-Y binary header value.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    KeyName: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Key Name')
+    """
+    Relationship to a reference value for a name of a property header such as LineNumber.
+    """
+    OverrideByConstant: int | None = Field(None, title='Override by Constant')
+    """
+    The constant value to be assigned to the position.
+    """
+
+
+class Data(BaseModel):
+    """
+    Array of objects which define the meaning and format of a tabular structure used in a binary file as a header.  The initial use case is the trace headers of a SEG-Y file.  Note that some of this information may be repeated in the SEG-Y EBCDIC header.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ResourceHomeRegionID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-OSDURegion:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Resource Home Region ID')
+    """
+    The name of the home [cloud environment] region for this OSDU resource object.
+    """
+    ResourceHostRegionIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-OSDURegion:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Resource Host Region ID')
+    """
+    The name of the host [cloud environment] region(s) for this OSDU resource object.
+    """
+    ResourceCurationStatus: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceCurationStatus:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Curation Status')
+    """
+    Describes the current Curation status.
+    """
+    ResourceLifecycleStatus: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceLifecycleStatus:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Lifecycle Status')
+    """
+    Describes the current Resource Lifecycle status.
+    """
+    ResourceSecurityClassification: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceSecurityClassification:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Security Classification')
+    """
+    Classifies the security level of the resource.
+    """
+    Source: str | None = Field(None, title='Data Source')
+    """
+    The entity that produced the record, or from which it is received; could be an organization, agency, system, internal team, or individual. For informational purposes only, the list of sources is not governed.
+    """
+    ExistenceKind: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ExistenceKind:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Existence Kind')
+    """
+    Where does this data resource sit in the cradle-to-grave span of its existence?
+    """
+    TechnicalAssuranceID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TechnicalAssuranceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Technical Assurance ID')
+    """
+    DEPRECATED: Describes a record's overall suitability for general business consumption based on data quality. Clarifications: Since Certified is the highest classification of suitable quality, any further change or versioning of a Certified record should be carefully considered and justified. If a Technical Assurance value is not populated then one can assume the data has not been evaluated or its quality is unknown (=Unevaluated). Technical Assurance values are not intended to be used for the identification of a single "preferred" or "definitive" record by comparison with other records.
+    """
+    Name: str | None = Field(None, examples=['Dataset X221/15'], title='Name')
+    """
+    An optional name of the dataset, e.g. a user friendly file or file collection name.
+    """
+    Description: str | None = Field(
+        None, examples=['As originally delivered by ACME.com.'], title='Description'
+    )
+    """
+    An optional, textual description of the dataset.
+    """
+    TotalSize: constr(pattern=r'^[0-9]+$') | None = Field(
+        None, examples=[13245217273], title='Total Size'
+    )
+    """
+    Total size of the dataset in bytes; for files it is the same as declared in FileSourceInfo.FileSize or the sum of all individual files. Implemented as string. The value must be convertible to a long integer (sizes can become very large).
+    """
+    EncodingFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-EncodingFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--EncodingFormatType:text%2Fcsv:'],
+        title='Encoding Format Type ID',
+    )
+    """
+    EncodingFormatType ID reference value relationship. It can be a mime-type or media-type.
+    """
+    SchemaFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SchemaFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--SchemaFormatType:CWLS%20LAS3:'],
+        title='Schema Format Type ID',
+    )
+    """
+    Relationship to the SchemaFormatType reference value.
+    """
+    Endian_1: Endian | None = Field(None, alias='Endian')
+    """
+    Endianness of binary value.  Enumeration: "BIG", "LITTLE".  If absent, applications will need to interpret from context indicators.
+    """
+    DatasetProperties_1: DatasetProperties = Field(
+        ..., alias='DatasetProperties', examples=[{}], title='Dataset Properties'
+    )
+    """
+    The dataset properties for a file collection.
+    """
+    VectorHeaderMapping: list[VectorHeaderMappingItem] | None = Field(
+        None, title='Vector Header Mapping'
+    )
+    """
+    Array of objects which define the meaning and format of a tabular structure used in a binary file as a header.  The initial use case is the trace headers of a SEG-Y file.  Note that some of this information may be repeated in the SEG-Y EBCDIC header.
+    """
+    TraceHeaderOverrides: list[TraceHeaderOverride] | None = Field(
+        None, title='Trace Header Overrides'
+    )
+    """
+    Trace header override definitions.
+    """
+    BinaryHeaderOverrides: list[BinaryHeaderOverride] | None = Field(
+        None, title='Binary Header Overrides'
+    )
+    """
+    Binary header override definitions.
+    """
+    SEGYRevision: str | None = Field(None, examples=['rev 0'], title='SEG-Y Revision')
+    """
+    The SEG-Y standard revision the SEG-Y file set is conforming to.
+    """
+    Precision: v1_0_0_1.AbstractSeismicPrecision | None = Field(None, title='Precision')
+    """
+    The numeric precision of the dataset.
+    """
+    Is3D: bool | None = Field(None, title='Is 3D')
+    """
+    If TRUE, this means the dataset is a 3D dataset and the trace header values HeaderKeyName:Inline and HeaderKeyName:Crossline are expected to be populated. If FALSE the dataset is interpreted as 2D and HeaderKeyName:SP and HeaderKeyName:CMP are expected to be populated.
+    """
+    StorageFacilityID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-StorageFacility:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Storage Facility ID')
+    """
+    Name of storage facility of the physical asset.
+    """
+    TapeLabels: list[str] | None = Field(None, title='Tape Labels')
+    """
+    Tape numbers, or other tape identifiers.
+    """
+    BoxLabels: list[str] | None = Field(None, title='Box Labels')
+    """
+    Box numbers containing tapes if the tapes are in containers, else the list is empty or absent.
+    """
+    ExtensionProperties: dict[str, Any] | None = None