OGSF library - loading and manipulating volumes (lower level functions) More...

#include <string.h>
#include <stdlib.h>
#include <grass/gis.h>
#include <grass/ogsf.h>
#include <grass/raster3d.h>
#include <grass/glocale.h>

Include dependency graph for gvl_file.c:

Go to the source code of this file.

Macros
#define	LUCKY 33

#define	MODE_DIRECT 0

#define	MODE_SLICE 1

#define	MODE_FULL 2

#define	MODE_PRELOAD 3

#define	MODE_DEFAULT 0

#define	STATUS_READY 0

#define	STATUS_BUSY 1

Functions
void *	open_g3d_file (const char filename, IFLAG type, double min, double max)
	Open 3d raster file. More...

int	close_g3d_file (void *map)
	Close g3d file. More...

geovol_file *	gvl_file_get_volfile (int id)
	Get geovol_file structure for given handle. More...

int	find_datah (const char *name, IFLAG type, int begin)
	Find file with name and type in geovol_file array an return handle. More...

char *	gvl_file_get_name (int id)
	Get file name for given handle. More...

int	gvl_file_get_file_type (geovol_file *vf)
	Get file type for given handle. More...

int	gvl_file_get_data_type (geovol_file *vf)
	Get data type for given handle. More...

void	gvl_file_get_min_max (geovol_file vf, double min, double *max)
	Get minimum and maximum value in volume file. More...

void *	open_volfile (const char name, IFLAG file_type, IFLAG data_type, double min, double max)
	Open 3d raster file. More...

int	close_volfile (void *map, IFLAG type)
	Close volume file. More...

int	gvl_file_newh (const char *name, IFLAG file_type)
	Get handle for given file name and type. More...

int	free_volfile_buffs (geovol_file *vf)
	Free allocated buffers. More...

int	gvl_file_free_datah (int id)
	Free geovol_file structure for given handle. More...

int	read_g3d_value (IFLAG type, void map, int x, int y, int z, void value)
	Eead value from g3d file. More...

int	read_g3d_slice (IFLAG type, void map, int level, void data)
	Read slice of values at level from g3d file. More...

int	read_g3d_vol (IFLAG type, void map, void data)
	Read all values from g3d file. More...

int	is_null_g3d_value (IFLAG type, void *value)
	Check for null value. More...

int	get_buff_value (IFLAG type, void data, int offset, void value)
	Get value from buffer. More...

int	get_direct_value (geovol_file vf, int x, int y, int z, void value)
	Read value direct from volume file. More...

int	alloc_vol_buff (geovol_file *vf)
	Allocate buffer memory for full mode reading. More...

int	free_vol_buff (geovol_file *vf)
	Free memory buffer memory. More...

int	read_vol (geovol_file *vf)
	Read all values from volume file. More...

int	get_vol_value (geovol_file vf, int x, int y, int z, void value)
	Get value from volume buffer. More...

int	alloc_slice_buff (geovol_file *vf)
	Allocate buffer for slice mode reading. More...

int	free_slice_buff (geovol_file *vf)
	Free buffer for slice mode reading. More...

int	read_slice (geovol_file *vf, int s, int l)
	Read slice of values at level from volume file. More...

void	shift_slices (geovol_file *vf)
	Read new slice into buffer. More...

int	get_slice_value (geovol_file vf, int x, int y, int z, void value)
	Get value from slice buffer. More...

int	gvl_file_start_read (geovol_file *vf)
	Start read - allocate memory buffer a read first data into buffer. More...

int	gvl_file_end_read (geovol_file *vf)
	End read - free buffer memory. More...

int	gvl_file_get_value (geovol_file vf, int x, int y, int z, void value)
	Get value for volume file at x, y, z. More...

int	gvl_file_is_null_value (geovol_file vf, void value)
	Check for null value. More...

int	gvl_file_set_mode (geovol_file *vf, IFLAG mode)
	Set read mode. More...

int	gvl_file_set_slices_param (geovol_file *vf, int n, int b)
	Set parameters for slice reading. More...

