Main Page   Modules   Compound List   File List   Compound Members   File Members  

convolve1D.h File Reference

#include <gandalf/vision/mask1D.h>
#include <gandalf/image/image_defs.h>
#include <gandalf/image/image_channel.h>

Go to the source code of this file.

Functions

Gan_Bool gan_convolve1D_f (float *source, int sstride, float *dest, int dstride, Gan_Mask1D *mask, unsigned int dsize)
 1D convolution function for float arrays.

Gan_Bool gan_convolve1D_d (double *source, int sstride, double *dest, int dstride, Gan_Mask1D *mask, unsigned int dsize)
 1D convolution function for double arrays.

Gan_Bool gan_convolve1D_i (int *source, int sstride, int *dest, int dstride, Gan_Mask1D *mask, unsigned int dsize)
 1D convolution function for integer arrays.

Gan_Bool gan_convolve_circular1D_f (float *source, int sstride, float *dest, int dstride, Gan_Mask1D *mask, unsigned int dsize)
 Circular 1D convolution function for float arrays.

Gan_Bool gan_convolve_circular1D_d (double *source, int sstride, double *dest, int dstride, Gan_Mask1D *mask, unsigned int dsize)
 Circular 1D convolution function for double arrays.

Gan_Imagegan_image_convolve1Dx_q (Gan_Image *image, Gan_ImageChannelType channel, Gan_Mask1D *mask, Gan_Image *dest)
 Convolves an image in the x-direction.

Gan_Imagegan_image_convolve1Dy_q (Gan_Image *image, Gan_ImageChannelType channel, Gan_Mask1D *mask, Gan_Image *dest)
 Convolves an image in the y-direction.

Gan_Imagegan_image_convolve1Dx_s (Gan_Image *image, Gan_ImageChannelType channel, Gan_Mask1D *mask)
 Macro: Convolves an image in the x-direction.

Gan_Imagegan_image_convolve1Dy_s (Gan_Image *image, Gan_ImageChannelType channel, Gan_Mask1D *mask)
 Macro: Convolves an image in the y-direction.


Detailed Description

Module: Image 1D convolution routines

Part of: Gandalf Library

Revision: Last edited: Author:

Copyright: (c) 2000 Imagineer Software Limited


Function Documentation

Gan_Bool gan_convolve1D_d double *    source,
int    sstride,
double *    dest,
int    dstride,
Gan_Mask1D   mask,
unsigned int    dsize
 

1D convolution function for double arrays.

Parameters:
source The input array to be convolved
sstride The stride of the source array in units of doubles
dest The destination array for the convolution
dstride The stride of the dest array in units of doubles
mask The convolution mask
dsize The number of output elements to compute
Applies a one-dimensional convolution operation to the given source array. Both arrays must be of type double.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
See also:
gan_convolve1D_i().

Gan_Bool gan_convolve1D_f float *    source,
int    sstride,
float *    dest,
int    dstride,
Gan_Mask1D   mask,
unsigned int    dsize
 

1D convolution function for float arrays.

Parameters:
source The input array to be convolved
sstride The stride of the source array in units of floats
dest The destination array for the convolution
dstride The stride of the dest array in units of floats
mask The convolution mask
dsize The number of output elements to compute
Applies a one-dimensional convolution operation to the given source array. Both arrays must be of type float.
Returns:
GAN_TRUE on success, GAN_FALSE on failure.
See also:
gan_convolve1D_i().

Gan_Bool gan_convolve1D_i int *    source,
int    sstride,
int *    dest,
int    dstride,
Gan_Mask1D   mask,
unsigned int    dsize
 

1D convolution function for integer arrays.

Parameters:
source The input array to be convolved
sstride The stride of the source array
dest The destination array for the convolution
dstride The stride of the dest array
mask The convolution mask
dsize The number of output elements to compute
Applies a one-dimensional convolution operation to the given source array. Both arrays must be of type int. There is no checking for overflow.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
See also:
gan_convolve1D_i().

Gan_Bool gan_convolve_circular1D_d double *    source,
int    sstride,
double *    dest,
int    dstride,
Gan_Mask1D   mask,
unsigned int    size
 

Circular 1D convolution function for double arrays.

Parameters:
source The input array to be convolved
sstride The stride of the source array in units of doubles
dest The destination array for the convolution
dstride The stride of the dest array in units of doubles
mask The convolution mask
size The number of input/output elements
Applies a one-dimensional convolution operation to the given source array. Both arrays must be of type double. The input source array is treated as circular, so that no values are lost at the ends.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
See also:
gan_convolve_circular1D_i().

Gan_Bool gan_convolve_circular1D_f float *    source,
int    sstride,
float *    dest,
int    dstride,
Gan_Mask1D   mask,
unsigned int    size
 

Circular 1D convolution function for float arrays.

Parameters:
source The input array to be convolved
sstride The stride of the source array in units of floats
dest The destination array for the convolution
dstride The stride of the dest array in units of floats
mask The convolution mask
size The number of input/output elements
Applies a one-dimensional convolution operation to the given source array. Both arrays must be of type float. The input source array is treated as circular, so that no values are lost at the ends.

Returns:
GAN_TRUE on success, GAN_FALSE on failure.
See also:
gan_convolve_circular1D_i().

Gan_Image* gan_image_convolve1Dx_q Gan_Image   image,
Gan_ImageChannelType    channel,
Gan_Mask1D   mask,
Gan_Image   dest
 

Convolves an image in the x-direction.

Parameters:
image The input image
channel Colour channel to be convolved where applicable
mask The image convolution mask
dest The destination image for the convolution operation
Applies a one-dimensional convolution operation to the given image in the x-direction. When the image contains colour or vector field data, a particular colour channel/vector field element can be specified by the channel argument, which should otherwise be passed as GAN_ALL_CHANNELS. There is no checking for overflow of integer values.

Macro call to gan_image_convolve1Dx_q().

Returns:
Non-NULL on successfully returning the destination image dest, NULL on failure.
See also:
gan_image_convolve1Dx_q, gan_gauss_mask_new().

Gan_Image* gan_image_convolve1Dy_q Gan_Image   image,
Gan_ImageChannelType    channel,
Gan_Mask1D   mask,
Gan_Image   dest
 

Convolves an image in the y-direction.

Parameters:
image The input image
channel Colour channel to be convolved where applicable
mask The image convolution mask
dest The destination image for the convolution operation
Applies a one-dimensional convolution operation to the given image in the y-direction. When the image contains colour or vector field data, a particular colour channel/vector field element can be specified by the channel argument, which should otherwise be passed as GAN_ALL_CHANNELS. There is no checking for overflow of integer values.

Macro call to gan_image_convolve1Dy_q().

Returns:
Non-NULL on successfully returning the destination image dest, NULL on failure.
See also:
gan_image_convolve1Dy_q, gan_gauss_mask_new().


Generated on Mon Oct 13 16:14:41 2003 by doxygen1.3-rc1