Sirius  0.0.0
Public Types | Public Member Functions | List of all members
sirius::IFrequencyResampler Class Referenceabstract

Interface that frequency resampler should implement. More...

#include <sirius/i_frequency_resampler.h>

Inheritance diagram for sirius::IFrequencyResampler:
sirius::resampler::FrequencyResampler< ImageDecompositionPolicy, ZoomStrategy >

Public Types

using UPtr = std::unique_ptr< IFrequencyResampler >
 

Public Member Functions

virtual ~IFrequencyResampler ()=default
 
virtual Image Compute (const ZoomRatio &zoom_ratio, const Image &input, const Padding &image_padding, const Filter &filter={}) const =0
 Resample an image by a ratio in the frequency domain. More...
 

Detailed Description

Interface that frequency resampler should implement.

Member Typedef Documentation

◆ UPtr

Constructor & Destructor Documentation

◆ ~IFrequencyResampler()

virtual sirius::IFrequencyResampler::~IFrequencyResampler ( )
virtualdefault

Member Function Documentation

◆ Compute()

virtual Image sirius::IFrequencyResampler::Compute ( const ZoomRatio zoom_ratio,
const Image input,
const Padding image_padding,
const Filter filter = {} 
) const
pure virtual

Resample an image by a ratio in the frequency domain.

Remarks
This method is thread safe
Parameters
zoom_ratiozoom ratio
inputimage to zoom in/out
image_paddingexpected padding to add to the image to comply with the filter
filteroptional filter to apply after the zoom transformation. The filter must be compatible with the requested ratio.
Returns
Zoomed in/out image
Exceptions
sirius::Exceptionif a computing issue happens

Implemented in sirius::resampler::FrequencyResampler< ImageDecompositionPolicy, ZoomStrategy >.


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