Baillehache Pascal's personal website

LibCapy - imgKernel

Kernel class to perform operations on 2D images.

Macros:

#define CAPY_IMGKERNEL_H

Enumerations:

None.

Typedefs:

None.

Struct CapyImgKernel :

Struct CapyImgKernel's properties:

  CapyImgDims_t size;

Size of the kernel

  CapyPad(CapyImgDims_t, size);

  double* mat;

Kernel matrix (the kernel matrix is a (1+2*size)x(1+2*size) matrix). Values stored by rows.

  size_t sizeMat;

Size of the kernel matrix

  CapyRangeImgPos range;

Range to loop on the kernel values

Struct CapyImgKernel's methods:

  void (*destruct)(void);

Destructor

  CapyImg* (*apply)(CapyImg const* const img);

Convolve the kernel on a given image

Input argument(s):

img: the image to which the kernel is applied

Output and side effect(s):

Return the result of the convolution as a newly allocated image

Exception(s):

May raise CapyExc_MallocFailed.

  void (*setToIdentity)(void);

Set the kernel to the identity

  void (*setToGaussianBlur)(double const stdDev);

Set the kernel to Gaussian blur (the kernel is normalised)

Input argument(s):

stdDev: the standard deviation (in pixels) of the blur

Exception(s):

May raise CapyExc_MallocFailed.

  void (*setToDerivativeGaussianBlur)(
    double const stdDev,
    size_t const axis);

Set the kernel to derivative Gaussian blur along a given axis

Input argument(s):

stdDev: the standard deviation (in pixels) of the blur
axis: axis of derivation (0:x, 1:y)

Exception(s):

May raise CapyExc_MallocFailed.

  void (*setToSharpen)(void);

Set the kernel to the sharpen kernel (only center 3x3 is used)

  void (*setToEdgeDetection)(void);

Set the kernel to the edge detection kernel (only center 3x3 is used)

  void (*setToSobelX)(void);

Set the kernel to the Sobel operator on X axis (only center 3x3 is used)

  void (*setToSobelY)(void);

Set the kernel to the Sobel operator on Y axis (only center 3x3 is used)

  void (*setToLaplace)(void);

Set the kernel to the Discrete Laplace operator (only center 3x3 is used)

Functions:

CapyImgKernel CapyImgKernelCreate(CapyImgDims_t const size);

Create a CapyImgKernel

Input argument(s):

size: the size of the kernel (the kernel matrix is a (1+2*size)x(1+2*size) matrix)

Output and side effect(s):

Return a CapyImgKernel with identity matrix (in kernel sense)

Exception(s):

May raise CapyExc_MallocFailed.

CapyImgKernel* CapyImgKernelAlloc(CapyImgDims_t const size);

Allocate memory for a new CapyImgKernel and create it

Input argument(s):

size: the size of the kernel (the kernel matrix is a (1+2*size)x(1+2*size) matrix)

Output and side effect(s):

Return a CapyImgKernel with identity matrix (in kernel sense)

Exception(s):

May raise CapyExc_MallocFailed.

void CapyImgKernelFree(CapyImgKernel** const that);

Free the memory used by a CapyImgKernel* and reset '*that' to NULL

Input argument(s):

that: a pointer to the CapyImgKernel to free

2022-03-22
in LibCapy,
105 views