Tensor & depth image value ranges can now be configured, from UI & code

Cargo.lock

@@ -5572,6 +5572,7 @@ dependencies = [
  "re_chunk_store",
  "re_data_ui",
  "re_log_types",
+ "re_query",
  "re_renderer",
  "re_space_view",
  "re_tracing",

crates/store/re_types/definitions/rerun/archetypes/depth_image.fbs

@@ -5,7 +5,7 @@ namespace rerun.archetypes;
 ///
 /// Each pixel corresponds to a depth value in units specified by [components.DepthMeter].
 ///
-/// \cpp Since the underlying `rerun::datatypes::TensorData` uses `rerun::Collection` internally,
+/// \cpp Since the underlying `rerun::datatypes::ImageBuffer` uses `rerun::Collection` internally,
 /// \cpp data can be passed in without a copy from raw pointers or by reference from `std::vector`/`std::array`/c-arrays.
 /// \cpp If needed, this "borrow-behavior" can be extended by defining your own `rerun::CollectionAdapter`.
 ///
@@ -41,17 +41,30 @@ table DepthImage (
   /// If not set, the depth image will be rendered using the Turbo colormap.
   colormap: rerun.components.Colormap ("attr.rerun.component_optional", nullable, order: 3200);
 
+  /// The expected range of depth values.
+  ///
+  /// This is typically the expected range of valid values.
+  /// Everything outside of the range is clamped to the range for the purpose of colormpaping.
+  /// Note that point clouds generated from this image will still display all points, regardless of this range.
+  ///
+  /// If not specified, the range will be automatically estimated from the data.
+  /// Note that the Viewer may try to guess a wider range than the minimum/maximum of values
+  /// in the contents of the depth image.
+  /// E.g. if all values are positive, some bigger than 1.0 and all smaller than 255.0,
+  /// the Viewer will guess that the data likely came from an 8bit image, thus assuming a range of 0-255.
+  depth_range: rerun.components.ValueRange ("attr.rerun.component_optional", nullable, order: 3300);
+
   /// Scale the radii of the points in the point cloud generated from this image.
   ///
   /// A fill ratio of 1.0 (the default) means that each point is as big as to touch the center of its neighbor
   /// if it is at the same depth, leaving no gaps.
   /// A fill ratio of 0.5 means that each point touches the edge of its neighbor if it has the same depth.
   ///
   /// TODO(#6744): This applies only to 3D views!
-  point_fill_ratio: rerun.components.FillRatio ("attr.rerun.component_optional", nullable, order: 3300);
+  point_fill_ratio: rerun.components.FillRatio ("attr.rerun.component_optional", nullable, order: 3400);
 
   /// An optional floating point value that specifies the 2D drawing order, used only if the depth image is shown as a 2D image.
   ///
   /// Objects with higher values are drawn on top of those with lower values.
-  draw_order: rerun.components.DrawOrder ("attr.rerun.component_optional", nullable, order: 3400);
+  draw_order: rerun.components.DrawOrder ("attr.rerun.component_optional", nullable, order: 3500);
 }

crates/store/re_types/definitions/rerun/archetypes/tensor.fbs

@@ -19,4 +19,19 @@ table Tensor (
 ) {
   /// The tensor data
   data: rerun.components.TensorData ("attr.rerun.component_required", order: 1000);
+
+  // --- Optional ---
+
+  /// The expected range of values.
+  ///
+  /// This is typically the expected range of valid values.
+  /// Everything outside of the range is clamped to the range for the purpose of colormpaping.
+  /// Any colormap applied for display, will map this range.
+  ///
+  /// If not specified, the range will be automatically estimated from the data.
+  /// Note that the Viewer may try to guess a wider range than the minimum/maximum of values
+  /// in the contents of the tensor.
+  /// E.g. if all values are positive, some bigger than 1.0 and all smaller than 255.0,
+  /// the Viewer will guess that the data likely came from an 8bit image, thus assuming a range of 0-255.
+  value_range: rerun.components.ValueRange ("attr.rerun.component_optional", nullable, order: 2000);
 }

crates/store/re_types/definitions/rerun/blueprint/archetypes/tensor_scalar_mapping.fbs

@@ -17,10 +17,8 @@ table TensorScalarMapping (
     ///
     /// Raises the normalized values to the power of this value before mapping to color.
     /// Acts like an inverse brightness. Defaults to 1.0.
+    ///
+    /// The final value for display is set as:
+    /// `colormap( ((value - data_display_range.min) / (data_display_range.max - data_display_range.min)) ** gamma )`
     gamma: rerun.components.GammaCorrection ("attr.rerun.component_optional", nullable, order: 1200);
-
-    // TODO(andreas): explicit scalar ranges should go in here as well!
-    // Overall we should communicate scalar mapping to work like this here
-    // https://matplotlib.org/stable/api/_as_gen/matplotlib.colors.PowerNorm.html#matplotlib.colors.PowerNorm
-    // (value - vmin) ** gamma / (vmax - vmin) ** gamma
 }

crates/store/re_types/definitions/rerun/components/value_range.fbs

@@ -0,0 +1,11 @@
+namespace rerun.components;
+
+// ---
+
+/// Range of expected or valid values, specifying a lower and upper bound.
+struct ValueRange (
+  "attr.rust.derive": "Copy, PartialEq, bytemuck::Pod, bytemuck::Zeroable",
+  "attr.rust.repr": "transparent"
+) {
+  range: rerun.datatypes.Range1D (order: 100);
+}

crates/store/re_types/src/archetypes/depth_image_ext.rs

@@ -42,6 +42,7 @@ impl DepthImage {
             meter: None,
             colormap: None,
             point_fill_ratio: None,
+            depth_range: None,
         })
     }
 }