Detailed Description

OGSF library - loading and manipulating volumes (lower level functions)

GRASS OpenGL gsurf OGSF Library

This program is free software under the GNU General Public License (>=v2). Read the file COPYING that comes with GRASS for details.

Author: Tomas Paudits (February 2004); Doxygenized by Martin Landa <landa.martin gmail.com> (May 2008)

Definition in file gvl_file.c.

Macro Definition Documentation

◆ LUCKY

#define LUCKY 33

Definition at line 27 of file gvl_file.c.

◆ MODE_DEFAULT

#define MODE_DEFAULT 0

Definition at line 34 of file gvl_file.c.

◆ MODE_DIRECT

#define MODE_DIRECT 0

Definition at line 29 of file gvl_file.c.

Referenced by gvl_file_get_value().

◆ MODE_FULL

#define MODE_FULL 2

Definition at line 31 of file gvl_file.c.

Referenced by gvl_file_end_read(), gvl_file_get_value(), and gvl_file_start_read().

◆ MODE_PRELOAD

#define MODE_PRELOAD 3

Definition at line 32 of file gvl_file.c.

Referenced by free_volfile_buffs(), and gvl_file_get_value().

◆ MODE_SLICE

#define MODE_SLICE 1

Definition at line 30 of file gvl_file.c.

Referenced by free_volfile_buffs(), gvl_file_end_read(), gvl_file_get_value(), gvl_file_set_slices_param(), and gvl_file_start_read().

◆ STATUS_BUSY

#define STATUS_BUSY 1

Definition at line 37 of file gvl_file.c.

Referenced by gvl_file_get_value(), gvl_file_set_slices_param(), and gvl_file_start_read().

◆ STATUS_READY

#define STATUS_READY 0

Definition at line 36 of file gvl_file.c.

Referenced by gvl_file_end_read().

Function Documentation

◆ alloc_slice_buff()

int alloc_slice_buff ( geovol_file * vf )

Allocate buffer for slice mode reading.

Parameters

vf	pointer to geovol_file struct

Returns: -1 on failure; 1 on success

Definition at line 811 of file gvl_file.c.

References geovol_file::buff, Cols, geovol_file::data_type, G_malloc, NULL, Rows, VOL_DTYPE_DOUBLE, and VOL_DTYPE_FLOAT.

Referenced by gvl_file_start_read().

◆ alloc_vol_buff()

int alloc_vol_buff ( geovol_file * vf )

Allocate buffer memory for full mode reading.

Parameters

vf	pointer to geovol_file

Returns: -1 on failure; 1 on success

Definition at line 717 of file gvl_file.c.

References geovol_file::buff, Cols, geovol_file::data_type, Depths, G_malloc, NULL, Rows, VOL_DTYPE_DOUBLE, and VOL_DTYPE_FLOAT.

Referenced by gvl_file_start_read().

◆ close_g3d_file()

int close_g3d_file ( void * map )

Close g3d file.

Parameters

map	3d raster map

Returns: -1 on failure; 1 on success

Definition at line 466 of file gvl_file.c.

References _, G_warning(), and Rast3d_close().

◆ close_volfile()

int close_volfile	(	void *	map,
		IFLAG	type
	)

Close volume file.

Parameters

map	volume filename
type	file type

Returns: -1 on failure

Definition at line 251 of file gvl_file.c.

◆ find_datah()

int find_datah	(	const char *	name,
		IFLAG	type,
		int	begin
	)

Find file with name and type in geovol_file array an return handle.

Parameters

name	file name
begin
data	id
-1	not found

Definition at line 139 of file gvl_file.c.

◆ free_slice_buff()

int free_slice_buff ( geovol_file * vf )

Free buffer for slice mode reading.

Parameters

vf	pointer to geovol_file struct

Returns: 1

Definition at line 850 of file gvl_file.c.

References geovol_file::buff, and G_free().

Referenced by gvl_file_end_read().

◆ free_vol_buff()

