#include <string.h>
#include "allheaders.h"

Functions
static l_int32	fpixaExtendArray (FPIXA *fpixa)

static l_int32	fpixaExtendArrayToSize (FPIXA *fpixa, l_int32 size)

FPIX *	fpixCreate (l_int32 width, l_int32 height)

FPIX *	fpixCreateTemplate (FPIX *fpixs)

FPIX *	fpixClone (FPIX *fpix)

FPIX *	fpixCopy (FPIX fpixd, FPIX fpixs)

l_ok	fpixResizeImageData (FPIX fpixd, FPIX fpixs)

void	fpixDestroy (FPIX **pfpix)

l_ok	fpixGetDimensions (FPIX fpix, l_int32 pw, l_int32 *ph)

l_ok	fpixSetDimensions (FPIX *fpix, l_int32 w, l_int32 h)

l_int32	fpixGetWpl (FPIX *fpix)

l_ok	fpixSetWpl (FPIX *fpix, l_int32 wpl)

l_int32	fpixGetRefcount (FPIX *fpix)

l_ok	fpixChangeRefcount (FPIX *fpix, l_int32 delta)

l_ok	fpixGetResolution (FPIX fpix, l_int32 pxres, l_int32 *pyres)

l_ok	fpixSetResolution (FPIX *fpix, l_int32 xres, l_int32 yres)

l_ok	fpixCopyResolution (FPIX fpixd, FPIX fpixs)

l_float32 *	fpixGetData (FPIX *fpix)

l_ok	fpixSetData (FPIX fpix, l_float32 data)

l_ok	fpixGetPixel (FPIX fpix, l_int32 x, l_int32 y, l_float32 pval)

l_ok	fpixSetPixel (FPIX *fpix, l_int32 x, l_int32 y, l_float32 val)

FPIXA *	fpixaCreate (l_int32 n)

FPIXA *	fpixaCopy (FPIXA *fpixa, l_int32 copyflag)

void	fpixaDestroy (FPIXA **pfpixa)

l_ok	fpixaAddFPix (FPIXA fpixa, FPIX fpix, l_int32 copyflag)

l_int32	fpixaGetCount (FPIXA *fpixa)

l_ok	fpixaChangeRefcount (FPIXA *fpixa, l_int32 delta)

FPIX *	fpixaGetFPix (FPIXA *fpixa, l_int32 index, l_int32 accesstype)

l_ok	fpixaGetFPixDimensions (FPIXA fpixa, l_int32 index, l_int32 pw, l_int32 *ph)

l_float32 *	fpixaGetData (FPIXA *fpixa, l_int32 index)

l_ok	fpixaGetPixel (FPIXA fpixa, l_int32 index, l_int32 x, l_int32 y, l_float32 pval)

l_ok	fpixaSetPixel (FPIXA *fpixa, l_int32 index, l_int32 x, l_int32 y, l_float32 val)

DPIX *	dpixCreate (l_int32 width, l_int32 height)

DPIX *	dpixCreateTemplate (DPIX *dpixs)

DPIX *	dpixClone (DPIX *dpix)

DPIX *	dpixCopy (DPIX dpixd, DPIX dpixs)

l_ok	dpixResizeImageData (DPIX dpixd, DPIX dpixs)

void	dpixDestroy (DPIX **pdpix)

l_ok	dpixGetDimensions (DPIX dpix, l_int32 pw, l_int32 *ph)

l_ok	dpixSetDimensions (DPIX *dpix, l_int32 w, l_int32 h)

l_int32	dpixGetWpl (DPIX *dpix)

l_ok	dpixSetWpl (DPIX *dpix, l_int32 wpl)

l_int32	dpixGetRefcount (DPIX *dpix)

l_ok	dpixChangeRefcount (DPIX *dpix, l_int32 delta)

l_ok	dpixGetResolution (DPIX dpix, l_int32 pxres, l_int32 *pyres)

l_ok	dpixSetResolution (DPIX *dpix, l_int32 xres, l_int32 yres)

l_ok	dpixCopyResolution (DPIX dpixd, DPIX dpixs)

l_float64 *	dpixGetData (DPIX *dpix)

l_ok	dpixSetData (DPIX dpix, l_float64 data)

l_ok	dpixGetPixel (DPIX dpix, l_int32 x, l_int32 y, l_float64 pval)

l_ok	dpixSetPixel (DPIX *dpix, l_int32 x, l_int32 y, l_float64 val)

FPIX *	fpixRead (const char *filename)

FPIX *	fpixReadStream (FILE *fp)

FPIX *	fpixReadMem (const l_uint8 *data, size_t size)

l_ok	fpixWrite (const char filename, FPIX fpix)

l_ok	fpixWriteStream (FILE fp, FPIX fpix)

l_ok	fpixWriteMem (l_uint8 *pdata, size_t psize, FPIX *fpix)

FPIX *	fpixEndianByteSwap (FPIX fpixd, FPIX fpixs)

DPIX *	dpixRead (const char *filename)

DPIX *	dpixReadStream (FILE *fp)

DPIX *	dpixReadMem (const l_uint8 *data, size_t size)

l_ok	dpixWrite (const char filename, DPIX dpix)

l_ok	dpixWriteStream (FILE fp, DPIX dpix)

l_ok	dpixWriteMem (l_uint8 *pdata, size_t psize, DPIX *dpix)

DPIX *	dpixEndianByteSwap (DPIX dpixd, DPIX dpixs)

l_ok	fpixPrintStream (FILE fp, FPIX fpix, l_int32 factor)

Variables
static const l_int32	INITIAL_PTR_ARRAYSIZE = 20

Detailed Description



   This file has these FPix, FPixa and DPix utilities:
