Struct Psnr

source

pub struct Psnr<B: Backend> {
    pub coefficient: Tensor<B, 1>,
    pub mse: MeanSquareError,
}

Expand description

Computing the peak signal-to-noise ratio (PSNR) between the inputs:

10 * log10(1 / MSE) = -10 / log(10) * log(MSE)

§Details

It relies on MSE.

Fields§

§coefficient: Tensor<B, 1>

Coefficient for PSNR.

§mse: MeanSquareError

Inner metric.

Implementations§

source §

impl<B: Backend> Psnr

source

pub fn init(device: &B::Device) -> Self

Initialize the metric.

Trait Implementations§

source §

impl<B: Clone + Backend> Clone for Psnr

source §

fn clone(&self) -> Psnr

Returns a copy 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<B: Debug + Backend> Debug for Psnr

source §

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

Formats the value using the given formatter. Read more

source §

impl<B: Backend> Default for Psnr

source §

fn default() -> Self

Returns the “default value” for a type. Read more

source §

impl<B: Backend> Metric for Psnr

source §

fn evaluate<const D: usize>( &self, value: Tensor<B, D>, target: Tensor<B, D>, ) -> Tensor<B, 1>

§Returns

The peak signal-to-noise ratio (PSNR) with shape [1].

Auto Trait Implementations§

§

impl Freeze for Psnr
where ::FloatTensorPrimitive: Freeze, ::QuantizedTensorPrimitive: Freeze,

§

impl RefUnwindSafe for Psnr
where ::FloatTensorPrimitive: RefUnwindSafe, ::QuantizedTensorPrimitive: RefUnwindSafe,

§

impl Send for Psnr

§

impl Sync for Psnr

§

impl Unpin for Psnr
where ::FloatTensorPrimitive: Unpin, ::QuantizedTensorPrimitive: Unpin,

§

impl UnwindSafe for Psnr
where ::FloatTensorPrimitive: UnwindSafe, ::QuantizedTensorPrimitive: UnwindSafe,

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

§

fn from(t: T) -> T

Returns the argument unchanged.

source §

impl<T, U> Into 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

§