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

osdu_models/workproductcomponent/rock_image/v1_0_0.py

@@ -0,0 +1,130 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/rock_image/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_0_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for RockImage 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RockSampleIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-RockSample:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='RockSampleID')
+    """
+    The rock sample that this image relates to. One or many RockSample are permitted. Preferred relationship
+    """
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='WellboreID')
+    """
+    The associated wellbore. Optional relationship if RockSampleID is populated and WellboreID is populated
+    """
+    CoringID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Coring:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='CoringID')
+    """
+    The associated coring activity. Optional relationship if RockSampleID is populated and CoringID is populated
+    """
+    RockImageTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RockImageType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Rock Image Type ID')
+    """
+    The type of rock image. Examples include Photograph, Computed Tomography (CT), Thin Section, etc
+    """
+    TopDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Top Depth Measured Depth'
+    )
+    """
+    The measured top depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same
+    """
+    BaseDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Base Depth Measured Depth'
+    )
+    """
+    The measured base depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same
+    """
+    DepthShiftID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Depth Shift ID')
+    """
+    The WellLog representation carrying the preferred sample-depth to logging-depth correction or mapping
+    """
+    AcquisitionDate: str | None = Field(
+        None, examples=['2022-09-09'], title='Acquisition Date'
+    )
+    """
+    The date the image was originally taken or acquired
+    """
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Service CompanyID')
+    """
+    The organisation or contractor that originally took or acquired the image
+    """
+    ReferenceIdentifier: str | None = Field(
+        None, examples=['X12A'], title='Image Reference Identifier'
+    )
+    """
+    Unique or Distinctive Image Reference Number, Job Number, File Number, Identifier, Label, Name, etc. Typically given by the original image acquisition supplier and as indicated in the report or file. Use this attribute to allow correlation back to the original source document, file, etc.
+    """
+    Remark: str | None = Field(
+        None, examples=['Natural light. Taken in the field.'], title='Remark'
+    )
+    """
+    Remarks regarding the image acquisition and or processing environment or parameters
+    """
+    FormatInterval: float | None = Field(None, examples=[4], title='Format Interval')
+    """
+    The interval included in the image. Typically used for conventional core. For example 1m or 4m
+    """
+    TextualHeader: list[str] | None = Field(
+        None,
+        examples=[
+            [
+                'File Size: 322 kB\nFile Type: JPEG\nMIME Type: image/jpeg\nImage Width: 1231\nImage Height: 927\nEncoding Process: Baseline DCT, Huffman coding\nBits Per Sample: 8\nColor Components: 3\nX Resolution: 1\nY Resolution: 1\nSoftware: Google\nYCbCr Sub Sampling: YCbCr4:2:0 (2 2)'
+            ]
+        ],
+        title='Textual Header',
+    )
+    """
+    A free text array to capture the image file header or image parameters for knowledge capture, index and search purposes. Header values can be extracted from, e.g., Exchangeable Image File Format (EXIF) properties, Digital Imaging and Communications in Medicine (DICOM) header properties (such as x-ray intensity) and etc.
+    """
+    LightingConditionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ImageLightingCondition:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Lighting Condition ID')
+    """
+    The type of lighting conditions captured in the image. Examples include Ultraviolet, White, Natural, etc
+    """
+    Magnification: float | None = Field(None, examples=[5], title='Magnification')
+    """
+    Magnification of the image
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/rock_image/v1_1_0.py

@@ -0,0 +1,130 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/rock_image/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+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 Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for RockImage 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RockSampleIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-RockSample:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='RockSampleID')
+    """
+    The rock sample that this image relates to. One or many RockSample are permitted. Preferred relationship
+    """
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='WellboreID')
+    """
+    The associated wellbore. Optional relationship if RockSampleID is populated and WellboreID is populated
+    """
+    CoringID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Coring:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='CoringID')
+    """
+    The associated coring activity. Optional relationship if RockSampleID is populated and CoringID is populated
+    """
+    RockImageTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RockImageType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Rock Image Type ID')
+    """
+    The type of rock image. Examples include Photograph, Computed Tomography (CT), Thin Section, etc
+    """
+    TopDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Top Depth Measured Depth'
+    )
+    """
+    The measured top depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same
+    """
+    BaseDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Base Depth Measured Depth'
+    )
+    """
+    The measured base depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same
+    """
+    DepthShiftID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Depth Shift ID')
+    """
+    The WellLog representation carrying the preferred sample-depth to logging-depth correction or mapping
+    """
+    AcquisitionDate: str | None = Field(
+        None, examples=['2022-09-09'], title='Acquisition Date'
+    )
+    """
+    The date the image was originally taken or acquired
+    """
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Service CompanyID')
+    """
+    The organisation or contractor that originally took or acquired the image
+    """
+    ReferenceIdentifier: str | None = Field(
+        None, examples=['X12A'], title='Image Reference Identifier'
+    )
+    """
+    Unique or Distinctive Image Reference Number, Job Number, File Number, Identifier, Label, Name, etc. Typically given by the original image acquisition supplier and as indicated in the report or file. Use this attribute to allow correlation back to the original source document, file, etc.
+    """
+    Remark: str | None = Field(
+        None, examples=['Natural light. Taken in the field.'], title='Remark'
+    )
+    """
+    Remarks regarding the image acquisition and or processing environment or parameters
+    """
+    FormatInterval: float | None = Field(None, examples=[4], title='Format Interval')
+    """
+    The interval included in the image. Typically used for conventional core. For example 1m or 4m
+    """
+    TextualHeader: list[str] | None = Field(
+        None,
+        examples=[
+            [
+                'File Size: 322 kB\nFile Type: JPEG\nMIME Type: image/jpeg\nImage Width: 1231\nImage Height: 927\nEncoding Process: Baseline DCT, Huffman coding\nBits Per Sample: 8\nColor Components: 3\nX Resolution: 1\nY Resolution: 1\nSoftware: Google\nYCbCr Sub Sampling: YCbCr4:2:0 (2 2)'
+            ]
+        ],
+        title='Textual Header',
+    )
+    """
+    A free text array to capture the image file header or image parameters for knowledge capture, index and search purposes. Header values can be extracted from, e.g., Exchangeable Image File Format (EXIF) properties, Digital Imaging and Communications in Medicine (DICOM) header properties (such as x-ray intensity) and etc.
+    """
+    LightingConditionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ImageLightingCondition:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Lighting Condition ID')
+    """
+    The type of lighting conditions captured in the image. Examples include Ultraviolet, White, Natural, etc
+    """
+    Magnification: float | None = Field(None, examples=[5], title='Magnification')
+    """
+    Magnification of the image
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/rock_image/v1_2_0.py

