Loading...
Searching...
No Matches
n_arrays_io.c
Go to the documentation of this file.
/*****************************************************************************
*
* MODULE: Grass PDE Numerical Library
* AUTHOR(S): Soeren Gebbert, Berlin (GER) Dec 2006
* soerengebbert <at> gmx <dot> de
*
* PURPOSE: IO array management functions
* part of the gpde library
*
* COPYRIGHT: (C) 2000 by the GRASS Development Team
*
* This program is free software under the GNU General Public
* License (>=v2). Read the file COPYING that comes with GRASS
* for details.
*
*****************************************************************************/
#include <math.h>
#include <grass/N_pde.h>
#include <grass/raster.h>
#include <grass/glocale.h>
/* ******************** 2D ARRAY FUNCTIONS *********************** */
/*!
* \brief Read a raster map into a N_array_2d structure
*
* The raster map will be opened in the current region settings.
* If no N_array_2d structure is provided (NULL pointer), a new structure will
* be allocated with the same data type as the raster map and the size of the
* current region. The array offset will be set to 0. <br><br> If a N_array_2d
* structure is provided, the values from the raster map are casted to the
* N_array_2d type. The array must have the same size as the current region.
* <br><br>
* The new created or the provided array are returned.
* If the reading of the raster map fails, G_fatal_error() will
* be invoked.
*
* \param name * char - the name of an existing raster map
* \param array * N_array_2d - an existing array or NULL
* \return N_array_2d * - the existing or new allocated array
* */
N_array_2d *N_read_rast_to_array_2d(char *name, N_array_2d *array)
{
int map; /*The rastermap */
int x, y, cols, rows, type;
void *rast;
void *ptr;
struct Cell_head region;
N_array_2d *data = array;
/* Get the active region */
G_get_set_window(&region);
/*set the rows and cols */
rows = region.rows;
cols = region.cols;
/*open the raster map */
map = Rast_open_old(name, "");
type = Rast_get_map_type(map);
/*if the array is NULL create a new one with the data type of the raster map
*/
/*the offset is 0 by default */
if (data == NULL) {
if (type == DCELL_TYPE) {
data = N_alloc_array_2d(cols, rows, 0, DCELL_TYPE);
}
if (type == FCELL_TYPE) {
data = N_alloc_array_2d(cols, rows, 0, FCELL_TYPE);
}
if (type == CELL_TYPE) {
data = N_alloc_array_2d(cols, rows, 0, CELL_TYPE);
}
}
else {
/*Check the array sizes */
if (data->cols != cols)
G_fatal_error("N_read_rast_to_array_2d: the data array size is "
"different from the current region settings");
if (data->rows != rows)
G_fatal_error("N_read_rast_to_array_2d: the data array size is "
"different from the current region settings");
}
rast = Rast_allocate_buf(type);
G_message(_("Reading raster map <%s> into memory"), name);
for (y = 0; y < rows; y++) {
G_percent(y, rows - 1, 10);
Rast_get_row(map, rast, y, type);
for (x = 0, ptr = rast; x < cols;
x++, ptr = G_incr_void_ptr(ptr, Rast_cell_size(type))) {
if (type == CELL_TYPE) {
if (Rast_is_c_null_value(ptr)) {
N_put_array_2d_value_null(data, x, y);
}
else {
if (data->type == CELL_TYPE)
N_put_array_2d_c_value(data, x, y,
(CELL) * (CELL *)ptr);
if (data->type == FCELL_TYPE)
N_put_array_2d_f_value(data, x, y,
(FCELL) * (CELL *)ptr);
if (data->type == DCELL_TYPE)
N_put_array_2d_d_value(data, x, y,
(DCELL) * (CELL *)ptr);
}
}
if (type == FCELL_TYPE) {
if (Rast_is_f_null_value(ptr)) {
N_put_array_2d_value_null(data, x, y);
}
else {
if (data->type == CELL_TYPE)
N_put_array_2d_c_value(data, x, y,
(CELL) * (FCELL *)ptr);
if (data->type == FCELL_TYPE)
N_put_array_2d_f_value(data, x, y,
(FCELL) * (FCELL *)ptr);
if (data->type == DCELL_TYPE)
N_put_array_2d_d_value(data, x, y,
(DCELL) * (FCELL *)ptr);
}
}
if (type == DCELL_TYPE) {
if (Rast_is_d_null_value(ptr)) {
N_put_array_2d_value_null(data, x, y);
}
else {
if (data->type == CELL_TYPE)
N_put_array_2d_c_value(data, x, y,
(CELL) * (DCELL *)ptr);
if (data->type == FCELL_TYPE)
N_put_array_2d_f_value(data, x, y,
(FCELL) * (DCELL *)ptr);
if (data->type == DCELL_TYPE)
N_put_array_2d_d_value(data, x, y,
(DCELL) * (DCELL *)ptr);
}
}
}
}
/* Close file */
Rast_close(map);
G_free(rast);
return data;
}
/*!
* \brief Write a N_array_2d struct to a raster map
*
* A new raster map is created with the same type as the N_array_2d.
* The current region is used to open the raster map.
* The N_array_2d must have the same size as the current region.
If the writing of the raster map fails, G_fatal_error() will
* be invoked.
* \param array N_array_2d *
* \param name char * - the name of the raster map
* \return void
*
* */
void N_write_array_2d_to_rast(N_array_2d *array, char *name)
{
int map; /*The rastermap */
int x, y, cols, rows, type;
CELL *rast = NULL;
FCELL *frast = NULL;
DCELL *drast = NULL;
struct Cell_head region;
if (!array)
G_fatal_error(_("N_array_2d * array is empty"));
/* Get the current region */
G_get_set_window(&region);
rows = region.rows;
cols = region.cols;
type = array->type;
/*Open the new map */
map = Rast_open_new(name, type);
if (type == CELL_TYPE)
rast = Rast_allocate_buf(type);
if (type == FCELL_TYPE)
frast = Rast_allocate_buf(type);
if (type == DCELL_TYPE)
drast = Rast_allocate_buf(type);
G_message(_("Write 2d array to raster map <%s>"), name);
for (y = 0; y < rows; y++) {
G_percent(y, rows - 1, 10);
for (x = 0; x < cols; x++) {
if (type == CELL_TYPE)
rast[x] = N_get_array_2d_c_value(array, x, y);
if (type == FCELL_TYPE)
frast[x] = N_get_array_2d_f_value(array, x, y);
if (type == DCELL_TYPE)
drast[x] = N_get_array_2d_d_value(array, x, y);
}
if (type == CELL_TYPE)
Rast_put_c_row(map, rast);
if (type == FCELL_TYPE)
Rast_put_f_row(map, frast);
if (type == DCELL_TYPE)
Rast_put_d_row(map, drast);
}
/* Close file */
Rast_close(map);
G_free(rast);
G_free(frast);
G_free(drast);
}
/* ******************** 3D ARRAY FUNCTIONS *********************** */
/*!
* \brief Read a volume map into a N_array_3d structure
*
* The volume map is opened in the current region settings.
* If no N_array_3d structure is provided (NULL pointer), a new structure will
* be allocated with the same data type as the volume map and the size of the
* current region. The array offset will be set to 0. <br><br>
*
* If a N_array_3d structure is provided, the values from the volume map are
* casted to the N_array_3d type. The array must have the same size
* as the current region.
* <br><br>
*
* The new created or the provided array is returned.
* If the reading of the volume map fails, Rast3d_fatal_error() will
* be invoked.
*
* \param name * char - the name of an existing volume map
* \param array * N_array_3d - an existing array or NULL
* \param mask int - 0 = false, 1 = true : if a mask is presenent, use it with
* the input volume map \return N_array_3d * - the existing or new allocated
* array
* */
N_array_3d *N_read_rast3d_to_array_3d(char *name, N_array_3d *array, int mask)
{
void *map = NULL; /*The 3D Rastermap */
int changemask = 0;
int x, y, z, cols, rows, depths, type;
double d1 = 0, f1 = 0;
N_array_3d *data = array;
RASTER3D_Region region;
/*get the current region */
Rast3d_get_window(&region);
cols = region.cols;
rows = region.rows;
depths = region.depths;
if (NULL == G_find_raster3d(name, ""))
Rast3d_fatal_error(_("3D raster map <%s> not found"), name);
/*Open all maps with default region */
map = Rast3d_open_cell_old(
name, G_find_raster3d(name, ""), RASTER3D_DEFAULT_WINDOW,
RASTER3D_TILE_SAME_AS_FILE, RASTER3D_USE_CACHE_DEFAULT);
if (map == NULL)
Rast3d_fatal_error(_("Unable to open 3D raster map <%s>"), name);
type = Rast3d_tile_type_map(map);
/*if the array is NULL create a new one with the data type of the volume map
*/
/*the offset is 0 by default */
if (data == NULL) {
if (type == FCELL_TYPE) {
data = N_alloc_array_3d(cols, rows, depths, 0, FCELL_TYPE);
}
if (type == DCELL_TYPE) {
data = N_alloc_array_3d(cols, rows, depths, 0, DCELL_TYPE);
}
}
else {
/*Check the array sizes */
if (data->cols != cols)
G_fatal_error("N_read_rast_to_array_3d: the data array size is "
"different from the current region settings");
if (data->rows != rows)
G_fatal_error("N_read_rast_to_array_3d: the data array size is "
"different from the current region settings");
if (data->depths != depths)
G_fatal_error("N_read_rast_to_array_3d: the data array size is "
"different from the current region settings");
}
G_message(_("Read g3d map <%s> into the memory"), name);
/*if requested set the Mask on */
if (mask) {
if (Rast3d_mask_file_exists()) {
changemask = 0;
if (Rast3d_mask_is_off(map)) {
Rast3d_mask_on(map);
changemask = 1;
}
}
}
for (z = 0; z < depths; z++) { /*From the bottom to the top */
G_percent(z, depths - 1, 10);
for (y = 0; y < rows; y++) {
for (x = 0; x < cols; x++) {
if (type == FCELL_TYPE) {
Rast3d_get_value(map, x, y, z, &f1, type);
if (Rast_is_f_null_value((void *)&f1)) {
N_put_array_3d_value_null(data, x, y, z);
}
else {
if (data->type == FCELL_TYPE)
N_put_array_3d_f_value(data, x, y, z, f1);
if (data->type == DCELL_TYPE)
N_put_array_3d_d_value(data, x, y, z, (double)f1);
}
}
else {
Rast3d_get_value(map, x, y, z, &d1, type);
if (Rast_is_d_null_value((void *)&d1)) {
N_put_array_3d_value_null(data, x, y, z);
}
else {
if (data->type == FCELL_TYPE)
N_put_array_3d_f_value(data, x, y, z, (float)d1);
if (data->type == DCELL_TYPE)
N_put_array_3d_d_value(data, x, y, z, d1);
}
}
}
}
}
/*We set the Mask off, if it was off before */
if (mask) {
if (Rast3d_mask_file_exists())
if (Rast3d_mask_is_on(map) && changemask)
Rast3d_mask_off(map);
}
/* Close files and exit */
if (!Rast3d_close(map))
Rast3d_fatal_error(_("Error closing g3d file <%s>"), name);
return data;
}
/*!
* \brief Write a N_array_3d struct to a volume map
*
* A new volume map is created with the same type as the N_array_3d.
* The current region is used to open the volume map.
* The N_array_3d must have the same size as the current region.
* If the writing of the volume map fails, Rast3d_fatal_error() will
* be invoked.
*
*
* \param array N_array_3d *
* \param name char * - the name of the volume map
* \param mask int - 1 = use a 3d mask, 0 do not use a 3d mask
* \return void
*
* */
void N_write_array_3d_to_rast3d(N_array_3d *array, char *name, int mask)
{
void *map = NULL; /*The 3D Rastermap */
int changemask = 0;
int x, y, z, cols, rows, depths, type;
double d1 = 0.0, f1 = 0.0;
N_array_3d *data = array;
RASTER3D_Region region;
/*get the current region */
Rast3d_get_window(&region);
cols = region.cols;
rows = region.rows;
depths = region.depths;
type = data->type;
/*Check the array sizes */
if (data->cols != cols)
G_fatal_error("N_write_array_3d_to_rast3d: the data array size is "
"different from the current region settings");
if (data->rows != rows)
G_fatal_error("N_write_array_3d_to_rast3d: the data array size is "
"different from the current region settings");
if (data->depths != depths)
G_fatal_error("N_write_array_3d_to_rast3d: the data array size is "
"different from the current region settings");
/*Open the new map */
if (type == DCELL_TYPE)
map = Rast3d_open_new_opt_tile_size(name, RASTER3D_USE_CACHE_XY,
&region, DCELL_TYPE, 32);
else if (type == FCELL_TYPE)
map = Rast3d_open_new_opt_tile_size(name, RASTER3D_USE_CACHE_XY,
&region, FCELL_TYPE, 32);
if (map == NULL)
Rast3d_fatal_error(_("Error opening g3d map <%s>"), name);
G_message(_("Write 3d array to g3d map <%s>"), name);
/*if requested set the Mask on */
if (mask) {
if (Rast3d_mask_file_exists()) {
changemask = 0;
if (Rast3d_mask_is_off(map)) {
Rast3d_mask_on(map);
changemask = 1;
}
}
}
for (z = 0; z < depths; z++) { /*From the bottom to the top */
G_percent(z, depths - 1, 10);
for (y = 0; y < rows; y++) {
for (x = 0; x < cols; x++) {
if (type == FCELL_TYPE) {
f1 = N_get_array_3d_f_value(data, x, y, z);
Rast3d_put_float(map, x, y, z, f1);
}
else if (type == DCELL_TYPE) {
d1 = N_get_array_3d_d_value(data, x, y, z);
Rast3d_put_double(map, x, y, z, d1);
}
}
}
}
/*We set the Mask off, if it was off before */
if (mask) {
if (Rast3d_mask_file_exists())
if (Rast3d_mask_is_on(map) && changemask)
Rast3d_mask_off(map);
}
/* Flush all tile */
if (!Rast3d_flush_all_tiles(map))
Rast3d_fatal_error("Error flushing tiles with Rast3d_flush_all_tiles");
/* Close files and exit */
if (!Rast3d_close(map))
Rast3d_fatal_error(_("Error closing g3d file <%s>"), name);
return;
}
G_incr_void_ptr
void * G_incr_void_ptr(const void *ptr, size_t size)
Advance void pointer.
Definition alloc.c:184
G_free
void G_free(void *buf)
Free allocated memory.
Definition alloc.c:147
NULL
#define NULL
Definition ccmath.h:32
G_find_raster3d
const char * G_find_raster3d(const char *name, const char *mapset)
Definition find_rast3d.c:28
G_fatal_error
void G_fatal_error(const char *msg,...)
Print a fatal error message to stderr.
Definition gis/error.c:159
G_message
void G_message(const char *msg,...)
Print a message to stderr.
Definition gis/error.c:89
G_get_set_window
void G_get_set_window(struct Cell_head *window)
Get the current working window (region).
Definition gis/set_window.c:35
N_get_array_2d_f_value
FCELL N_get_array_2d_f_value(N_array_2d *data, int col, int row)
Returns the value of type FCELL at position col, row.
Definition n_arrays.c:347
N_put_array_3d_value_null
void N_put_array_3d_value_null(N_array_3d *data, int col, int row, int depth)
This function writes a null value to the N_array_3d data at position col, row, depth.
Definition n_arrays.c:1060
N_alloc_array_3d
N_array_3d * N_alloc_array_3d(int cols, int rows, int depths, int offset, int type)
Allocate memory for a N_array_3d data structure.
Definition n_arrays.c:719
N_get_array_2d_c_value
CELL N_get_array_2d_c_value(N_array_2d *data, int col, int row)
Returns the value of type CELL at position col, row.
Definition n_arrays.c:314
N_put_array_2d_f_value
void N_put_array_2d_f_value(N_array_2d *data, int col, int row, FCELL value)
Writes a FCELL value to the N_array_2d struct at position col, row.
Definition n_arrays.c:546
N_get_array_3d_f_value
float N_get_array_3d_f_value(N_array_3d *data, int col, int row, int depth)
This function returns the value of type float at position col, row, depth.
Definition n_arrays.c:948
N_put_array_3d_f_value
void N_put_array_3d_f_value(N_array_3d *data, int col, int row, int depth, float value)
This function writes a float value to the N_array_3d data at position col, row, depth.
Definition n_arrays.c:1121
N_get_array_2d_d_value
DCELL N_get_array_2d_d_value(N_array_2d *data, int col, int row)
Returns the value of type DCELL at position col, row.
Definition n_arrays.c:380
N_put_array_3d_d_value
void N_put_array_3d_d_value(N_array_3d *data, int col, int row, int depth, double value)
Writes a double value to the N_array_3d struct at position col, row, depth.
Definition n_arrays.c:1148
N_alloc_array_2d
N_array_2d * N_alloc_array_2d(int cols, int rows, int offset, int type)
Allocate memory for a N_array_2d data structure.
Definition n_arrays.c:75
N_get_array_3d_d_value
double N_get_array_3d_d_value(N_array_3d *data, int col, int row, int depth)
This function returns the value of type float at position col, row, depth.
Definition n_arrays.c:979
N_put_array_2d_value_null
void N_put_array_2d_value_null(N_array_2d *data, int col, int row)
Writes the null value to the N_array_2d struct at position col, row.
Definition n_arrays.c:459
N_put_array_2d_c_value
void N_put_array_2d_c_value(N_array_2d *data, int col, int row, CELL value)
Writes a CELL value to the N_array_2d struct at position col, row.
Definition n_arrays.c:516
N_put_array_2d_d_value
void N_put_array_2d_d_value(N_array_2d *data, int col, int row, DCELL value)
Writes a DCELL value to the N_array_2d struct at position col, row.
Definition n_arrays.c:576
N_write_array_3d_to_rast3d
void N_write_array_3d_to_rast3d(N_array_3d *array, char *name, int mask)
Write a N_array_3d struct to a volume map.
Definition n_arrays_io.c:381
N_read_rast_to_array_2d
N_array_2d * N_read_rast_to_array_2d(char *name, N_array_2d *array)
Read a raster map into a N_array_2d structure.
Definition n_arrays_io.c:44
N_read_rast3d_to_array_3d
N_array_3d * N_read_rast3d_to_array_3d(char *name, N_array_3d *array, int mask)
Read a volume map into a N_array_3d structure.
Definition n_arrays_io.c:253
N_write_array_2d_to_rast
void N_write_array_2d_to_rast(N_array_2d *array, char *name)
Write a N_array_2d struct to a raster map.
Definition n_arrays_io.c:172
name
const char * name
Definition named_colr.c:6
G_percent
void G_percent(long n, long d, int s)
Print percent complete messages.
Definition percent.c:61
N_array_2d
Definition N_pde.h:132
N_array_2d::type
int type
Definition N_pde.h:133
N_array_3d
Definition N_pde.h:175
x
#define x