Enum cameraunit::DynamicSerialImage

pub enum DynamicSerialImage {
    U8(SerialImageBuffer<u8>),
    U16(SerialImageBuffer<u16>),
    F32(SerialImageBuffer<f32>),
}

Dynamic serial image enumeration. This data type encapsulates the specific serial image data types.

The enumeration variants are DynamicSerialImage::U8, DynamicSerialImage::U16, DynamicSerialImage::F32.

Traits

DynamicSerialImage implements the std::clone::Clone, std::convert::From, std::convert::TryFrom, std::convert::Into and std::fmt::Debug traits.

Specifically, the following conversions are implemented:

With std::convert::From:

• DynamicSerialImage <-> DynamicImage
• DynamicSerialImage <- SerialImageBuffer<u8>
• DynamicSerialImage <- SerialImageBuffer<u16>
• DynamicSerialImage <- SerialImageBuffer<f32>

With std::convert::TryFrom:

• DynamicImage <-> SerialImageBuffer<u8>
• DynamicImage <-> SerialImageBuffer<u16>
• DynamicImage <-> SerialImageBuffer<f32>

Variants

U8(SerialImageBuffer<u8>)

8-bit unsigned integer image data.

U16(SerialImageBuffer<u16>)

16-bit unsigned integer image data.

F32(SerialImageBuffer<f32>)

32-bit floating point image data.

Implementations

impl DynamicSerialImage

pub fn get_metadata(&self) -> Option<ImageMetaData>

Get the image metadata.

pub fn set_metadata(&mut self, meta: ImageMetaData)

Update the image metadata.

pub fn width(&self) -> usize

Get image width.

pub fn height(&self) -> usize

Get image height.

pub fn as_u8(&self) -> Option<&SerialImageBuffer<u8>>

Get the underlying SerialImageBuffer<u8> if the image is of type DynamicSerialImage::U8.

pub fn as_u16(&self) -> Option<&SerialImageBuffer<u16>>

Get the underlying SerialImageBuffer<u16> if the image is of type DynamicSerialImage::U16.

pub fn as_f32(&self) -> Option<&SerialImageBuffer<f32>>

Get the underlying SerialImageBuffer<f32> if the image is of type DynamicSerialImage::F32.

pub fn into_luma(&self) -> SerialImageBuffer<u16>

Convert the image to grayscale. The transformation used is 0.2162 * red + 0.7152 * green + 0.0722 * blue for converting RGB to grayscale (see here).

pub fn into_luma_alpha(&self) -> SerialImageBuffer<u16>

Convert the image to grayscale with alpha channel. The transformation used is 0.2162 * red + 0.7152 * green + 0.0722 * blue for converting RGB to grayscale (see here).

pub fn resize( self, nwidth: usize, nheight: usize, filter: FilterType ) -> DynamicSerialImage

Resize this image using the specified filter algorithm. Returns a new image. The image’s aspect ratio is preserved. The image is scaled to the maximum possible size that fits within the bounds specified by nwidth and nheight.

pub fn save(&self, path: &str) -> Result<(), ImageError>

Saves the buffer to a file at the path specified.

The image format is derived from the file extension. png, jpg, bmp, ico, tiff and exr files are supported.

pub fn savefits( &self, dir_prefix: &Path, file_prefix: &str, progname: Option<&str>, compress: bool, overwrite: bool ) -> Result<PathBuf, Error>

Save the image data to a FITS file.

Arguments

• dir_prefix - The directory where the file will be saved.
• file_prefix - The prefix of the file name. The file name will be of the form {file_prefix}_{timestamp}.fits.
• progname - The name of the program that generated the image.
• compress - Whether to compress the FITS file.
• overwrite - Whether to overwrite the file if it already exists.

Errors

• fitsio::errors::Error with the error description.

impl DynamicSerialImage

pub fn from_vec_u8( width: usize, height: usize, data: Vec<u8> ) -> Result<DynamicSerialImage, &'static str>

Create a new image from a vector of u8 pixels.

Arguments

• width - The width of the image.
• height - The height of the image.
• data - The image data as a vector of u8 pixels.

