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

remove the old man pages

Browse Source 
Finally junk the old man pages, everything is redone as gtk-doc now.
This commit is contained in:
John Cupitt 2011-02-03 11:50:58 +00:00
parent 729b680841
commit aa620ea540
547 changed files with 1 additions and 12213 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
ChangeLog
View File

@ -30,6 +30,7 @@
- gtk-doc for video ... all operators done! amazing argh
- set MAP_NOCACHE on OS X, otherwise performance dives off a cliff with
files larger than memory
- removed man pages, we are all gtk-doc now
30/11/10 started 7.24.0
- bump for new stable

1
Makefile.am
View File

@ -22,7 +22,6 @@ endif
SUBDIRS = \
libvips \
tools \
man \
po \
doc \
$(C_COMPILE_DIR) \

1
configure.in
View File

@ -655,7 +655,6 @@ AC_OUTPUT([
swig/Makefile
swig/vipsCC/Makefile
swig/python/setup.py
man/Makefile
doc/Makefile
doc/reference/Makefile
doc/reference/libvips-docs.sgml

77
man/IM_ARRAY.3
View File

@ -1,77 +0,0 @@
.TH IM_ARRAY 3 "11 April 1993"
.SH NAME
IM_ARRAY, IM_NEW, IM_NUMBER \- memory allocation macros
.SH SYNOPSIS
#include <vips/vips.h>
type-name *IM_NEW( IMAGE *im, type-name )
.br
type-name *IM_ARRAY( IMAGE *im, int number, type-name )
.br
int IM_NUMBER( array )
.SH DESCRIPTION
NEW, NUMBER and ARRAY are macros built on im_malloc(3) which make memory
allocation slightly easier. Given a type name, NEW returns a pointer to a
piece of memory large enough to hold an object of that type. ARRAY works as
NEW, but allocates space for a number of objects. Given an array, NUMBER
returns the number of elements in that array.
#define IM_NEW(IM,A) ((A *)im_malloc((IM),sizeof(A)))
#define IM_NUMBER(R) (sizeof(R)/sizeof(R[0]))
#define IM_ARRAY(IM,N,T) ((T *)im_malloc((IM),(N) * sizeof(T)))
Both IM_ARRAY and IM_NEW take an image descriptor as their first
parameter. Memory is allocated local to this descriptor, that is, when the
descriptor is closed, the memory is automatically freed for you. If you
pass NULL instead of an image descriptor, memory is allocated globally and
is not automatically freed.
(NOTE: in versions of VIPS before 7.3, NEW(3) and ARRAY(3) did not have the
initial IMAGE parameter. If you are converting an old VIPS7.2 program, you
will need to add a NULL parameter to the start of all NEW(3) and ARRAY(3)
parameter lists.)
Both functions return NULL on error, setting im_errorstring.
Example:
#include <vips/vips.h>
/* A structure we want to carry about.
*/
typedef struct {
...
} Wombat;
/* A static array of them.
*/
static Wombat swarm[] = {
{ ... },
{ ... },
{ ... }
};
static int swarm_size = IM_NUMBER( swarm );
int
transform_wombat( IMAGE *in, IMAGE *out )
{
/* Allocate space for a Wombat.
*/
Wombat *mar = IM_NEW( out, Wombat );
/* Allocate space for a copy of swarm.
*/
Wombat *mar = IM_ARRAY( out, swarm_size, Wombat );
....
}
.SH COPYRIGHT
National Gallery, 1993
.SH SEE ALSO
im_malloc(3), im_open_local(3).
.SH AUTHOR
J. Cupitt \- 23/7/93

66
man/IM_IMAGE_ADDR.3
View File

@ -1,66 +0,0 @@
.TH MACROS 3 "11 April 1990"
.SH NAME
IM_IMAGE_ADDR, IM_IMAGE_SIZEOF_ELEMENT, IM_IMAGE_SIZEOF_PEL,
IM_IMAGE_SIZEOF_LINE, IM_IMAGE_N_ELEMENTS \-
macros for images
.SH SYNOPSIS
.B #include <vips/vips.h>
int IM_IMAGE_SIZEOF_ELEMENT( im )
.br
IMAGE *im;
int IM_IMAGE_SIZEOF_PEL( im )
.br
IMAGE *im;
int IM_IMAGE_SIZEOF_LINE( im )
.br
IMAGE *im;
int IM_IMAGE_N_ELEMENTS( im )
.br
IMAGE *im;
char *IM_IMAGE_ADDR( im, x, y )
.br
IMAGE *im;
.br
int x;
.br
int y;
.SH DESCRIPTION
These macros help to simplify address arithmetic for images.
IM_IMAGE_SIZEOF_ELEMENT(3) returns sizeof( one band element ).
IM_IMAGE_SIZEOF_PEL(3) returns sizeof( one pel ).
IM_IMAGE_SIZEOF_LINE(3) returns sizeof( one horizontal line of pels ).
IM_IMAGE_N_ELEMENTS(3) returns the number of band elements across a horizontal line.
IM_IMAGE_ADDR(3) returns a pointer to the pixel at position (x,y) in the
image. The point (x,y) should lie within the image.
If the macro DEBUG has been defined, then IM_IMAGE_ADDR(3) will also
perform bounds checking. If you ask for the address of a pel outside the
image,
then IM_IMAGE_ADDR(3) will print an error message of the form:
IM_IMAGE_ADDR: point out of bounds, file "test.c", line 18
(point x=50, y=0
should have been within Rect left=0, top=0, width=50, height=50)
and call abort(3).
DEBUG needs to be defined *before* vips.h is included. Either define DEBUG
with -D in your Makefile, or have a #define DEBUG right at the top of your
file.
.SH COPYRIGHT
National Gallery, 1993
.SH SEE ALSO
IM_REGION_ADDR(3), im_malloc(3), im_open_local(3).
.SH AUTHOR
J. Cupitt \- 23/7/93

1
man/IM_IMAGE_N_ELEMENTS.3
View File

@ -1 +0,0 @@
.so man3/IM_IMAGE_ADDR.3

1
man/IM_IMAGE_SIZEOF_ELEMENT.3
View File

@ -1 +0,0 @@
.so man3/IM_IMAGE_ADDR.3

1
man/IM_IMAGE_SIZEOF_LINE.3
View File

@ -1 +0,0 @@
.so man3/IM_IMAGE_ADDR.3

1
man/IM_IMAGE_SIZEOF_PEL.3
View File

@ -1 +0,0 @@
.so man3/IM_IMAGE_ADDR.3

34
man/IM_MACROS.3
View File

@ -1,34 +0,0 @@
.TH MACROS 3 "11 April 1990"
.SH NAME
IM_RINT, IM_MAX, IM_MIN \- misc math macros
.SH SYNOPSIS
.B #include <vips/vips.h>
int IM_RINT( float )
.br
any IM_MAX( any, any )
.br
any IM_MIN( any, any )
.SH DESCRIPTION
These macros provide some simple but fast math functions --- IM_MAX(3)
returns the maximum of its two arguments, IM_MIN(3) the smallest, and
IM_RINT(3) rounds a float or double to the nearest integer.
Beware: these macros may evaluate their argument more than once, so you MUST
NOT use ++,--, or a function call in their argument lists.
They are defined as:
#define IM_MAX(A,B) ((A)>(B)?(A):(B))
#define IM_MIN(A,B) ((A)<(B)?(A):(B))
#define IM_RINT(R) ((int)((R)>0?((R)+0.5):((R)-0.5)))
.SH COPYRIGHT
National Gallery, 1993
.SH SEE ALSO
im_malloc(3), im_open_local(3).
.SH AUTHOR
J. Cupitt \- 23/7/93

1
man/IM_NEW.3
View File

@ -1 +0,0 @@
.so man3/IM_ARRAY.3

1
man/IM_NUMBER.3
View File

@ -1 +0,0 @@
.so man3/IM_ARRAY.3

1
man/IM_RECT_BOTTOM.3
View File

@ -1 +0,0 @@
.so man3/im_rect_marginadjust.3

1
man/IM_RECT_HCENTRE.3
View File

@ -1 +0,0 @@
.so man3/im_rect_marginadjust.3

1
man/IM_RECT_RIGHT.3
View File

@ -1 +0,0 @@
.so man3/im_rect_marginadjust.3

1
man/IM_RECT_VCENTRE.3
View File

@ -1 +0,0 @@
.so man3/im_rect_marginadjust.3

63
man/IM_REGION_ADDR.3
View File

@ -1,63 +0,0 @@
.TH MACROS 3 "11 April 1990"
.SH NAME
IM_REGION_ADDR,
IM_REGION_LSKIP,
IM_REGION_N_ELEMENTS, IM_REGION_SIZEOF_LINE \-
macros for regions
.SH SYNOPSIS
.B #include <vips/vips.h>
int IM_REGION_LSKIP( reg )
.br
REGION *reg;
int IM_REGION_N_ELEMENTS( reg )
.br
REGION *reg;
int IM_REGION_SIZEOF_LINE( reg )
.br
REGION *reg;
char *IM_REGION_ADDR( reg, x, y )
.br
REGION *reg;
.br
int x, y;
.SH DESCRIPTION
These macros help to simplify address arithmetic for regions.
IM_REGION_LSKIP(3) returns the number of *bytes* you should add to move
down a scan line. Remember that if your pointer has been cast to the type
of the image pels, this will not be the correct amount to add! The value
lskip returns can be changed by a call to im_prepare(3).
IM_REGION_N_ELEMENTS(3) returns the number of band elements across the region.
IM_REGION_SIZEOF_LINE(3) returns sizeof( horizontal line across region ).
IM_REGION_ADDR(3) returns a pointer to the pixel at position (x,y) in the
image on which reg has been defined. The point (x,y) should lie within the
valid area for this region.
If the macro DEBUG has been defined, then IM_REGION_ADDR(3) will also
perform bounds checking. If you ask for the address of a pel outside the rect
reg->valid, then IM_REGION_ADDR(3) will print an error message of the form:
IM_REGION_ADDR: point out of bounds, file "test.c", line 18
(point x=50, y=0
should have been within Rect left=0, top=0, width=50, height=50)
and call abort(3).
DEBUG needs to be defined *before* region.h is included. Either define DEBUG
with -D in your Makefile, or have a #define DEBUG right at the top of your
file.
.SH COPYRIGHT
National Gallery, 1993
.SH SEE ALSO
IM_IMAGE_ADDR(3), im_malloc(3), im_open_local(3).
.SH AUTHOR
J. Cupitt \- 23/7/93

1
man/IM_REGION_LSKIP.3
View File

@ -1 +0,0 @@
.so man3/IM_REGION_ADDR.3

1
man/IM_REGION_N_ELEMENTS.3
View File

@ -1 +0,0 @@
.so man3/IM_REGION_ADDR.3

1
man/IM_REGION_SIZEOF_LINE.3
View File

@ -1 +0,0 @@
.so man3/IM_REGION_ADDR.3

546
man/Makefile.am
View File

@ -1,546 +0,0 @@
man_MANS = \
batch_crop.1 \
batch_image_convert.1 \
batch_rubber_sheet.1 \
binfile.1 \
cooc.1 \
cooc_features.1 \
debugim.1 \
edvips.1 \
glds.1 \
glds_features.1 \
header.1 \
light_correct.1 \
printlines.1 \
simcontr.1 \
sines.1 \
squares.1 \
vips.1 \
vipsthumbnail.1 \
error_exit.3 \
im_abs.3 \
im_acostra.3 \
im_add.3 \
im_rad2float.3 \
im_float2rad.3 \
im_add_preclose_callback.3 \
im_add_close_callback.3 \
im_add_evalstart_callback.3 \
im_add_eval_callback.3 \
im_add_evalend_callback.3 \
im_add_invalidate_callback.3 \
im_addgnoise.3 \
im_affine.3 \
im_affinei.3 \
im_affinei_all.3 \
im_allocate_input_array.3 \
im_amiMSBfirst.3 \
im_analyze2vips.3 \
im_andconst.3 \
im_andimage.3 \
im_and_vec.3 \
IM_ARRAY.3 \
im_asintra.3 \
im_atantra.3 \
im_avg.3 \
im_BandFmt2char.3 \
im_bandjoin.3 \
im_bandmean.3 \
im_benchmark.3 \
im_binfile.3 \
im_bits_of_fmt.3 \
im_black.3 \
im_blend.3 \
im_buildlut.3 \
im_c2amph.3 \
im_c2imag.3 \
im_c2ps.3 \
im_c2real.3 \
im_c2rect.3 \
im_cache.3 \
im_ceil.3 \
im_char2BandFmt.3 \
im_char2Coding.3 \
im_char2Compression.3 \
im_char2Type.3 \
im_circle.3 \
im_clip2c.3 \
im_clip2cm.3 \
im_clip2d.3 \
im_clip2dcm.3 \
im_clip2f.3 \
im_clip2fmt.3 \
im_clip2i.3 \
im_clip2s.3 \
im_clip2ui.3 \
im_clip2us.3 \
im_clip.3 \
im_close.3 \
im_cmulnorm.3 \
im_cntlines.3 \
im_Coding2char.3 \
im_col_ab2Ch.3 \
im_col_C2Cucs.3 \
im_col_Ch2ab.3 \
im_col_Ch2hucs.3 \
im_col_Chucs2h.3 \
im_col_Cucs2C.3 \
im_col_dECMC.3 \
im_col_display.3 \
im_col_L2Lucs.3 \
im_col_Lab2XYZ.3 \
im_col_Lucs2L.3 \
im_col_make_tables_RGB.3 \
im_col_make_tables_UCS.3 \
im_col_pythagoras.3 \
im_col_rgb2XYZ.3 \
im_col_XYZ2Lab.3 \
im_col_XYZ2rgb.3 \
im_compass.3 \
im_Compression2char.3 \
im_concurrency_get.3 \
im_concurrency_set.3 \
im_contrast_surface.3 \
im_contrast_surface_raw.3 \
im_conv.3 \
im_convf.3 \
im_convf_raw.3 \
im_conv_raw.3 \
im_convsep.3 \
im_convsepf.3 \
im_convsepf_raw.3 \
im_convsep_raw.3 \
im_convsub.3 \
im_cooc_asm.3 \
im_cooc_contrast.3 \
im_cooc_correlation.3 \
im_cooc_entropy.3 \
im_cooc_matrix.3 \
im_copy.3 \
im_copy_from.3 \
im_copy_morph.3 \
im_copy_set.3 \
im_copy_set_meta.3 \
im_copy_swap.3 \
im_correl.3 \
im_costra.3 \
im_cp_desc.3 \
im_cp_desc_array.3 \
im_cp_descv.3 \
im_create_dmask.3 \
im_create_fmask.3 \
im_create_imask.3 \
im_csv2vips.3 \
im_dE00_fromLab.3 \
im_debugim.3 \
im_dECMC_fromdisp.3 \
im_dECMC_fromLab.3 \
im_dE_fromdisp.3 \
im_dE_fromLab.3 \
im_dE_fromXYZ.3 \
im_demand_hint.3 \
im_demand_hint_array.3 \
im_deviate.3 \
im_diag.3 \
im_dif_std.3 \
im_dilate.3 \
im_dilate_raw.3 \
im_disp2Lab.3 \
im_disp2XYZ.3 \
im_disp_ps.3 \
im_divide.3 \
im_dup_dmask.3 \
im_dup_imask.3 \
im_embed.3 \
im_eorconst.3 \
im_eorimage.3 \
im_eor_vec.3 \
im_equal.3 \
im_equalconst.3 \
im_equal_vec.3 \
im_erode.3 \
im_erode_raw.3 \
im_error.3 \
im_error_buffer.3 \
im_error_clear.3 \
im_exp10tra.3 \
im_expntra.3 \
im_expntra_vec.3 \
im_exptra.3 \
im_exr2vips.3 \
im_extract.3 \
im_extract_area.3 \
im_extract_areabands.3 \
im_extract_bands.3 \
im_eye.3 \
im_falsecolour.3 \
im_fastcor.3 \
im_fastline.3 \
im_fastlineuser.3 \
im_fav4.3 \
im_feye.3 \
im_fgrey.3 \
im_fliphor.3 \
im_flipver.3 \
im_flood.3 \
im_flood_blob.3 \
im_floor.3 \
im_flt_imag_freq.3 \
VipsObject.3 \
VipsFormat.3 \
VipsInterpolate.3 \
vips_format_for_file.3 \
vips_format_for_name.3 \
vips_format_map.3 \
vips_format_read.3 \
vips_format_write.3 \
im_fractsurf.3 \
im_free.3 \
im_free_dmask.3 \
im_free_imask.3 \
im_freqflt.3 \
im_fwfft.3 \
im_fzone.3 \
im_gadd.3 \
im_gaddim.3 \
im_gammacorrect.3 \
im_gauss_dmask.3 \
im_gauss_imask.3 \
im_gauss_imask_sep.3 \
im_gaussnoise.3 \
im_gbandjoin.3 \
im_generate.3 \
im_get_option_group.3 \
im_gfadd.3 \
im_glds_asm.3 \
im_glds_contrast.3 \
im_glds_entropy.3 \
im_glds_matrix.3 \
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 \
im_guess_libdir.3 \
im_header.3 \
im_header_double.3 \
im_header_get.3 \
im_header_get_type.3 \
im_header_int.3 \
im_header_map.3 \
im_header_string.3 \
im_heq.3 \
im_hist.3 \
im_histcum.3 \
im_histeq.3 \
im_histgr.3 \
im_histlin.3 \
im_histnD.3 \
im_histnorm.3 \
im_history_get.3 \
im_histplot.3 \
im_histspec.3 \
im_hsp.3 \
im_icc_ac2rc.3 \
im_icc_export.3 \
im_icc_export_depth.3 \
im_icc_import.3 \
im_icc_import_embedded.3 \
im_icc_present.3 \
im_icc_transform.3 \
im_identity.3 \
im_identity_ushort.3 \
im_ifthenelse.3 \
im_image.3 \
IM_IMAGE_ADDR.3 \
IM_IMAGE_N_ELEMENTS.3 \
im_image_sanity.3 \
IM_IMAGE_SIZEOF_ELEMENT.3 \
IM_IMAGE_SIZEOF_LINE.3 \
IM_IMAGE_SIZEOF_PEL.3 \
im_incheck.3 \
im_init.3 \
im_initdesc.3 \
im_init_world.3 \
im_insert.3 \
im_insertplace.3 \
im_invalidate.3 \
im_invert.3 \
im_invertlut.3 \
im_invfft.3 \
im_invfftr.3 \
im_iocheck.3 \
im_iscomplex.3 \
im_isfile.3 \
im_isfloat.3 \
im_isint.3 \
im_isMSBfirst.3 \
im_ispartial.3 \
im_isscalar.3 \
im_isuint.3 \
im_isvips.3 \
im_iterate.3 \
im_jpeg2vips.3 \
im_Lab2disp.3 \
im_Lab2LabQ.3 \
im_Lab2LabS.3 \
im_Lab2LCh.3 \
im_Lab2UCS.3 \
im_Lab2XYZ.3 \
im_lab_morph.3 \
im_LabQ2disp.3 \
im_LabQ2disp_build_table.3 \
im_LabQ2disp_table.3 \
im_LabQ2Lab.3 \
im_LabQ2LabS.3 \
im_LabQ2XYZ.3 \
im_LabS2Lab.3 \
im_LabS2LabQ.3 \
im_LCh2Lab.3 \
im_LCh2UCS.3 \
im_less.3 \
im_lessconst.3 \
im_lesseq.3 \
im_lesseqconst.3 \
im_lesseq_vec.3 \
im_less_vec.3 \
im_lhisteq.3 \
im_lhisteq_raw.3 \
im_lindetect.3 \
im_line.3 \
im_lineset.3 \
im_lintra.3 \
im_lintra_vec.3 \
im_litecor.3 \
im_log10tra.3 \
im_log_dmask.3 \
im_log_imask.3 \
im_logtra.3 \
im_lowpass.3 \
im_lrjoin.3 \
im_lrmerge.3 \
im_lrmosaic.3 \
im_lu_decomp.3 \
im_lu_solve.3 \
IM_MACROS.3 \
im_magick2vips.3 \
im_makerw.3 \
im_make_xy.3 \
im_malloc.3 \
im_maplut.3 \
im_mask2vips.3 \
im_matcat.3 \
im_match_linear.3 \
im_match_linear_search.3 \
im_matinv.3 \
im_matinv_inplace.3 \
im_matmul.3 \
im_mattrn.3 \
im_max.3 \
im_maxpos.3 \
im_maxpos_vec.3 \
im_maxvalue.3 \
im_mean_std_double_buffer.3 \
im_mean_std_int_buffer.3 \
im_measure.3 \
im_meta.3 \
im_meta_get.3 \
im_meta_get_area.3 \
im_meta_get_blob.3 \
im_meta_get_double.3 \
im_meta_get_int.3 \
im_meta_get_string.3 \
im_meta_get_type.3 \
im_meta_set.3 \
im_meta_set_area.3 \
im_meta_set_blob.3 \
im_meta_set_double.3 \
im_meta_set_int.3 \
im_meta_set_string.3 \
im_min.3 \
im_minpos.3 \
im_minpos_vec.3 \
im_mmapin.3 \
im_mmapinrw.3 \
im_more.3 \
im_moreconst.3 \
im_moreeq.3 \
im_moreeqconst.3 \
im_moreeq_vec.3 \
im_more_vec.3 \
im_mpercent.3 \
im_msb.3 \
im_msb_band.3 \
im_multiply.3 \
IM_NEW.3 \
im_norm_dmask.3 \
im_notequal.3 \
im_notequalconst.3 \
im_notequal_vec.3 \
IM_NUMBER.3 \
im_offsets45.3 \
im_offsets90.3 \
im_open.3 \
im_open_local.3 \
im_open_local_array.3 \
im_openout.3 \
im_orconst.3 \
im_orimage.3 \
im_or_vec.3 \
im_outcheck.3 \
im_paintrect.3 \
im_partial.3 \
im_pincheck.3 \
im_piocheck.3 \
im_plotmask.3 \
im_plotpoint.3 \
im_png2vips.3 \
im_poutcheck.3 \
im_powtra.3 \
im_powtra_vec.3 \
im_ppm2vips.3 \
im_prepare.3 \
im_prepare_many.3 \
im_prepare_to.3 \
im_print.3 \
im_printdesc.3 \
im_print_dmask.3 \
im_print_imask.3 \
im_printlines.3 \
im_profile.3 \
im_project.3 \
im_quantim.3 \
im_quantlut.3 \
im_rank.3 \
im_rank_image.3 \
im_raw2vips.3 \
im_read_dmask.3 \
im_read_imask.3 \
im_readpoint.3 \
im_recomb.3 \
IM_RECT_BOTTOM.3 \
im_rect_dup.3 \
im_rect_equalsrect.3 \
IM_RECT_HCENTRE.3 \
im_rect_includespoint.3 \
im_rect_includesrect.3 \
im_rect_intersectrect.3 \
im_rect_isempty.3 \
im_rect_marginadjust.3 \
im_rect_normalise.3 \
IM_RECT_RIGHT.3 \
im_rect_unionrect.3 \
IM_RECT_VCENTRE.3 \
IM_REGION_ADDR.3 \
im_region_buffer.3 \
im_region_create.3 \
im_region_free.3 \
im_region_image.3 \
IM_REGION_LSKIP.3 \
IM_REGION_N_ELEMENTS.3 \
im_region_position.3 \
im_region_region.3 \
IM_REGION_SIZEOF_LINE.3 \
im_remainder.3 \
im_remainderconst.3 \
im_remainderconst_vec.3 \
im_remosaic.3 \
im_render.3 \
im_render_fade.3 \
im_replicate.3 \
im_resize_linear.3 \
im_ri2c.3 \
im_rightshift_size.3 \
im_rint.3 \
im_rot180.3 \
im_rot270.3 \
im_rot90.3 \
im_rotate_dmask45.3 \
im_rotate_dmask90.3 \
im_rotate_imask45.3 \
im_rotate_imask90.3 \
im_rotquad.3 \
im_scale.3 \
im_scale_dmask.3 \
im_scaleps.3 \
im_setbuf.3 \
im_setupout.3 \
im_sharpen.3 \
im_shiftleft.3 \
im_shiftright.3 \
im_shrink.3 \
im_sign.3 \
im_simcontr.3 \
im_similarity.3 \
im_similarity_area.3 \
im_sines.3 \
im_sintra.3 \
im_slice.3 \
im_smear.3 \
im_smudge.3 \
im_spatres.3 \
im_spcor.3 \
im_sRGB2XYZ.3 \
im_start_many.3 \
im_start_one.3 \
im_stats.3 \
im_stdif.3 \
im_stop_many.3 \
im_stop_one.3 \
im_stretch3.3 \
im_subsample.3 \
im_subtract.3 \
im_system.3 \
im_tantra.3 \
im_tbjoin.3 \
im_tbmerge.3 \
im_tbmosaic.3 \
im_text.3 \
im_thresh.3 \
im_tiff2vips.3 \
im_tile_cache.3 \
im_tone_analyse.3 \
im_tone_build.3 \
im_tone_map.3 \
im_Type2char.3 \
im_UCS2Lab.3 \
im_UCS2LCh.3 \
im_UCS2XYZ.3 \
im_updatehist.3 \
im_verror.3 \
im_version.3 \
im_version_string.3 \
im_video_v4l1.3 \
im_vips2bufjpeg.3 \
im_vips2csv.3 \
im_vips2jpeg.3 \
im_vips2mask.3 \
im_vips2mimejpeg.3 \
im_vips2png.3 \
im_vips2ppm.3 \
im_vips2raw.3 \
im_vips2tiff.3 \
im_warn.3 \
im_wrapmany.3 \
im_wrapone.3 \
im_write_dmask.3 \
im_write_dmask_name.3 \
im_write_imask.3 \
im_write_imask_name.3 \
im_writeline.3 \
im_XYZ2disp.3 \
im_XYZ2Lab.3 \
im_XYZ2sRGB.3 \
im_XYZ2UCS.3 \
im_XYZ2Yxy.3 \
im_Yxy2XYZ.3 \
im_zerox.3 \
im_zone.3 \
im_zoom.3
EXTRA_DIST = ${man_MANS}

179
man/VipsFormat.3
View File

@ -1,179 +0,0 @@
.TH VIPS_FORMAT 3 "16 August 2008"
.SH NAME
VipsFormat,
vips_format_map, vips_format_for_file, vips_format_for_name,
vips_format_write \-
load and search image formats
.SH SYNOPSIS
#include <vips/vips.h>
typedef enum {
.br
VIPS_FORMAT_NONE = 0,
.br
VIPS_FORMAT_PARTIAL = 1
.br
} VipsFormatFlags;
typedef struct _VipsFormatClass {
.br
VipsObjectClass parent_class;
gboolean (*is_a)( const char * );
.br
int (*header)( const char *, IMAGE * );
.br
int (*load)( const char *, IMAGE * );
.br
int (*save)( IMAGE *, const char * );
.br
VipsFormatFlags (*get_flags)( const char * );
.br
int priority;
.br
const char **suffs;
.br
} VipsFormatClass;
void *vips_format_map( VSListMap2Fn fn, void *a, void *b );
.br
VipsFormatClass *vips_format_for_file( const char *filename );
.br
VipsFormatClass *vips_format_for_name( const char *filename );
int vips_format_write( IMAGE *im, const char *filename );
int vips_format_read( const char *filename, IMAGE *out );
.SH DESCRIPTION
These functions search the
available image formats to find one suitable for loading or saving a file.
.B im_open(3)
will do something similar, but that returns a descriptor to the file rather
than copying to a descriptor you supply.
The two APIs are useful in different circumstances:
.B im_open(3)
is good if you want to directly manipulate a file on disc, for example with
the paintbox functions. On the other hand, this format API is useful for
controlling how a image
is unpacked, since you can specify a destination for the copy.
Image formats are subclasses of
.B VipsFormat
as outlined above. They are expected to implement at least one of the methods.
They should also set values for the
.B nickname
and
.B description
members of
.B VipsObject.
Other members are:
.B is_a()
A function which tests whether a file is of the specified format. This is
useful if you can guess a file type from the first few bytes in the file. If
you leave this function NULL, vips will guess from the filename suffix for
you.
.B header()
Load only the image header, not any of the image pixels. vips will call this
first on
.B im_open(3)
and delay loading pixels until asked. If you leave this NULL, vips will just
use the
.B load()
function.
.B load()
Load the image from the file into the IMAGE. You can leave this function NULL
if you only have a
.B save()
method implemented. Load options may be embedded in the filename, see the
loaders below.
.B save()
Write from the IMAGE to the file in this format. You can leave this function
NULL if you only have a load method implemented. Save options may be embedded
in the filename, see the savers below.
.B get_flags()
A function which examines the file and sets various flags to indicate
properties of the image. The only flag implemented at the moment is
.B VIPS_FORMAT_PARTIAL
which may be set to indicate that the file can be read lazily.
.B priority
sets a priority for the format. Priorities for formats default to zero: you
mmay set a lower or higher number to set where in the format table your format
is positioned.
.B suffs
A NULL-terminated array of possible file-name suffixes for this format. This
list is used to filter filenames when they are shown to the user, and to help
select a format to sav a file as. For example, the JPEG format has the
suffixes:
.B { ".jpg", ".jpeg", ".jpe", NULL }
.B vips_format_map(3)
maps a function over the list of available formats. See
.B im_slist_map(3).
.B vips_format_for_file(3)
looks at a file on disc and selects the 'best' format to use to load that
file. If no suitable format is found, it returns NULL and sets an error
message.
.B vips_format_for_name(3)
looks at a filename and picks a format to use to save that file based on the
file extension. If no suitable format is found, it returns NULL and sets an
error message.
.B vips_format_read(3)
is a convenience function which copies the image from the file into the IMAGE.
error, it returns non-zero and sets an error message.
.B vips_format_write(3)
is a convenience function which copies the image to the file in the
appropriate format. On error, it returns non-zero and sets an error message.
.SH SUPPORTED FORMATS
See the following manpages for details on each of the converters and the
options they implement.
.B im_analyze2vips(3)
.B im_csv2vips(3)
.B im_exr2vips(3)
.B im_jpeg2vips(3)
.B im_magick2vips(3)
.B im_png2vips(3)
.B im_ppm2vips(3)
.B im_tiff2vips(3)
.B im_vips2csv(3)
.B im_vips2jpeg(3)
.B im_vips2png(3)
.B im_vips2ppm(3)
.B im_vips2tiff(3)
You can also load Matlab .mat files and load or save Radiance HDR files. See
.B im_binfile(3)
and
.B im_raw2vips(3)
for RAW file read.
You can list the supported formats with
$ vips --list classes
look for subclasses of
.B VipsFormat.
.SH RETURN VALUE
The functions return 0 success and -1 on error.
.SH SEE ALSO
im_tiff2vips(3), im_open(3), vips(1).
.SH AUTHOR
Jesper Friis and John Cupitt

100
man/VipsInterpolate.3
View File

@ -1,100 +0,0 @@
.TH VIPS_INTERPOLATE 3 "28 March 2009"
.SH NAME
VipsInterpolate,
vips_interpolate,
vips_interpolate_get_method,
vips_interpolate_get_window_size
\-
base class for VIPS interpolators
.SH SYNOPSIS
#include <vips/vips.h>
typedef void (*VipsInterpolateMethod)( VipsInterpolate *,
.br
PEL *out, REGION *in, double x, double y );
typedef struct _VipsInterpolateClass {
.br
VipsObjectClass parent_class;
VipsInterpolateMethod interpolate;
.br
int (*get_window_size)( VipsInterpolate * );
.br
int window_size;
.br
} VipsInterpolateClass;
void vips_interpolate( VipsInterpolate *interpolate,
.br
PEL *out, REGION *in, double x, double y );
.br
VipsInterpolateMethod vips_interpolate_get_method( VipsInterpolate * );
.br
int vips_interpolate_get_window_size( VipsInterpolate *interpolate );
VipsInterpolate *vips_interpolate_nearest_static( void );
.br
VipsInterpolate *vips_interpolate_bilinear_static( void );
.br
VipsInterpolate *vips_interpolate_bicubic_static( void );
VipsInterpolate *vips_interpolate_new( const char *nickname );
.SH DESCRIPTION
.B VipsInterpolate
is the base class for VIPS interpolators. It provides a simple framework that
subclasses use to implement the various interpolators that VIPS ships with.
You can add new interpolators by subclassing
.B VipsInterpolated
and implementing an
.B interpolate
method.
You can use any interpolator in your code via the methods of
.B VipsInterpolate.
.B vips_interpolate(3)
looks up the interpolate method for the object and calls it for you.
.B vips_interpolate_get_method(3)
just does the lookup and returns a pointer to the interpolate function. You
can use this to take the lookup out of an inner loop.
.B vips_interpolate_get_window_size(3)
either calls
.B get_window_size()
or if it is NULL, returns
.B window_size.
.B vips_interpolate_nearest_static(3),
.B vips_interpolate_bilinear_static(3)
and
.B vips_interpolate_bicubic_static(3)
are convenience functions which return a pointer to a static instance of a
nearest-neighbour, bilinear and bicubic interpolator. You can pass these to
any function which needs a
.B VipsInterpolator
as an argument. No need to free the result.
.B vips_interpolate_new(3)
is a convenience function which makes an interpolator from a nickname. Free
the result with
.B g_object_unref(3)
when you're done with it.
.SH SUPPORTED INTERPOLATORS
You can list the supported interpolators with
$ vips --list classes
look for subclasses of
.B VipsInterpolate.
.SH RETURN VALUE
Unless otherwise noted, functions return 0 success and -1 on error.
.SH SEE ALSO
VipsObject(3), VipsInterpolate(3),
vips_type_find(3), vips(1).
.SH AUTHOR
John Cupitt

317
man/VipsObject.3
View File

@ -1,317 +0,0 @@
.TH VIPS_OBJECT 3 "28 March 2009"
.SH NAME
VipsObject,
vips_object_build, vips_object_print_class,
vips_object_print,
vips_object_class_install_argument,
vips_argument_map,
vips_object_set_property,
vips_object_get_property,
vips_object_new,
vips_object_new_from_string,
vips_object_to_string
\-
VIPS base class
.SH SYNOPSIS
#include <vips/vips.h>
/* Flags we associate with each argument.
.br
*/
.br
typedef enum _VipsArgumentFlags {
.br
VIPS_ARGUMENT_NONE = 0,
/* Must be set in the constructor.
.br
*/
.br
VIPS_ARGUMENT_REQUIRED = 1,
/* Can only be set in the constructor.
.br
*/
.br
VIPS_ARGUMENT_CONSTRUCT = 2,
/* Can only be set once.
.br
*/
.br
VIPS_ARGUMENT_SET_ONCE = 4,
/* Have input & output flags. Both set is an error; neither set
.br
* is OK.
.br
*/
/* Is an input argument (one we depend on) ... if it's a gobject, we
.br
* should ref it. In our _dispose(), we should unref it.
.br
*/
.br
VIPS_ARGUMENT_INPUT = 8,
/* Is an output argument (one that depends on us) ... if it's a
.br
* gobject, we should ref ourselves. We watch "destroy" on the
.br
* argument: if it goes, we unref ourselves. If we dispose, we
.br
* disconnect the signal.
.br
*/
.br
VIPS_ARGUMENT_OUTPUT = 16
.br
} VipsArgumentFlags;
/* Useful flag combinations. User-visible ones are:
VIPS_ARGUMENT_REQURED_INPUT Eg. the "left" argument for add
VIPS_ARGUMENT_OPTIONAL_INPUT Eg. the "caption" for an object
VIPS_ARGUMENT_REQURED_OUTPUT Eg. the "result" of an add operation
VIPS_ARGUMENT_OPTIONAL_OUTPUT Eg. the "width" of an image
Other combinations are used internally, eg. supplying the cast-table
.br
for an arithmetic operation
*/
#define VIPS_ARGUMENT_REQUIRED_INPUT \
.br
(VIPS_ARGUMENT_INPUT | VIPS_ARGUMENT_REQUIRED | \
.br
VIPS_ARGUMENT_CONSTRUCT | VIPS_ARGUMENT_SET_ONCE)
#define VIPS_ARGUMENT_OPTIONAL_INPUT \
.br
(VIPS_ARGUMENT_INPUT | \
.br
VIPS_ARGUMENT_CONSTRUCT | VIPS_ARGUMENT_SET_ONCE)
#define VIPS_ARGUMENT_REQUIRED_OUTPUT \
.br
(VIPS_ARGUMENT_OUTPUT | VIPS_ARGUMENT_REQUIRED | \
.br
VIPS_ARGUMENT_SET_ONCE)
#define VIPS_ARGUMENT_OPTIONAL_OUTPUT \
.br
(VIPS_ARGUMENT_OUTPUT | \
.br
VIPS_ARGUMENT_SET_ONCE)
/* Keep one of these for every argument.
.br
*/
.br
typedef struct _VipsArgument {
.br
GParamSpec *pspec; /* pspec for this argument */
/* More stuff, see below */
.br
} VipsArgument;
typedef void *(*VipsArgumentMapFn)( VipsObject *, GParamSpec *,
.br
VipsArgumentClass *, VipsArgumentInstance *, void *a, void *b );
.br
void *vips_argument_map( VipsObject *object,
.br
VipsArgumentMapFn fn, void *a, void *b );
struct _VipsObject {
.br
GObject parent_object;
};
struct _VipsObjectClass {
.br
GObjectClass parent_class;
/* Build the object ... all argument properties have been set,
.br
* now build the thing.
.br
*/
.br
int (*build)( VipsObject *object );
/* Try to print something about the class, handy for help displays.
.br
*/
.br
void (*print_class)( struct _VipsObjectClass *, VipsBuf * );
/* Try to print something about the object, handy for debugging.
.br
*/
.br
void (*print)( VipsObject *, VipsBuf * );
/* Class nickname, eg. "VipsInterpolateBicubic" has "bicubic" as a
.br
* nickname. Not internationalised.
.br
*/
.br
const char *nickname;
/* Class description. Used for help messages, so internationalised.
.br
*/
.br
const char *description;
};
void vips_object_set_property( GObject *gobject,
.br
guint property_id, const GValue *value, GParamSpec *pspec );
.br
void vips_object_get_property( GObject *gobject,
.br
guint property_id, GValue *value, GParamSpec *pspec );
int vips_object_build( VipsObject *object );
.br
void vips_object_print_class( VipsObjectClass *klass );
.br
void vips_object_print( VipsObject *object );
void vips_object_class_install_argument( VipsObjectClass *,
.br
GParamSpec *pspec, VipsArgumentFlags flags, guint offset );
typedef void *(*VipsObjectSetArguments)( VipsObject *,
.br
void *, void * );
.br
VipsObject *vips_object_new( GType type,
.br
VipsObjectSetArguments set, void *a, void *b );
VipsObject *vips_object_new_from_string( const char *base,
.br
const char *str );
.br
void vips_object_to_string( VipsObject *object, VipsBuf *buf );
.SH DESCRIPTION
.B VipsObject
is the base class for VIPS. It provides some common features, like class
nicknames, and implements an extension to
.B GObject
for properties to let them be used more like function arguments.
.B VipsObject
is still being developed, so this documentation only covers enough of the
interface to let you use the classes that have been built on top of
.B VipsObject:
.B VipsInterpolate
and
.B VipsFormat.
Hopefully the next version will be more fleshed out.
.B VipsObject
adds two properties:
.B nickname
and
.B description.
They are actually class properties, but are available as instance properties
too for convenience.
.B nickname
is the non-internationalised nickname of the class and is used to simplify
lookup. For example, the
.B VipsInterpolateBicubic
class has the nickname "bicubic".
.B description
is the internationalised short description of the class.
For example, the
.B VipsInterpolateBicubic
class might have the description "bicubic interpolation (Catmull-Rom)".
Like the rest of VIPS,
.B VipsObject
is a functional type. You can set
properties during object construction, but not after that point. You may read
properties at any time after construction, but not before.
To enforce these rules, VIPS extends the standard
.B GObject
property
system and adds a new phase to object creation.
In class_init, after creating a property, you make it into an argument by
adding a call to
.B vips_object_class_install_argument(3).
This takes a set of flags, used to tell VIPS what sort of argument this is,
and an offset for the data value in the class instance. For example:
pspec = g_param_spec_string( "description",
_( "Description" ),
_( "Class description" ),
"",
(GParamFlags) G_PARAM_READWRITE );
g_object_class_install_property( gobject_class,
PROP_DESCRIPTION, pspec );
vips_object_class_install_argument( object_class, pspec,
VIPS_ARGUMENT_SET_ONCE,
G_STRUCT_OFFSET( VipsObject, description ) );
After
.B g_object_new(3)
you can continue to set arguments. After you have set all the ones you want to
set, call
.B vips_object_build(3)
to check that required arguments have been set, no arguments have been set
many times, and so on.
Once a
.B VipsObject
has been built, you can no longer set arguments, but you can read them.
Use
.B vips_argument_map(3)
to iterate over the arguments for an object in the correct order. You can use
this to discover the arguments any class takes at runtime.
.B vips_object_set_property(3)
and
.B vips_object_get_property(3)
are used in subclasses of
.B VipsObject
to get and set object arguments. You don't need to implement your own get/set
methods.
.B vips_object_new(3)
is a convenience function which encapsulates the new/set/build sequence
outlined above.
.B vips_object_new_from_string(3)
is a convenience function which builds an object from a set of arguments
encoded as a string. It used used by the VIPS command-line program to generate
operation arguments.
.B vips_object_to_string(3)
is the exact inverse: it prints the string that would construct an object.
.SH RETURN VALUE
Unless otherwise noted, functions return 0 success and -1 on error.
.SH SEE ALSO
VipsFormat(3), VipsInterpolate(3),
vips_type_find(3).
.SH AUTHOR
John Cupitt

22
man/batch_crop.1
View File

@ -1,22 +0,0 @@
.TH BATCH_CROP 1 "2 Feb 2002"
.SH NAME
batch_crop \- crop a set of images
.SH SYNOPSIS
.B batch_crop left top width height image1 image2 ...
.SH DESCRIPTION
The area defined by the rectangle left, top, width, height is cropped out of
each of the images and saved in a file of the same name, but prefixed by
"crop_".
For example:
batch_crop 10 10 100 100 fred.jpg jim.png
will make two images, crop_fred.jpg and crop_jim.png, each of 100 by 100
pixels, taken from the corresponding input images.
.SH RETURN VALUE
returns 0 on success and non-zero on error.
.SH SEE ALSO
header(1), im_vips2tiff(3), im_vips2jpeg(3), im_vips2png(3), im_vips2ppm(3)

29
man/batch_image_convert.1
View File

@ -1,29 +0,0 @@
.TH BATCH_IMAGE_CONVERT 1 "2 Feb 2002"
.SH NAME
batch_image_convert \- use VIPS to convert a set of images to a new type
.SH SYNOPSIS
.B batch_image_convert type image1 image2 ...
.SH DESCRIPTION
The first argument is the name of an image type, subsequent arguments are
the names of files to be converted to that type. VIPS can usually read almost
any image type, but it can only write VIPS, PNG, TIFF, PPM/PGM/PBM and JPEG.
You can specify conversion parameters in the type name.
For example:
batch_image_convert tiff fred.jpg jim.png
will convert
.B fred.jpg
and
.B jim.png
to TIFF format.
batch_image_convert jpeg:95 jim.png
will write jim.jpeg with a 95% quality factor.
.SH RETURN VALUE
returns 0 on success and non-zero on error.
.SH SEE ALSO
header(1), im_vips2tiff(3), im_vips2jpeg(3), im_vips2png(3), im_vips2ppm(3)

30
man/batch_rubber_sheet.1
View File

@ -1,30 +0,0 @@
.TH BATCH_RUBBER_SHEET 1 "2 Feb 2002"
.SH NAME
batch_rubber_sheet \- warp a set of images with a rubber-sheet transformation
.SH SYNOPSIS
.B batch_rubber_sheet matrix image1 image2 ...
.SH DESCRIPTION
The first argument specifies a file containing the transformation, subsequent
arguments are image files to be transformed. The transformed image is written
to a new file, named as the old file, but with "rsc_" prepended to the file
name.
For example:
batch_rubber_sheet lens.mat fred.jpg jim.png
will read a transform from the file
.B lens.mat
and apply it to
.B fred.jpg
and
.B jim.png,
writing files
.B rsc_fred.jpg
and
.B rsc_jim.png.
.SH RETURN VALUE
returns 0 on success and non-zero on error.
.SH SEE ALSO
The "Image=>Rubber" menu in nip.

19
man/binfile.1
View File

@ -1,19 +0,0 @@
.TH BINFILE 1 "11 April 1990"
.SH NAME
im_binfile \- convert raw binary files to VIPS format
.SH SYNOPSIS
.B binfile in out xs ys b
.SH DESCRIPTION
.B binfile
expects as input a raw UNIX file with its filename held by the string in
and writes it to the vasari image file out by filling properly the header
details. It is expected that the file has sizes xs by ys and
has b bands. It is an error if the file in has less than xs*ys*b data.
The program is unable to check whether the supplied xs, ys and b are correct.
.SH SEE\ ALSO
im_binfile(3).
.SH COPYRIGHT
.br
N. Dessipris
.SH AUTHOR
N. Dessipris \- 11/04/1990

41
man/cooc.1
View File

@ -1,41 +0,0 @@
.TH COOC 1 "27 Jan 1992"
.SH NAME
cooc, cooc_features \- calculate the co-occurrence matrix and features on it
.SH SYNOPSIS
cooc image matrix xpos ypos xsize ysize dx dy flag
.br
.B cooc_features matrix
.SH DESCRIPTION
.B cooc
creates a 256 by 256 one channel co-occurrence matrix of the box
determined by the parameters (xp, yp; xs, ys) within
the image file. The matrix
is written onto the Vasari image file matrix. The displacement
vector is determined by (dx, dy). The user must ensure that there
is enough border pixels around the box within im dictated by the displacement
vector (dx,dy) or else the program fails.
All entries of the co-occurrence matrix are double normalised to the number
of pairs involved. This function is a direct implementation of the paper:
Haralick R. M., Shanmugan K. and Dinstein I., 'Textural features for
image classification', IEEE Transactions on Systems, Man, and Cybernetics,
Vol. SMC-3, No 6, Nov. 1973, pp 610-621.
If flag sym is 1, the created co-occurrence matrix is symmetric that is
dispacement vectors (dx, dy), (-dx, -dy) create exactly the same matrix.
If sym is 0, the created co-occurrence matrix is not symmetric that is
dispacement vectors (dx, dy), (-dx, -dy) create different matrices.
Input image should be one band unsigned char image.
.B cooc_features
calculates and prints at the standard error output features
of the cooccurrence matrix matrix.
.SH SEE\ ALSO
im_glds_matrix(3X), im_cooc_asm(3X), im_cooc_contrast(3X),
im_cooc_correlation(3X), im_cooc_entropy(3X)
.SH COPYRIGHT
.br
N. Dessipris
.SH AUTHOR
N. Dessipris \- 27/2/1992

1
man/cooc_features.1
View File

@ -1 +0,0 @@
.so man1/cooc.1

21
man/debugim.1
View File

@ -1,21 +0,0 @@
.TH DEBUGIM 1 "12 July 1990"
.SH NAME
debugim, printlines \- prints the raw image data of a vasari file format
.SH SYNOPSIS
debugim infile
printlines infile
.SH DESCRIPTION
debugim prints at the standard error output the raw image data of a vasari
format file. This function is useful for debugging when applied on small
image files
printlines prints at the standard error output the raw image data of a vasari
format together with the line no and the x location and the value(s) of each
pixel.
.SH SEE ALSO
im_intro(3X), im_debugim(3X), im_printlines(3X), vips2mask(1X).
.SH COPYRIGHT
N. Dessipris
.SH AUTHOR
N. Dessipris \- 12/07/1990

49
man/edvips.1
View File

@ -1,49 +0,0 @@
.TH EDVIPS 1 "30 June 1993"
.SH NAME
edvips \- edit header of a vips image file
.SH SYNOPSIS
.B edvips [OPTION...] vipsfile
.SH DESCRIPTION
.B edvips
alters a VIPS image file's header. This is useful for setting the resolution,
for example.
The options are:
-x, --xsize=N set Xsize to N
-y, --ysize=N set Ysize to N
-b, --bands=N set Bands to N
-f, --format=F set BandFmt to F (eg. IM_BANDFMT_UCHAR)
-t, --type=T set Type to T (eg. IM_TYPE_XYZ)
-c, --coding=C set Coding to C (eg. IM_CODING_LABQ)
-X, --xres=R set Xres to R pixels/mm
-Y, --yres=R set Yres to R pixels/mm
-u, --xoffset=N set Xoffset to N
-v, --yoffset=N set Yoffset to N
-e, --setext replace extension block with stdin
Be very careful when changing Xsize, Ysize, BandFmt or Bands. edvips does no
checking!
.SH EXAMPLES
To set the Xsize to 512 and Bands to 6:
edvips --xsize=512 --bands=6 fred.v
or
edvips -x 512 -b 6 fred.v
Extract the XML metadata from an image with
.B header(1),
edit it, and reattach with
.B edvips(1).
header -f getext fred.v | sed s/banana/pineapple/ | edvips -e fred.v
.SH RETURN VALUE
returns 0 on success and non-zero on error.
.SH SEE ALSO
header(1)
.SH COPYRIGHT
K. Martinez 1993

1
man/error_exit.3
View File

@ -1 +0,0 @@
.so man3/im_error.3

35
man/glds.1
View File

@ -1,35 +0,0 @@
.TH GLDS 1 "27 January 1992"
.SH NAME
glds, glds_features \- calculate the spatial grey level difference matrix and features on it
.SH SYNOPSIS
glds image matrix xpos ypos xsize ysize dx dy
glds_features matrix
.SH DESCRIPTION
.B glds
creates a 256 by 1 one channel spatial grey level difference
matrix (sglds) of the box
determined by the parameters (xp, yp; xs, ys) within
the vasari image file image. The matrix
is written onto the vasari image file matrix. The displacement
vector is determined by (dx, dy). The user must ensure that there
is enough border pixels around the box within im dictated by the displacement
vector (dx,dy) or else the program fails.
All entries of the sgld matrix are double normalised to the number
of pairs involved. This function is a direct implementation of the paper:
Haralick R. M., Shanmugan K. and Dinstein I., 'Textural features for
image classification', IEEE Transactions on Systems, Man, and Cybernetics,
Vol. SMC-3, No 6, Nov. 1973, pp 610-621.
Input im should be one band unsigned char image file.
.B glds_features
calculates features on the spatial grey level difference vasari image
file matrix. The calculated features are printed in the stderr.
.SH SEE\ ALSO
im_glds_matrix(3X), im_glds_asm(3X), im_glds_contrast(3X),
im_glds_correlation(3X), im_glds_entropy(3X).
.SH COPYRIGHT
N. Dessipris
.SH AUTHOR
N. Dessipris \- 27/02/1992

1
man/glds_features.1
View File

@ -1 +0,0 @@
.so man1/glds.1

33
man/header.1
View File

@ -1,33 +0,0 @@
.TH HEADER 1 "12 July 1990"
.SH NAME
header \- prints information about an image file
.SH SYNOPSIS
header [OPTIONS ...] files ...
.SH DESCRIPTION
.B header(1)
prints image header fields to stdout.
.SH OPTIONS
.TP
.B -f FIELD, --field=FIELD
Print value of
.B FIELD
from image header. The special field name getext prints
the VIPS extension block: the XML defining the image metadata. You can alter
this, then reattach with
.B edvips(1).
.SH EXAMPLES
pineapple:~/CVS/vips-7.12/src/iofuncs john$ header -f Xsize ~/pics/*.v
1024
1279
22865
1
256
.SH SEE ALSO
im_intro(3), edvips(1), im_printdesc(3), im_header_get(3).
.SH COPYRIGHT
N. Dessipris
.SH AUTHOR
N. Dessipris \- 12/07/1990

1
man/im_BandFmt2char.3
View File

@ -1 +0,0 @@
.so man3/im_printdesc.3

1
man/im_Coding2char.3
View File

@ -1 +0,0 @@
.so man3/im_printdesc.3

1
man/im_Compression2char.3
View File

@ -1 +0,0 @@
.so man3/im_printdesc.3

1
man/im_LCh2Lab.3
View File

@ -1 +0,0 @@
.so man3/im_XYZ2disp.3

1
man/im_LCh2UCS.3
View File

@ -1 +0,0 @@
.so man3/im_XYZ2disp.3

1
man/im_Lab2LCh.3
View File

@ -1 +0,0 @@
.so man3/im_XYZ2disp.3

59
man/im_Lab2LabQ.3
View File

@ -1,59 +0,0 @@
.TH IM_XYZ2disp 3 "2 Decemder 1992"
.SH NAME
im_LabQ2Lab, im_Lab2LabQ, im_LabQ2LabS, im_LabS2LabQ, im_Lab2LabS, im_LabS2Lab \- pack and unpack LABPACK images.
.SH SYNOPSIS
#include <vips/vips.h>
int im_LabQ2Lab(in, out)
.br
IMAGE *in, *out;
int im_Lab2LabQ(in, out)
.br
IMAGE *in, *out;
int im_Lab2LabS(in, out)
.br
IMAGE *in, *out;
int im_LabS2LabQ(in, out)
.br
IMAGE *in, *out;
int im_LabS2Lab(in, out)
.br
IMAGE *in, *out;
int im_LabQ2LabS(in, out)
.br
IMAGE *in, *out;
.SH DESCRIPTION
These functions pack and unpack LAB images.
LabQ is Lab packed in to 4 unsigned chars, with the Coding field set to
LABPACK. It counts as a coded type, since most operations will not give the
correct result on an image of this type. This is the MARC image type. Bits
are allocated as 10 for L and 11 for each of a and b. The first three bytes
contain the 8 most significant bits of Lab respectively, the final byte has
2/3/3 bits (MSB on left) of Lab respectively.
im_LabQ2Lab() and im_Lab2LabQ() convert LABPACK images to three band float
images, scaled to look sensible to humans. This is the most convenient LAB
format for development work, but is rather slow.
im_LabQ2LabS() and im_LabS2LabQ() convert LABPACK to and from three band
signed short images. L is shifted and masked to be in the range [0,32767], a
and b are shifted and masked to lie in [-32768,32767]. This is the best
computational LAB format, combining precision and speed. Programs such as
conv(1X) and similarity(1X), which can operate directly on LABPACK images,
unpack to LabS for computation.
.SH RETURN VALUE
The functions return 0 on success and -1 on error.
.SH SEE ALSO
im_col_XYZ2rgb(3), im_dE_fromdisp(3), im_XYZ2disp(3).
.SH COPYRIGHT
National Gallery, 1990 - 1993
.SH AUTHOR
J. Cupitt \- 21/7/93

1
man/im_Lab2LabS.3
View File

@ -1 +0,0 @@
.so man3/im_Lab2LabQ.3

70
man/im_Lab2UCS.3
View File

@ -1,70 +0,0 @@
.TH IM_LAB2UCS 3 "2 December 1992"
.SH NAME
im_Lab2UCS, im_LabQ2XYZ, im_UCS2Lab, im_Lab2disp, im_disp2Lab, im_UCS2XYZ,
im_XYZ2UCS \- derived colour space conversion functions
.SH SYNOPSIS
#include <vips/vips.h>
int im_Lab2UCS(in, out)
.br
IMAGE *in, *out;
int im_LabQ2XYZ(in, out)
.br
IMAGE *in, *out;
int im_UCS2Lab(in, out)
.br
IMAGE *in, *out;
int im_Lab2disp(in, out, display)
.br
IMAGE *in, *out;
.br
struct im_col_display *display;
int im_disp2Lab(in, out, display)
.br
IMAGE *in, *out;
.br
struct im_col_display *display;
int im_UCS2XYZ(in, out)
.br
IMAGE *in, *out;
int im_XYZ2UCS(in, out)
.br
IMAGE *in, *out;
.SH DESCRIPTION
These functions are built on the basic VIPS colour space transformations as a
convenience for the programmer. See im_Lab2XYZ(3) for an explanation of the
colour spaces and the basic conversion functions.
im_Lab2UCS(3), for example, is defined as:
int
im_Lab2UCS( IMAGE *in, IMAGE *out )
{
IMAGE *t1 = im_open_local( out,
"im_Lab2UCS intermediate", "p" );
if( !t1 ||
im_Lab2LCh( in, t1 ) ||
im_LCh2UCS( t1, out ) )
return( -1 );
return( 0 );
}
.SH RETURN VALUE
The functions return 0 on success and -1 on error.
.SH SEE ALSO
im_col_XYZ2rgb(3), im_dE_fromLab(3), im_LabQ2Lab(3), im_Lab2disp(3).
.SH COPYRIGHT
National Gallery and Birkbeck College, 1990 - 1993
.SH AUTHOR
K. Martinez \- 2/12/1992
.br
J. Cupitt \- 21/7/93

1
man/im_Lab2XYZ.3
View File

@ -1 +0,0 @@
.so man3/im_XYZ2disp.3

1
man/im_Lab2disp.3
View File

@ -1 +0,0 @@
.so man3/im_Lab2UCS.3

1
man/im_LabQ2Lab.3
View File

@ -1 +0,0 @@
.so man3/im_Lab2LabQ.3

1
man/im_LabQ2LabS.3
View File

@ -1 +0,0 @@
.so man3/im_Lab2LabQ.3

1
man/im_LabQ2XYZ.3
View File

@ -1 +0,0 @@
.so man3/im_Lab2UCS.3

32
man/im_LabQ2disp.3
View File

@ -1,32 +0,0 @@
.TH IM_LABQ2DISP 3 "2 Decemder 1997"
.SH NAME
im_LabQ2disp, im_LabQ2disp_build_table, im_LabQ2disp_table \- convert LabQ to display rgb quickly and badly
.SH SYNOPSIS
#include <vips/vips.h>
int im_LabQ2disp( IMAGE *in, IMAGE *out, struct im_col_display *d );
void *im_LabQ2disp_build_table( IMAGE *out, struct im_col_display *d );
int im_LabQ2disp_table( IMAGE *in, IMAGE *out, void *table );
.SH DESCRIPTION
These functions convert LabQ images to displayable RGB as quickly as possible.
im_LabQ2disp() converts in to out using the display profile d. It has to build
a large lookup table, so takes a while to start.
im_LabQ2disp_build_table() is just the table-build phase of im_LabQ2disp(). It
returns a handle to the built table (or NULL for error). The memory for the
table is allocated local to out (ie is freed when out is closed).
im_LabQ2disp_table() converts in to out using the supplied table.
.SH RETURN VALUE
The functions return 0 on success and -1 on error.
.SH SEE ALSO
im_LabQ2Lab(3), im_Lab2XYZ(3), im_XYZ2disp(3)
.SH COPYRIGHT
National Gallery, 1990 - 1997
.SH AUTHOR
J. Cupitt \- 21/7/97

1
man/im_LabQ2disp_build_table.3
View File

@ -1 +0,0 @@
.so man3/im_LabQ2disp.3

1
man/im_LabQ2disp_table.3
View File

@ -1 +0,0 @@
.so man3/im_LabQ2disp.3

1
man/im_LabS2Lab.3
View File

@ -1 +0,0 @@
.so man3/im_Lab2LabQ.3

1
man/im_LabS2LabQ.3
View File

@ -1 +0,0 @@
.so man3/im_Lab2LabQ.3

1
man/im_Type2char.3
View File

@ -1 +0,0 @@
.so man3/im_printdesc.3

1
man/im_UCS2LCh.3
View File

@ -1 +0,0 @@
.so man3/im_XYZ2disp.3

1
man/im_UCS2Lab.3
View File

@ -1 +0,0 @@
.so man3/im_Lab2UCS.3

1
man/im_UCS2XYZ.3
View File

@ -1 +0,0 @@
.so man3/im_Lab2UCS.3

1
man/im_XYZ2Lab.3
View File

@ -1 +0,0 @@
.so man3/im_XYZ2disp.3

1
man/im_XYZ2UCS.3
View File

@ -1 +0,0 @@
.so man3/im_Lab2UCS.3

1
man/im_XYZ2Yxy.3
View File

@ -1 +0,0 @@
.so man3/im_XYZ2disp.3

142
man/im_XYZ2disp.3
View File

@ -1,142 +0,0 @@
.TH IM_XYZ2disp 3 "2 Decemder 1992"
.SH NAME
im_XYZ2disp, im_disp2XYZ, im_Lab2XYZ, im_XYZ2Lab, im_XYZ2Yxy, im_Yxy2XYZ,
im_XYZ2sRGB, im_sRGB2XYZ,
im_Lab2LCh, im_LCh2Lab, im_LCh2UCS, im_UCS2LCh \- convert images between
various colour spaces
.SH SYNOPSIS
#include <vips/vips.h>
int im_XYZ2disp(in, out, display)
.br
IMAGE *in, *out;
.br
struct im_col_display *display;
int im_disp2XYZ(in, out, display)
.br
IMAGE *in, *out;
.br
struct im_col_display *display;
int im_Lab2XYZ(in, out)
.br
IMAGE *in, *out;
int im_XYZ2Lab(in, out)
.br
IMAGE *in, *out;
int im_XYZ2Yxy(in, out)
.br
IMAGE *in, *out;
int im_Yxy2XYZ(in, out)
.br
IMAGE *in, *out;
int im_XYZ2sRGB(in, out)
.br
IMAGE *in, *out;
int im_sRGB2XYZ(in, out)
.br
IMAGE *in, *out;
int im_Lab2LCh(in, out)
.br
IMAGE *in, *out;
int im_LCh2Lab(in, out)
.br
IMAGE *in, *out;
int im_LCh2UCS(in, out)
.br
IMAGE *in, *out;
int im_UCS2LCh(in, out)
.br
IMAGE *in, *out;
.SH DESCRIPTION
Functions to convert images between the different colour spaces supported by
VIPS: RGB, sRGB, XYZ, Yxy, Lab, LCh and UCS. RGB and sRGB are three band uchar
files. XYZ, Lab, LCh and UCS are three band float files.
These are the basic conversion routines provided by VIPS. Other conversions,
such as im_Lab2disp(3), are built by composing these functions and are provided
as a convenience to the programmer.
The VIPS colour spaces inter-convert as follows:
+------- sRGB
|
LabQ ----- Lab ----- XYZ ----- RGB
| | |
| | +------- Yxy
| |
| +------- LCh ----- UCS
|
+-------- LabS
The colour spaces are:
LabQ --- This is the principal VIPS colorimetric storage format. See
im_LabQ2Lab(3) for an explanation. You cannot perform calculations on LabQ
images. They are for storage only.
LabS --- This format represents coordinates in CIE Lab space as 16-bit
integers. It is the best format for computation, being relatively compact,
quick, and accurate. Colour values expressed in this way are hard to
visualise. See the page for im_LabQ2LabS().
Lab --- Coordinates in CIE Lab space are represented as float values in the
usual range. This is the easiest format for general work: adding 50 to the L
channel, for example, has the expected result.
XYZ --- CIE XYZ colour space.
Yxy --- CIE Yxy colour space.
RGB --- This format is compatible with the RGB colour systems used in other
packages. If you want to export your image to a PC, for example, convert your
colorimetric image to RGB, then turn it to TIFF with vips2TIFF(1). You need to
supply a structure which characterises your display. See the manual page for
im_col_XYZ2rgb(3) for hints on these guys.
sRGB --- This is a standard RGB, as defined by:
http://www.color.org/contrib/sRGB.html
it's handy for carrying colour information through JPEG compressors, for
example.
LCh --- Like Lab, but the rectangular ab coordinates are replaced with the
polar Ch (Chroma and hue) coordinates. Hue angles are expressed in degrees.
UCS --- A colour space based on the CMC(1:1) colour difference measurement.
This is a highly uniform colour space, much better than Lab for expressing
small differences. Conversions to and from UCS are extremely slow.
These conversions set the Type field in the image header to LABQ, LABS, LAB,
XYZ, RGB, sRGB, LCH and UCS respectively. The Type field is for user
information only --- no function reads the Type field to determine its
behaviour. Visualisation programs, such as ip(1), use the Type field to help
present the information to the user.
All VIPS colour spaces are based around D65.
VIPS has functions for finding colour difference images. See
im_dE_fromLab(3).
.SH RETURN VALUE
The functions return 0 on success and -1 on error.
.SH SEE ALSO
im_col_XYZ2rgb(3), im_dE_fromLab(3), im_LabQ2Lab(3), im_Lab2disp(3).
.SH COPYRIGHT
National Gallery and Birkbeck College, 1990 - 1993
.SH AUTHOR
K. Martinez \- 2/12/1992
.br
J. Cupitt \- 21/7/93

1
man/im_XYZ2sRGB.3
View File

@ -1 +0,0 @@
.so man3/im_XYZ2disp.3

1
man/im_Yxy2XYZ.3
View File

@ -1 +0,0 @@
.so man3/im_XYZ2disp.3

18
man/im_abs.3
View File

@ -1,18 +0,0 @@
.TH IM_ABS 3 "25 April 1991"
.SH NAME
im_abs \- finds the absolute value or the magnitude of an image
.SH SYNOPSIS
#include <vips/vips.h>
int im_abs( in, out )
.br
IMAGE *in, *out;
.SH DESCRIPTION
.B im_abs(3)
finds the absolute value of an image. Copy for UNSIGNED types, negate
for int types, fabs(3) for float types, and calculate modulus for
complex types. Any size, any number of bands.
.SH RETURN VALUE
The function returns 0 on success and -1 on error.
.SH SEE ALSO
im_exp10tra(3), im_sign(3)

1
man/im_acostra.3
View File

@ -1 +0,0 @@
.so man3/im_costra.3

102
man/im_add.3
View File

@ -1,102 +0,0 @@
.TH ADDITION 3 "24 April 1991"
.SH NAME
im_add, im_gadd, im_gaddim, im_gfadd \- add two images
.SH SYNOPSIS
#include <vips/vips.h>
int im_add(in1, in2, out)
.br
IMAGE *in1, *in2, *out;
int im_gadd(a, in1, b, in2, c, out)
.br
double a, b, c;
.br
IMAGE *in1, *in2, *out;
int im_gaddim(a, in1, b, in2, c, out)
.br
double a, b, c;
.br
IMAGE *in1, *in2, *out;
int im_gfadd(a, in1, b, in2, c, out)
.br
double a, b, c;
.br
IMAGE *in1, *in2, *out;
.SH DESCRIPTION
These functions operate on two images held by image descriptors in1 and in2
and write the result to the image descriptor out. Input images in1 and in2
should have the same channels and the same size; however they can be of
different types. Only the history of the image descriptor pointed by in1 is
copied to out.
.B im_add(3)
For two integer images, add the two images and write the output as
in1 - uchar char ushort short uint int
-------|-----------------------------------------
in2 |
uchar | ushort short ushort short uint int
char | short short short short int int
ushort | ushort short ushort short uint int
short | short short short short int int
uint | uint int uint int uint int
int | int int int int int int
If one or more of the images is a floating point type, the output is FMTFLOAT,
unless one or more of the inputs is FMTDOUBLE, in which case the output is
also FMTDOUBLE.
If one or more of the images is a complex type, the output is FMTCOMPLEX,
unless one or more of the inputs is FMTDPCOMPLEX, in which case the output is
also FMTDPCOMPLEX.
.B im_gadd(3)
performs generalised addition of two images by calling
.B im_gaddim(3)
and
.B im_gfadd(3).
These are very old and tired things, and should not be used.
Input should be non complex. Output depends on input according to function
called. The result at each point is: a * pel1 + b * pel2 + c, properly
rounded if necessary. Pel1 and pel2 are the
corresponding pixels from in1 and in2 respectively.
im_gaddim() performs generalised addition of in1 and in2, on the condition
they are neither float nor double nor complex. The format of the resultant
image is given by the table:
in1 - uchar char ushort short uint int
-------|-----------------------------------------
in2 |
uchar | ushort short ushort short uint int
char | short short short short int int
ushort | ushort short ushort short uint int
short | short short short short int int
uint | uint int uint int uint int
int | int int int int int int
The result at each point is: a * pel1 + b * pel2 + c, properly rounded. Pel1
and pel2 are the corresponding pixels from in1 and in2 respectively.
.B im_gfadd(3)
adds the non-complex images pointed by in1 and in2. Result is
float except if one (or both) inputs is double. In the latter case the result
is double. The result at each point is: a * pel1 + b * pel2 + c. Pel1 and
pel2 are the corresponding pixels from in1 and in2 respectively.
.SH BUGS
None of the functions checks the result for over/underflow.
.SH RETURN VALUE
All functions return 0 on success and -1 on error.
.SH SEE ALSO
im_subtract(3), im_lintra(3), im_multiply(3).
.SH AUTHOR
N. Dessipris \- 22/04/1991
.br
J. Cupitt, im_add(), \- 21/7/93

1
man/im_add_close_callback.3
View File

@ -1 +0,0 @@
.so man3/im_malloc.3

1
man/im_add_eval_callback.3
View File

@ -1 +0,0 @@
.so man3/im_malloc.3

1
man/im_add_evalend_callback.3
View File

@ -1 +0,0 @@
.so man3/im_malloc.3

1
man/im_add_evalstart_callback.3
View File

@ -1 +0,0 @@
.so man3/im_malloc.3

1
man/im_add_invalidate_callback.3
View File

@ -1 +0,0 @@
.so man3/im_malloc.3

1
man/im_add_preclose_callback.3
View File

@ -1 +0,0 @@
.so man3/im_malloc.3

27
man/im_addgnoise.3
View File

@ -1,27 +0,0 @@
.TH IM_ADDGNOISE 3 "14 May 1991"
.SH NAME
im_addgnoise \- add gaussian noise to an image
.SH SYNOPSIS
#include <vips/vips.h>
int im_addgnoise(in, out, sigma)
.br
IMAGE *in, *out;
.br
double sigma;
.SH DESCRIPTION
im_addgnoise() adds gaussian noise with mean 0 and standard deviation sigma to
the image held by the image descriptor in and writes the result on the image
descriptor out. The function works on any non-complex input image.
Input can have any no of bands. The noise is generated by adding
12 random numbers.
.SH RETURN VALUE
The function returns 0 on success and -1 on error.
.SH SEE ALSO
im_add(3), im_lintra(3), im_multiply(3).
.SH COPYRIGHT
N. Dessipris
.SH AUTHOR
N. Dessipris \- 25/04/1991

41
man/im_affine.3
View File

@ -1,41 +0,0 @@
.TH IM_AFFINE 3 "21 December 1999"
.SH NAME
im_affine \- apply an affine transform to an image
.SH SYNOPSIS
.B #include <vips/vips.h>
int im_affine(in, out, a, b, c, d, dx, dy, x, y, w, h)
.br
.B IMAGE *in, *out;
.br
.B double a, b, c, d, dx, dy;
.br
.B int x, y;
.br
.B int w, h;
.SH DESCRIPTION
This function is deprecated. See
.B im_affine(3)
for the replacement.
.B im_affine(3)
applies an affine transformation on the image held by the IMAGE descriptor
in and puts the result at the location pointed by the IMAGE descriptor out. in
many have any number of bands, be any size, and have any non-complex type.
The transformation is described by a, b, c, d, dx, dy. The point (x,y) in
the input is mapped onto point (X,Y) in the output by
X = a * x + b * y + dx
Y = c * x + d * y + dy
The area of the output image given by w, h, x, y is generated. (0,0) is
the position of the transformed top-left-hand corner of the input image.
Function im_affine resamples the transformed image using bilinear
interpolation.
.SH RETURN VALUE
The functions return 0 on success and -1 on error.
.SH SEE ALSO
im_similarity(3)

58
man/im_affinei.3
View File

@ -1,58 +0,0 @@
.TH IM_AFFINEI 3 "8 February 2009"
.SH NAME
im_affinei \- apply an affine transform to an image
.SH SYNOPSIS
.B #include <vips/vips.h>
int im_affinei(in, out, interpolate, a, b, c, d, dx, dy, x, y, w, h)
.br
.B IMAGE *in, *out;
.br
.B VipsInterpolate *interpolate;
.br
.B double a, b, c, d, dx, dy;
.br
.B int x, y;
.br
.B int w, h;
int im_affinei_all(in, out, interpolate, a, b, c, d, dx, dy)
.br
.B IMAGE *in, *out;
.br
.B VipsInterpolate *interpolate;
.br
.B double a, b, c, d, dx, dy;
.SH DESCRIPTION
.B im_affinei(3)
applies an affine transformation on the image held by the IMAGE descriptor
in and puts the result at the location pointed by the IMAGE descriptor out. in
many have any number of bands, be any size, and have any non-complex type.
The transformation is described by a, b, c, d, dx, dy. The point (x,y) in
the input is mapped onto point (X,Y) in the output by
X = a * x + b * y + dx
Y = c * x + d * y + dy
The area of the output image given by w, h, x, y is generated. (0,0) is
the position of the transformed top-left-hand corner of the input image.
Points are generated using the supplied interpolator. See
.B VipsInterpolate(3)
for a list of the interpolators that come with vips.
.B im_affinei_all(3)
is a convenience function that transforms the whole of the input image. It
calls
.B im_affine(3)
for you, with x y w h set to exactly enclose the transformed image.
.SH RETURN VALUE
The functions return 0 on success and -1 on error.
.SH BUGS
As with most resamplers, im_affine(3) performs poorly at the edges of
images.
.SH SEE ALSO
im_similarity(3)

1
man/im_affinei_all.3
View File

@ -1 +0,0 @@
.so man3/im_affinei.3

1
man/im_allocate_input_array.3
View File

@ -1 +0,0 @@
.so man3/im_generate.3

1
man/im_amiMSBfirst.3
View File

@ -1 +0,0 @@
.so man3/im_iscomplex.3

33
man/im_analyze2vips.3
View File

@ -1,33 +0,0 @@
.TH IM_ANALYZE2VIPS 3 "4 August 2005"
.SH NAME
im_analyze2vips \- convert Analyze 7.5 images to VIPS format
.SH SYNOPSIS
#include <vips/vips.h>
int im_analyze2vips( const char *filename, IMAGE *out )
.SH DESCRIPTION
.B im_analyze2vips(3)
reads the Analyze image in
.B filename,
and writes the image out
in VIPS format. It can read (almost) any Analyze format image. Images with
more than two dimensions simply appear as a very tall, thin strip. Use
.B im_grid(3)
to lay the tiles out as your prefer.
It reads the old-style 7.5 format, where the header and the image data are
stored in separate files. You can give the name of either the header (for
example, "fred.hdr") the image data (for example, "fred.img"), or neither (eg.
"fred").
The fields in the Analyze header appear in the VIPS header with a "dsr-"
prefix. So the Analyze field "patient_id", which is part of data_history, may
be retrieved with
im_header_string "dsr-data_history.patient_id" fred.v
.SH SEE ALSO
im_grid(3)
.SH COPYRIGHT
Imperial College 2005

2
man/im_and_vec.3
View File

@ -1,2 +0,0 @@
.so man3/im_andimage.3

1
man/im_andconst.3
View File

@ -1 +0,0 @@
.so man3/im_andimage.3

91
man/im_andimage.3
View File

@ -1,91 +0,0 @@
.TH IM_ANDIMAGE 3 "30 October 1992"
.SH NAME
im_andimage, im_andconst, im_and_vec, im_orimage, im_orconst, im_or_vec,
im_eorimage, im_eorconst, im_eor_vec \- boolean
operations on unsigned char images
.SH SYNOPSIS
.B #include <vips/vips.h>
.B int im_andimage(a, b, out)
.br
.B IMAGE *a, *b, *out;
.B int im_andconst(a, out, c)
.br
.B IMAGE *a, *out;
.br
.B double c;
.B int im_and_vec(a, out, n, v)
.br
.B IMAGE *a, *out;
.br
.B int n;
.br
.B double *v;
.B int im_orimage(a, b, out)
.br
.B IMAGE *a, *b, *out;
.B int im_orconst(a, out, c)
.br
.B IMAGE *a, *out;
.br
.B double c;
.B int im_or_vec(a, out, n, v)
.br
.B IMAGE *a, *out;
.br
.B int n;
.br
.B double *v;
.B int im_eorimage(a, b, out)
.br
.B IMAGE *a, *b, *out;
.B int im_eorconst(a, out, c)
.br
.B IMAGE *a, *out;
.br
.B double c;
.B int im_eor_vec(a, out, n, v)
.br
.B IMAGE *a, *out;
.br
.B int n;
.br
.B double *v;
.SH DESCRIPTION
Perform bitwise logical operations on integer images.
.B im_andimage(3)
performs bitwise and between corresponding pixels in a and b, writing the
result to out. Both images must be the same size and have the same number
of bands. They can have any integer type.
.B im_andconst(3)
performs bitwise and between pixels in a and a single
constant value.
.B im_and_vec(3)
lets you specify n constants, one per band.
.B im_orimage(3)
and
.B im_eorimage(3)
behave similarly. Use im_eorconst( in, out, -1 ) or
.B im_invert(3)
as a not operator.
.SH RETURN VALUE
All functions return 0 on success and -1 on error.
.SH SEE ALSO
im_ifthenelse(3), im_equal(3).
.SH COPYRIGHT
National Gallery, 1992
.SH AUTHOR
J. Cupitt

1
man/im_asintra.3
View File

@ -1 +0,0 @@
.so man3/im_costra.3

1
man/im_atantra.3
View File

@ -1 +0,0 @@
.so man3/im_costra.3

101
man/im_avg.3
View File

@ -1,101 +0,0 @@
.TH STATS 3 "24 April 1991"
.SH NAME
im_avg, im_deviate, im_min, im_minpos, im_max, im_maxpos \- find the mean, standard deviation, minimum and maximum of an image
.SH SYNOPSIS
.B #include <vips/vips.h>
.B int im_avg(im, out)
.br
.B IMAGE *im;
.br
.B double *out;
.B int im_deviate(im, out)
.br
.B IMAGE *im;
.br
.B double *out;
.B int im_min(im, out)
.br
.B IMAGE *im;
.br
.B double *out;
.B int im_minpos(im, xpos, ypos, min)
.br
.B IMAGE *im;
.br
.B int *xpos, *ypos;
.br
.B double *min;
.B int im_max(im, out)
.br
.B IMAGE *im;
.br
.B double *out;
.B int im_maxpos(im, xpos, ypos, max)
.br
.B IMAGE *im;
.br
.B int *xpos, *ypos;
.br
.B double *max;
.SH DESCRIPTION
These functions find the mean, standard deviation, minimum, maximum of an image.
They operate on all bands of the input image. Use
.B im_stats(3)
if you need to calculate on bands separately.
All computations are carried out in
double precision arithmetic.
The standard deviation is calculated using the formula:
Var{E} = 1 / (N - 1) * (E{X^2} - E{X}^2 / N)
stdev{E} = sqrt(Var{E}).
.B im_avg(3)
finds the average of an image pointed by im. Takes as input any non-complex
image format and returns a double at the location pointed by out.
.B im_deviate(3)
finds the standard deviation of an image pointed by im. Takes as
input any non-complex image format and returns
a double at the location pointed by out.
.B im_min(3)
finds the the minimum value of the image pointed by im and returns it at the
location pointed by out. Takes as
input any image format and returns
a double at the location pointed by out. If input is complex
the min square amplitude (re*re+im*im) is returned.
.B im_minpos(3)
finds the the minimum value of the image pointed by im and returns it at the
location pointed by out. The coordinates of the last occurrence of
min is returned at locations pointed by xpos, ypos. If input is complex
the min square amplitude (re*re+im*im) is returned.
.B im_max(3)
finds the the maximum value of the image pointed by im and returns it at the
location pointed by out. If input is complex
the max square amplitude (re*re+im*im) is returned.
.B im_maxpos(3)
finds the the maximum value of the image pointed by im and returns it at the
location pointed by max. The coordinates of the last occurrence of
max is returned at locations pointed by xpos, ypos. If input is complex
the max square amplitude (re*re+im*im) and its last occurrence is returned.
.SH RETURN VALUE
All functions return 0 on success and -1 on error.
.SH SEE ALSO
im_exptra(3), im_lintra(3), im_abs(3), im_stats(3).
.SH COPYRIGHT
.br
N. Dessipris
.SH AUTHOR
N. Dessipris \- 24/04/1991
.br
J. Cupitt \- 21/7/93

39
man/im_bandjoin.3
View File

@ -1,39 +0,0 @@
.TH IM_BANDJOIN 3 "28 June 1990"
.SH NAME
im_bandjoin, im_gbandjoin \- join two or more images
.SH SYNOPSIS
.B #include <vips/vips.h>
.B int im_bandjoin(im1, im2, imout)
.br
.B IMAGE *im1, *im2, *imout;
.B int im_gbandjoin(imarray, imout, no)
.br
.B IMAGE *imarray[], *imout;
.br
.B int no;
.SH DESCRIPTION
These function perform a band-wise join of two or more images. Input
images should be of the same type and should have the same sizes.
.B im_bandjoin()
performs a band-wise join of two images. If the two images
have n and m bands respectively, then the output image will have n+m
bands, with the first n coming from the first image and the last m
from the second.
.B im_gbandjoin()
performs a generalised band-wise join of no images.
Input images can have any number of bands; for instance if imarray[0] has j
bands, imarray[1] has k bands, ...., imarray[no-1] has z bands, output
has j+k+...+z bands.
.SH RETURN VALUE
The functions returns 0 on success and -1 on error.
.SH SEE\ ALSO
im_lrjoin(3), im_lrmerge(3), im_insert(3).
.SH COPYRIGHT
.br
J. Cupitt, N. Dessipris
.SH AUTHOR
J. Cupitt, N. Dessipris \- 25/04/1991

20
man/im_bandmean.3
View File

@ -1,20 +0,0 @@
.TH IM_BANDMEAN 3 "18 July 2007"
.SH NAME
im_bandmean \- average bands in an image
.SH SYNOPSIS
#include <vips/vips.h>
int im_bandmean( in, out )
.br
IMAGE *in, *out;
.SH DESCRIPTION
.B im_bandmean(3)
writes a one-band image where each pixel is the average of the bands for that
pixel in the input image. The output band format is the same as the input
band format.
Any size, any number of bands, any type.
.SH RETURN VALUE
The function returns 0 on success and -1 on error.
.SH SEE ALSO
im_add(3), im_mean(3), im_recomb(3)

16
man/im_benchmark.3
View File

@ -1,16 +0,0 @@
.TH IM_BENCHMARK 3 "6 Oct 2006"
.SH NAME
im_benchmark \- do something complicated
.SH SYNOPSIS
.B #include <vips/vips.h>
int im_benchmark( IMAGE *in, IMAGE *out )
.SH DESCRIPTION
.B im_benchmark(3)
performs a complicated operation (based on a real example of VIPS usage) on a
LABPACK image. It is useful for benchmarking the VIPS threading system. It
should speed up (mostly) linearly with more CPUs.
.SH RETURNED VALUES
The function returns 0 on success and -1 on error.

42
man/im_binfile.3
View File

@ -1,42 +0,0 @@
.TH IM_BINFILE 3 "11 April 1990"
.SH NAME
im_binfile, im_image \- wrap a raw binary file inside an IMAGE descriptor
.SH SYNOPSIS
.B #include <vips/vips.h>
IMAGE *im_binfile( name, xs, ys, b, off )
.br
char *in;
.br
IMAGE *out;
.br
int xs, ys, b, off;
IMAGE *
.br
im_image( void *buffer, int width, int height, int bands, int format )
.SH DESCRIPTION
.B im_binfile(3)
maps the file named, and returns an image descriptor which looks
very like the sort of thing that
.B im_mmapin(3)
returns.
The parameters specify the image width, height, number of bands and offset
in bytes from the start of the file.
.B im_image(3)
makes an IMAGE deriptor from an area of pixels in memory. The memory
buffer will not be freed when the IMAGE is closed, use
.B im_add_close_callback()
if you want this.
.SH RETURN VALUE
The functions return NULL on error.
.SH SEE ALSO
im_mmapin(3), im_openout(3), im_setbuf(3).
.SH COPYRIGHT
N. Dessipris
.SH AUTHOR
N. Dessipris \- 11/04/1990

16
man/im_bits_of_fmt.3
View File

@ -1,16 +0,0 @@
.TH IM_BITS_OF_FMT 3 "2 June 2005"
.SH NAME
im_bits_of_fmt \- return number of bits of band format
.SH SYNOPSIS
.B #include <vips/vips.h>
.B int im_bits_of_fmt( int bandfmt )
.SH DESCRIPTION
.B im_bits_of_fmt(3)
calculates the number of bits of band format.
.SH RETURN VALUE
On success this function returns the number of bits of band format and
-1 is returned on error.

23
man/im_black.3
View File

@ -1,23 +0,0 @@
.TH IM_BLACK 3 "11 April 1990"
.SH NAME
im_black \- make a black image
.SH SYNOPSIS
.B #include <vips/vips.h>
.B int im_black(out, x, y, bands)
.br
.B IMAGE *out;
.br
.B int x, y, bands;
.SH DESCRIPTION
im_black()
makes a black uchar image of the specified size and number of bands.
.SH RETURN VALUE
The function returns 0 on success and -1 on error.
.SH SEE\ ALSO
im_openin(3), im_openout(3), im_setbuf(3).
.SH COPYRIGHT
.br
National Gallery 1990 - 1993
.SH AUTHOR
J. Cupitt \- 11/04/1990

1
man/im_blend.3
View File

@ -1 +0,0 @@
.so man3/im_ifthenelse.3

44
man/im_buildlut.3
View File

@ -1,44 +0,0 @@
.TH IM_BUILDLUT 3 "June 2006"
.SH NAME
im_buildlut \- build a LUT from a set of x/y points
.SH SYNOPSIS
#include <vips/vips.h>
int
.br
im_buildlut( DOUBLEMASK *input, IMAGE *output )
.SH DESCRIPTION
.B im_buildlut(3)
constructs a LUT, interpolating a set of x/y points. Interpolation is strictly
piecewise linear. For example, if the input is:
0 0
128 20
255 100
we generate the values:
index value
0 0
1 0.01
.. etc. linear interpolation
128 20
129 20.5
.. etc. linear interpolation
255 100
(we don't generate the index column, that's just there to show the
position in the table)
The x/y points don't need to be
sorted: we do that. You can have several Ys: each becomes a band in the
output LUT. X can start at any integer value, including negatives.
.SH RETURN VALUE
-1 on error, otherwise 0
.SH SEE ALSO
im_invertlut(3), im_identity(3).
.SH COPYRIGHT
2006, Imperial College

1
man/im_c2amph.3
View File

@ -1 +0,0 @@
.so man3/im_clip.3

1
man/im_c2imag.3
View File

@ -1 +0,0 @@
.so man3/im_clip.3

1
man/im_c2ps.3
View File

@ -1 +0,0 @@
.so man3/im_clip.3

1
man/im_c2real.3
View File

@ -1 +0,0 @@
.so man3/im_clip.3

1
man/im_c2rect.3
View File

@ -1 +0,0 @@
.so man3/im_clip.3

Some files were not shown because too many files have changed in this diff Show More