creation and destruction
accessors
- serialization and deserialization

   FPix Create/copy/destroy
         FPIX          *fpixCreate()
         FPIX          *fpixCreateTemplate()
         FPIX          *fpixClone()
         FPIX          *fpixCopy()
         l_int32        fpixResizeImageData()
         void           fpixDestroy()

   FPix accessors
         l_int32        fpixGetDimensions()
         l_int32        fpixSetDimensions()
         l_int32        fpixGetWpl()
         l_int32        fpixSetWpl()
         l_int32        fpixGetRefcount()
         l_int32        fpixChangeRefcount()
         l_int32        fpixGetResolution()
         l_int32        fpixSetResolution()
         l_int32        fpixCopyResolution()
         l_float32     *fpixGetData()
         l_int32        fpixSetData()
         l_int32        fpixGetPixel()
         l_int32        fpixSetPixel()

   FPixa Create/copy/destroy
         FPIXA         *fpixaCreate()
         FPIXA         *fpixaCopy()
         void           fpixaDestroy()

   FPixa addition
         l_int32        fpixaAddFPix()
         static l_int32 fpixaExtendArray()
         static l_int32 fpixaExtendArrayToSize()

   FPixa accessors
         l_int32        fpixaGetCount()
         l_int32        fpixaChangeRefcount()
         FPIX          *fpixaGetFPix()
         l_int32        fpixaGetFPixDimensions()
         l_float32     *fpixaGetData()
         l_int32        fpixaGetPixel()
         l_int32        fpixaSetPixel()

   DPix Create/copy/destroy
         DPIX          *dpixCreate()
         DPIX          *dpixCreateTemplate()
         DPIX          *dpixClone()
         DPIX          *dpixCopy()
         l_int32        dpixResizeImageData()
         void           dpixDestroy()

   DPix accessors
         l_int32        dpixGetDimensions()
         l_int32        dpixSetDimensions()
         l_int32        dpixGetWpl()
         l_int32        dpixSetWpl()
         l_int32        dpixGetRefcount()
         l_int32        dpixChangeRefcount()
         l_int32        dpixGetResolution()
         l_int32        dpixSetResolution()
         l_int32        dpixCopyResolution()
         l_float64     *dpixGetData()
         l_int32        dpixSetData()
         l_int32        dpixGetPixel()
         l_int32        dpixSetPixel()

   FPix serialized I/O
         FPIX          *fpixRead()
         FPIX          *fpixReadStream()
         FPIX          *fpixReadMem()
         l_int32        fpixWrite()
         l_int32        fpixWriteStream()
         l_int32        fpixWriteMem()
         FPIX          *fpixEndianByteSwap()

   DPix serialized I/O
         DPIX          *dpixRead()
         DPIX          *dpixReadStream()
         DPIX          *dpixReadMem()
         l_int32        dpixWrite()
         l_int32        dpixWriteStream()
         l_int32        dpixWriteMem()
         DPIX          *dpixEndianByteSwap()

   Print FPix (subsampled, for debugging)
         l_int32        fpixPrintStream()

Definition in file fpix1.c.

Function Documentation

◆ dpixChangeRefcount()

l_ok dpixChangeRefcount	(	DPIX *	dpix,
		l_int32	delta
	)

dpixChangeRefcount()

Parameters

[in]	dpix
[in]	delta

Returns: 0 if OK, 1 on error

Definition at line 1509 of file fpix1.c.

References DPix::refcount.

Referenced by dpixClone(), and dpixDestroy().

◆ dpixClone()

DPIX* dpixClone ( DPIX * dpix )

dpixClone()

Parameters

[in] dpix

Returns: same dpix ptr, or NULL on error

Notes:
     (1) See pixClone() for definition and usage.

Definition at line 1235 of file fpix1.c.

References dpixChangeRefcount().

Referenced by dpixEndianByteSwap().

◆ dpixCopy()

DPIX* dpixCopy	(	DPIX *	dpixd,
		DPIX *	dpixs
	)

dpixCopy()

Parameters

[in]	dpixd	[optional]; can be null, or equal to dpixs, or different from dpixs
[in]	dpixs

Returns: dpixd, or NULL on error

Notes:
     (1) There are three cases:
           (a) dpixd == null  (makes a new dpix; refcount = 1)
           (b) dpixd == dpixs  (no-op)
           (c) dpixd != dpixs  (data copy; no change in refcount)
         If the refcount of dpixd > 1, case (c) will side-effect
         these handles.
     (2) The general pattern of use is:
            dpixd = dpixCopy(dpixd, dpixs);
         This will work for all three cases.
         For clarity when the case is known, you can use:
           (a) dpixd = dpixCopy(NULL, dpixs);
           (c) dpixCopy(dpixd, dpixs);
     (3) For case (c), we check if dpixs and dpixd are the same size.
         If so, the data is copied directly.
         Otherwise, the data is reallocated to the correct size
         and the copy proceeds.  The refcount of dpixd is unchanged.
     (4) This operation, like all others that may involve a pre-existing
         dpixd, will side-effect any existing clones of dpixd.

Definition at line 1278 of file fpix1.c.

References dpixCopyResolution(), dpixCreateTemplate(), dpixGetData(), dpixGetDimensions(), and dpixResizeImageData().

Referenced by dpixEndianByteSwap(), and dpixLinearCombination().

◆ dpixCopyResolution()

l_ok dpixCopyResolution	(	DPIX *	dpixd,
		DPIX *	dpixs
	)

dpixCopyResolution()

Parameters

[in] dpixd,dpixs

Returns: 0 if OK, 1 on error

Definition at line 1574 of file fpix1.c.

References dpixGetResolution(), and dpixSetResolution().

Referenced by dpixCopy(), and dpixCreateTemplate().

◆ dpixCreate()

DPIX* dpixCreate	(	l_int32	width,
		l_int32	height
	)

dpixCreate()

Parameters

[in] width,height

Returns: dpix with data allocated and initialized to 0, or NULL on error

Notes:
     (1) Makes a DPix of specified size, with the data array
         allocated and initialized to 0.
     (2) The number of pixels must be less than 2^28.

Definition at line 1156 of file fpix1.c.

References dpixDestroy(), dpixSetData(), dpixSetDimensions(), dpixSetWpl(), and DPix::refcount.

Referenced by dpixCreateTemplate(), dpixReadStream(), dpixScaleByInteger(), and fpixConvertToDPix().

◆ dpixCreateTemplate()

DPIX* dpixCreateTemplate ( DPIX * dpixs )

dpixCreateTemplate()

Parameters

[in] dpixs

Returns: dpixd, or NULL on error

