Struct QualityPSNR

pub struct QualityPSNR { /* private fields */ }

Full reference peak signal to noise ratio (PSNR) algorithm https://en.wikipedia.org/wiki/Peak_signal-to-noise_ratio

Implementations

impl QualityPSNR

pub const MAX_PIXEL_VALUE_DEFAULT: f64 = 255f64

pub fn create( ref_: &impl ToInputArray, max_pixel_value: f64, ) -> Result<Ptr<QualityPSNR>>

Create an object which calculates quality

Parameters

• ref: input image to use as the source for comparison
• maxPixelValue: maximum per-channel value for any individual pixel; eg 255 for uint8 image

C++ default parameters

• max_pixel_value: QualityPSNR::MAX_PIXEL_VALUE_DEFAULT

pub fn create_def(ref_: &impl ToInputArray) -> Result<Ptr<QualityPSNR>>

Create an object which calculates quality

Parameters

• ref: input image to use as the source for comparison
• maxPixelValue: maximum per-channel value for any individual pixel; eg 255 for uint8 image

Note

This alternative version of QualityPSNR::create function uses the following default values for its arguments:

• max_pixel_value: QualityPSNR::MAX_PIXEL_VALUE_DEFAULT

pub fn compute( ref_: &impl ToInputArray, cmp: &impl ToInputArray, quality_map: &mut impl ToOutputArray, max_pixel_value: f64, ) -> Result<Scalar>

static method for computing quality

Parameters

• ref: reference image
• cmp: comparison image
• qualityMap: output quality map, or cv::noArray()
• maxPixelValue: maximum per-channel value for any individual pixel; eg 255 for uint8 image

Returns

PSNR value, or std::numeric_limits::infinity() if the MSE between the two images == 0

C++ default parameters

• max_pixel_value: QualityPSNR::MAX_PIXEL_VALUE_DEFAULT

pub fn compute_def( ref_: &impl ToInputArray, cmp: &impl ToInputArray, quality_map: &mut impl ToOutputArray, ) -> Result<Scalar>

static method for computing quality

Parameters

• ref: reference image
• cmp: comparison image
• qualityMap: output quality map, or cv::noArray()
• maxPixelValue: maximum per-channel value for any individual pixel; eg 255 for uint8 image

Returns

PSNR value, or std::numeric_limits::infinity() if the MSE between the two images == 0

Note

This alternative version of QualityPSNR::compute function uses the following default values for its arguments:

• max_pixel_value: QualityPSNR::MAX_PIXEL_VALUE_DEFAULT

Trait Implementations

impl AlgorithmTrait for QualityPSNR

fn as_raw_mut_Algorithm(&mut self) -> *mut c_void

fn clear(&mut self) -> Result<()>

Clears the algorithm state

fn read(&mut self, fn_: &impl FileNodeTraitConst) -> Result<()>

Reads algorithm parameters from a file storage

impl AlgorithmTraitConst for QualityPSNR

fn as_raw_Algorithm(&self) -> *const c_void

fn write(&self, fs: &mut impl FileStorageTrait) -> Result<()>

Stores algorithm parameters in a file storage

fn write_1(&self, fs: &mut impl FileStorageTrait, name: &str) -> Result<()>

Stores algorithm parameters in a file storage

fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>

@deprecated

fn write_with_name_def(&self, fs: &Ptr<FileStorage>) -> Result<()>

👎Deprecated:

Note

Deprecated: ## Note This alternative version of AlgorithmTraitConst::write_with_name function uses the following default values for its arguments:

fn empty(&self) -> Result<bool>

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

fn save(&self, filename: &str) -> Result<()>

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

fn get_default_name(&self) -> Result<String>

Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.

impl Boxed for QualityPSNR

unsafe fn from_raw( ptr: <QualityPSNR as OpenCVFromExtern>::ExternReceive, ) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <QualityPSNR as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <QualityPSNR as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self, ) -> <QualityPSNR as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for QualityPSNR

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

Formats the value using the given formatter.

impl Drop for QualityPSNR

fn drop(&mut self)

Executes the destructor for this type.

impl From<QualityPSNR> for Algorithm

fn from(s: QualityPSNR) -> Self

Converts to this type from the input type.

impl From<QualityPSNR> for QualityBase

fn from(s: QualityPSNR) -> Self

Converts to this type from the input type.

impl QualityBaseTrait for QualityPSNR

fn as_raw_mut_QualityBase(&mut self) -> *mut c_void

fn compute(&mut self, img: &impl ToInputArray) -> Result<Scalar>

Compute quality score per channel with the per-channel score in each element of the resulting cv::Scalar. See specific algorithm for interpreting result scores

fn clear(&mut self) -> Result<()>

Implements Algorithm::clear()

impl QualityBaseTraitConst for QualityPSNR

fn as_raw_QualityBase(&self) -> *const c_void

fn get_quality_map(&self, dst: &mut impl ToOutputArray) -> Result<()>

Returns output quality map that was generated during computation, if supported by the algorithm

fn empty(&self) -> Result<bool>

Implements Algorithm::empty()

impl QualityPSNRTrait for QualityPSNR

fn as_raw_mut_QualityPSNR(&mut self) -> *mut c_void

fn compute(&mut self, cmp: &impl ToInputArray) -> Result<Scalar>

Compute the PSNR

fn clear(&mut self) -> Result<()>

Implements Algorithm::clear()

fn set_max_pixel_value(&mut self, val: f64) -> Result<()>

sets the maximum pixel value used for PSNR computation

impl QualityPSNRTraitConst for QualityPSNR

fn as_raw_QualityPSNR(&self) -> *const c_void

fn empty(&self) -> Result<bool>

Implements Algorithm::empty()

fn get_max_pixel_value(&self) -> Result<f64>

return the maximum pixel value used for PSNR computation

impl TryFrom<QualityBase> for QualityPSNR

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: QualityBase) -> Result<Self>

Performs the conversion.

impl Send for QualityPSNR