@@ -0,0 +1,130 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/rock_image/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+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 Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for RockImage 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RockSampleIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-RockSample:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='RockSampleID')
+    """
+    The rock sample that this image relates to. One or many RockSample are permitted. Preferred relationship
+    """
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='WellboreID')
+    """
+    The associated wellbore. Optional relationship if RockSampleID is populated and WellboreID is populated
+    """
+    CoringID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Coring:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='CoringID')
+    """
+    The associated coring activity. Optional relationship if RockSampleID is populated and CoringID is populated
+    """
+    RockImageTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RockImageType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Rock Image Type ID')
+    """
+    The type of rock image. Examples include Photograph, Computed Tomography (CT), Thin Section, etc
+    """
+    TopDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Top Depth Measured Depth'
+    )
+    """
+    The measured top depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same
+    """
+    BaseDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Base Depth Measured Depth'
+    )
+    """
+    The measured base depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same
+    """
+    DepthShiftID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Depth Shift ID')
+    """
+    The WellLog representation carrying the preferred sample-depth to logging-depth correction or mapping
+    """
+    AcquisitionDate: str | None = Field(
+        None, examples=['2022-09-09'], title='Acquisition Date'
+    )
+    """
+    The date the image was originally taken or acquired
+    """
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Service CompanyID')
+    """
+    The organisation or contractor that originally took or acquired the image
+    """
+    ReferenceIdentifier: str | None = Field(
+        None, examples=['X12A'], title='Image Reference Identifier'
+    )
+    """
+    Unique or Distinctive Image Reference Number, Job Number, File Number, Identifier, Label, Name, etc. Typically given by the original image acquisition supplier and as indicated in the report or file. Use this attribute to allow correlation back to the original source document, file, etc.
+    """
+    Remark: str | None = Field(
+        None, examples=['Natural light. Taken in the field.'], title='Remark'
+    )
+    """
+    Remarks regarding the image acquisition and or processing environment or parameters
+    """
+    FormatInterval: float | None = Field(None, examples=[4], title='Format Interval')
+    """
+    The interval included in the image. Typically used for conventional core. For example 1m or 4m
+    """
+    TextualHeader: list[str] | None = Field(
+        None,
+        examples=[
+            [
+                'File Size: 322 kB\nFile Type: JPEG\nMIME Type: image/jpeg\nImage Width: 1231\nImage Height: 927\nEncoding Process: Baseline DCT, Huffman coding\nBits Per Sample: 8\nColor Components: 3\nX Resolution: 1\nY Resolution: 1\nSoftware: Google\nYCbCr Sub Sampling: YCbCr4:2:0 (2 2)'
+            ]
+        ],
+        title='Textual Header',
+    )
+    """
+    A free text array to capture the image file header or image parameters for knowledge capture, index and search purposes. Header values can be extracted from, e.g., Exchangeable Image File Format (EXIF) properties, Digital Imaging and Communications in Medicine (DICOM) header properties (such as x-ray intensity) and etc.
+    """
+    LightingConditionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ImageLightingCondition:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Lighting Condition ID')
+    """
+    The type of lighting conditions captured in the image. Examples include Ultraviolet, White, Natural, etc
+    """
+    Magnification: float | None = Field(None, examples=[5], title='Magnification')
+    """
+    Magnification of the image
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/rock_image/v1_3_0.py

@@ -0,0 +1,137 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/rock_image/v1_3_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_facility_vertical_measurement import v1_0_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 Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for RockImage 1.3.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RockSampleIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-RockSample:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='RockSampleID')
+    """
+    The rock sample that this image relates to. One or many RockSample are permitted. Preferred relationship
+    """
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='WellboreID')
+    """
+    The associated wellbore. Optional relationship if RockSampleID is populated and WellboreID is populated
+    """
+    CoringID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Coring:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='CoringID')
+    """
+    The associated coring activity. Optional relationship if RockSampleID is populated and CoringID is populated
+    """
+    RockImageTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RockImageType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Rock Image Type ID')
+    """
+    The type of rock image. Examples include Photograph, Computed Tomography (CT), Thin Section, etc
+    """
+    TopDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Top Depth Measured Depth'
+    )
+    """
+    The measured top depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same
+    """
+    BaseDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Base Depth Measured Depth'
+    )
+    """
+    The measured base depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='Vertical Measurement'
+    )
+    """
+    The data structure defining the zero depth point for the measured depths as well as the VerticalMeasurementSource (driller's depth or logger's depth), so that it becomes clear whether or not a depth correction is required and if so, in which direction the correction has to be performed (driller's depth to logger's depth or vice versa).
+    """
+    DepthShiftID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Depth Shift ID')
+    """
+    The WellLog representation carrying the preferred sample-depth to logging-depth correction or mapping
+    """
+    AcquisitionDate: str | None = Field(
+        None, examples=['2022-09-09'], title='Acquisition Date'
+    )
+    """
+    The date the image was originally taken or acquired
+    """
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Service CompanyID')
+    """
+    The organisation or contractor that originally took or acquired the image
+    """
+    ReferenceIdentifier: str | None = Field(
+        None, examples=['X12A'], title='Image Reference Identifier'
+    )
+    """
+    Unique or Distinctive Image Reference Number, Job Number, File Number, Identifier, Label, Name, etc. Typically given by the original image acquisition supplier and as indicated in the report or file. Use this attribute to allow correlation back to the original source document, file, etc.
+    """
+    Remark: str | None = Field(
+        None, examples=['Natural light. Taken in the field.'], title='Remark'
+    )
+    """
+    Remarks regarding the image acquisition and or processing environment or parameters
+    """
+    FormatInterval: float | None = Field(None, examples=[4], title='Format Interval')
+    """
+    The interval included in the image. Typically used for conventional core. For example 1m or 4m
+    """
+    TextualHeader: list[str] | None = Field(
+        None,
+        examples=[
+            [
+                'File Size: 322 kB\nFile Type: JPEG\nMIME Type: image/jpeg\nImage Width: 1231\nImage Height: 927\nEncoding Process: Baseline DCT, Huffman coding\nBits Per Sample: 8\nColor Components: 3\nX Resolution: 1\nY Resolution: 1\nSoftware: Google\nYCbCr Sub Sampling: YCbCr4:2:0 (2 2)'
+            ]
+        ],
+        title='Textual Header',
+    )
+    """
+    A free text array to capture the image file header or image parameters for knowledge capture, index and search purposes. Header values can be extracted from, e.g., Exchangeable Image File Format (EXIF) properties, Digital Imaging and Communications in Medicine (DICOM) header properties (such as x-ray intensity) and etc.
+    """
+    LightingConditionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ImageLightingCondition:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Lighting Condition ID')
+    """
+    The type of lighting conditions captured in the image. Examples include Ultraviolet, White, Natural, etc
+    """
+    Magnification: float | None = Field(None, examples=[5], title='Magnification')
+    """
+    Magnification of the image
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/rock_image/v1_3_1.py

@@ -0,0 +1,137 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/rock_image/v1_3_1.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_facility_vertical_measurement import v1_0_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 Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for RockImage 1.3.1.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RockSampleIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-RockSample:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='RockSampleID')
+    """
+    The rock sample that this image relates to. One or many RockSample are permitted. Preferred relationship
+    """
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='WellboreID')
+    """
+    The associated wellbore. Optional relationship if RockSampleID is populated and WellboreID is populated
+    """
+    CoringID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Coring:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='CoringID')
+    """
+    The associated coring activity. Optional relationship if RockSampleID is populated and CoringID is populated
+    """
+    RockImageTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RockImageType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Rock Image Type ID')
+    """
+    The type of rock image. Examples include Photograph, Computed Tomography (CT), Thin Section, etc
+    """
+    TopDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Top Depth Measured Depth'
+    )
+    """
+    The measured top depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same
+    """
+    BaseDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Base Depth Measured Depth'
+    )
+    """
+    The measured base depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='Vertical Measurement'
+    )
+    """
+    The data structure defining the zero depth point for the measured depths as well as the VerticalMeasurementSource (driller's depth or logger's depth), so that it becomes clear whether or not a depth correction is required and if so, in which direction the correction has to be performed (driller's depth to logger's depth or vice versa).
+    """
+    DepthShiftID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Depth Shift ID')
+    """
+    The WellLog representation carrying the preferred sample-depth to logging-depth correction or mapping
+    """
+    AcquisitionDate: str | None = Field(
+        None, examples=['2022-09-09'], title='Acquisition Date'
+    )
+    """
+    The date the image was originally taken or acquired
+    """
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Service CompanyID')
+    """
+    The organisation or contractor that originally took or acquired the image
+    """
+    ReferenceIdentifier: str | None = Field(
+        None, examples=['X12A'], title='Image Reference Identifier'
+    )
+    """
+    Unique or Distinctive Image Reference Number, Job Number, File Number, Identifier, Label, Name, etc. Typically given by the original image acquisition supplier and as indicated in the report or file. Use this attribute to allow correlation back to the original source document, file, etc.
+    """
+    Remark: str | None = Field(
+        None, examples=['Natural light. Taken in the field.'], title='Remark'
+    )
+    """
+    Remarks regarding the image acquisition and or processing environment or parameters
+    """
+    FormatInterval: float | None = Field(None, examples=[4], title='Format Interval')
+    """
+    The interval included in the image. Typically used for conventional core. For example 1m or 4m
+    """
+    TextualHeader: list[str] | None = Field(
+        None,
+        examples=[
+            [
+                'File Size: 322 kB\nFile Type: JPEG\nMIME Type: image/jpeg\nImage Width: 1231\nImage Height: 927\nEncoding Process: Baseline DCT, Huffman coding\nBits Per Sample: 8\nColor Components: 3\nX Resolution: 1\nY Resolution: 1\nSoftware: Google\nYCbCr Sub Sampling: YCbCr4:2:0 (2 2)'
+            ]
+        ],
+        title='Textual Header',
+    )
+    """
+    A free text array to capture the image file header or image parameters for knowledge capture, index and search purposes. Header values can be extracted from, e.g., Exchangeable Image File Format (EXIF) properties, Digital Imaging and Communications in Medicine (DICOM) header properties (such as x-ray intensity) and etc.
+    """
+    LightingConditionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ImageLightingCondition:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Lighting Condition ID')
+    """
+    The type of lighting conditions captured in the image. Examples include Ultraviolet, White, Natural, etc
+    """
+    Magnification: float | None = Field(None, examples=[5], title='Magnification')
+    """
+    Magnification of the image
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/rock_sample_analysis/__init__.py

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