Notes:
     (1) Makes a DPix of the same size as the input DPix, with the
         data array allocated and initialized to 0.
     (2) Copies the resolution.

Definition at line 1206 of file fpix1.c.

References dpixCopyResolution(), dpixCreate(), and dpixGetDimensions().

Referenced by dpixCopy().

◆ dpixDestroy()

void dpixDestroy ( DPIX ** pdpix )

dpixDestroy()

Parameters

[in,out] pdpix will be nulled

Returns: void

Notes:
     (1) Decrements the ref count and, if 0, destroys the dpix.
     (2) Always nulls the input ptr.

Definition at line 1367 of file fpix1.c.

References dpixChangeRefcount(), dpixGetData(), and dpixGetRefcount().

Referenced by dpixCreate(), dpixReadStream(), and dpixWriteStream().

◆ dpixEndianByteSwap()

DPIX* dpixEndianByteSwap	(	DPIX *	dpixd,
		DPIX *	dpixs
	)

dpixEndianByteSwap()

Parameters

[in]	dpixd	can be equal to dpixs or NULL
[in]	dpixs

Returns: dpixd always

Notes:
     (1) On big-endian hardware, this does byte-swapping on each of
         the 4-byte words in the dpix data.  On little-endians,
         the data is unchanged.  This is used for serialization
         of dpix; the data is serialized in little-endian byte
         order because most hardware is little-endian.
     (2) The operation can be either in-place or, if dpixd == NULL,
         a new dpix is made.  If not in-place, caller must catch
         the returned pointer.

Definition at line 2252 of file fpix1.c.

References dpixClone(), dpixCopy(), dpixGetData(), and dpixGetDimensions().

Referenced by dpixReadStream(), and dpixWriteStream().

◆ dpixGetData()

l_float64* dpixGetData ( DPIX * dpix )

dpixGetData()

Parameters

[in] dpix

Returns: ptr DPix::data, or NULL on error

Definition at line 1596 of file fpix1.c.

References DPix::data.

Referenced by dpixAddMultConstant(), dpixConvertToFPix(), dpixConvertToPix(), dpixCopy(), dpixDestroy(), dpixEndianByteSwap(), dpixGetMax(), dpixGetMin(), dpixLinearCombination(), dpixReadStream(), dpixResizeImageData(), dpixScaleByInteger(), dpixSetAllArbitrary(), dpixWriteStream(), and fpixConvertToDPix().

◆ dpixGetDimensions()

l_ok dpixGetDimensions	(	DPIX *	dpix,
		l_int32 *	pw,
		l_int32 *	ph
	)

dpixGetDimensions()

Parameters

[in]	dpix
[out]	pw,ph	[optional] each can be null

Returns: 0 if OK, 1 on error

Definition at line 1406 of file fpix1.c.

References DPix::h, and DPix::w.

Referenced by dpixAddMultConstant(), dpixConvertToFPix(), dpixConvertToPix(), dpixCopy(), dpixCreateTemplate(), dpixEndianByteSwap(), dpixGetMax(), dpixGetMin(), dpixGetPixel(), dpixLinearCombination(), dpixResizeImageData(), dpixScaleByInteger(), dpixSetAllArbitrary(), dpixSetPixel(), and dpixWriteStream().

◆ dpixGetPixel()

l_ok dpixGetPixel	(	DPIX *	dpix,
		l_int32	x,
		l_int32	y,
		l_float64 *	pval
	)

dpixGetPixel()

Parameters

[in]	dpix
[in]	x,y	pixel coords
[out]	pval	pixel value

Returns: 0 if OK; 1 or 2 on error

Notes: (1) If the point is outside the image, this returns an error (2), with 0.0 in pval. To avoid spamming output, it fails silently.

Definition at line 1640 of file fpix1.c.

References DPix::data, and dpixGetDimensions().

◆ dpixGetRefcount()

l_int32 dpixGetRefcount ( DPIX * dpix )

dpixGetRefcount()

Parameters

[in] dpix

Returns: refcount, or UNDEF on error

Definition at line 1491 of file fpix1.c.

References DPix::refcount.

Referenced by dpixDestroy().

◆ dpixGetResolution()

l_ok dpixGetResolution	(	DPIX *	dpix,
		l_int32 *	pxres,
		l_int32 *	pyres
	)

dpixGetResolution()

Parameters

[in]	dpix
[out]	pxres,pyres	[optional] x and y resolution

Returns: 0 if OK, 1 on error

Definition at line 1530 of file fpix1.c.

References DPix::xres, and DPix::yres.

Referenced by dpixCopyResolution(), and dpixWriteStream().

◆ dpixGetWpl()

l_int32 dpixGetWpl ( DPIX * dpix )

dpixGetWpl()

Parameters

[in] dpix

Returns: wpl, or UNDEF on error

Definition at line 1453 of file fpix1.c.

References DPix::wpl.

Referenced by dpixAddMultConstant(), dpixConvertToFPix(), dpixConvertToPix(), dpixGetMax(), dpixGetMin(), dpixLinearCombination(), dpixScaleByInteger(), and fpixConvertToDPix().

◆ dpixRead()

DPIX* dpixRead ( const char * filename )

dpixRead()

Parameters

[in] filename

Returns: dpix, or NULL on error

Definition at line 2006 of file fpix1.c.

References dpixReadStream(), and fopenReadStream().

◆ dpixReadMem()

DPIX* dpixReadMem	(	const l_uint8 *	data,
		size_t	size
	)

dpixReadMem()

Parameters

[in]	data	of serialized dpix
[in]	size	of data in bytes

Returns: dpix, or NULL on error

Definition at line 2086 of file fpix1.c.

References dpixReadStream(), and fopenReadFromMemory().

◆ dpixReadStream()

DPIX* dpixReadStream ( FILE * fp )

dpixReadStream()

Parameters

[in] fp file stream

Returns: dpix, or NULL on error

Definition at line 2033 of file fpix1.c.

References DPIX_VERSION_NUMBER, dpixCreate(), dpixDestroy(), dpixEndianByteSwap(), dpixGetData(), and dpixSetResolution().

Referenced by dpixRead(), and dpixReadMem().

◆ dpixResizeImageData()

