Struct generic_camera::GenericImage

source ·

pub struct GenericImage<'a> { /* private fields */ }

Expand description

A serializable, generic image with metadata.

This struct holds an image with associated metadata. The metadata is stored as a vector of GenericLineItem structs. The image data is stored as a DynamicImageData.

§Usage

use refimage::{ImageData, DynamicImageData, GenericImage, ColorSpace};
use std::time::SystemTime;
let data = vec![1u8, 2, 3, 4, 5, 6];
let img = ImageData::from_owned(data, 3, 2, ColorSpace::Gray).unwrap();
let img = DynamicImageData::from(img);
let mut img = GenericImage::new(std::time::SystemTime::now(), img);

img.insert_key("CAMERA", "Canon EOS 5D Mark IV").unwrap();

Implementations§

source §

impl<'a> GenericImage<'a>

source

pub fn new(tstamp: SystemTime, image: DynamicImageData<'a>) -> GenericImage<'a>

Create a new GenericImage with metadata.

§Arguments

tstamp: The timestamp of the image.
image: The image data, of type DynamicImageData.

§Example

use refimage::{ImageData, DynamicImageData, GenericImage, ColorSpace};
use std::time::SystemTime;
let data = vec![1u8, 2, 3, 4, 5, 6];
let img = ImageData::from_owned(data, 3, 2, ColorSpace::Gray).unwrap();
let img = DynamicImageData::from(img);
let mut img = GenericImage::new(std::time::SystemTime::now(), img);

img.insert_key("CAMERA", "Canon EOS 5D Mark IV").unwrap();

source

pub fn insert_key<T>( &mut self, name: &str, value: T, ) -> Result<(), &'static str>
where T: InsertValue,

Insert a metadata value into the GenericImage.

§Arguments

name: The name of the metadata value. The name must be non-empty and less than 80 characters.
value: The value to insert. The value is either a primitive type, a String, or a std::time::Duration or std::time::SystemTime or a tuple of a primitive type and a comment ().

§Valid Types

The valid types for the metadata value are:

u8 | u16 | u32 | u64
i8 | i16 | i32 | i64
f32 | f64
std::time::Duration | std::time::SystemTime
String | &str

§Note

The metadata key is case-insensitive and is stored as an uppercase string.
Re-inserting a timestamp key will return an error.
When saving to a FITS file, the metadata comment may be truncated.
Metadata of type std::time::Duration or std::time::SystemTime is split and stored as two consecutive metadata items, with the same key, split into seconds (u64) and microseconds (u32).

source

pub fn remove_key(&mut self, name: &str) -> Result<(), &'static str>

Remove a metadata value from the GenericImage.

§Arguments

name: The name of the metadata value to remove.

§Returns

Ok(()) if the key was removed successfully.
Err("Can not remove timestamp key") if the key is the timestamp key.
Err("Key not found") if the key was not found.
Err("Key cannot be empty") if the key is an empty string.
Err("Key cannot be longer than 80 characters") if the key is longer than 80 characters.

source

pub fn replace_key<T>( &mut self, name: &str, value: T, ) -> Result<(), &'static str>
where T: InsertValue,

Replace a metadata value in the GenericImage.

§Arguments

name: The name of the metadata value to replace.
value: The new value to insert. The value is either a primitive type, a String, or a std::time::Duration or std::time::SystemTime or a tuple of a value type and a comment.