Struct opencv::quality::QualityPSNR

pub struct QualityPSNR { /* fields omitted */ }

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

Implementations

impl QualityPSNR

pub fn as_raw_QualityPSNR(&self) -> *const c_void

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

impl QualityPSNR

pub const MAX_PIXEL_VALUE_DEFAULT: f64

pub fn create(
    ref_: &dyn 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 compute(
    ref_: &dyn ToInputArray,
    cmp: &dyn ToInputArray,
    quality_map: &mut dyn 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

Trait Implementations

impl AlgorithmTrait for QualityPSNR

pub fn as_raw_Algorithm(&self) -> *const c_void

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

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

Clears the algorithm state

pub fn write(&self, fs: &mut FileStorage) -> Result<()>

Stores algorithm parameters in a file storage

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

simplified API for language bindings Stores algorithm parameters in a file storage

pub fn read(&mut self, fn_: &FileNode) -> Result<()>

Reads algorithm parameters from a file storage

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

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

pub 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).

pub 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

pub unsafe fn from_raw(ptr: *mut c_void) -> Self

Wrap the specified raw pointer

pub fn into_raw(self) -> *mut c_void

Return an the underlying raw pointer while consuming this wrapper.

pub fn as_raw(&self) -> *const c_void

Return the underlying raw pointer.

pub fn as_raw_mut(&mut self) -> *mut c_void

Return the underlying mutable raw pointer

impl Drop for QualityPSNR

pub fn drop(&mut self)

Executes the destructor for this type.

impl QualityBase for QualityPSNR

pub fn as_raw_QualityBase(&self) -> *const c_void

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

pub fn compute(&mut self, img: &dyn 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

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

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

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

Implements Algorithm::clear()

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

Implements Algorithm::empty()

impl QualityPSNRTrait for QualityPSNR

pub fn as_raw_QualityPSNR(&self) -> *const c_void

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

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

Compute the PSNR

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

Implements Algorithm::empty()

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

Implements Algorithm::clear()

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

return the maximum pixel value used for PSNR computation

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

sets the maximum pixel value used for PSNR computation

impl Send for QualityPSNR