l_ok dpixResizeImageData	(	DPIX *	dpixd,
		DPIX *	dpixs
	)

dpixResizeImageData()

Parameters

[in] dpixd,dpixs

Returns: 0 if OK, 1 on error

Definition at line 1324 of file fpix1.c.

References dpixGetData(), dpixGetDimensions(), dpixSetData(), dpixSetDimensions(), and dpixSetWpl().

Referenced by dpixCopy().

◆ dpixSetData()

l_ok dpixSetData	(	DPIX *	dpix,
		l_float64 *	data
	)

dpixSetData()

Parameters

[in]	dpix
[in]	data

Returns: 0 if OK, 1 on error

Definition at line 1614 of file fpix1.c.

References DPix::data.

Referenced by dpixCreate(), and dpixResizeImageData().

◆ dpixSetDimensions()

l_ok dpixSetDimensions	(	DPIX *	dpix,
		l_int32	w,
		l_int32	h
	)

dpixSetDimensions()

Parameters

[in]	dpix
[in]	w,h

Returns: 0 if OK, 1 on error

Definition at line 1432 of file fpix1.c.

References DPix::h, and DPix::w.

Referenced by dpixCreate(), and dpixResizeImageData().

◆ dpixSetPixel()

l_ok dpixSetPixel	(	DPIX *	dpix,
		l_int32	x,
		l_int32	y,
		l_float64	val
	)

dpixSetPixel()

Parameters

[in]	dpix
[in]	x,y	pixel coords
[in]	val	pixel value

Returns: 0 if OK; 1 or 2 on error

Notes: (1) If the point is outside the image, this returns an error (2), with 0.0 in pval. To avoid spamming output, it fails silently.

Definition at line 1677 of file fpix1.c.

References DPix::data, and dpixGetDimensions().

◆ dpixSetResolution()

l_ok dpixSetResolution	(	DPIX *	dpix,
		l_int32	xres,
		l_int32	yres
	)

dpixSetResolution()

Parameters

[in]	dpix
[in]	xres,yres	x and y resolution

Returns: 0 if OK, 1 on error

Definition at line 1552 of file fpix1.c.

References DPix::xres, and DPix::yres.

Referenced by dpixCopyResolution(), and dpixReadStream().

◆ dpixSetWpl()

l_ok dpixSetWpl	(	DPIX *	dpix,
		l_int32	wpl
	)

dpixSetWpl()

Parameters

[in]	dpix
[in]	wpl

Returns: 0 if OK, 1 on error

Definition at line 1471 of file fpix1.c.

References DPix::wpl.

Referenced by dpixCreate(), and dpixResizeImageData().

◆ dpixWrite()

l_ok dpixWrite	(	const char *	filename,
		DPIX *	dpix
	)

dpixWrite()

Parameters

[in]	filename
[in]	dpix

Returns: 0 if OK, 1 on error

Definition at line 2114 of file fpix1.c.

References dpixWriteStream(), and fopenWriteStream().

◆ dpixWriteMem()

l_ok dpixWriteMem	(	l_uint8 **	pdata,
		size_t *	psize,
		DPIX *	dpix
	)

dpixWriteMem()

Parameters

[out]	pdata	data of serialized dpix
[out]	psize	size of returned data
[in]	dpix

Returns: 0 if OK, 1 on error

Notes:
     (1) Serializes a dpix in memory and puts the result in a buffer.

Definition at line 2192 of file fpix1.c.

References dpixWriteStream(), fopenWriteWinTempfile(), and l_binaryReadStream().

◆ dpixWriteStream()

l_ok dpixWriteStream	(	FILE *	fp,
		DPIX *	dpix
	)

dpixWriteStream()

Parameters

[in]	fp	file stream opened for "wb"
[in]	dpix

Returns: 0 if OK, 1 on error

Definition at line 2145 of file fpix1.c.

References DPIX_VERSION_NUMBER, dpixDestroy(), dpixEndianByteSwap(), dpixGetData(), dpixGetDimensions(), and dpixGetResolution().

Referenced by dpixWrite(), and dpixWriteMem().

◆ fpixaAddFPix()

l_ok fpixaAddFPix	(	FPIXA *	fpixa,
		FPIX *	fpix,
		l_int32	copyflag
	)

fpixaAddFPix()

Parameters

[in]	fpixa
[in]	fpix	to be added
[in]	copyflag	L_INSERT, L_COPY, L_CLONE

Returns: 0 if OK; 1 on error

Definition at line 842 of file fpix1.c.

References FPixa::fpix, fpixaExtendArray(), fpixaGetCount(), fpixClone(), fpixCopy(), L_CLONE, L_COPY, L_INSERT, FPixa::n, and FPixa::nalloc.

Referenced by fpixaConvertLABToXYZ(), fpixaConvertXYZToLAB(), and fpixaCopy().

◆ fpixaChangeRefcount()

l_ok fpixaChangeRefcount	(	FPIXA *	fpixa,
		l_int32	delta
	)

fpixaChangeRefcount()

Parameters

[in]	fpixa
[in]	delta

Returns: 0 if OK, 1 on error

Definition at line 961 of file fpix1.c.

References FPixa::refcount.

Referenced by fpixaCopy(), and fpixaDestroy().

◆ fpixaCopy()

FPIXA* fpixaCopy	(	FPIXA *	fpixa,
		l_int32	copyflag
	)

fpixaCopy()

Parameters

[in]	fpixa
[in]	copyflag	L_COPY, L_CLODE or L_COPY_CLONE

Returns: new fpixa, or NULL on error

Notes:
     copyflag may be one of
       ~ L_COPY makes a new fpixa and copies each fpix
       ~ L_CLONE gives a new ref-counted handle to the input fpixa
       ~ L_COPY_CLONE makes a new fpixa with clones of all fpix

Definition at line 754 of file fpix1.c.

References fpixaAddFPix(), fpixaChangeRefcount(), fpixaCreate(), fpixaGetFPix(), L_CLONE, L_COPY, L_COPY_CLONE, L_INSERT, and FPixa::n.

◆ fpixaCreate()

FPIXA* fpixaCreate ( l_int32 n )

fpixaCreate()

Parameters

