Histogram example update (kornia#98)

* update histogram example and rerun to 0.17.0 * update readme * add image
jeffin07 · Jul 16, 2024 · 06f929b · 06f929b
1 parent 0a48437
commit 06f929b
Show file tree

Hide file tree

Showing 14 changed files with 25 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ Use the library to perform image I/O, visualisation and other low level operatio
 
 ## Getting Started
 
-`cargo run --example hello_world`
+`cargo run --bin hello_world`
 
 ```rust
 use kornia::image::Image;
@@ -21,9 +21,9 @@ use kornia::io::functional as F;
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     // read the image
     let image_path = std::path::Path::new("tests/data/dog.jpeg");
-    let image: Image<u8, 3> = F::read_image_jpeg(image_path)?;
+    let image: Image<u8, 3> = F::read_image_any(image_path)?;
 
-    println!("Hello, world!");
+    println!("Hello, world! 🦀");
     println!("Loaded Image size: {:?}", image.size());
     println!("\nGoodbyte!");
 
@@ -113,7 +113,7 @@ use kornia::io::functional as F;
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     // read the image
     let image_path = std::path::Path::new("tests/data/dog.jpeg");
-    let image: Image<u8, 3> = F::read_image_jpeg(image_path)?;
+    let image: Image<u8, 3> = F::read_image_any(image_path)?;
     let image_viz = image.clone();
 
     let image_f32: Image<f32, 3> = image.cast_and_scale::<f32>(1.0 / 255.0)?;

diff --git a/examples/binarize/Cargo.toml b/examples/binarize/Cargo.toml
@@ -15,4 +15,4 @@ publish = false
 [dependencies]
 clap = { version = "4.5.9", features = ["derive"] }
 kornia.workspace = true
-rerun = "0.16.0"
+rerun = "0.17.0"
diff --git a/examples/color_detector/Cargo.toml b/examples/color_detector/Cargo.toml
@@ -15,4 +15,4 @@ publish = false
 [dependencies]
 clap = { version = "4.5.9", features = ["derive"] }
 kornia.workspace = true
-rerun = "0.16.0"
+rerun = "0.17.0"
diff --git a/examples/histogram/Cargo.toml b/examples/histogram/Cargo.toml
@@ -15,4 +15,4 @@ publish = false
 [dependencies]
 clap = { version = "4.5.9", features = ["derive"] }
 kornia.workspace = true
-rerun = "0.16.0"
+rerun = "0.17.0"
diff --git a/examples/histogram/README.md b/examples/histogram/README.md
@@ -1,3 +1,7 @@
+# Image histogram
+
+## Usage
+
 Example showing to compute the histogram of an image using the Kornia Rust image processing library.
 
 ```bash
@@ -8,12 +12,12 @@ Options:
   -h, --help                     Print help
 ```
 
-Example:
+## Example
 
 ```bash
 cargo run -p histogram -- --image-path path/to/image.jpg
 ```
 
-Output:
+## Output
 
-TODO: add image output
+![green_black_histogram](https://github.com/user-attachments/assets/010a15db-3721-4217-bbca-79711011ebb5)
diff --git a/examples/histogram/src/main.rs b/examples/histogram/src/main.rs
@@ -16,16 +16,16 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     // read the image
     let image: Image<u8, 3> = F::read_image_any(&args.image_path)?;
 
-    // create a Rerun recording stream
-    let rec = rerun::RecordingStreamBuilder::new("Kornia App").spawn()?;
-
     // compute the histogram per channel
     let histogram = image
         .split_channels()?
         .iter()
         .map(|ch| imgproc::histogram::compute_histogram(ch, 256))
         .collect::<Result<Vec<_>, _>>()?;
 
+    // create a Rerun recording stream
+    let rec = rerun::RecordingStreamBuilder::new("Kornia Histogram App").spawn()?;
+
     // log the image and the histogram
     rec.set_time_sequence("step", 0);
     rec.log("image", &rerun::Image::try_from(image.clone().data)?)?;

diff --git a/examples/imgproc/Cargo.toml b/examples/imgproc/Cargo.toml
@@ -14,4 +14,4 @@ version.workspace = true
 [dependencies]
 clap = { version = "4.5.9", features = ["derive"] }
 kornia.workspace = true
-rerun = "0.16.0"
+rerun = "0.17.0"
diff --git a/examples/metrics/Cargo.toml b/examples/metrics/Cargo.toml
@@ -14,4 +14,4 @@ version.workspace = true
 [dependencies]
 clap = { version = "4.5.9", features = ["derive"] }
 kornia.workspace = true
-rerun = "0.16.0"
+rerun = "0.17.0"
diff --git a/examples/normalize/Cargo.toml b/examples/normalize/Cargo.toml
@@ -15,4 +15,4 @@ publish = false
 [dependencies]
 clap = { version = "4.5.9", features = ["derive"] }
 kornia.workspace = true
-rerun = "0.16.0"
+rerun = "0.17.0"
diff --git a/examples/normalize_ii/Cargo.toml b/examples/normalize_ii/Cargo.toml
@@ -15,4 +15,4 @@ publish = false
 [dependencies]
 clap = { version = "4.5.9", features = ["derive"] }
 kornia.workspace = true
-rerun = "0.16.0"
+rerun = "0.17.0"
diff --git a/examples/rerun_viz/Cargo.toml b/examples/rerun_viz/Cargo.toml
@@ -14,4 +14,4 @@ version.workspace = true
 [dependencies]
 clap = { version = "4.5.9", features = ["derive"] }
 kornia.workspace = true
-rerun = "0.16.0"
+rerun = "0.17.0"
diff --git a/examples/rotate/Cargo.toml b/examples/rotate/Cargo.toml
@@ -14,4 +14,4 @@ version.workspace = true
 [dependencies]
 clap = { version = "4.5.9", features = ["derive"] }
 kornia.workspace = true
-rerun = "0.16.0"
+rerun = "0.17.0"
diff --git a/examples/undistort_image/Cargo.toml b/examples/undistort_image/Cargo.toml
@@ -14,4 +14,4 @@ version.workspace = true
 [dependencies]
 clap = { version = "4.5.9", features = ["derive"] }
 kornia.workspace = true
-rerun = "0.16.0"
+rerun = "0.17.0"
diff --git a/examples/webcam/Cargo.toml b/examples/webcam/Cargo.toml
@@ -10,5 +10,5 @@ publish = false
 clap = { version = "4.5.4", features = ["derive"] }
 ctrlc = "3.4.4"
 kornia = { workspace = true, features = ["gstreamer"] }
-rerun = "0.16.0"
+rerun = "0.17.0"
 tokio = { version = "1" }