Portable graymap format (PGM) parser - Definition. More...
Go to the source code of this file.
Functions | |
static int | remove_blanks (FILE *f) |
static int | remove_line (FILE *f) |
VL_EXPORT int | vl_pgm_extract_data (FILE *f, VlPgmImage const *im, void *data) |
Extract PGM data from stream. | |
VL_EXPORT int | vl_pgm_extract_head (FILE *f, VlPgmImage *im) |
Extract PGM header from stream. | |
VL_EXPORT vl_size | vl_pgm_get_bpp (VlPgmImage const *im) |
Get PGM image bytes per pixel. | |
VL_EXPORT vl_size | vl_pgm_get_npixels (VlPgmImage const *im) |
Get PGM image number of pixels. | |
VL_EXPORT int | vl_pgm_insert (FILE *f, VlPgmImage const *im, void const *data) |
Insert a PGM image into a stream. | |
VL_EXPORT int | vl_pgm_read_new (char const *name, VlPgmImage *im, vl_uint8 **data) |
Read a PGM file. | |
VL_EXPORT int | vl_pgm_read_new_f (char const *name, VlPgmImage *im, float **data) |
Read floats from a PGM file. | |
VL_EXPORT int | vl_pgm_write (char const *name, vl_uint8 const *data, int width, int height) |
Write bytes to a PGM file. | |
VL_EXPORT int | vl_pgm_write_f (char const *name, float const *data, int width, int height) |
Write floats to PGM file. |
Portable graymap format (PGM) parser - Definition.
Definition in file pgm.c.
static int remove_blanks | ( | FILE * | f | ) | [static] |
static int remove_line | ( | FILE * | f | ) | [static] |
VL_EXPORT int vl_pgm_extract_data | ( | FILE * | f, |
VlPgmImage const * | im, | ||
void * | data | ||
) |
Extract PGM data from stream.
------------------------------------------------------------------
f | input file. |
im | PGM image descriptor. |
data | data buffer to fill. |
The function extracts from the file f the data section of an image encoded in PGM format. The function fills the buffer data according. The buffer data should be vl_pgm_get_npixels() by vl_pgm_get_bpp() bytes large.
VL_EXPORT int vl_pgm_extract_head | ( | FILE * | f, |
VlPgmImage * | im | ||
) |
Extract PGM header from stream.
------------------------------------------------------------------
f | input file. |
im | image structure to fill. |
The function extracts from the file f the meta-data section of an image encoded in PGM format. The function fills the structure VlPgmImage accordingly.
The error may be either VL_ERR_PGM_INV_HEAD or VL_ERR_PGM_INV_META depending whether the error occurred in decoding the header or meta section of the PGM file.
VL_EXPORT vl_size vl_pgm_get_bpp | ( | VlPgmImage const * | im | ) |
VL_EXPORT vl_size vl_pgm_get_npixels | ( | VlPgmImage const * | im | ) |
Get PGM image number of pixels.
------------------------------------------------------------------
im | PGM image descriptor. |
The functions returns the number of pixels of the PGM image im.
To calculate the image data size in bytes, this value must be multiplied by the number of byte per pixels (see vl_pgm_get_bpp()).
VL_EXPORT int vl_pgm_insert | ( | FILE * | f, |
VlPgmImage const * | im, | ||
void const * | data | ||
) |
VL_EXPORT int vl_pgm_read_new | ( | char const * | name, |
VlPgmImage * | im, | ||
vl_uint8 ** | data | ||
) |
Read a PGM file.
------------------------------------------------------------------
name | file name. |
im | a pointer to the PGM image structure to fill. |
data | a pointer to the pointer to the allocated buffer. |
The function reads a PGM image from file name and initializes the structure im and the buffer data accordingly.
The ownership of the buffer data is transfered to the caller. data should be freed by means of vl_free().
VL_EXPORT int vl_pgm_read_new_f | ( | char const * | name, |
VlPgmImage * | im, | ||
float ** | data | ||
) |
Read floats from a PGM file.
------------------------------------------------------------------
name | file name. |
im | a pointer to the PGM image structure to fill. |
data | a pointer to the pointer to the allocated buffer. |
The function reads a PGM image from file name and initializes the structure im and the buffer data accordingly. The buffer data is an array of floats in the range [0, 1].
The ownership of the buffer data is transfered to the caller. data should be freed by means of vl_free().
VL_EXPORT int vl_pgm_write | ( | char const * | name, |
vl_uint8 const * | data, | ||
int | width, | ||
int | height | ||
) |
Write bytes to a PGM file.
------------------------------------------------------------------
name | file name. |
data | data to write. |
width | width of the image. |
height | height of the image. |
The function dumps the image data to the PGM file of the specified name. This is an helper function simplifying the usage of vl_pgm_insert().
VL_EXPORT int vl_pgm_write_f | ( | char const * | name, |
float const * | data, | ||
int | width, | ||
int | height | ||
) |
Write floats to PGM file.
-------------------------------------------------------------------
name | file name. |
data | data to write. |
width | width of the image. |
height | height of the image. |
The function dumps the image data to the PGM file of the specified name. The data is re-scaled to fit in the range 0-255. This is an helper function simplifying the usage of vl_pgm_insert().