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 timestamp(&self) -> DateTime<Utc>

The UTC timestamp of the image.

pub fn exposure(&self) -> Duration

The exposure time of the image (Duration::ZERO if not applicable).

pub fn set_exposure(&mut self, exposure: Duration)

Set the exposure time of the image.

pub fn frame_id(&self) -> Option<u32>

The acquisition frame ID of the image, or None if unset.

pub fn set_frame_id(&mut self, frame_id: u32)

Set the acquisition frame ID of the image.

pub fn insert_key<T>( &mut self, name: &str, value: T, ) -> Result<(), MetadataError>

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 a UTC chrono::DateTime 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 | chrono::DateTime<Utc>
• 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 a UTC chrono::DateTime is stored as two consecutive metadata items split into seconds and nanoseconds (keys suffixed _S and _NS), plus a base card.

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

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<GenericLineItem, MetadataError>

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 a UTC chrono::DateTime 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 image(&self) -> DynamicImageView<'_>

A read-only, type-erased DynamicImageView over the samples, whichever half this GenericImage holds.

pub fn metadata(&self) -> &Metadata

Borrow the image’s Metadata.

pub fn metadata_mut(&mut self) -> &mut Metadata

Mutably borrow the image’s Metadata.

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

A specific extra metadata item by name (case-insensitive).

pub fn into_owned(self) -> GenericImageOwned

Convert into an owned GenericImageOwned, copying the samples when this is the borrowed half.

impl GenericImage<'_>

pub fn optimum_exposure( &mut self, eval: &OptimumExposure, bin: u16, ) -> Result<OptimumExposureResult, ExposureError>

Optimum exposure and binning, using this image’s own recorded exposure.

Errors

ExposureError::ZeroExposure if the recorded exposure is Duration::ZERO, otherwise see ExposureError.

Trait Implementations

impl CalcOptExp for GenericImage<'_>

fn calc_opt_exp( &mut self, eval: &OptimumExposure, exposure: Duration, bin: u16, ) -> Result<OptimumExposureResult, ExposureError>

Calculate the optimum exposure and binning.

impl Clone for GenericImage<'_>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl FitsWrite for GenericImage<'_>

fn write_fits<P, C>( &self, path: P, compress: C, overwrite: bool, ) -> Result<PathBuf, FitsError>

where P: AsRef<Path>, C: Into<FitsCompression>,

Write the image to path (created, or truncated if overwrite). Returns path.

fn write_fits_to<W, C>(&self, sink: W, compress: C) -> Result<(), FitsError>

where W: Write, C: Into<FitsCompression>,

Write the image to any Write sink (no filesystem needed).

fn append_fits<W>(&self, writer: &mut FitsWriter<W>) -> Result<(), FitsError>

where W: Write,

Append the image as a new HDU of an open FitsWriter (file- or memory-backed).

fn fits_bytes<C>(&self, compress: C) -> Result<Vec<u8>, FitsError>

where C: Into<FitsCompression>,

Serialise the image to an in-memory FITS file.

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<'_>

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.

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

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

Equality operator ==.

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

Inequality operator !=.

impl PixelData for GenericImage<'_>

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

The whole sample buffer reinterpreted as bytes (native endianness).

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

as_raw_u8, but None on a reinterpret-cast failure instead of panicking.

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

The samples as &[u8], or None unless the element type is u8.

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

The samples as &mut [u8], or None unless the element type is u8.

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

The samples as &[u16], or None unless the element type is u16.

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

The samples as &mut [u16], or None unless the element type is u16.

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

The samples as &[f32], or None unless the element type is f32.

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

The samples as &mut [f32], or None unless the element type is f32.

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> StructuralPartialEq for GenericImage<'a>

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.