[in] n initial number of ptrs

Returns: fpixa, or NULL on error

Definition at line 714 of file fpix1.c.

Referenced by fpixaConvertLABToXYZ(), fpixaConvertXYZToLAB(), and fpixaCopy().

◆ fpixaDestroy()

void fpixaDestroy ( FPIXA ** pfpixa )

fpixaDestroy()

Parameters

[in,out] pfpixa to be nulled

Returns: void

Notes:
     (1) Decrements the ref count and, if 0, destroys the fpixa.
     (2) Always nulls the input ptr.

Definition at line 801 of file fpix1.c.

References FPixa::fpix, fpixaChangeRefcount(), fpixDestroy(), FPixa::n, and FPixa::refcount.

◆ fpixaExtendArray()

static l_int32 fpixaExtendArray ( FPIXA * fpixa )

static

fpixaExtendArray()

Parameters

[in] fpixa

Returns: 0 if OK; 1 on error

Notes:
     (1) Doubles the size of the fpixa ptr array.

Definition at line 889 of file fpix1.c.

References fpixaExtendArrayToSize(), and FPixa::nalloc.

Referenced by fpixaAddFPix().

◆ fpixaExtendArrayToSize()

static l_int32 fpixaExtendArrayToSize	(	FPIXA *	fpixa,
		l_int32	size
	)

static

fpixaExtendArrayToSize()

Parameters

[in]	fpixa
[in]	size	new size

Returns: 0 if OK; 1 on error

Notes:
     (1) If necessary, reallocs new fpixa ptrs array to size.

Definition at line 913 of file fpix1.c.

References FPixa::fpix, FPixa::nalloc, and reallocNew().

Referenced by fpixaExtendArray().

◆ fpixaGetCount()

l_int32 fpixaGetCount ( FPIXA * fpixa )

fpixaGetCount()

Parameters

[in] fpixa

Returns: count, or 0 if no pixa

Definition at line 942 of file fpix1.c.

References FPixa::n.

Referenced by fpixaAddFPix(), fpixaConvertLABToRGB(), fpixaConvertLABToXYZ(), fpixaConvertXYZToLAB(), fpixaConvertXYZToRGB(), fpixaDisplayQuadtree(), fpixaGetData(), fpixaGetPixel(), fpixaSetPixel(), quadtreeGetChildren(), and quadtreeGetParent().

◆ fpixaGetData()

l_float32* fpixaGetData	(	FPIXA *	fpixa,
		l_int32	index
	)

fpixaGetData()

Parameters

[in]	fpixa
[in]	index	into fpixa array

Returns: data not a copy, or NULL on error

Definition at line 1046 of file fpix1.c.

References fpixaGetCount(), fpixaGetFPix(), fpixDestroy(), fpixGetData(), and L_CLONE.

Referenced by fpixaConvertLABToXYZ(), and fpixaConvertXYZToLAB().

◆ fpixaGetFPix()

FPIX* fpixaGetFPix	(	FPIXA *	fpixa,
		l_int32	index,
		l_int32	accesstype
	)

fpixaGetFPix()

Parameters

[in]	fpixa
[in]	index	to the index-th fpix
[in]	accesstype	L_COPY or L_CLONE

Returns: fpix, or NULL on error

Definition at line 983 of file fpix1.c.

References FPixa::fpix, fpixClone(), fpixCopy(), L_CLONE, L_COPY, and FPixa::n.

Referenced by fpixaCopy(), fpixaDisplayQuadtree(), fpixaGetData(), fpixaGetFPixDimensions(), fpixaGetPixel(), and fpixaSetPixel().

◆ fpixaGetFPixDimensions()

l_ok fpixaGetFPixDimensions	(	FPIXA *	fpixa,
		l_int32	index,
		l_int32 *	pw,
		l_int32 *	ph
	)

fpixaGetFPixDimensions()

Parameters

[in]	fpixa
[in]	index	to the index-th box
[out]	pw,ph	[optional] each can be null

Returns: 0 if OK, 1 on error

Definition at line 1012 of file fpix1.c.

References fpixaGetFPix(), fpixDestroy(), fpixGetDimensions(), L_CLONE, and FPixa::n.

Referenced by fpixaConvertLABToRGB(), fpixaConvertLABToXYZ(), fpixaConvertXYZToLAB(), and fpixaConvertXYZToRGB().

◆ fpixaGetPixel()

l_ok fpixaGetPixel	(	FPIXA *	fpixa,
		l_int32	index,
		l_int32	x,
		l_int32	y,
		l_float32 *	pval
	)

fpixaGetPixel()

Parameters

[in]	fpixa
[in]	index	into fpixa array
[in]	x,y	pixel coords
[out]	pval	pixel value

Returns: 0 if OK; 1 on error

Definition at line 1078 of file fpix1.c.

References fpixaGetCount(), fpixaGetFPix(), fpixDestroy(), fpixGetPixel(), and L_CLONE.

Referenced by quadtreeGetChildren(), and quadtreeGetParent().

◆ fpixaSetPixel()

l_ok fpixaSetPixel	(	FPIXA *	fpixa,
		l_int32	index,
		l_int32	x,
		l_int32	y,
		l_float32	val
	)

fpixaSetPixel()

Parameters

[in]	fpixa
[in]	index	into fpixa array
[in]	x,y	pixel coords
[in]	val	pixel value

Returns: 0 if OK; 1 on error

Definition at line 1115 of file fpix1.c.

References fpixaGetCount(), fpixaGetFPix(), fpixDestroy(), fpixSetPixel(), and L_CLONE.

◆ fpixChangeRefcount()

l_ok fpixChangeRefcount	(	FPIX *	fpix,
		l_int32	delta
	)

fpixChangeRefcount()

Parameters

[in]	fpix
[in]	delta

Returns: 0 if OK, 1 on error

Definition at line 515 of file fpix1.c.

References FPix::refcount.

Referenced by fpixClone(), and fpixDestroy().

◆ fpixClone()

FPIX* fpixClone ( FPIX * fpix )

fpixClone()

Parameters

[in] fpix

Returns: same fpix ptr, or NULL on error

Notes:
     (1) See pixClone() for definition and usage.

