Enrollment 28.2.0
Loading...
Searching...
No Matches
Image::AreaImageResampler Class Reference

Image resampler for DPI-change operations, including upsampling and downsampling using area interpolation resampling algorithm. More...

#include <Image.h>

Collaboration diagram for Image::AreaImageResampler:

Public Member Functions

 AreaImageResampler (ImageDpi targetDpi)
 Constructs pixel-area-relation interpolation image resampler for a target DPI.
std::shared_ptr< Image > Resample (const inno::Image &image) const final
 Resample image to a target DPI using pixel-area-relation interpolation.

Protected Member Functions

ImageDpi GetDpi () const
 Retrieves target DPI of the resampler.

Detailed Description

Image resampler for DPI-change operations, including upsampling and downsampling using area interpolation resampling algorithm.

Constructor & Destructor Documentation

◆ AreaImageResampler()

AreaImageResampler ( ImageDpi targetDpi)
inlineexplicit

Constructs pixel-area-relation interpolation image resampler for a target DPI.

This constructor initializes the image resampler to resample an image to the specified DPI using pixel-area-relation interpolation. In most cases, this resampler provides the fastest resampling among the Enrollment SDK resamplers.

Parameters
targetDpiThe DPI (dots per inch) of the new image.
Exceptions
EnrollmentInvalidArgumentExceptionwhen targetDpi is 0

References Image::ImageResampler::ImageResampler().

Here is the call graph for this function:

Member Function Documentation

◆ GetDpi()

ImageDpi GetDpi ( ) const
inlinenodiscardprotectedinherited

Retrieves target DPI of the resampler.

Returns
The target DPI (dots per inch) of the resampler

Referenced by Image::AreaImageResampler::Resample(), Image::BicubicImageResampler::Resample(), and Image::NISTImageResampler::Resample().

Here is the caller graph for this function:

◆ Resample()

std::shared_ptr< Image > Resample ( const inno::Image & image) const
inlinenodiscardfinalvirtual

Resample image to a target DPI using pixel-area-relation interpolation.

It creates new image as result of resampling with factor target DPI/original DPI. In most cases, this resampling method provides the fastest resampling among the Enrollment SDK resamplers.

Parameters
imageImage to resize.
Returns
image with given DPI
Exceptions
ImageExceptionwhen there is an processing error

Implements Image::ImageResampler.

References Image::ImageResampler::GetDpi().

Here is the call graph for this function:

The documentation for this class was generated from the following file: