Skip to main content

FeatureView

Struct FeatureView 

Source
pub struct FeatureView<'a> { /* private fields */ }
Expand description

Named view over a flat feature vector.

Provides ergonomic access to features by name, scale, and channel without changing the underlying storage format.

let result = z.compute_all_features(&src, &dst)?;
let view = FeatureView::new(result.features(), 4)?;
let ssim_mean_s0_y = view.ssim_mean(0, 1);
let ssim_max_s2_x = view.ssim_max(0, 2).unwrap();

Implementations§

Source§

impl<'a> FeatureView<'a>

Source

pub fn new(features: &'a [f64], n_scales: usize) -> Option<Self>

Create a view over a feature vector.

Automatically detects the tier (peaks/extended) from length. Returns None if the length doesn’t match any valid layout. Peaks are always present (basic-only 156-element vectors are no longer generated).

Source

pub fn n_scales(&self) -> usize

Number of scales in this feature vector.

Source

pub fn has_peaks(&self) -> bool

Whether peak features (max/L8) are present.

Source

pub fn has_masked(&self) -> bool

Whether masked features are present.

Source

pub fn ssim_mean(&self, scale: usize, ch: usize) -> f64

SSIM error, mean pooling.

Source

pub fn ssim_4th(&self, scale: usize, ch: usize) -> f64

SSIM error, L4 norm.

Source

pub fn ssim_2nd(&self, scale: usize, ch: usize) -> f64

SSIM error, L2 norm.

Source

pub fn art_mean(&self, scale: usize, ch: usize) -> f64

Edge artifact (ringing), mean pooling.

Source

pub fn art_4th(&self, scale: usize, ch: usize) -> f64

Edge artifact, L4 norm.

Source

pub fn art_2nd(&self, scale: usize, ch: usize) -> f64

Edge artifact, L2 norm.

Source

pub fn det_mean(&self, scale: usize, ch: usize) -> f64

Edge detail lost (blur), mean pooling.

Source

pub fn det_4th(&self, scale: usize, ch: usize) -> f64

Edge detail lost, L4 norm.

Source

pub fn det_2nd(&self, scale: usize, ch: usize) -> f64

Edge detail lost, L2 norm.

Source

pub fn mse(&self, scale: usize, ch: usize) -> f64

Mean squared error.

Source

pub fn hf_energy_loss(&self, scale: usize, ch: usize) -> f64

High-frequency energy loss ratio.

Source

pub fn hf_mag_loss(&self, scale: usize, ch: usize) -> f64

High-frequency magnitude loss ratio.

Source

pub fn hf_energy_gain(&self, scale: usize, ch: usize) -> f64

High-frequency energy gain ratio.

Source

pub fn ssim_max(&self, scale: usize, ch: usize) -> Option<f64>

SSIM error, pixel-wise max.

Source

pub fn art_max(&self, scale: usize, ch: usize) -> Option<f64>

Edge artifact, pixel-wise max.

Source

pub fn det_max(&self, scale: usize, ch: usize) -> Option<f64>

Edge detail lost, pixel-wise max.

Source

pub fn ssim_l8(&self, scale: usize, ch: usize) -> Option<f64>

SSIM error, L8 norm (Σd⁸/N)^(1/8).

Source

pub fn art_l8(&self, scale: usize, ch: usize) -> Option<f64>

Edge artifact, L8 norm.

Source

pub fn det_l8(&self, scale: usize, ch: usize) -> Option<f64>

Edge detail lost, L8 norm.

Source

pub fn masked_ssim_mean(&self, scale: usize, ch: usize) -> Option<f64>

Masked SSIM error, mean pooling.

Source

pub fn masked_ssim_4th(&self, scale: usize, ch: usize) -> Option<f64>

Masked SSIM error, L4 norm.

Source

pub fn masked_ssim_2nd(&self, scale: usize, ch: usize) -> Option<f64>

Masked SSIM error, L2 norm.

Source

pub fn masked_art_4th(&self, scale: usize, ch: usize) -> Option<f64>

Masked edge artifact, L4 norm.

Source

pub fn masked_det_4th(&self, scale: usize, ch: usize) -> Option<f64>

Masked edge detail lost, L4 norm.

Source

pub fn masked_mse(&self, scale: usize, ch: usize) -> Option<f64>

Masked MSE.

Source

pub fn scored_features(&self) -> &[f64]

Get the scored features slice (first N features, WEIGHTS-compatible).

Source

pub fn peak_features(&self) -> Option<&[f64]>

Get the peak features slice, if present.

Source

pub fn masked_features(&self) -> Option<&[f64]>

Get the masked features slice, if present.

Trait Implementations§

Source§

impl<'a> Clone for FeatureView<'a>

Source§

fn clone(&self) -> FeatureView<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for FeatureView<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for FeatureView<'a>

§

impl<'a> RefUnwindSafe for FeatureView<'a>

§

impl<'a> Send for FeatureView<'a>

§

impl<'a> Sync for FeatureView<'a>

§

impl<'a> Unpin for FeatureView<'a>

§

impl<'a> UnsafeUnpin for FeatureView<'a>

§

impl<'a> UnwindSafe for FeatureView<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.