Enum GenericImage

pub enum GenericImage<'a> {
    Ref(GenericImageRef<'a>),
    Own(GenericImageOwned),
}

A serializable, generic image with metadata, backed by either a GenericImageRef or a GenericImageOwned.

Variants

Ref(GenericImageRef<'a>)

Holds a GenericImageRef.

Own(GenericImageOwned)

Holds a GenericImageOwned.

Implementations

impl GenericImage<'_>

pub fn get_timestamp(&self) -> SystemTime

Get the timestamp of the image.

pub fn get_exposure(&self) -> Option<Duration>

Get the exposure time of the image.

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
• ColorSpace
• 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 nanoseconds (u64).

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

Remove a metadata value from the GenericImageOwned.

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.

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

where T: InsertValue,

Replace a metadata value in the GenericImageOwned.

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.

Returns

• Ok(()) if the key was replaced successfully.
• Err("Key not found") if the key was not found.

pub fn get_metadata(&self) -> &HashMap<String, GenericLineItem>

Get the contained metadata as a slice of GenericLineItems.

Returns

A slice of GenericLineItems containing the metadata.

pub fn get_key(&self, name: &str) -> Option<&GenericLineItem>

Get a specific metadata value by name.

Returns the first metadata value with the given name.

Arguments

• name: The name of the metadata value.

impl GenericImage<'_>

pub fn as_raw_u8(&self) -> &[u8]

Get the data as a slice of u8, regardless of the underlying type.

pub fn as_raw_u8_checked(&self) -> Option<&[u8]>

Get the data as a slice of u8, regardless of the underlying type.

pub fn as_slice_u8(&self) -> Option<&[u8]>

Get the data as a slice of u8.

pub fn as_mut_slice_u8(&mut self) -> Option<&mut [u8]>

Get the data as a mutable slice of u8.

pub fn as_slice_u16(&self) -> Option<&[u16]>

Get the data as a slice of u16.

pub fn as_mut_slice_u16(&mut self) -> Option<&mut [u16]>

Get the data as a mutable slice of u16.

pub fn as_slice_f32(&self) -> Option<&[f32]>

Get the data as a slice of f32.

pub fn as_mut_slice_f32(&mut self) -> Option<&mut [f32]>

Get the data as a mutable slice of f32.

Trait Implementations

impl CalcOptExp for GenericImage<'_>

fn calc_opt_exp( self, eval: &OptimumExposure, exposure: Duration, bin: u8, ) -> Result<(Duration, u16), &'static str>

Calculate the optimum exposure time and binning.

impl Clone for GenericImage<'_>

fn clone(&self) -> GenericImage<'_>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, 'b> Debayer<'a, 'b> for GenericImage<'b>

where 'a: 'b,

type Output = GenericImage<'a>

The output type of the debayering process.

fn debayer( &'b self, method: DemosaicMethod, ) -> Result<<GenericImage<'b> as Debayer<'a, 'b>>::Output, BayerError>

Debayer the image.

impl<'a> Debug for GenericImage<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<GenericImageOwned> for GenericImage<'_>

fn from(img: GenericImageOwned) -> GenericImage<'_>

Converts to this type from the input type.

impl<'a> From<GenericImageRef<'a>> for GenericImage<'a>

fn from(img: GenericImageRef<'a>) -> GenericImage<'a>

Converts to this type from the input type.

impl ImageProps for GenericImage<'_>

type OutputU8 = GenericImageOwned

The output type of ImageProps::cast_u8.

fn width(&self) -> usize

Get the width of the image.

fn height(&self) -> usize

Get the height of the image.

fn channels(&self) -> u8

Get the number of channels in the image.

fn color_space(&self) -> ColorSpace

Get the color space of the image.

fn pixel_type(&self) -> PixelType

Get the pixel type of the image.

fn len(&self) -> usize

Get the length of the image data.

fn is_empty(&self) -> bool

Check if the data is empty.

fn cast_u8(&self) -> <GenericImage<'_> as ImageProps>::OutputU8

Convert the image to a u8 image.

impl<'a> PartialEq for GenericImage<'a>

fn eq(&self, other: &GenericImage<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for GenericImage<'a>

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, 'b> ToLuma<'a, 'b> for GenericImage<'b>

where 'a: 'b,

type Output = GenericImageOwned

The output type of the conversion.

fn to_luma( &'b self, ) -> Result<<GenericImage<'b> as ToLuma<'a, 'b>>::Output, &'static str>

Convert the image to a luminance image.

fn to_luma_alpha( &'b self, ) -> Result<<GenericImage<'b> as ToLuma<'a, 'b>>::Output, &'static str>

Convert the image to a luminance alpha image.

fn to_luma_custom( &'b self, coeffs: [f64; 3], ) -> Result<<GenericImage<'b> as ToLuma<'a, 'b>>::Output, &'static str>

Convert the image to a luminance image with custom coefficients.

fn to_luma_alpha_custom( &'b self, coeffs: [f64; 3], ) -> Result<<GenericImage<'b> as ToLuma<'a, 'b>>::Output, &'static str>

Convert the image to a luminance image with custom coefficients.

impl<'a> TryInto<GenericImageRef<'a>> for GenericImage<'a>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<GenericImageRef<'a>, <GenericImage<'a> as TryInto<GenericImageRef<'a>>>::Error>

Performs the conversion.

impl<'a> StructuralPartialEq for GenericImage<'a>