1
/*====================================================================*
2
- Copyright (C) 2001 Leptonica. All rights reserved.
3
- This software is distributed in the hope that it will be
4
- useful, but with NO WARRANTY OF ANY KIND.
5
- No author or distributor accepts responsibility to anyone for the
6
- consequences of using this software, or for whether it serves any
7
- particular purpose or works at all, unless he or she says so in
8
- writing. Everyone is granted permission to copy, modify and
9
- redistribute this source code, for commercial or non-commercial
10
- purposes, with the following restrictions: (1) the origin of this
11
- source code must not be misrepresented; (2) modified versions must
12
- be plainly marked as such; and (3) this notice may not be removed
13
- or altered from any source or modified source distribution.
14
*====================================================================*/
16
#ifndef LEPTONICA_PIX_H
17
#define LEPTONICA_PIX_H
22
* Contains the following structures:
41
* Contains definitions for:
43
* Perceptual color weights
44
* Colormap conversion flags
46
* Structure access flags (for insert, copy, clone, copy-clone)
47
* Sorting flags (by type and direction)
49
* Graphics pixel setting flags
50
* Size filtering flags
51
* Color component selection flags
52
* Rotation and shear flags
53
* Affine transform order flags
54
* Grayscale filling flags
55
* Flags for setting to white or black
58
* Statistical measures
60
* Text orientation flags
61
* Edge orientation flags
62
* Line orientation flags
63
* Scan direction flags
65
* Pixel selection for resampling
69
* Handling negative values in conversion to unsigned int
70
* Subpixel color component ordering in LCD display
71
* Relative to zero flags
73
* Region flags (inclusion, exclusion)
74
* Flags for adding text to a pix
75
* Flags for selecting display program
79
/*-------------------------------------------------------------------------*
81
*-------------------------------------------------------------------------*/
84
l_uint32 w; /* width in pixels */
85
l_uint32 h; /* height in pixels */
86
l_uint32 d; /* depth in bits */
87
l_uint32 wpl; /* 32-bit words/line */
88
l_uint32 refcount; /* reference count (1 if no clones) */
89
l_int32 xres; /* image res (ppi) in x direction */
90
/* (use 0 if unknown) */
91
l_int32 yres; /* image res (ppi) in y direction */
92
/* (use 0 if unknown) */
93
l_int32 informat; /* input file format, IFF_* */
94
char *text; /* text string associated with pix */
95
struct PixColormap *colormap; /* colormap (may be null) */
96
l_uint32 *data; /* the image data */
98
typedef struct Pix PIX;
103
void *array; /* colormap table (array of RGBA_QUAD) */
104
l_int32 depth; /* of pix (1, 2, 4 or 8 bpp) */
105
l_int32 nalloc; /* number of color entries allocated */
106
l_int32 n; /* number of color entries used */
108
typedef struct PixColormap PIXCMAP;
111
/* Colormap table entry (after the BMP version).
112
* Note that the BMP format stores the colormap table exactly
113
* as it appears here, with color samples being stored sequentially,
114
* in the order (b,g,r,a). */
122
typedef struct RGBA_Quad RGBA_QUAD;
126
/*-------------------------------------------------------------------------*
127
* Colors for 32 bpp *
128
*-------------------------------------------------------------------------*/
130
* (1) These are the byte indices for colors in 32 bpp images.
131
* They are used through the GET/SET_DATA_BYTE accessors.
132
* The 4th byte, typically known as the "alpha channel" and used
133
* for blending, is not explicitly used in leptonica.
134
* (2) If you redefine these values, functions that have the shifts
135
* hardcoded (instead of using the constants below) will break.
136
* These functions are labelled with "***" next to their names
137
* at the top of the files in which they are defined.
138
* Advice: Do not change these values!
139
* (3) The shifts to extract the red, green and blue components
140
* from a 32 bit pixel are defined in terms of these colors.
149
static const l_int32 L_RED_SHIFT =
150
8 * (sizeof(l_uint32) - 1 - COLOR_RED); /* 24 */
151
static const l_int32 L_GREEN_SHIFT =
152
8 * (sizeof(l_uint32) - 1 - COLOR_GREEN); /* 16 */
153
static const l_int32 L_BLUE_SHIFT =
154
8 * (sizeof(l_uint32) - 1 - COLOR_BLUE); /* 8 */
155
static const l_int32 L_ALPHA_SHIFT =
156
8 * (sizeof(l_uint32) - 1 - L_ALPHA_CHANNEL); /* 0 */
159
/*-------------------------------------------------------------------------*
160
* Perceptual color weights *
161
*-------------------------------------------------------------------------*/
163
* (1) These numbers are ad-hoc, but they do add up to 1.
164
* Unlike, for example, the weighting factor for conversion
165
* of RGB to luminance, or more specifically to Y in the
166
* YUV colorspace. Those numbers come from the
167
* International Telecommunications Union, via ITU-R.
169
static const l_float32 L_RED_WEIGHT = 0.3;
170
static const l_float32 L_GREEN_WEIGHT = 0.5;
171
static const l_float32 L_BLUE_WEIGHT = 0.2;
174
/*-------------------------------------------------------------------------*
175
* Flags for colormap conversion *
176
*-------------------------------------------------------------------------*/
178
REMOVE_CMAP_TO_BINARY = 0,
179
REMOVE_CMAP_TO_GRAYSCALE = 1,
180
REMOVE_CMAP_TO_FULL_COLOR = 2,
181
REMOVE_CMAP_BASED_ON_SRC = 3
185
/*-------------------------------------------------------------------------*
187
* The following operation bit flags have been modified from
190
* The 'op' in 'rasterop' is represented by an integer
191
* composed with Boolean functions using the set of five integers
192
* given below. The integers, and the op codes resulting from
193
* boolean expressions on them, need only be in the range from 0 to 15.
194
* The function is applied on a per-pixel basis.
196
* Examples: the op code representing ORing the src and dest
197
* is computed using the bit OR, as PIX_SRC | PIX_DST; the op
198
* code representing XORing src and dest is found from
199
* PIX_SRC ^ PIX_DST; the op code representing ANDing src and dest
200
* is found from PIX_SRC & PIX_DST. Note that
201
* PIX_NOT(PIX_CLR) = PIX_SET, and v.v., as they must be.
203
* We would like to use the following set of definitions:
205
* #define PIX_SRC 0xc
206
* #define PIX_DST 0xa
207
* #define PIX_NOT(op) ((op) ^ 0xf)
208
* #define PIX_CLR 0x0
209
* #define PIX_SET 0xf
211
* Now, these definitions differ from Sun's, in that Sun
212
* left-shifted each value by 1 pixel, and used the least
213
* significant bit as a flag for the "pseudo-operation" of
214
* clipping. We don't need this bit, because it is both
215
* efficient and safe ALWAYS to clip the rectangles to the src
216
* and dest images, which is what we do. See the notes in rop.h
217
* on the general choice of these bit flags.
219
* However, if you include Sun's xview package, you will get their
220
* definitions, and because I like using these flags, we will
221
* adopt the original Sun definitions to avoid redefinition conflicts.
223
* Then we have, for reference, the following 16 unique op flags:
229
* PIX_NOT(PIX_SRC) 00110 0x06
230
* PIX_NOT(PIX_DST) 01010 0x0a
231
* PIX_SRC | PIX_DST 11100 0x1c
232
* PIX_SRC & PIX_DST 10000 0x10
233
* PIX_SRC ^ PIX_DST 01100 0x0c
234
* PIX_NOT(PIX_SRC) | PIX_DST 10110 0x16
235
* PIX_NOT(PIX_SRC) & PIX_DST 00100 0x04
236
* PIX_SRC | PIX_NOT(PIX_DST) 11010 0x1a
237
* PIX_SRC & PIX_NOT(PIX_DST) 01000 0x08
238
* PIX_NOT(PIX_SRC | PIX_DST) 00010 0x02
239
* PIX_NOT(PIX_SRC & PIX_DST) 01110 0x0e
240
* PIX_NOT(PIX_SRC ^ PIX_DST) 10010 0x12
242
*-------------------------------------------------------------------------*/
243
#define PIX_SRC (0xc << 1)
244
#define PIX_DST (0xa << 1)
245
#define PIX_NOT(op) ((op) ^ 0x1e)
246
#define PIX_CLR (0x0 << 1)
247
#define PIX_SET (0xf << 1)
249
#define PIX_PAINT (PIX_SRC | PIX_DST)
250
#define PIX_MASK (PIX_SRC & PIX_DST)
251
#define PIX_SUBTRACT (PIX_DST & PIX_NOT(PIX_SRC))
252
#define PIX_XOR (PIX_SRC ^ PIX_DST)
255
/*-------------------------------------------------------------------------*
259
* (1) The image data is stored in a single contiguous
260
* array of l_uint32, into which the pixels are packed.
261
* By "packed" we mean that there are no unused bits
262
* between pixels, except for end-of-line padding to
263
* satisfy item (2) below.
265
* (2) Every image raster line begins on a 32-bit word
266
* boundary within this array.
268
* (3) Pix image data is stored in 32-bit units, with the
269
* pixels ordered from left to right in the image being
270
* stored in order from the MSB to LSB within the word,
271
* for both big-endian and little-endian machines.
272
* This is the natural ordering for big-endian machines,
273
* as successive bytes are stored and fetched progressively
274
* to the right. However, for little-endians, when storing
275
* we re-order the bytes from this byte stream order, and
276
* reshuffle again for byte access on 32-bit entities.
277
* So if the bytes come in sequence from left to right, we
278
* store them on little-endians in byte order:
279
* 3 2 1 0 7 6 5 4 ...
280
* This MSB to LSB ordering allows left and right shift
281
* operations on 32 bit words to move the pixels properly.
283
* (4) For 24-bit color images, use 32 bpp data, leaving
284
* the fourth byte unused. Within each 4 byte pixel, the
285
* colors are ordered from MSB to LSB, as follows:
287
* | MSB | 2nd MSB | 3rd MSB | LSB |
288
* red green blue unused
289
* 0 1 2 3 (big-endian)
290
* 3 2 1 0 (little-endian)
292
* Because we use MSB to LSB ordering within the 32-bit word,
293
* the individual 8-bit samples can be accessed with
294
* GET_DATA_BYTE and SET_DATA_BYTE macros, using the
295
* (implicitly big-ending) ordering
297
* green: byte 1 (2nd MSB)
298
* blue: byte 2 (3rd MSB)
300
* This specific color assignment is made in this file,
301
* through the definitions of COLOR_RED, etc. Then the R, G
302
* and B sample values can be retrieved using
303
* redval = GET_DATA_BYTE(&pixel, COLOR_RED);
304
* greenval = GET_DATA_BYTE(&pixel, COLOR_GREEN);
305
* blueval = GET_DATA_BYTE(&pixel, COLOR_BLUE);
306
* and they can be set with
307
* SET_DATA_BYTE(&pixel, COLOR_RED, redval);
308
* SET_DATA_BYTE(&pixel, COLOR_GREEN, greenval);
309
* SET_DATA_BYTE(&pixel, COLOR_BLUE, blueval);
311
* For extra speed we extract the R, G and B colors directly
312
* by shifting and masking, explicitly using the values in
313
* L_RED_SHIFT, L_GREEN_SHIFT and L_BLUE_SHIFT:
314
* (pixel32 >> L_RED_SHIFT) & 0xff; (red)
315
* (pixel32 >> L_GREEN_SHIFT) & 0xff; (green)
316
* (pixel32 >> L_BLUE_SHIFT) & 0xff; (blue)
317
* All these operations work properly on both big- and little-endians.
319
* For a few situations, these color shift values are hard-coded.
320
* Changing the RGB color component ordering through the assignments
321
* in this file will cause functions marked with "***" to fail.
323
* (5) A reference count is held within each pix, giving the
324
* number of ptrs to the pix. When a pixClone() call
325
* is made, the ref count is increased by 1, and
326
* when a pixDestroy() call is made, the reference count
327
* of the pix is decremented. The pix is only destroyed
328
* when the reference count goes to zero.
330
* (6) The version numbers (below) are used in the serialization
331
* of these data structures. They are placed in the files,
332
* and rarely (if ever) change. Provision is currently made for
333
* backward compatibility in reading from boxaa version 2.
335
* (7) The serialization dependencies are as follows:
336
* pixaa : pixa : boxa
338
* So, for example, pixaa and boxaa can be changed without
339
* forcing a change in pixa or boxa. However, if pixa is
340
* changed, it forces a change in pixaa, and if boxa is
341
* changed, if forces a change in the other three.
342
* We define four version numbers:
343
* PIXAA_VERSION_NUMBER
344
* PIXA_VERSION_NUMBER
345
* BOXAA_VERSION_NUMBER
346
* BOXA_VERSION_NUMBER
348
*-------------------------------------------------------------------------*/
352
/*-------------------------------------------------------------------------*
354
*-------------------------------------------------------------------------*/
356
/* Serialization for primary data structures */
357
#define PIXAA_VERSION_NUMBER 2
358
#define PIXA_VERSION_NUMBER 2
359
#define BOXA_VERSION_NUMBER 2
360
#define BOXAA_VERSION_NUMBER 3
365
l_int32 n; /* number of Pix in ptr array */
366
l_int32 nalloc; /* number of Pix ptrs allocated */
367
l_uint32 refcount; /* reference count (1 if no clones) */
368
struct Pix **pix; /* the array of ptrs to pix */
369
struct Boxa *boxa; /* array of boxes */
371
typedef struct Pixa PIXA;
376
l_int32 n; /* number of Pixa in ptr array */
377
l_int32 nalloc; /* number of Pixa ptrs allocated */
378
struct Pixa **pixa; /* array of ptrs to pixa */
379
struct Boxa *boxa; /* array of boxes */
381
typedef struct Pixaa PIXAA;
384
/*-------------------------------------------------------------------------*
385
* Basic rectangle and rectangle arrays *
386
*-------------------------------------------------------------------------*/
393
l_uint32 refcount; /* reference count (1 if no clones) */
396
typedef struct Box BOX;
400
l_int32 n; /* number of box in ptr array */
401
l_int32 nalloc; /* number of box ptrs allocated */
402
l_uint32 refcount; /* reference count (1 if no clones) */
403
struct Box **box; /* box ptr array */
405
typedef struct Boxa BOXA;
409
l_int32 n; /* number of boxa in ptr array */
410
l_int32 nalloc; /* number of boxa ptrs allocated */
411
struct Boxa **boxa; /* boxa ptr array */
413
typedef struct Boxaa BOXAA;
416
/*-------------------------------------------------------------------------*
418
*-------------------------------------------------------------------------*/
419
#define PTA_VERSION_NUMBER 1
423
l_int32 n; /* actual number of pts */
424
l_int32 nalloc; /* size of allocated arrays */
425
l_int32 refcount; /* reference count (1 if no clones) */
426
l_float32 *x, *y; /* arrays of floats */
428
typedef struct Pta PTA;
431
/*-------------------------------------------------------------------------*
433
*-------------------------------------------------------------------------*/
436
l_int32 n; /* number of pta in ptr array */
437
l_int32 nalloc; /* number of pta ptrs allocated */
438
struct Pta **pta; /* pta ptr array */
440
typedef struct Ptaa PTAA;
443
/*-------------------------------------------------------------------------*
444
* Pix accumulator container *
445
*-------------------------------------------------------------------------*/
448
l_int32 w; /* array width */
449
l_int32 h; /* array height */
450
l_int32 offset; /* used to allow negative */
451
/* intermediate results */
452
struct Pix *pix; /* the 32 bit accumulator pix */
454
typedef struct Pixacc PIXACC;
457
/*-------------------------------------------------------------------------*
459
*-------------------------------------------------------------------------*/
462
struct Pix *pix; /* input pix (a clone) */
463
l_int32 nx; /* number of tiles horizontally */
464
l_int32 ny; /* number of tiles vertically */
465
l_int32 w; /* tile width */
466
l_int32 h; /* tile height */
467
l_int32 xoverlap; /* overlap on left and right */
468
l_int32 yoverlap; /* overlap on top and bottom */
469
l_int32 strip; /* strip for paint; default is TRUE */
471
typedef struct PixTiling PIXTILING;
474
/*-------------------------------------------------------------------------*
475
* FPix: pix with float array *
476
*-------------------------------------------------------------------------*/
477
#define FPIX_VERSION_NUMBER 1
481
l_int32 w; /* width in pixels */
482
l_int32 h; /* height in pixels */
483
l_int32 wpl; /* 32-bit words/line */
484
l_int32 refcount; /* reference count (1 if no clones) */
485
l_int32 xres; /* image res (ppi) in x direction */
486
/* (use 0 if unknown) */
487
l_int32 yres; /* image res (ppi) in y direction */
488
/* (use 0 if unknown) */
489
l_float32 *data; /* the float image data */
491
typedef struct FPix FPIX;
496
l_int32 n; /* number of Pix in ptr array */
497
l_int32 nalloc; /* number of Pix ptrs allocated */
498
l_uint32 refcount; /* reference count (1 if no clones) */
499
struct FPix **fpix; /* the array of ptrs to fpix */
501
typedef struct FPixa FPIXA;
504
/*-------------------------------------------------------------------------*
505
* DPix: pix with double array *
506
*-------------------------------------------------------------------------*/
507
#define DPIX_VERSION_NUMBER 1
511
l_int32 w; /* width in pixels */
512
l_int32 h; /* height in pixels */
513
l_int32 wpl; /* 32-bit words/line */
514
l_int32 refcount; /* reference count (1 if no clones) */
515
l_int32 xres; /* image res (ppi) in x direction */
516
/* (use 0 if unknown) */
517
l_int32 yres; /* image res (ppi) in y direction */
518
/* (use 0 if unknown) */
519
l_float64 *data; /* the double image data */
521
typedef struct DPix DPIX;
524
/*-------------------------------------------------------------------------*
525
* PixComp: compressed pix *
526
*-------------------------------------------------------------------------*/
529
l_int32 w; /* width in pixels */
530
l_int32 h; /* height in pixels */
531
l_int32 d; /* depth in bits */
532
l_int32 xres; /* image res (ppi) in x direction */
533
/* (use 0 if unknown) */
534
l_int32 yres; /* image res (ppi) in y direction */
535
/* (use 0 if unknown) */
536
l_int32 comptype; /* compressed format (IFF_TIFF_G4, */
537
/* IFF_PNG, IFF_JFIF_JPEG) */
538
char *text; /* text string associated with pix */
539
l_int32 cmapflag; /* flag (1 for cmap, 0 otherwise) */
540
l_uint8 *data; /* the compressed image data */
541
size_t size; /* size of the data array */
543
typedef struct PixComp PIXC;
546
/*-------------------------------------------------------------------------*
547
* PixaComp: array of compressed pix *
548
*-------------------------------------------------------------------------*/
549
#define PIXACOMP_VERSION_NUMBER 1
553
l_int32 n; /* number of PixComp in ptr array */
554
l_int32 nalloc; /* number of PixComp ptrs allocated */
555
struct PixComp **pixc; /* the array of ptrs to PixComp */
556
struct Boxa *boxa; /* array of boxes */
558
typedef struct PixaComp PIXAC;
561
/*-------------------------------------------------------------------------*
562
* Access and storage flags *
563
*-------------------------------------------------------------------------*/
565
* For Pix, Box, Pta and Numa, there are 3 standard methods for handling
566
* the retrieval or insertion of a struct:
567
* (1) direct insertion (Don't do this if there is another handle
568
* somewhere to this same struct!)
569
* (2) copy (Always safe, sets up a refcount of 1 on the new object.
570
* Can be undesirable if very large, such as an image or
571
* an array of images.)
572
* (3) clone (Makes another handle to the same struct, and bumps the
573
* refcount up by 1. Safe to do unless you're changing
574
* data through one of the handles but don't want those
575
* changes to be seen by the other handle.)
577
* For Pixa and Boxa, which are structs that hold an array of clonable
578
* structs, there is an additional method:
579
* (4) copy-clone (Makes a new higher-level struct with a refcount
580
* of 1, but clones all the structs in the array.)
582
* Unlike the other structs, when retrieving a string from an Sarray,
583
* you are allowed to get a handle without a copy or clone (i.e., that
584
* you don't own!). You must not free or insert such a string!
585
* Specifically, for an Sarray, the copyflag for retrieval is either:
586
* TRUE (or 1 or L_COPY)
588
* FALSE (or 0 or L_NOCOPY)
589
* For insertion, the copyflag is either:
590
* TRUE (or 1 or L_COPY)
592
* FALSE (or 0 or L_INSERT)
593
* Note that L_COPY is always 1, and L_INSERT and L_NOCOPY are always 0.
596
L_INSERT = 0, /* stuff it in; no copy, clone or copy-clone */
597
L_COPY = 1, /* make/use a copy of the object */
598
L_CLONE = 2, /* make/use clone (ref count) of the object */
599
L_COPY_CLONE = 3 /* make a new object and fill with with clones */
600
/* of each object in the array(s) */
602
static const l_int32 L_NOCOPY = 0; /* copyflag value in sarrayGetString() */
605
/*--------------------------------------------------------------------------*
607
*--------------------------------------------------------------------------*/
609
L_SORT_INCREASING = 1, /* sort in increasing order */
610
L_SORT_DECREASING = 2 /* sort in decreasing order */
614
L_SORT_BY_X = 3, /* sort box or c.c. by horiz location */
615
L_SORT_BY_Y = 4, /* sort box or c.c. by vert location */
616
L_SORT_BY_WIDTH = 5, /* sort box or c.c. by width */
617
L_SORT_BY_HEIGHT = 6, /* sort box or c.c. by height */
618
L_SORT_BY_MIN_DIMENSION = 7, /* sort box or c.c. by min dimension */
619
L_SORT_BY_MAX_DIMENSION = 8, /* sort box or c.c. by max dimension */
620
L_SORT_BY_PERIMETER = 9, /* sort box or c.c. by perimeter */
621
L_SORT_BY_AREA = 10, /* sort box or c.c. by area */
622
L_SORT_BY_ASPECT_RATIO = 11 /* sort box or c.c. by width/height ratio */
626
/*-------------------------------------------------------------------------*
628
*-------------------------------------------------------------------------*/
630
L_BLEND_WITH_INVERSE = 1, /* add some of src inverse to itself */
631
L_BLEND_TO_WHITE = 2, /* shift src colors towards white */
632
L_BLEND_TO_BLACK = 3, /* shift src colors towards black */
633
L_BLEND_GRAY = 4, /* blend src directly with blender */
634
L_BLEND_GRAY_WITH_INVERSE = 5 /* add amount of src inverse to itself, */
635
/* based on blender pix value */
639
L_PAINT_LIGHT = 1, /* colorize non-black pixels */
640
L_PAINT_DARK = 2 /* colorize non-white pixels */
644
/*-------------------------------------------------------------------------*
645
* Graphics pixel setting *
646
*-------------------------------------------------------------------------*/
648
L_SET_PIXELS = 1, /* set all bits in each pixel to 1 */
649
L_CLEAR_PIXELS = 2, /* set all bits in each pixel to 0 */
650
L_FLIP_PIXELS = 3 /* flip all bits in each pixel */
654
/*-------------------------------------------------------------------------*
655
* Size filter flags *
656
*-------------------------------------------------------------------------*/
658
L_SELECT_WIDTH = 1, /* width must satisfy constraint */
659
L_SELECT_HEIGHT = 2, /* height must satisfy constraint */
660
L_SELECT_IF_EITHER = 3, /* either width or height can satisfy */
661
L_SELECT_IF_BOTH = 4 /* both width and height must satisfy */
665
L_SELECT_IF_LT = 1, /* save if value is less than threshold */
666
L_SELECT_IF_GT = 2, /* save if value is more than threshold */
667
L_SELECT_IF_LTE = 3, /* save if value is <= to the threshold */
668
L_SELECT_IF_GTE = 4 /* save if value is >= to the threshold */
672
/*-------------------------------------------------------------------------*
673
* Color component selection flags *
674
*-------------------------------------------------------------------------*/
676
L_SELECT_RED = 1, /* use red component */
677
L_SELECT_GREEN = 2, /* use green component */
678
L_SELECT_BLUE = 3, /* use blue component */
679
L_SELECT_MIN = 4, /* use min color component */
680
L_SELECT_MAX = 5 /* use max color component */
684
/*-------------------------------------------------------------------------*
685
* Rotate and shear flags *
686
*-------------------------------------------------------------------------*/
688
L_ROTATE_AREA_MAP = 1, /* use area map rotation, if possible */
689
L_ROTATE_SHEAR = 2, /* use shear rotation */
690
L_ROTATE_SAMPLING = 3 /* use sampling */
694
L_BRING_IN_WHITE = 1, /* bring in white pixels from the outside */
695
L_BRING_IN_BLACK = 2 /* bring in black pixels from the outside */
699
L_SHEAR_ABOUT_CORNER = 1, /* shear image about UL corner */
700
L_SHEAR_ABOUT_CENTER = 2 /* shear image about center */
704
/*-------------------------------------------------------------------------*
705
* Affine transform order flags *
706
*-------------------------------------------------------------------------*/
708
L_TR_SC_RO = 1, /* translate, scale, rotate */
709
L_SC_RO_TR = 2, /* scale, rotate, translate */
710
L_RO_TR_SC = 3, /* rotate, translate, scale */
711
L_TR_RO_SC = 4, /* translate, rotate, scale */
712
L_RO_SC_TR = 5, /* rotate, scale, translate */
713
L_SC_TR_RO = 6 /* scale, translate, rotate */
717
/*-------------------------------------------------------------------------*
718
* Grayscale filling flags *
719
*-------------------------------------------------------------------------*/
721
L_FILL_WHITE = 1, /* fill white pixels (e.g, in fg map) */
722
L_FILL_BLACK = 2 /* fill black pixels (e.g., in bg map) */
726
/*-------------------------------------------------------------------------*
727
* Flags for setting to white or black *
728
*-------------------------------------------------------------------------*/
730
L_SET_WHITE = 1, /* set pixels to white */
731
L_SET_BLACK = 2 /* set pixels to black */
735
/*-------------------------------------------------------------------------*
736
* Dither parameters *
737
* If within this grayscale distance from black or white, *
738
* do not propagate excess or deficit to neighboring pixels. *
739
*-------------------------------------------------------------------------*/
741
DEFAULT_CLIP_LOWER_1 = 10, /* dist to black with no prop; 1 bpp */
742
DEFAULT_CLIP_UPPER_1 = 10, /* dist to black with no prop; 1 bpp */
743
DEFAULT_CLIP_LOWER_2 = 5, /* dist to black with no prop; 2 bpp */
744
DEFAULT_CLIP_UPPER_2 = 5 /* dist to black with no prop; 2 bpp */
748
/*-------------------------------------------------------------------------*
750
*-------------------------------------------------------------------------*/
752
L_MANHATTAN_DISTANCE = 1, /* L1 distance (e.g., in color space) */
753
L_EUCLIDEAN_DISTANCE = 2 /* L2 distance */
757
/*-------------------------------------------------------------------------*
758
* Statistical measures *
759
*-------------------------------------------------------------------------*/
761
L_MEAN_ABSVAL = 1, /* average of abs values */
762
L_MEDIAN_VAL = 2, /* median value of set */
763
L_MODE_VAL = 3, /* mode value of set */
764
L_MODE_COUNT = 4, /* mode count of set */
765
L_ROOT_MEAN_SQUARE = 5, /* rms of values */
766
L_STANDARD_DEVIATION = 6, /* standard deviation from mean */
767
L_VARIANCE = 7 /* variance of values */
771
/*-------------------------------------------------------------------------*
772
* Set selection flags *
773
*-------------------------------------------------------------------------*/
775
L_CHOOSE_CONSECUTIVE = 1, /* select 'n' consecutive */
776
L_CHOOSE_SKIP_BY = 2 /* select at intervals of 'n' */
780
/*-------------------------------------------------------------------------*
781
* Text orientation flags *
782
*-------------------------------------------------------------------------*/
784
L_TEXT_ORIENT_UNKNOWN = 0, /* low confidence on text orientation */
785
L_TEXT_ORIENT_UP = 1, /* portrait, text rightside-up */
786
L_TEXT_ORIENT_LEFT = 2, /* landscape, text up to left */
787
L_TEXT_ORIENT_DOWN = 3, /* portrait, text upside-down */
788
L_TEXT_ORIENT_RIGHT = 4 /* landscape, text up to right */
792
/*-------------------------------------------------------------------------*
793
* Edge orientation flags *
794
*-------------------------------------------------------------------------*/
796
L_HORIZONTAL_EDGES = 0, /* filters for horizontal edges */
797
L_VERTICAL_EDGES = 1, /* filters for vertical edges */
798
L_ALL_EDGES = 2 /* filters for all edges */
802
/*-------------------------------------------------------------------------*
803
* Line orientation flags *
804
*-------------------------------------------------------------------------*/
806
L_HORIZONTAL_LINE = 0, /* horizontal line */
807
L_POS_SLOPE_LINE = 1, /* 45 degree line with positive slope */
808
L_VERTICAL_LINE = 2, /* vertical line */
809
L_NEG_SLOPE_LINE = 3, /* 45 degree line with negative slope */
810
L_OBLIQUE_LINE = 4 /* neither horizontal nor vertical */
814
/*-------------------------------------------------------------------------*
815
* Scan direction flags *
816
*-------------------------------------------------------------------------*/
818
L_FROM_LEFT = 0, /* scan from left */
819
L_FROM_RIGHT = 1, /* scan from right */
820
L_FROM_TOP = 2, /* scan from top */
821
L_FROM_BOTTOM = 3 /* scan from bottom */
825
/*-------------------------------------------------------------------------*
827
*-------------------------------------------------------------------------*/
829
L_WARP_TO_LEFT = 1, /* increasing stretch or contraction to left */
830
L_WARP_TO_RIGHT = 2 /* increasing stretch or contraction to right */
834
L_LINEAR_WARP = 1, /* stretch or contraction grows linearly */
835
L_QUADRATIC_WARP = 2 /* stretch or contraction grows quadratically */
839
/*-------------------------------------------------------------------------*
840
* Pixel selection for resampling *
841
*-------------------------------------------------------------------------*/
843
L_INTERPOLATED = 1, /* linear interpolation from src pixels */
844
L_SAMPLED = 2 /* nearest src pixel sampling only */
848
/*-------------------------------------------------------------------------*
850
*-------------------------------------------------------------------------*/
852
L_THIN_FG = 1, /* thin foreground of 1 bpp image */
853
L_THIN_BG = 2 /* thin background of 1 bpp image */
857
/*-------------------------------------------------------------------------*
859
*-------------------------------------------------------------------------*/
861
L_HORIZONTAL_RUNS = 0, /* determine runlengths of horizontal runs */
862
L_VERTICAL_RUNS = 1 /* determine runlengths of vertical runs */
866
/*-------------------------------------------------------------------------*
867
* Edge filter flags *
868
*-------------------------------------------------------------------------*/
870
L_SOBEL_EDGE = 1, /* Sobel edge filter */
871
L_TWO_SIDED_EDGE = 2 /* Two-sided edge filter */
875
/*-------------------------------------------------------------------------*
876
* Handling negative values in conversion to unsigned int *
877
*-------------------------------------------------------------------------*/
879
L_CLIP_TO_ZERO = 1, /* Clip negative values to 0 */
880
L_TAKE_ABSVAL = 2 /* Convert to positive using L_ABS() */
884
/*-------------------------------------------------------------------------*
885
* Subpixel color component ordering in LCD display *
886
*-------------------------------------------------------------------------*/
888
L_SUBPIXEL_ORDER_RGB = 1, /* sensor order left-to-right RGB */
889
L_SUBPIXEL_ORDER_BGR = 2, /* sensor order left-to-right BGR */
890
L_SUBPIXEL_ORDER_VRGB = 3, /* sensor order top-to-bottom RGB */
891
L_SUBPIXEL_ORDER_VBGR = 4 /* sensor order top-to-bottom BGR */
895
/*-------------------------------------------------------------------------*
896
* Relative to zero flags *
897
*-------------------------------------------------------------------------*/
899
L_LESS_THAN_ZERO = 1, /* Choose values less than zero */
900
L_EQUAL_TO_ZERO = 2, /* Choose values equal to zero */
901
L_GREATER_THAN_ZERO = 3 /* Choose values greater than zero */
905
/*-------------------------------------------------------------------------*
906
* HSV histogram flags *
907
*-------------------------------------------------------------------------*/
909
L_HS_HISTO = 1, /* Use hue-saturation histogram */
910
L_HV_HISTO = 2, /* Use hue-value histogram */
911
L_SV_HISTO = 3 /* Use saturation-value histogram */
915
/*-------------------------------------------------------------------------*
916
* Region flags (inclusion, exclusion) *
917
*-------------------------------------------------------------------------*/
919
L_INCLUDE_REGION = 1, /* Use hue-saturation histogram */
920
L_EXCLUDE_REGION = 2 /* Use hue-value histogram */
924
/*-------------------------------------------------------------------------*
925
* Flags for adding text to a pix *
926
*-------------------------------------------------------------------------*/
928
L_ADD_ABOVE = 1, /* Add text above the image */
929
L_ADD_AT_TOP = 2, /* Add text over the top of the image */
930
L_ADD_AT_BOTTOM = 3, /* Add text over the bottom of the image */
931
L_ADD_BELOW = 4 /* Add text below the image */
935
/*-------------------------------------------------------------------------*
936
* Flags for selecting display program *
937
*-------------------------------------------------------------------------*/
939
L_DISPLAY_WITH_XV = 1, /* Use xv with pixDisplay() */
940
L_DISPLAY_WITH_XLI = 2, /* Use xli with pixDisplay() */
941
L_DISPLAY_WITH_XZGV = 3, /* Use xzgv with pixDisplay() */
942
L_DISPLAY_WITH_IV = 4 /* Use irfvanview with pixDisplay() */
945
#endif /* LEPTONICA_PIX_H */
added
removed
vs2010/include/leptonica/pix.h