int free_vol_buff ( geovol_file * vf )

Free memory buffer memory.

Parameters

vf	pointer to geovol_file struct

Returns: 1

Definition at line 750 of file gvl_file.c.

References geovol_file::buff, and G_free().

Referenced by gvl_file_end_read().

◆ free_volfile_buffs()

int free_volfile_buffs ( geovol_file * vf )

Free allocated buffers.

Parameters

vf	pointer to geovol_file struct

Returns: 1

Definition at line 342 of file gvl_file.c.

References geovol_file::buff, G_free(), geovol_file::mode, MODE_PRELOAD, MODE_SLICE, and NULL.

◆ get_buff_value()

int get_buff_value	(	IFLAG	type,
		void *	data,
		int	offset,
		void *	value
	)

Get value from buffer.

Parameters

type	data type
data	data buffer
offset
value

Returns: -1 on failure (unsupported data type); 1 on success

Definition at line 652 of file gvl_file.c.

Referenced by get_slice_value(), and get_vol_value().

◆ get_direct_value()

int get_direct_value	(	geovol_file *	vf,
		int	x,
		int	y,
		int	z,
		void *	value
	)

Read value direct from volume file.

Parameters

	vf	pointer to geovol_file struct
	x,y,z	real point
[out]	value	data value

Returns: -1 on failure; 1 on success

Definition at line 688 of file gvl_file.c.

References geovol_file::data_type, geovol_file::file_type, geovol_file::map, read_g3d_value(), and VOL_FTYPE_RASTER3D.

Referenced by gvl_file_get_value().

◆ get_slice_value()

int get_slice_value	(	geovol_file *	vf,
		int	x,
		int	y,
		int	z,
		void *	value
	)

Get value from slice buffer.

Parameters

	vf	pointer to geovol_file struct
	x,y,z	real point
[out]	value	data value

Returns: -1 on failure; 1 on success

Definition at line 927 of file gvl_file.c.

References geovol_file::buff, Cols, geovol_file::data_type, get_buff_value(), if(), and shift_slices().

Referenced by gvl_file_get_value().

◆ get_vol_value()

int get_vol_value	(	geovol_file *	vf,
		int	x,
		int	y,
		int	z,
		void *	value
	)

Get value from volume buffer.

Parameters

	vf	pointer to geovol_file struct
	x,y,z	real point
[out]	value	data value

Returns: 1

Definition at line 790 of file gvl_file.c.

References geovol_file::buff, Cols, geovol_file::data_type, get_buff_value(), and Rows.

Referenced by gvl_file_get_value().

◆ gvl_file_end_read()

int gvl_file_end_read ( geovol_file * vf )

End read - free buffer memory.

Parameters

vf	pointer to geovol_file struct

Returns: -1 on failure; 1 on success

Definition at line 1018 of file gvl_file.c.

References free_slice_buff(), free_vol_buff(), geovol_file::mode, MODE_FULL, MODE_SLICE, geovol_file::status, and STATUS_READY.

◆ gvl_file_free_datah()

int gvl_file_free_datah ( int id )

Free geovol_file structure for given handle.

Parameters

id

Returns

Definition at line 364 of file gvl_file.c.

References G_debug().

Referenced by gvl_free_volmem().

◆ gvl_file_get_data_type()

int gvl_file_get_data_type ( geovol_file * vf )

Get data type for given handle.

Parameters

vf	pointer to geovol_file struct

Returns: data type

Definition at line 202 of file gvl_file.c.

References geovol_file::data_type.

◆ gvl_file_get_file_type()

int gvl_file_get_file_type ( geovol_file * vf )

Get file type for given handle.

Parameters

vf	pointer to geovol_file struct

Returns: file type

Definition at line 190 of file gvl_file.c.

References geovol_file::file_type.

◆ gvl_file_get_min_max()

void gvl_file_get_min_max	(	geovol_file *	vf,
		double *	min,
		double *	max
	)

Get minimum and maximum value in volume file.

