Main Page   Modules   Compound List   File List   Compound Members   File Members  

mask1D.h File Reference

#include <gandalf/common/misc_defs.h>

Go to the source code of this file.

Compounds

struct  Gan_Mask1D
 1D convolution mask. More...


Enumerations

enum  Gan_Mask1DFormat { GAN_MASK1D_SYMMETRIC, GAN_MASK1D_ANTISYMMETRIC, GAN_MASK1D_GENERIC }
 Format of convolution mask. More...


Functions

Gan_Mask1Dgan_mask1D_form_gen (Gan_Mask1D *mask, Gan_Mask1DFormat format, Gan_Type type, void *data, unsigned int size)
 Form a new 1D convolution mask.

Gan_Bool gan_mask1D_copy_q (Gan_Mask1D *source, Gan_Mask1D *dest)
 Copies a convolution mask.

Gan_Bool gan_mask1D_free (Gan_Mask1D *mask)
 Frees a convolution mask.

Gan_Mask1Dgan_gauss_mask_new (Gan_Type type, double sigma, unsigned mask_size, double scale, void *mask_data)
 Make new Gaussian convolution mask.

Gan_Mask1Dgan_mask1D_alloc (Gan_Mask1DFormat format, Gan_Type type, unsigned int size)
 Macro: Allocate and return a new 1D convolution mask.

Gan_Mask1Dgan_mask1D_alloc_data (Gan_Mask1DFormat format, Gan_Type type, void *data, unsigned int size)
 Macro: Allocate and return a new 1D convolution mask.

Gan_Mask1Dgan_mask1D_form (Gan_Mask1D *mask, Gan_Mask1DFormat format, Gan_Type type, unsigned int size)
 Macro: Build a new 1D convolution mask.

Gan_Mask1Dgan_mask1D_form_data (Gan_Mask1D *mask, Gan_Mask1DFormat format, Gan_Type type, void *data, unsigned int size)
 Macro: Build a new 1D convolution mask.


Detailed Description

Module: Constructing 1D Gaussian convolution masks

Part of: Gandalf Library

Revision: Last edited: Author:

Copyright: (c) 2000 Imagineer Software Limited


Function Documentation

Gan_Mask1D* gan_gauss_mask_new Gan_Type    type,
double    sigma,
unsigned    mask_size,
double    scale,
void *    mask_data
 

Make new Gaussian convolution mask.

Parameters:
type Type of mask element, e.g. GAN_DOUBLE
sigma Standard deviation of convolution
mask_size Mask dimension, must be odd/
scale Scale factor for mask entries
mask_data Pointer to mask data or NULL
Allocates, fills and returns a pointer to a new Gaussian convolution mask structure with given size and standard deviation.

Returns:
Non-NULL Pointer to the created convolution mask structure, or NULL on failure.
See also:
gan_mask1D_free().

Gan_Bool gan_mask1D_copy_q Gan_Mask1D   source,
Gan_Mask1D   dest
 

Copies a convolution mask.

Parameters:
source The input convolution mask
dest The output convolution mask
Copy 1D convolution mask from source mask to dest mask
Returns:
GAN_TRUE on success, GAN_FALSE on failure.

Gan_Mask1D* gan_mask1D_form_gen Gan_Mask1D   mask,
Gan_Mask1DFormat    format,
Gan_Type    type,
void *    data,
unsigned int    size
 

Form a new 1D convolution mask.

Don't call this function directly. Use the macro gan_mask1D_form_data() instead.

Gan_Bool gan_mask1D_free Gan_Mask1D   mask
 

Frees a convolution mask.

Parameters:
mask The convolution mask to be freed
Free memory associated with 1D convolution mask.
Returns:
GAN_TRUE on success, GAN_FALSE on failure.


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