Errors

• Error messages as strings.

Note: The length of the vector must be width * height * channels.

• For grayscale images, channels is 1.
• For grayscale images with alpha channel, channels is 2.
• For RGB images, channels is 3.
• For RGBA images, channels is 4.

pub fn from_vec_u16( width: usize, height: usize, data: Vec<u16> ) -> Result<DynamicSerialImage, &'static str>

Create a new image from a vector of u16 pixels.

Arguments

• width - The width of the image.
• height - The height of the image.
• data - The image data as a vector of u16 pixels.

Errors

• Error messages as strings.

Note: The length of the vector must be width * height * channels.

• For grayscale images, channels is 1.
• For grayscale images with alpha channel, channels is 2.
• For RGB images, channels is 3.
• For RGBA images, channels is 4.

pub fn from_vec_f32( width: usize, height: usize, data: Vec<f32> ) -> Result<DynamicSerialImage, &'static str>

Create a new image from a vector of f32 pixels.

Arguments

• width - The width of the image.
• height - The height of the image.
• data - The image data as a vector of f32 pixels.

Errors

• Error messages as strings.

Note: The length of the vector must be width * height * channels. Grayscale images are not supported.

• For RGB images, channels is 3.
• For RGBA images, channels is 4.

Trait Implementations

impl Clone for DynamicSerialImage

fn clone(&self) -> DynamicSerialImage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicSerialImage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DynamicSerialImage

fn deserialize<__D>( __deserializer: __D ) -> Result<DynamicSerialImage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&DynamicImage> for DynamicSerialImage

fn from(value: &DynamicImage) -> DynamicSerialImage

Converts to this type from the input type.

impl From<&SerialImageBuffer<f32>> for DynamicSerialImage

fn from(value: &SerialImageBuffer<f32>) -> DynamicSerialImage

Converts to this type from the input type.

impl From<&SerialImageBuffer<u16>> for DynamicSerialImage

fn from(value: &SerialImageBuffer<u16>) -> DynamicSerialImage

Converts to this type from the input type.

impl From<&SerialImageBuffer<u8>> for DynamicSerialImage

fn from(value: &SerialImageBuffer<u8>) -> DynamicSerialImage

Converts to this type from the input type.

impl From<DynamicImage> for DynamicSerialImage

fn from(value: DynamicImage) -> DynamicSerialImage

Converts to this type from the input type.

impl From<SerialImageBuffer<f32>> for DynamicSerialImage

fn from(value: SerialImageBuffer<f32>) -> DynamicSerialImage

Converts to this type from the input type.

impl From<SerialImageBuffer<u16>> for DynamicSerialImage

fn from(value: SerialImageBuffer<u16>) -> DynamicSerialImage

Converts to this type from the input type.

impl From<SerialImageBuffer<u8>> for DynamicSerialImage

fn from(value: SerialImageBuffer<u8>) -> DynamicSerialImage

Converts to this type from the input type.

impl PartialEq for DynamicSerialImage

fn eq(&self, other: &DynamicSerialImage) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for DynamicSerialImage

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 TryInto<SerialImageBuffer<f32>> for &DynamicSerialImage

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<SerialImageBuffer<f32>, &'static str>

Performs the conversion.

impl TryInto<SerialImageBuffer<f32>> for DynamicSerialImage

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<SerialImageBuffer<f32>, &'static str>

Performs the conversion.

impl TryInto<SerialImageBuffer<u16>> for &DynamicSerialImage

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<SerialImageBuffer<u16>, &'static str>

Performs the conversion.

impl TryInto<SerialImageBuffer<u16>> for DynamicSerialImage

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<SerialImageBuffer<u16>, &'static str>

Performs the conversion.

impl TryInto<SerialImageBuffer<u8>> for &DynamicSerialImage

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<SerialImageBuffer<u8>, &'static str>

Performs the conversion.

impl TryInto<SerialImageBuffer<u8>> for DynamicSerialImage

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<SerialImageBuffer<u8>, &'static str>

Performs the conversion.

impl StructuralPartialEq for DynamicSerialImage