Parameters

	vf	pointer to geovol_file struct
[out]	min	min value
[out]	max	max value

Definition at line 214 of file gvl_file.c.

References geovol_file::max, and geovol_file::min.

Referenced by iso_get_range().

◆ gvl_file_get_name()

char* gvl_file_get_name ( int id )

Get file name for given handle.

Parameters

id handle id

Returns: file name; NULL on failure

Definition at line 165 of file gvl_file.c.

References GPATH_MAX.

◆ gvl_file_get_value()

int gvl_file_get_value	(	geovol_file *	vf,
		int	x,
		int	y,
		int	z,
		void *	value
	)

Get value for volume file at x, y, z.

Parameters

vf	pointer to geovol_file struct

Returns: -1 on failure; 1 on success

Definition at line 1050 of file gvl_file.c.

References get_direct_value(), get_slice_value(), get_vol_value(), geovol_file::mode, MODE_DIRECT, MODE_FULL, MODE_PRELOAD, MODE_SLICE, geovol_file::status, and STATUS_BUSY.

◆ gvl_file_get_volfile()

geovol_file* gvl_file_get_volfile ( int id )

Get geovol_file structure for given handle.

Parameters

id

Returns: pointer to geovol_file struct; NULL on failure

Definition at line 117 of file gvl_file.c.

Referenced by iso_get_range().

◆ gvl_file_is_null_value()

int gvl_file_is_null_value	(	geovol_file *	vf,
		void *	value
	)

Check for null value.

Parameters

vf	pointer to geovol_file struct
value	data value

Returns: -1 on failure; 1 on success

Definition at line 1087 of file gvl_file.c.

References geovol_file::file_type, is_null_g3d_value(), and VOL_FTYPE_RASTER3D.

◆ gvl_file_newh()

int gvl_file_newh	(	const char *	name,
		IFLAG	file_type
	)

Get handle for given file name and type.

Parameters

name	volume filename
file_type	file type

Returns: data id; -1 on failure

Definition at line 269 of file gvl_file.c.

◆ gvl_file_set_mode()

int gvl_file_set_mode	(	geovol_file *	vf,
		IFLAG	mode
	)

Set read mode.

Parameters

vf	pointer to geovol_file struct
mode	read mode

Returns: -1 on failure; 1 on success

Definition at line 1116 of file gvl_file.c.

◆ gvl_file_set_slices_param()

int gvl_file_set_slices_param	(	geovol_file *	vf,
		int	n,
		int	b
	)

Set parameters for slice reading.

Parameters

vf	pointer to geovol_file struct
n
b

Returns: -1 on failure; 1 on success

Definition at line 1166 of file gvl_file.c.

References geovol_file::buff, geovol_file::mode, MODE_SLICE, return(), geovol_file::status, and STATUS_BUSY.

◆ gvl_file_start_read()

int gvl_file_start_read ( geovol_file * vf )

Start read - allocate memory buffer a read first data into buffer.

Parameters

vf	pointer to geovol_file struct

Returns: -1 on failure; 1 on success

Definition at line 967 of file gvl_file.c.

References alloc_slice_buff(), alloc_vol_buff(), geovol_file::buff, geovol_file::mode, MODE_FULL, MODE_SLICE, read_slice(), read_vol(), geovol_file::status, and STATUS_BUSY.

◆ is_null_g3d_value()

int is_null_g3d_value	(	IFLAG	type,
		void *	value
	)

Check for null value.

Parameters

type	data type
value

