JUCE
|
Represents a filter kernel to use in convoluting an image. More...
Public Member Functions | |
ImageConvolutionKernel (int size) | |
Creates an empty convulution kernel. More... | |
~ImageConvolutionKernel () | |
Destructor. More... | |
void | clear () |
Resets all values in the kernel to zero. More... | |
float | getKernelValue (int x, int y) const noexcept |
Returns one of the kernel values. More... | |
void | setKernelValue (int x, int y, float value) noexcept |
Sets the value of a specific cell in the kernel. More... | |
void | setOverallSum (float desiredTotalSum) |
Rescales all values in the kernel to make the total add up to a fixed value. More... | |
void | rescaleAllValues (float multiplier) |
Multiplies all values in the kernel by a value. More... | |
void | createGaussianBlur (float blurRadius) |
Intialises the kernel for a gaussian blur. More... | |
int | getKernelSize () const |
Returns the size of the kernel. More... | |
void | applyToImage (Image &destImage, const Image &sourceImage, const Rectangle< int > &destinationArea) const |
Applies the kernel to an image. More... | |
Represents a filter kernel to use in convoluting an image.
ImageConvolutionKernel::ImageConvolutionKernel | ( | int | size | ) |
Creates an empty convulution kernel.
size | the length of each dimension of the kernel, so e.g. if the size is 5, it will create a 5x5 kernel |
ImageConvolutionKernel::~ImageConvolutionKernel | ( | ) |
Destructor.
void ImageConvolutionKernel::clear | ( | ) |
Resets all values in the kernel to zero.
|
noexcept |
Returns one of the kernel values.
|
noexcept |
Sets the value of a specific cell in the kernel.
The x and y parameters must be in the range 0 < x < getKernelSize().
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).
void ImageConvolutionKernel::rescaleAllValues | ( | float | multiplier | ) |
Multiplies all values in the kernel by a value.
void ImageConvolutionKernel::createGaussianBlur | ( | float | blurRadius | ) |
Intialises the kernel for a gaussian blur.
blurRadius | this 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 |
Returns the size of the kernel.
E.g. if it's a 3x3 kernel, this returns 3.
References JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR.
void ImageConvolutionKernel::applyToImage | ( | Image & | destImage, |
const Image & | sourceImage, | ||
const Rectangle< int > & | destinationArea | ||
) | const |
Applies the kernel to an image.
destImage | the image that will receive the resultant convoluted pixels. |
sourceImage | the 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. |
destinationArea | the region of the image to apply the filter to |