Adds missing distortionOverscanMax. Update image to SVG and make suggested changes to OpenLensIO

Author: jamesmosys

src/main/python/camdkit/examples.py

@@ -31,6 +31,7 @@ def get_complete_static_example():
   clip.duration = Fraction(1,25)
   clip.fdl_link = uuid.uuid4().urn
   clip.iso = 4000
+  clip.lens_distortion_overscan_max = 1.2
   clip.lens_make = "LensMaker"
   clip.lens_model = "Model15"
   clip.lens_nominal_focal_length = 14

src/main/python/camdkit/model.py

@@ -1041,6 +1041,14 @@ class DistortionOverscan(NonNegativeRealParameter):
   canonical_name = "distortionOverscan"
   section = "lens"
   units = None
+
+class DistortionOverscanMaximum(NonNegativeRealParameter):
+  """Static maximum overscan factor on lens distortion"""
+
+  sampling = Sampling.STATIC
+  canonical_name = "distortionOverscanMax"
+  section = "lens"
+  units = None
 
 class LensExposureFalloff(Parameter):
   """Coefficients for calculating the exposure fall-off (vignetting) of
@@ -1297,6 +1305,7 @@ class Clip(ParameterContainer):
   duration: typing.Optional[numbers.Rational] = Duration()
   fdl_link: typing.Optional[str] = FDLLink()
   iso: typing.Optional[numbers.Integral] = ISO()
+  lens_distortion_overscan_max: typing.Optional[numbers.Real] = DistortionOverscanMaximum()
   lens_firmware: typing.Optional[str] = LensFirmware()
   lens_make: typing.Optional[str] = LensMake()
   lens_model: typing.Optional[str] = LensModel()
@@ -1311,7 +1320,7 @@ class Clip(ParameterContainer):
   global_stage: typing.Optional[typing.Tuple[GlobalPosition]] = GlobalStagePosition()
   lens_custom: typing.Optional[typing.Tuple[tuple]] = LensCustom()
   lens_distortion: typing.Optional[typing.Tuple[Distortion]] = LensDistortion()
-  lens_distortion_overscan: typing.Optional[typing.Tuple[Orientations]] = DistortionOverscan()
+  lens_distortion_overscan: typing.Optional[typing.Tuple[numbers.Real]] = DistortionOverscan()
   lens_distortion_shift: typing.Optional[typing.Tuple[DistortionShift]] = LensDistortionShift()
   lens_encoders: typing.Optional[typing.Tuple[LensEncoders]] = LensEncoders()
   lens_entrance_pupil_offset: typing.Optional[typing.Tuple[numbers.Real]] = EntrancePupilOffset()

src/main/resources/img/Coordinate_System.png

@@ -44,6 +44,7 @@ def test_serialize(self):
     clip.tracker_serial_number = "1234567890A"
     clip.fdl_link = "urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
     clip.iso = 13
+    clip.lens_distortion_overscan_max = 1.2
     clip.lens_make = "ABC"
     clip.lens_model = "FGH"
     clip.lens_firmware = "1-dev.1"
@@ -128,6 +129,7 @@ def test_serialize(self):
     self.assertEqual(d["static"]["camera"]["serialNumber"], "132456")
     self.assertEqual(d["static"]["camera"]["firmwareVersion"], "7.1")
     self.assertEqual(d["static"]["camera"]["label"], "A")
+    self.assertEqual(d["static"]["lens"]["distortionOverscanMax"], 1.2)
     self.assertEqual(d["static"]["lens"]["make"], "ABC")
     self.assertEqual(d["static"]["lens"]["model"], "FGH")
     self.assertEqual(d["static"]["lens"]["serialNumber"], "123456789")
@@ -865,6 +867,20 @@ def test_lens_distortion_overscan(self):
     clip.lens_distortion_overscan = value
     self.assertTupleEqual(clip.lens_distortion_overscan, value)
 
+  def test_lens_distortion_overscan_max(self):
+    clip = Clip()
+
+    self.assertIsNone(clip.lens_distortion_overscan_max)
+
+    with self.assertRaises(ValueError):
+      clip.lens_distortion_overscan_max = ""
+    with self.assertRaises(ValueError):
+      clip.lens_distortion_overscan_max = -1.0
+
+    value = 1.2
+    clip.lens_distortion_overscan_max = value
+    self.assertEqual(clip.lens_distortion_overscan_max, value)
+    
   def test_lens_exposure_falloff(self):
     clip = Clip()
 

src/main/resources/img/Coordinate_System.svg

@@ -41,7 +41,7 @@ <h2>OpenTrackIO protocol</h2>
             <p>All the fields described should be considered optional by the consumer (although for high-quality tracking for Virtual Production see the recommended set in the samples <a href="#recommended">below</a>).</p>
             <p>OpenTrackIO transforms employs a right-handed coordinate system where the Z axis points upwards and positive rotations are clockwise around the axis. Y points in the forward camera direction (when pan, tilt and roll are zero). For example in an LED volume Y would point towards the centre of the LED wall and so X would point to camera-right.</p>
             <p>OpenTrackIO employs the <a href="res/OpenLensIO_v0_9_0.pdf" target="_blank">OpenLensIO mathematical lens model</a> for the practical application of spherical lens distortion in Virtual Production.</p>
-            <img class="img-inline" src="img/Coordinate_System.png" /><img class="img-inline" src="img/Axis_Rotation.svg" /></span>
+            <img class="img-inline" src="img/Coordinate_System.svg" /><img class="img-inline" src="img/Axis_Rotation.svg" /></span>
 
             <h2>Software resources</h2>
             <p>OpenTrackIO's parameters are defined by <a href="https://github.com/SMPTE/ris-osvp-metadata-camdkit" target="_blank">CamDKit</a>. This repository includes examples for <a href="https://github.com/SMPTE/ris-osvp-metadata-camdkit/tree/main/src/main/python/camdkit/mosys" target="_blank">generating</a> and parsing data in <a href="https://github.com/SMPTE/ris-osvp-metadata-camdkit/tree/main/src/test/python/parser" target="_blank">python</a> and <a href="https://github.com/SMPTE/ris-osvp-metadata-camdkit/tree/main/src/test/cpp/opentrackio-parser" target="_blank">C++</a>.</p>