Definition at line 233 of file fpix1.c.

References fpixChangeRefcount().

Referenced by fpixaAddFPix(), fpixAffinePta(), fpixaGetFPix(), fpixEndianByteSwap(), and fpixProjectivePta().

◆ fpixCopy()

FPIX* fpixCopy	(	FPIX *	fpixd,
		FPIX *	fpixs
	)

fpixCopy()

Parameters

[in]	fpixd	[optional]; can be null, or equal to fpixs, or different from fpixs
[in]	fpixs

Returns: fpixd, or NULL on error

Notes:
     (1) There are three cases:
           (a) fpixd == null  (makes a new fpix; refcount = 1)
           (b) fpixd == fpixs  (no-op)
           (c) fpixd != fpixs  (data copy; no change in refcount)
         If the refcount of fpixd > 1, case (c) will side-effect
         these handles.
     (2) The general pattern of use is:
            fpixd = fpixCopy(fpixd, fpixs);
         This will work for all three cases.
         For clarity when the case is known, you can use:
           (a) fpixd = fpixCopy(NULL, fpixs);
           (c) fpixCopy(fpixd, fpixs);
     (3) For case (c), we check if fpixs and fpixd are the same size.
         If so, the data is copied directly.
         Otherwise, the data is reallocated to the correct size
         and the copy proceeds.  The refcount of fpixd is unchanged.
     (4) This operation, like all others that may involve a pre-existing
         fpixd, will side-effect any existing clones of fpixd.

Definition at line 276 of file fpix1.c.

References fpixCopyResolution(), fpixCreateTemplate(), fpixGetData(), fpixGetDimensions(), and fpixResizeImageData().

Referenced by dewarpPopulateFullRes(), fpixaAddFPix(), fpixAddBorder(), fpixaGetFPix(), fpixEndianByteSwap(), fpixFlipLR(), fpixFlipTB(), fpixLinearCombination(), fpixRemoveBorder(), fpixRotate180(), and fpixRotateOrth().

◆ fpixCopyResolution()

l_ok fpixCopyResolution	(	FPIX *	fpixd,
		FPIX *	fpixs
	)

fpixCopyResolution()

Parameters

[in] fpixd,fpixs

Returns: 0 if OK, 1 on error

Definition at line 580 of file fpix1.c.

References fpixGetResolution(), and fpixSetResolution().

Referenced by fpixAddBorder(), fpixCopy(), fpixCreateTemplate(), fpixRemoveBorder(), and fpixRotate90().

◆ fpixCreate()

FPIX* fpixCreate	(	l_int32	width,
		l_int32	height
	)

fpixCreate()

Parameters

[in] width,height

Returns: fpixd with data allocated and initialized to 0, or NULL on error

Notes:
     (1) Makes a FPix of specified size, with the data array
         allocated and initialized to 0.
     (2) The number of pixels must be less than 2^29.

Definition at line 153 of file fpix1.c.

References fpixDestroy(), fpixSetData(), fpixSetDimensions(), fpixSetWpl(), and FPix::refcount.

Referenced by dpixConvertToFPix(), fpixaConvertLABToXYZ(), fpixaConvertXYZToLAB(), fpixAddBorder(), fpixCreateTemplate(), fpixReadStream(), fpixRemoveBorder(), fpixRotate90(), and fpixScaleByInteger().

◆ fpixCreateTemplate()

FPIX* fpixCreateTemplate ( FPIX * fpixs )

fpixCreateTemplate()

Parameters

[in] fpixs

Returns: fpixd, or NULL on error

Notes:
     (1) Makes a FPix of the same size as the input FPix, with the
         data array allocated and initialized to 0.
     (2) Copies the resolution.

Definition at line 203 of file fpix1.c.

References fpixCopyResolution(), fpixCreate(), and fpixGetDimensions().

Referenced by fpixAffine(), fpixCopy(), and fpixProjective().

◆ fpixDestroy()

void fpixDestroy ( FPIX ** pfpix )

fpixDestroy()

Parameters

[in,out] pfpix will be nulled

Returns: void

Notes:
     (1) Decrements the ref count and, if 0, destroys the fpix.
     (2) Always nulls the input ptr.

Definition at line 373 of file fpix1.c.

References fpixChangeRefcount(), fpixGetData(), and fpixGetRefcount().

Referenced by dewarpDestroy(), dewarpMinimize(), dewarpPopulateFullRes(), fpixaDestroy(), fpixaDisplayQuadtree(), fpixAffinePta(), fpixaGetData(), fpixaGetFPixDimensions(), fpixaGetPixel(), fpixaSetPixel(), fpixCreate(), fpixFlipLR(), fpixFlipTB(), fpixProjectivePta(), fpixReadStream(), and fpixWriteStream().

◆ fpixEndianByteSwap()

FPIX* fpixEndianByteSwap	(	FPIX *	fpixd,
		FPIX *	fpixs
	)

fpixEndianByteSwap()

Parameters

[in]	fpixd	can be equal to fpixs or NULL
[in]	fpixs

Returns: fpixd always

Notes:
     (1) On big-endian hardware, this does byte-swapping on each of
         the 4-byte floats in the fpix data.  On little-endians,
         the data is unchanged.  This is used for serialization
         of fpix; the data is serialized in little-endian byte
         order because most hardware is little-endian.
     (2) The operation can be either in-place or, if fpixd == NULL,
         a new fpix is made.  If not in-place, caller must catch
         the returned pointer.

Definition at line 1954 of file fpix1.c.

References fpixClone(), fpixCopy(), fpixGetData(), and fpixGetDimensions().

Referenced by fpixReadStream(), and fpixWriteStream().

◆ fpixGetData()

l_float32* fpixGetData ( FPIX * fpix )

fpixGetData()

Parameters

[in] fpix

Returns: ptr FPix::data, or NULL on error

Definition at line 602 of file fpix1.c.

References FPix::data.

