liboxen 0.50.0

Oxen is a fast, unstructured data version control, to help version large machine learning datasets written in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! Helper functions to get metadata from the images.
//!

use crate::error::OxenError;
use crate::model::metadata::metadata_image::MetadataImage;

use std::fs::File;

use image::ImageReader;
use std::io::BufReader;
use std::path::Path;

/// Detects the image metadata for the given file.
pub fn get_metadata(path: impl AsRef<Path>) -> Result<MetadataImage, OxenError> {
    let file = File::open(path)?;
    let reader = BufReader::new(file);
    let reader = ImageReader::new(reader).with_guessed_format()?;

    match reader.into_dimensions() {
        Ok((width, height)) => Ok(MetadataImage::new(width, height)),
        Err(e) => {
            log::debug!("Could not get image metadata {e:?}");
            Err(OxenError::basic_str("Could not get image metadata"))
        }
    }
}

#[cfg(test)]
mod tests {

    use crate::model::entry::entry_data_type::EntryDataType;
    use crate::model::metadata::MetadataImage;
    use crate::model::metadata::generic_metadata::GenericMetadata;
    use crate::repositories;
    use crate::test;

    #[test]
    fn test_get_metadata_img_rgb() {
        let file = test::test_img_file_with_name("cat_1.jpg");

        let data = repositories::metadata::get(file).unwrap();

        assert_eq!(data.data_type, EntryDataType::Image);
        assert_eq!(data.mime_type, "image/jpeg");

        assert!(data.metadata.is_some());
        let metadata: MetadataImage = match data.metadata.unwrap() {
            GenericMetadata::MetadataImage(metadata) => metadata,
            _ => panic!("Wrong metadata type"),
        };

        assert_eq!(metadata.image.width, 499);
        assert_eq!(metadata.image.height, 375);
    }

    #[test]
    fn test_get_metadata_img_rgba() {
        let file = test::test_img_file_with_name("cat_rgba.png");
        let data = repositories::metadata::get(file).unwrap();

        assert_eq!(data.data_type, EntryDataType::Image);
        assert_eq!(data.mime_type, "image/png");

        assert!(data.metadata.is_some());
        let metadata: MetadataImage = match data.metadata.unwrap() {
            GenericMetadata::MetadataImage(metadata) => metadata,
            _ => panic!("Wrong metadata type"),
        };

        assert_eq!(metadata.image.width, 499);
        assert_eq!(metadata.image.height, 375);
    }

    #[test]
    fn test_get_metadata_img_grayscale() {
        let file = test::test_img_file_with_name("cat_grayscale.jpg");

        let data = repositories::metadata::get(file).unwrap();

        assert_eq!(data.data_type, EntryDataType::Image);
        assert_eq!(data.mime_type, "image/jpeg");

        assert!(data.metadata.is_some());
        let metadata: MetadataImage = match data.metadata.unwrap() {
            GenericMetadata::MetadataImage(metadata) => metadata,
            _ => panic!("Wrong metadata type"),
        };

        assert_eq!(metadata.image.width, 499);
        assert_eq!(metadata.image.height, 375);
    }

    #[test]
    fn test_get_metadata_img_mnist() {
        let file = test::test_img_file_with_name("mnist_7.png");
        let data = repositories::metadata::get(file).unwrap();

        assert_eq!(data.data_type, EntryDataType::Image);
        assert_eq!(data.mime_type, "image/png");

        assert!(data.metadata.is_some());
        let metadata: MetadataImage = match data.metadata.unwrap() {
            GenericMetadata::MetadataImage(metadata) => metadata,
            _ => panic!("Wrong metadata type"),
        };

        assert_eq!(metadata.image.width, 28);
        assert_eq!(metadata.image.height, 28);
    }
}