NAME

get_2D_gaussian_mask - Constructs a 2D Guassian mask

SYNOPSIS

#include "m/m_convolve.h"

Example compile flags (system dependent):
  -DLINUX_386 -DLINUX_386_P4  
   -I/home/kobus/include
   -L/home/kobus/load/linux_386_p4 -L/usr/local/lib -L/usr/lib
  -lKJB         -llapack -lblas -lg2c          -lXext -lX11 


int get_2D_gaussian_mask
(
	Matrix **mask_mpp,
	int mask_size,
	double sigma
);

PARAMETERS

Matrix **mask_mpp
Output gaussian smoothing mask.
int mask_size
Number of elements per axis.
double sigma
Standard deviation in bin units.

DESCRIPTION

This routine constructs a 2D Gaussian mask, putting the result into *out_mpp. If the size of the mask is odd, then the center of the Gaussian is in the center of the mask. If it is even, the the center is as thought the mask was one larger. If you want a have a mask which contains most of the Gaussian (excluded values are close to zero), then you need to make the mask size at least 6 times sigma. Regardless of the size and sigma, the mask is normalized so that its sum 1. If *out_vpp is NULL, then a vector of the appropriate size is created, if it is the wrong size, then it is resized, and if it is the right size, the storage is recycled.

RETURNS

NO_ERROR on success, and ERROR on failure, with an appropriate error message being set.

DISCLAIMER

This software is not adequatedly tested. It is recomended that results are checked independantly where appropriate.

AUTHOR

Kobus Barnard

DOCUMENTOR

Kobus Barnard

SEE ALSO

gauss_convolve_matrix , convolve_matrix , x_convolve_matrix , y_convolve_matrix , convolve_vector , get_1D_gaussian_mask