openshot-audio  0.1.7
Public Member Functions | List of all members
ImageConvolutionKernel Class Reference

#include <juce_ImageConvolutionKernel.h>

Public Member Functions

 ImageConvolutionKernel (int size)
 
 ~ImageConvolutionKernel ()
 
void clear ()
 
float getKernelValue (int x, int y) const noexcept
 
void setKernelValue (int x, int y, float value) noexcept
 
void setOverallSum (float desiredTotalSum)
 
void rescaleAllValues (float multiplier)
 
void createGaussianBlur (float blurRadius)
 
int getKernelSize () const
 
void applyToImage (Image &destImage, const Image &sourceImage, const Rectangle< int > &destinationArea) const
 

Detailed Description

Represents a filter kernel to use in convoluting an image.

See Also
Image::applyConvolution

Constructor & Destructor Documentation

ImageConvolutionKernel::ImageConvolutionKernel ( int  size)

Creates an empty convulution kernel.

Parameters
sizethe length of each dimension of the kernel, so e.g. if the size is 5, it will create a 5x5 kernel
ImageConvolutionKernel::~ImageConvolutionKernel ( )

Destructor.

Member Function Documentation

void ImageConvolutionKernel::applyToImage ( Image destImage,
const Image sourceImage,
const Rectangle< int > &  destinationArea 
) const

Applies the kernel to an image.

Parameters
destImagethe image that will receive the resultant convoluted pixels.
sourceImagethe source image to read from - this can be the same image as the destination, but if different, it must be exactly the same size and format.
destinationAreathe region of the image to apply the filter to
void ImageConvolutionKernel::clear ( )

Resets all values in the kernel to zero.

void ImageConvolutionKernel::createGaussianBlur ( float  blurRadius)

Intialises the kernel for a gaussian blur.

Parameters
blurRadiusthis may be larger or smaller than the kernel's actual size but this will obviously be wasteful or clip at the edges. Ideally the kernel should be just larger than (blurRadius * 2).
int ImageConvolutionKernel::getKernelSize ( ) const
inline

Returns the size of the kernel.

E.g. if it's a 3x3 kernel, this returns 3.

float ImageConvolutionKernel::getKernelValue ( int  x,
int  y 
) const
noexcept

Returns one of the kernel values.

void ImageConvolutionKernel::rescaleAllValues ( float  multiplier)

Multiplies all values in the kernel by a value.

void ImageConvolutionKernel::setKernelValue ( int  x,
int  y,
float  value 
)
noexcept

Sets the value of a specific cell in the kernel.

The x and y parameters must be in the range 0 < x < getKernelSize().

See Also
setOverallSum
void ImageConvolutionKernel::setOverallSum ( float  desiredTotalSum)

Rescales all values in the kernel to make the total add up to a fixed value.

This will multiply all values in the kernel by (desiredTotalSum / currentTotalSum).


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