sergiotarxz
/
libvips
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Doxygen added

This commit is contained in:
Kirk Martinez 2009-06-17 08:18:46 +00:00
parent 986b5b98c9
commit dc201a624a
4 changed files with 1571 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1510
Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff

55
include/vips/vips.h
View File

@ -1,6 +1,7 @@
/* @(#) Header file for Birkbeck/VIPS Image Processing Library /** Header file for VIPS Image Processing Library.
* Authors: N. Dessipris, K. Martinez, Birkbeck College, London. *@author N. Dessipris, K. Martinez, J. Cupitt
* Sept 94 *@file vips.h
*@date Sept 94
* *
* 15/7/96 JC * 15/7/96 JC
* - now does C++ extern stuff * - now does C++ extern stuff
@ -210,7 +211,7 @@ typedef unsigned char PEL; /* useful datum */
#endif /*IM_ENABLE_DEPRECATED*/ #endif /*IM_ENABLE_DEPRECATED*/
/* Types of image descriptor we may have. The type field is advisory only: it /** Types of image descriptor we may have. The type field is advisory only: it
* does not imply that any fields in IMAGE have valid data. * does not imply that any fields in IMAGE have valid data.
*/ */
typedef enum { typedef enum {
@ -224,7 +225,8 @@ typedef enum {
IM_PARTIAL /* partial image */ IM_PARTIAL /* partial image */
} im_desc_type; } im_desc_type;
/* Demand style from im_generate(). See im_demand_hint(). /** Demand style from im_generate().
*@see im_demand_hint().
*/ */
typedef enum { typedef enum {
IM_SMALLTILE, IM_SMALLTILE,
@ -248,7 +250,7 @@ typedef struct {
size_t length; /* Size of window */ size_t length; /* Size of window */
} im_window_t; } im_window_t;
/* Struct we keep a record of execution time in. Passed to eval callback, so /** Struct we keep a record of execution time in. Passed to eval callback, so
* it can assess progress. * it can assess progress.
* *
* The 'unused' field is there for binary compatibility, remove this when we * The 'unused' field is there for binary compatibility, remove this when we
@ -257,30 +259,31 @@ typedef struct {
* when we remove this. * when we remove this.
*/ */
typedef struct { typedef struct {
struct im__IMAGE *im; /* Image we are part of */ struct im__IMAGE *im; /**< Image we are part of */
time_t unused; /* FIXME ... for binary compatibility */ time_t unused; /**< FIXME ... for binary compatibility */
int run; /* Time we have been running */ int run; /**< Time we have been running */
int eta; /* Estimated seconds of computation left */ int eta; /**< Estimated seconds of computation left */
gint64 tpels; /* Number of pels we expect to calculate */ gint64 tpels; /**< Number of pels we expect to calculate */
gint64 npels; /* Number of pels calculated so far */ gint64 npels; /**< Number of pels calculated so far */
int percent; /* Percent complete */ int percent; /**< Percent complete */
GTimer *start; /* Start time */ GTimer *start; /**< Start time */
} im_time_t; } im_time_t;
/* Image descriptor for subroutine i/o args /**
* main Image struct for handling images in VIPS.
*@struct im__IMAGE
*@typedef IMAGE
*/ */
typedef struct im__IMAGE { typedef struct im__IMAGE {
/* Fields from file header. int Xsize; /**< width of image in pels*/
*/ int Ysize; /**< height in pels*/
int Xsize; int Bands; /**< number of bands*/
int Ysize; int Bbits; /**< bits per band*/
int Bands; int BandFmt; /**< code for band format*/
int Bbits; int Coding; /**< coding type*/
int BandFmt; int Type; /**< type of image*/
int Coding; float Xres; /**< X resolution in pels/mm*/
int Type; float Yres; /**< Y resolution in pels/mm*/
float Xres;
float Yres;
int Length; int Length;
short Compression; short Compression;
short Level; short Level;

21
libsrc/arithmetic/im_abs.c
View File

@ -1,13 +1,8 @@
/* @(#) Find the absolute value of an image. Copy for UNSIGNED types, negate /** Find the absolute value of an image.
* @(#) for int types, fabs() for float types, and calculate modulus for * Acts as a copy for UNSIGNED types, negate
* @(#) complex types. * for int types, fabs() for float types, and calculate modulus for
* @(#) * complex types.
* @(#) int *\file im_abs.c
* @(#) im_abs( in, out )
* @(#) IMAGE *in, *out;
* @(#)
* @(#) Returns 0 on success and -1 on error
* @(#)
* *
* Copyright: 1990, N. Dessipris, based on im_powtra() * Copyright: 1990, N. Dessipris, based on im_powtra()
* Author: Nicos Dessipris * Author: Nicos Dessipris
@ -210,7 +205,11 @@ abs_gen( PEL *in, PEL *out, int width, IMAGE *im )
} }
} }
/* Abs of image. /** Abs of image.
*@param in is input IMAGE
*@param out is output IMAGE
*@return 0 on success, -1 on failure
*@see IMAGE
*/ */
int int
im_abs( IMAGE *in, IMAGE *out ) im_abs( IMAGE *in, IMAGE *out )

40
libsrc/mosaicing/mosaic.h
View File

@ -1,10 +1,12 @@
/* @(#) Local definitions used by the mosaicing program /*!\file mosaic.h
* @(#) If IM_MAXPOINTS change please ensure that it is still a multiple of * \brief Local definitions used by the mosaicing program.
* @(#) AREAS or else AREAS must change as well. Initial setup is for *
* @(#) IM_MAXPOINTS = 60, AREAS = 3. * If IM_MAXPOINTS change please ensure that it is still a multiple of
* @(#) * AREAS or else AREAS must change as well. Initial setup is for
* IM_MAXPOINTS = 60, AREAS = 3.
*
* Copyright: 1990, 1991 N. Dessipris * Copyright: 1990, 1991 N. Dessipris
* Author: Nicos Dessipris * @Author: Nicos Dessipris, K Martinez, J Cupitt
* Written on: 07/11/1989 * Written on: 07/11/1989
* Modified on : 29/11/1989 * Modified on : 29/11/1989
*/ */
@ -37,33 +39,35 @@
#define IM_MAXPOINTS (60) /* IM_MAXPOINTS % AREAS must be zero */ #define IM_MAXPOINTS (60) /* IM_MAXPOINTS % AREAS must be zero */
#define AREAS (3) #define AREAS (3)
/**
* mosaic struct used to define all the parameters
*/
typedef struct { typedef struct {
char *reference; /* filename of reference */ char *reference; /**< filename of reference image*/
char *secondary; /* filename of secondary */ char *secondary; /**< filename of secondary image*/
int deltax; /* initial estimate of displacement */ int deltax; /**< initial estimate of displacement */
int deltay; /* initial estimate of displacement */ int deltay; /**< initial estimate of displacement */
int nopoints; /* must be multiple of AREAS and <= IM_MAXPOINTS */ int nopoints; /**< must be multiple of AREAS and <= IM_MAXPOINTS */
int halfcorsize; /* recommended 5 */ int halfcorsize; /**< half the correlation area size: recommended 5 */
int halfareasize; /* recommended 8 */ int halfareasize; /**< recommended 8 */
/* x, y_reference and contrast found by im_calcon() /** x, y_reference and contrast found by im_calcon()
*/ */
int x_reference[IM_MAXPOINTS], y_reference[IM_MAXPOINTS]; int x_reference[IM_MAXPOINTS], y_reference[IM_MAXPOINTS];
int contrast[IM_MAXPOINTS]; int contrast[IM_MAXPOINTS];
/* x, y_secondary and correlation set by im_chkpair() /** x, y_secondary and correlation set by im_chkpair()
*/ */
int x_secondary[IM_MAXPOINTS], y_secondary[IM_MAXPOINTS]; int x_secondary[IM_MAXPOINTS], y_secondary[IM_MAXPOINTS];
/* returns the corrected best correlation /** returns the corrected best correlation
* as detected in 2*halfareasize+1 * as detected in 2*halfareasize+1
* centered at point (x2, y2) and using * centered at point (x2, y2) and using
* correlation area 2*halfareasize+1 * correlation area 2*halfareasize+1
*/ */
double correlation[IM_MAXPOINTS]; double correlation[IM_MAXPOINTS];
/* Coefficients calculated by im_clinear() /** Coefficients calculated by im_clinear()
*/ */
double l_scale, l_angle, l_deltax, l_deltay; double l_scale, l_angle, l_deltax, l_deltay;