From f7cb74ff65c59c2a1bb21ec8b3034d7706a815c0 Mon Sep 17 00:00:00 2001 From: John Cupitt Date: Tue, 8 Jan 2008 13:44:50 +0000 Subject: [PATCH] docs for im_gradcor --- man/Makefile.am | 3 +++ man/im_grad_x.3 | 29 +++++++++++++++++++++++++++++ man/im_grad_y.3 | 1 + man/im_gradcor.3 | 1 + 4 files changed, 34 insertions(+) create mode 100644 man/im_grad_x.3 create mode 100644 man/im_grad_y.3 create mode 100644 man/im_gradcor.3 diff --git a/man/Makefile.am b/man/Makefile.am index 4a3696bc..4bcf7cbb 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -206,7 +206,10 @@ man_MANS = \ im_glds_mean.3 \ im_global_balance.3 \ im_global_balance_float.3 \ + im_gradcor.3 \ im_gradient.3 \ + im_grad_x.3 \ + im_grad_y.3 \ im_grey.3 \ im_grid.3 \ im_guess_prefix.3 \ diff --git a/man/im_grad_x.3 b/man/im_grad_x.3 new file mode 100644 index 00000000..fa786859 --- /dev/null +++ b/man/im_grad_x.3 @@ -0,0 +1,29 @@ +.TH IM_GRAD_X 3 "08 January 2008" +.SH NAME + im_grad_x, im_grad_y \- find horizontal or vertical differences +.SH SYNOPSIS +.nf +.B #include +.sp +.BI "int im_grad_x( IMAGE " "*in" ", IMAGE " "*out" " ); +.br + +.BI "int im_grad_y( IMAGE " "*in" ", IMAGE " "*out" " ); +.fi +.SH DESCRIPTION +.B im_grad_x(3) +generates an image where the value of each pixel is the difference between horizontally ajacent pixels in the input +image. The output has the same height as the input and one pixel less width. +.PP +.B im_grad_y(3) +generates an image where the value of each pixel is the difference between vertically ajacent pixels in the input +image. The output has the same width as the input and one pixel less height. +.PP +In both cases, the input can be any uncoded integer type, and the output is signed 32 bit integer. +.SH RETURN VALUE +The functions returns 0 on success and -1 on error. +.SH COPYRIGHT +.br +Copyright 2008, Nottingham Trent University. +.SH AUTHOR +Tom Vajzovic diff --git a/man/im_grad_y.3 b/man/im_grad_y.3 new file mode 100644 index 00000000..f7dc71d4 --- /dev/null +++ b/man/im_grad_y.3 @@ -0,0 +1 @@ +.so man3/im_grad_x.3 diff --git a/man/im_gradcor.3 b/man/im_gradcor.3 new file mode 100644 index 00000000..e22eb0f2 --- /dev/null +++ b/man/im_gradcor.3 @@ -0,0 +1 @@ +.so man3/im_fastcor.3