Merge pull request #154 from asam-ev/122-addind-IoR-properties

122 adding IoR properties
asam-ev · Oct 30, 2024 · 4e035bc · 4e035bc
2 parents 789aa20 + 6180d4f
commit 4e035bc
Show file tree

Hide file tree

Showing 8 changed files with 271 additions and 14 deletions.
diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml
@@ -53,6 +53,8 @@ jobs:
         mv material-schema.adoc ../content/material/
         python3 json2asciidoc.py ../schemas/material_emp_schema.json
         mv material-emp-schema.adoc ../content/material/
+        python3 json2asciidoc.py ../schemas/material_optical_schema.json
+        mv material-optical-schema.adoc ../content/material/
         python3 json2asciidoc.py ../schemas/material_brdf_schema.json
         mv material-brdf-schema.adoc ../content/material/
 

diff --git a/.github/workflows/validate-json.yaml b/.github/workflows/validate-json.yaml
@@ -42,6 +42,12 @@ jobs:
           schema: ./schemas/material_emp_schema.json
           file: ./examples/*_emp.xompt
 
+      - name: Validate optical material properties JSON schemas
+        uses: cardinalby/schema-validator-action@v3
+        with:
+          schema: ./schemas/material_optical_schema.json
+          file: ./examples/*_optical.xompt
+
       - name: Validate brdf JSON schemas
         uses: cardinalby/schema-validator-action@v3
         with:

diff --git a/content/index.adoc b/content/index.adoc
@@ -47,6 +47,7 @@ include::material/introduction.adoc[leveloffset=+1]
 include::material/file-structure.adoc[leveloffset=+1]
 include::material/material-schema.adoc[leveloffset=+1]
 include::material/material-emp-schema.adoc[leveloffset=+1]
+include::material/material-optical-schema.adoc[leveloffset=+1]
 include::material/material-brdf-schema.adoc[leveloffset=+1]
 
 

diff --git a/content/nav-openmaterial.adoc b/content/nav-openmaterial.adoc
@@ -27,6 +27,7 @@
 ** xref:material/file-structure.adoc[]
 ** xref:material/material-schema.adoc[]
 ** xref:material/material-emp-schema.adoc[]
+** xref:material/material-optical-schema.adoc[]
 ** xref:material/material-brdf-schema.adoc[]
 
 

diff --git a/examples/example_material.xomp b/examples/example_material.xomp
@@ -31,6 +31,7 @@
         "source": "internet: https://en.wikipedia.org/wiki/Aluminium"
     },
     "electromagneticPropertiesUri": "example_material_emp.xompt",
+    "opticalPropertiesUri": "example_material_optical.xompt",
     "brdfUris": [
       "example_material_camera_brdf.xompt",
       "example_material_lidar_brdf.xompt",

diff --git a/examples/example_material_optical.xompt b/examples/example_material_optical.xompt
@@ -0,0 +1,142 @@
+{
+  "metadata": {
+    "name": "aluminum",
+    "description": "Index of refraction and extinction coefficient of aluminum",
+    "uuid": "d8622b6b39f84bab808575ebf05ca087",
+    "materialVersion": "1.0.0",
+    "creationDate": "20241024T101728Z",
+    "openMaterialVersion": "1.0.0",
+    "copyright": "(C) 2023-2024, Example Company",
+    "license": "MPL-2.0",
+    "author": "[email protected]",
+    "source": "https://www.filmetrics.com/refractive-index-database/Al/Aluminium"
+  },
+  "opticalProperties":[
+  [1.8368e-07, 297, 2.0700, 0.102],
+  [1.8505e-07, 297, 2.0850, 0.1044],
+  [1.8644e-07, 297, 2.1033, 0.1062],
+  [1.8786e-07, 297, 2.1242, 0.1076],
+  [1.8929e-07, 297, 2.1467, 0.1088],
+  [1.9075e-07, 297, 2.1700, 0.11],
+  [1.9223e-07, 297, 2.1933, 0.1113],
+  [1.9373e-07, 297, 2.2157, 0.1129],
+  [1.9525e-07, 297, 2.2375, 0.1148],
+  [1.9680e-07, 297, 2.2589, 0.1168],
+  [1.9838e-07, 297, 2.2800, 0.119],
+  [1.9998e-07, 297, 2.3011, 0.1213],
+  [2.0160e-07, 297, 2.3225, 0.1236],
+  [2.0325e-07, 297, 2.3443, 0.1258],
+  [2.0493e-07, 297, 2.3667, 0.128],
+  [2.0664e-07, 297, 2.3900, 0.13],
+  [2.0838e-07, 297, 2.4144, 0.1318],
+  [2.1014e-07, 297, 2.4400, 0.134],
+  [2.1194e-07, 297, 2.4656, 0.1364],
+  [2.1377e-07, 297, 2.4900, 0.139],
+  [2.1563e-07, 297, 2.5094, 0.1415],
+  [2.1752e-07, 297, 2.5300, 0.144],
+  [2.1944e-07, 297, 2.5594, 0.1464],
+  [2.2140e-07, 297, 2.5900, 0.149],
+  [2.2340e-07, 297, 2.6150, 0.1519],
+  [2.2543e-07, 297, 2.6400, 0.155],
+  [2.2750e-07, 297, 2.6694, 0.1585],
+  [2.2960e-07, 297, 2.7000, 0.162],
+  [2.3175e-07, 297, 2.7300, 0.1649],
+  [2.3393e-07, 297, 2.7600, 0.168],
+  [2.3616e-07, 297, 2.7900, 0.1719],
+  [2.3843e-07, 297, 2.8200, 0.176],
+  [2.4075e-07, 297, 2.8500, 0.1796],
+  [2.4311e-07, 297, 2.8800, 0.183],
+  [2.4552e-07, 297, 2.9094, 0.1865],
+  [2.4797e-07, 297, 2.9400, 0.19],
+  [2.5048e-07, 297, 2.9750, 0.1934],
+  [2.5303e-07, 297, 3.0100, 0.197],
+  [2.5564e-07, 297, 3.0394, 0.2009],
+  [2.5830e-07, 297, 3.0700, 0.205],
+  [2.6102e-07, 297, 3.1094, 0.2089],
+  [2.6380e-07, 297, 3.1500, 0.213],
+  [2.6663e-07, 297, 3.1850, 0.2179],
+  [2.6953e-07, 297, 3.2200, 0.223],
+  [2.7249e-07, 297, 3.2594, 0.2279],
+  [2.7552e-07, 297, 3.3000, 0.233],
+  [2.7862e-07, 297, 3.3394, 0.2384],
+  [2.8178e-07, 297, 3.3800, 0.244],
+  [2.8502e-07, 297, 3.4250, 0.2494],
+  [2.8834e-07, 297, 3.4700, 0.255],
+  [2.9173e-07, 297, 3.5100, 0.2609],
+  [2.9520e-07, 297, 3.5500, 0.267],
+  [2.9876e-07, 297, 3.5938, 0.2734],
+  [3.0240e-07, 297, 3.6400, 0.28],
+  [3.0614e-07, 297, 3.6894, 0.2868],
+  [3.0996e-07, 297, 3.7400, 0.294],
+  [3.1389e-07, 297, 3.7894, 0.3019],
+  [3.1791e-07, 297, 3.8400, 0.31],
+  [3.2204e-07, 297, 3.8944, 0.3179],
+  [3.2628e-07, 297, 3.9500, 0.326],
+  [3.3063e-07, 297, 4.0050, 0.3348],
+  [3.3510e-07, 297, 4.0600, 0.344],
+  [3.3969e-07, 297, 4.1138, 0.3538],
+  [3.4440e-07, 297, 4.1700, 0.364],
+  [3.4925e-07, 297, 4.2338, 0.3744],
+  [3.5424e-07, 297, 4.3000, 0.385],
+  [3.5938e-07, 297, 4.3650, 0.3958],
+  [3.6466e-07, 297, 4.4300, 0.407],
+  [3.7011e-07, 297, 4.4938, 0.4191],
+  [3.7571e-07, 297, 4.5600, 0.432],
+  [3.8149e-07, 297, 4.6338, 0.4457],
+  [3.8745e-07, 297, 4.7100, 0.46],
+  [3.9360e-07, 297, 4.7844, 0.4747],
+  [3.9995e-07, 297, 4.8600, 0.49],
+  [4.0651e-07, 297, 4.9381, 0.5062],
+  [4.1328e-07, 297, 5.0200, 0.523],
+  [4.2029e-07, 297, 5.1088, 0.5401],
+  [4.2754e-07, 297, 5.2000, 0.558],
+  [4.3504e-07, 297, 5.2900, 0.5773],
+  [4.4280e-07, 297, 5.3800, 0.598],
+  [4.5086e-07, 297, 5.4800, 0.6203],
+  [4.5920e-07, 297, 5.5800, 0.644],
+  [4.6787e-07, 297, 5.6900, 0.6686],
+  [4.7687e-07, 297, 5.8000, 0.695],
+  [4.8622e-07, 297, 5.9150, 0.7238],
+  [4.9594e-07, 297, 6.0300, 0.755],
+  [5.0606e-07, 297, 6.1500, 0.789],
+  [5.1660e-07, 297, 6.2800, 0.826],
+  [5.2760e-07, 297, 6.4200, 0.867],
+  [5.3907e-07, 297, 6.5500, 0.912],
+  [5.5105e-07, 297, 6.7000, 0.963],
+  [5.6357e-07, 297, 6.8500, 1.02],
+  [5.7668e-07, 297, 7.0000, 1.08],
+  [5.9041e-07, 297, 7.1500, 1.15],
+  [6.0481e-07, 297, 7.3100, 1.22],
+  [6.1993e-07, 297, 7.4800, 1.3],
+  [6.3582e-07, 297, 7.6500, 1.39],
+  [6.5255e-07, 297, 7.8200, 1.49],
+  [6.7019e-07, 297, 8.0100, 1.6],
+  [6.8881e-07, 297, 8.2100, 1.74],
+  [7.0832e-07, 297, 8.3900, 1.91],
+  [7.2932e-07, 297, 8.5700, 2.14],
+  [7.5143e-07, 297, 8.6200, 2.41],
+  [7.7491e-07, 297, 8.6000, 2.63],
+  [7.9990e-07, 297, 8.4500, 2.8],
+  [8.2657e-07, 297, 8.3100, 2.74],
+  [8.5507e-07, 297, 8.2100, 2.58],
+  [8.8561e-07, 297, 8.2100, 2.24],
+  [9.1841e-07, 297, 8.4400, 1.86],
+  [9.5373e-07, 297, 8.9500, 1.47],
+  [9.9188e-07, 297, 9.4900, 1.37],
+  [1.0332e-06, 297, 10.0000, 1.26],
+  [1.0781e-06, 297, 10.6000, 1.21],
+  [1.1271e-06, 297, 11.2000, 1.2],
+  [1.1808e-06, 297, 11.8000, 1.21],
+  [1.2399e-06, 297, 12.5000, 1.21],
+  [1.3051e-06, 297, 13.2000, 1.23],
+  [1.3776e-06, 297, 14.0000, 1.26],
+  [1.4587e-06, 297, 14.9000, 1.33],
+  [1.5498e-06, 297, 16.0000, 1.44],
+  [1.6531e-06, 297, 17.1000, 1.59],
+  [1.7712e-06, 297, 18.3000, 1.77],
+  [1.9075e-06, 297, 19.8000, 1.99],
+  [2.0664e-06, 297, 21.4000, 2.27],
+  [2.2543e-06, 297, 23.3000, 2.62],
+  [2.4797e-06, 297, 25.6000, 3.07]
+  ]
+}
diff --git a/schemas/material_optical_schema.json b/schemas/material_optical_schema.json
@@ -0,0 +1,99 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "metadata": {
+      "type": "object",
+      "description": "Metadata about the material.",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name of the material."
+        },
+        "description": {
+          "type": "string",
+          "description": "Short description of the material in 2 - 3 sentences."
+        },
+        "uuid": {
+          "type": "string",
+          "description": "Universally unique identifier for the material.",
+          "pattern": "^[a-f0-9]{32}$"
+        },
+        "materialVersion": {
+          "type": "string",
+          "description": "Version of the material.",
+          "pattern": "^\\d+\\.\\d+\\.\\d+$"
+        },
+        "creationDate": {
+          "type": "string",
+          "description": "Creation date of the material in the format YYYYMMDDTHHMMSSZ.",
+          "pattern": "^\\d{8}T\\d{6}Z$"
+        },
+        "openMaterialVersion": {
+          "type": "string",
+          "description": "Version of OpenMATERIAL.",
+          "pattern": "^\\d+\\.\\d+\\.\\d+$"
+        },
+        "copyright": {
+          "type": "string",
+          "description": "Copyright information with year and company."
+        },
+        "license": {
+          "type": "string",
+          "description": "License information. For common open source licenses, provide an SPDX identifier. For other types of licenses, provide an URL to a webpage with the license or the filename of a separately provided license file."
+        },
+        "author": {
+          "type": "string",
+          "description": "Name or email address of the author of this material. In case of multiple authors, use comma-separation. The author can also be a company name."
+        },
+        "source": {
+          "type": "string",
+          "description": "Source of the electromagnetic property data."
+        }
+      },
+      "required": [
+        "name",
+        "description",
+        "uuid",
+        "materialVersion",
+        "creationDate",
+        "openMaterialVersion",
+        "copyright",
+        "license",
+        "author",
+        "source"
+      ]
+    },
+    "opticalProperties": {
+      "type": "array",
+      "items": {
+        "type": "array",
+        "description": "Array of optical property values, with each item representing a different property. The array SHALL be sorted based on the columns starting with the first.",
+        "items": [
+          {
+            "type": ["number", "null"],
+            "description": "Wavelength in meters."
+          },
+          {
+            "type": ["number", "null"],
+            "description": "Temperature in Kelvin."
+          },
+          {
+            "type": ["number", "null"],
+            "description": "Real part of index of refraction."
+          },
+          {
+            "type": ["number", "null"],
+            "description": "Imaginary part of index of refraction."
+          }
+        ],
+        "minItems": 4,
+        "maxItems": 4
+      }
+    }
+  },
+  "required": [
+    "metadata",
+    "opticalProperties"
+  ]
+}
diff --git a/schemas/material_schema.json b/schemas/material_schema.json
@@ -150,19 +150,6 @@
             "source"
           ]
         },
-        "electromagneticPropertiesUri": {
-          "type": "string",
-          "description": "Relative path to a property lookup table file with electromagnetic material properties.",
-          "pattern": ".*_emp\\.xompt$"
-        },
-        "brdfUris": {
-          "type": "array",
-          "description": "Relative paths to one or multiple property lookup table files with wavelength-dependent bidirectional reflectance distribution functions.",
-          "items": {
-            "type": "string",
-            "pattern": ".*_brdf\\.xompt$"
-          }
-        },
         "retroreflectivityData": {
           "type": "object",
           "description": "Information about the retro-reflective properties of the material in the visible light spectrum.",
@@ -180,6 +167,24 @@
             "coefficienOfRetroreflection",
             "source"
           ]
+        },
+        "electromagneticPropertiesUri": {
+          "type": "string",
+          "description": "Relative path to a property lookup table file with electromagnetic material properties.",
+          "pattern": ".*_emp\\.xompt$"
+        },
+        "opticalPropertiesUri": {
+          "type": "string",
+          "description": "Relative path to a property lookup table file with optical material properties.",
+          "pattern": ".*_optical\\.xompt$"
+        },
+        "brdfUris": {
+          "type": "array",
+          "description": "Relative paths to one or multiple property lookup table files with wavelength-dependent bidirectional reflectance distribution functions.",
+          "items": {
+            "type": "string",
+            "pattern": ".*_brdf\\.xompt$"
+          }
         }
       },
       "required": [
@@ -195,4 +200,4 @@
     "metadata",
     "materialProperties"
   ]
-}
+}