Struct Image 

pub struct Image {
    pub shape: Vec<usize>,
    pub samples: ImageData,
    pub scaling: Scaling,
}

An N-dimensional image: a flat, Fortran-ordered buffer (axis 0 varies fastest), the axis lengths from NAXISn, and the scaling map that turns its stored (raw) samples into physical values.

Fields

shape: Vec<usize>

samples: ImageData

scaling: Scaling

Implementations

impl Image

pub fn from_u16(shape: Vec<usize>, data: &[u16]) -> Image

Build an image storing a u16 buffer via the FITS unsigned convention (BITPIX = 16, BZERO = 2¹⁵, BSCALE = 1) — the inverse of Image::unsigned. The writer emits the BZERO keyword so it round-trips.

pub fn from_u32(shape: Vec<usize>, data: &[u32]) -> Image

Build an image storing a u32 buffer (BITPIX = 32, BZERO = 2³¹).

pub fn from_u64(shape: Vec<usize>, data: &[u64]) -> Image

Build an image storing a u64 buffer (BITPIX = 64, BZERO = 2⁶³).

pub fn from_i8(shape: Vec<usize>, data: &[i8]) -> Image

Build an image storing a signed-i8 buffer (BITPIX = 8, BZERO = -128).

pub fn unsigned(&self) -> Option<UnsignedView>

Reinterpret the stored buffer as exact typed integers when the scaling is precisely a FITS unsigned-integer (or signed-byte) convention: BSCALE == 1, no BLANK, and BZERO the matching sign-bit offset. Unlike Image::physical, this is exact for all 64-bit values (no f64 rounding past 2⁵³). Returns None for any other scaling or element type.

pub fn physical(&self) -> Vec<f64>

The physical-plane values: BZERO + BSCALE × sample for every sample (§3.4). Integer samples equal to the BLANK sentinel become NaN; float NaN/Inf pass through. The unsigned-integer convention falls out for free — e.g. a signed-16 buffer with BZERO = 32768 yields the u16 value.

pub fn physical_f32(&self) -> Vec<f32>

The physical plane narrowed to f32 in a single pass — the compact, lossy counterpart to physical; see RawImage::physical_f32.

pub fn sample_type(&self) -> SampleType

The effective element type these samples represent, resolving the unsigned and signed-byte conventions from the stored BITPIX + Scaling.

impl Image

pub fn physical_array(&self) -> ArrayD<f64>

Available on crate feature ndarray only.

The physical plane as an N-d f64 array (BZERO + BSCALE × sample, BLANK → NaN), in FITS axis order — index arr[[x, y]].

pub fn into_ndarray(self) -> ImageArray

Available on crate feature ndarray only.

Move the samples into a typed N-d ImageArray, in FITS axis order — zero-copy.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.