Referenced by dpixConvertToFPix(), fpixAddMultConstant(), fpixAffine(), fpixaGetData(), fpixConvertToDPix(), fpixConvertToPix(), fpixCopy(), fpixDestroy(), fpixDisplayMaxDynamicRange(), fpixEndianByteSwap(), fpixFlipLR(), fpixFlipTB(), fpixGetMax(), fpixGetMin(), fpixLinearCombination(), fpixProjective(), fpixRasterop(), fpixReadStream(), fpixRenderContours(), fpixResizeImageData(), fpixRotate90(), fpixScaleByInteger(), fpixSetAllArbitrary(), fpixThresholdToPix(), fpixWriteStream(), pixApplyHorizDisparity(), and pixApplyVertDisparity().

◆ fpixGetDimensions()

l_ok fpixGetDimensions	(	FPIX *	fpix,
		l_int32 *	pw,
		l_int32 *	ph
	)

fpixGetDimensions()

Parameters

[in]	fpix
[out]	pw,ph	[optional] each can be null

Returns: 0 if OK, 1 on error

Definition at line 412 of file fpix1.c.

References FPix::h, and FPix::w.

Referenced by dewarpPopulateFullRes(), fpixAddBorder(), fpixAddContinuedBorder(), fpixAddMirroredBorder(), fpixAddMultConstant(), fpixAddSlopeBorder(), fpixAffine(), fpixaGetFPixDimensions(), fpixConvertToDPix(), fpixConvertToPix(), fpixConvolve(), fpixCopy(), fpixCreateTemplate(), fpixDisplayMaxDynamicRange(), fpixEndianByteSwap(), fpixFlipLR(), fpixFlipTB(), fpixGetMax(), fpixGetMin(), fpixGetPixel(), fpixLinearCombination(), fpixPrintStream(), fpixProjective(), fpixRasterop(), fpixRemoveBorder(), fpixRenderContours(), fpixResizeImageData(), fpixRotate90(), fpixScaleByInteger(), fpixSetAllArbitrary(), fpixSetPixel(), fpixThresholdToPix(), fpixWriteStream(), pixApplyHorizDisparity(), and pixApplyVertDisparity().

◆ fpixGetPixel()

l_ok fpixGetPixel	(	FPIX *	fpix,
		l_int32	x,
		l_int32	y,
		l_float32 *	pval
	)

fpixGetPixel()

Parameters

[in]	fpix
[in]	x,y	pixel coords
[out]	pval	pixel value

Returns: 0 if OK; 1 or 2 on error

Notes: (1) If the point is outside the image, this returns an error (2), with 0.0 in pval. To avoid spamming output, it fails silently.

Definition at line 646 of file fpix1.c.

References FPix::data, and fpixGetDimensions().

Referenced by fpixAddSlopeBorder(), fpixaGetPixel(), and fpixPrintStream().

◆ fpixGetRefcount()

l_int32 fpixGetRefcount ( FPIX * fpix )

fpixGetRefcount()

Parameters

[in] fpix

Returns: refcount, or UNDEF on error

Definition at line 497 of file fpix1.c.

References FPix::refcount.

Referenced by fpixDestroy().

◆ fpixGetResolution()

l_ok fpixGetResolution	(	FPIX *	fpix,
		l_int32 *	pxres,
		l_int32 *	pyres
	)

fpixGetResolution()

Parameters

[in]	fpix
[out]	pxres,pyres	[optional] x and y resolution

Returns: 0 if OK, 1 on error

Definition at line 536 of file fpix1.c.

References FPix::xres, and FPix::yres.

Referenced by fpixCopyResolution(), and fpixWriteStream().

◆ fpixGetWpl()

l_int32 fpixGetWpl ( FPIX * fpix )

fpixGetWpl()

Parameters

[in] fpix

Returns: wpl, or UNDEF on error

Definition at line 459 of file fpix1.c.

References FPix::wpl.

Referenced by dpixConvertToFPix(), fpixaConvertLABToXYZ(), fpixaConvertXYZToLAB(), fpixAddMultConstant(), fpixAffine(), fpixConvertToDPix(), fpixConvertToPix(), fpixDisplayMaxDynamicRange(), fpixFlipLR(), fpixFlipTB(), fpixGetMax(), fpixGetMin(), fpixLinearCombination(), fpixProjective(), fpixRasterop(), fpixRenderContours(), fpixRotate90(), fpixScaleByInteger(), and fpixThresholdToPix().

◆ fpixPrintStream()

l_ok fpixPrintStream	(	FILE *	fp,
		FPIX *	fpix,
		l_int32	factor
	)

fpixPrintStream()

Parameters

[in]	fp	file stream
[in]	fpix
[in]	factor	subsampled

Returns: 0 if OK, 1 on error

Notes:
     (1) Subsampled printout of fpix for debugging.

Definition at line 2311 of file fpix1.c.

References fpixGetDimensions(), and fpixGetPixel().

◆ fpixRead()

FPIX* fpixRead ( const char * filename )

fpixRead()

Parameters

[in] filename

Returns: fpix, or NULL on error

Definition at line 1708 of file fpix1.c.

References fopenReadStream(), and fpixReadStream().

◆ fpixReadMem()

FPIX* fpixReadMem	(	const l_uint8 *	data,
		size_t	size
	)

fpixReadMem()

Parameters

[in]	data	of serialized fpix
[in]	size	of data in bytes

Returns: fpix, or NULL on error

Definition at line 1788 of file fpix1.c.

References fopenReadFromMemory(), and fpixReadStream().

◆ fpixReadStream()

FPIX* fpixReadStream ( FILE * fp )

fpixReadStream()

Parameters

[in] fp file stream

Returns: fpix, or NULL on error

Definition at line 1735 of file fpix1.c.

References FPIX_VERSION_NUMBER, fpixCreate(), fpixDestroy(), fpixEndianByteSwap(), fpixGetData(), and fpixSetResolution().

Referenced by dewarpReadStream(), fpixRead(), and fpixReadMem().

◆ fpixResizeImageData()

l_ok fpixResizeImageData	(	FPIX *	fpixd,
		FPIX *	fpixs
	)

fpixResizeImageData()

Parameters

[in] fpixd,fpixs

Returns: 0 if OK, 1 on error

Notes:
     (1) If the data sizes differ, this destroys the existing
         data in fpixd and allocates a new, uninitialized, data array
         of the same size as the data in fpixs.  Otherwise, this
         doesn't do anything.