Returns: 1 if value is null; 0 if value is not null; -1 on failure (unsupported data type

Definition at line 615 of file gvl_file.c.

Referenced by gvl_file_is_null_value().

◆ open_g3d_file()

void * open_g3d_file	(	const char *	filename,
		IFLAG *	type,
		double *	min,
		double *	max
	)

Open 3d raster file.

Parameters

	filename	file name
	type	data type
[out]	min	min value
[out]	max	max value

Returns: pointer to data

Definition at line 417 of file gvl_file.c.

Referenced by open_volfile().

◆ open_volfile()

void* open_volfile	(	const char *	name,
		IFLAG	file_type,
		IFLAG *	data_type,
		double *	min,
		double *	max
	)

Open 3d raster file.

Parameters

	name	file name
	file_type	file type
	data_type	data type
[out]	min	min value
[out]	max	max value

Returns: pointer to file; NULL on failure

Definition at line 232 of file gvl_file.c.

References NULL, open_g3d_file(), and VOL_FTYPE_RASTER3D.

◆ read_g3d_slice()

int read_g3d_slice	(	IFLAG	type,
		void *	map,
		int	level,
		void *	data
	)

Read slice of values at level from g3d file.

Parameters

	type	data type
	map	3D raster map
	level
[out]	data

Returns: -1 on failure; 0 on success

Definition at line 521 of file gvl_file.c.

◆ read_g3d_value()

int read_g3d_value	(	IFLAG	type,
		void *	map,
		int	x,
		int	y,
		int	z,
		void *	value
	)

Eead value from g3d file.

Parameters

	type	data type
	map	3D raster map
	x,y,z	real coordinates
[out]	value	data value

Returns: -1 on failure; 1 on success

Definition at line 489 of file gvl_file.c.

Referenced by get_direct_value().

◆ read_g3d_vol()

int read_g3d_vol	(	IFLAG	type,
		void *	map,
		void *	data
	)

Read all values from g3d file.

Parameters

	type	data type
	map	3D raster map
[out]	data	data buffer

Returns: -1 on failure; 1 on success

Definition at line 566 of file gvl_file.c.

Referenced by read_vol().

◆ read_slice()

int read_slice	(	geovol_file *	vf,
		int	s,
		int	l
	)

Read slice of values at level from volume file.

Parameters

vf	pointer to geovol_file struct
s
l

Returns: -1 on failure; 1 on success

Definition at line 872 of file gvl_file.c.

Referenced by gvl_file_start_read().

◆ read_vol()

int read_vol ( geovol_file * vf )

Read all values from volume file.

Parameters

vf	pointer to geovol_file struct

Returns: -1 on failure; 1 on success

Definition at line 765 of file gvl_file.c.

References geovol_file::buff, geovol_file::data_type, geovol_file::file_type, geovol_file::map, read_g3d_vol(), and VOL_FTYPE_RASTER3D.

Referenced by gvl_file_start_read().

◆ shift_slices()

void shift_slices ( geovol_file * vf )

Read new slice into buffer.

Parameters

vf	pointer to geovol_file struct

Definition at line 896 of file gvl_file.c.

Referenced by get_slice_value().

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ LUCKY

◆ MODE_DEFAULT

◆ MODE_DIRECT

◆ MODE_FULL

◆ MODE_PRELOAD

◆ MODE_SLICE

◆ STATUS_BUSY

◆ STATUS_READY

Function Documentation

◆ alloc_slice_buff()

◆ alloc_vol_buff()

◆ close_g3d_file()

◆ close_volfile()

◆ find_datah()

◆ free_slice_buff()

◆ free_vol_buff()

◆ free_volfile_buffs()

◆ get_buff_value()

◆ get_direct_value()

◆ get_slice_value()

◆ get_vol_value()

◆ gvl_file_end_read()

◆ gvl_file_free_datah()

◆ gvl_file_get_data_type()

◆ gvl_file_get_file_type()

◆ gvl_file_get_min_max()

◆ gvl_file_get_name()

◆ gvl_file_get_value()

◆ gvl_file_get_volfile()

◆ gvl_file_is_null_value()

◆ gvl_file_newh()

◆ gvl_file_set_mode()

◆ gvl_file_set_slices_param()

◆ gvl_file_start_read()

◆ is_null_g3d_value()

◆ open_g3d_file()

◆ open_volfile()

◆ read_g3d_slice()

◆ read_g3d_value()

◆ read_g3d_vol()

◆ read_slice()

◆ read_vol()

◆ shift_slices()