Definition at line 330 of file fpix1.c.

References fpixGetData(), fpixGetDimensions(), fpixSetData(), fpixSetDimensions(), and fpixSetWpl().

Referenced by fpixCopy().

◆ fpixSetData()

l_ok fpixSetData	(	FPIX *	fpix,
		l_float32 *	data
	)

fpixSetData()

Parameters

[in]	fpix
[in]	data

Returns: 0 if OK, 1 on error

Definition at line 620 of file fpix1.c.

References FPix::data.

Referenced by fpixCreate(), and fpixResizeImageData().

◆ fpixSetDimensions()

l_ok fpixSetDimensions	(	FPIX *	fpix,
		l_int32	w,
		l_int32	h
	)

fpixSetDimensions()

Parameters

[in]	fpix
[in]	w,h

Returns: 0 if OK, 1 on error

Definition at line 438 of file fpix1.c.

References FPix::h, and FPix::w.

Referenced by fpixCreate(), and fpixResizeImageData().

◆ fpixSetPixel()

l_ok fpixSetPixel	(	FPIX *	fpix,
		l_int32	x,
		l_int32	y,
		l_float32	val
	)

fpixSetPixel()

Parameters

[in]	fpix
[in]	x,y	pixel coords
[in]	val	pixel value

Returns: 0 if OK; 1 or 2 on error

Notes: (1) If the point is outside the image, this returns an error (2), with 0.0 in pval. To avoid spamming output, it fails silently.

Definition at line 683 of file fpix1.c.

References FPix::data, and fpixGetDimensions().

Referenced by fpixAddSlopeBorder(), and fpixaSetPixel().

◆ fpixSetResolution()

l_ok fpixSetResolution	(	FPIX *	fpix,
		l_int32	xres,
		l_int32	yres
	)

fpixSetResolution()

Parameters

[in]	fpix
[in]	xres,yres	x and y resolution

Returns: 0 if OK, 1 on error

Definition at line 558 of file fpix1.c.

References FPix::xres, and FPix::yres.

Referenced by fpixCopyResolution(), and fpixReadStream().

◆ fpixSetWpl()

l_ok fpixSetWpl	(	FPIX *	fpix,
		l_int32	wpl
	)

fpixSetWpl()

Parameters

[in]	fpix
[in]	wpl

Returns: 0 if OK, 1 on error

Definition at line 477 of file fpix1.c.

References FPix::wpl.

Referenced by fpixCreate(), and fpixResizeImageData().

◆ fpixWrite()

l_ok fpixWrite	(	const char *	filename,
		FPIX *	fpix
	)

fpixWrite()

Parameters

[in]	filename
[in]	fpix

Returns: 0 if OK, 1 on error

Definition at line 1816 of file fpix1.c.

References fopenWriteStream(), and fpixWriteStream().

◆ fpixWriteMem()

l_ok fpixWriteMem	(	l_uint8 **	pdata,
		size_t *	psize,
		FPIX *	fpix
	)

fpixWriteMem()

Parameters

[out]	pdata	data of serialized fpix
[out]	psize	size of returned data
[in]	fpix

Returns: 0 if OK, 1 on error

Notes:
     (1) Serializes a fpix in memory and puts the result in a buffer.

Definition at line 1894 of file fpix1.c.

References fopenWriteWinTempfile(), fpixWriteStream(), and l_binaryReadStream().

◆ fpixWriteStream()

l_ok fpixWriteStream	(	FILE *	fp,
		FPIX *	fpix
	)

fpixWriteStream()

Parameters

[in]	fp	file stream opened for "wb"
[in]	fpix

Returns: 0 if OK, 1 on error

Definition at line 1847 of file fpix1.c.

References FPIX_VERSION_NUMBER, fpixDestroy(), fpixEndianByteSwap(), fpixGetData(), fpixGetDimensions(), and fpixGetResolution().

Referenced by dewarpWriteStream(), fpixWrite(), and fpixWriteMem().

Functions

Variables

Detailed Description

- serialization and deserialization

Function Documentation

◆ dpixChangeRefcount()

◆ dpixClone()

◆ dpixCopy()

◆ dpixCopyResolution()

◆ dpixCreate()

◆ dpixCreateTemplate()

◆ dpixDestroy()

◆ dpixEndianByteSwap()

◆ dpixGetData()

◆ dpixGetDimensions()

◆ dpixGetPixel()

◆ dpixGetRefcount()

◆ dpixGetResolution()

◆ dpixGetWpl()

◆ dpixRead()

◆ dpixReadMem()

◆ dpixReadStream()

◆ dpixResizeImageData()

◆ dpixSetData()

◆ dpixSetDimensions()

◆ dpixSetPixel()

◆ dpixSetResolution()

◆ dpixSetWpl()

◆ dpixWrite()

◆ dpixWriteMem()

◆ dpixWriteStream()

◆ fpixaAddFPix()

◆ fpixaChangeRefcount()

◆ fpixaCopy()

◆ fpixaCreate()

◆ fpixaDestroy()

◆ fpixaExtendArray()

◆ fpixaExtendArrayToSize()

◆ fpixaGetCount()

◆ fpixaGetData()

◆ fpixaGetFPix()

◆ fpixaGetFPixDimensions()

◆ fpixaGetPixel()

◆ fpixaSetPixel()

◆ fpixChangeRefcount()

◆ fpixClone()

◆ fpixCopy()

◆ fpixCopyResolution()

◆ fpixCreate()

◆ fpixCreateTemplate()

◆ fpixDestroy()

◆ fpixEndianByteSwap()

◆ fpixGetData()

◆ fpixGetDimensions()

◆ fpixGetPixel()

◆ fpixGetRefcount()

◆ fpixGetResolution()

◆ fpixGetWpl()

◆ fpixPrintStream()

◆ fpixRead()

◆ fpixReadMem()

◆ fpixReadStream()

◆ fpixResizeImageData()

◆ fpixSetData()

◆ fpixSetDimensions()

◆ fpixSetPixel()

◆ fpixSetResolution()

◆ fpixSetWpl()

◆ fpixWrite()

◆ fpixWriteMem()

◆ fpixWriteStream()