Geografic-Information-System/lib/raster3d/gradient.c

/*!
   \file gradient.c

   \brief Gradient computation

   (C) 2014 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.

   \author Anna Petrasova
 */

/*!
   \brief Gradient computation

   Gradient computation (second order approximation)
   using central differencing scheme (plus forward and backward
   difference of second order approximation). When one or more of the cells,
   from which the gradient for a particular cell is computed, is null,
   gradient for that particular cell is set to 0.
   
   \param array pointer to RASTER3D_Array with input values
   \param step array of x, y, z steps for gradient (resolution values)
   \param[out] grad_x pointer to RASTER3D_Array_double with gradient in x direction
   \param[out] grad_y pointer to RASTER3D_Array_double with gradient in y direction
   \param[out] grad_z pointer to RASTER3D_Array_double with gradient in z direction

 */
#include <grass/raster3d.h>

void Rast3d_gradient_double(RASTER3D_Array_double *array, double *step,
			    RASTER3D_Array_double *grad_x,
			    RASTER3D_Array_double *grad_y,
			    RASTER3D_Array_double *grad_z)
{
    int col, row, depth;
    double val0, val1, val2;

    for (depth = 0; depth < array->sz; depth++) {
	for (row = 0; row < array->sy; row++) {
	    /* row start */
	    val0 = RASTER3D_ARRAY_ACCESS(array, 0, row, depth);
	    val1 = RASTER3D_ARRAY_ACCESS(array, 1, row, depth);
	    val2 = RASTER3D_ARRAY_ACCESS(array, 2, row, depth);
	    if (Rast_is_d_null_value(&val0))
		Rast_set_null_value(&RASTER3D_ARRAY_ACCESS(grad_x, 0, row, depth),
				    1, DCELL_TYPE);
	    else if (Rast_is_d_null_value(&val1) || Rast_is_d_null_value(&val2))
		RASTER3D_ARRAY_ACCESS(grad_x, 0, row, depth) = 0;
	    else
		RASTER3D_ARRAY_ACCESS(grad_x, 0, row, depth) =
			(-3 * val0 + 4 * val1 - val2) / (2 * step[0]);

	    /* row end */
	    val0 = RASTER3D_ARRAY_ACCESS(array, array->sx - 3, row, depth);
	    val1 = RASTER3D_ARRAY_ACCESS(array, array->sx - 2, row, depth);
	    val2 = RASTER3D_ARRAY_ACCESS(array, array->sx - 1, row, depth);
	    if (Rast_is_d_null_value(&val2))
		Rast_set_null_value(
			&RASTER3D_ARRAY_ACCESS(grad_x, array->sx - 1, row, depth),
			1, DCELL_TYPE);
	    else if (Rast_is_d_null_value(&val0) || Rast_is_d_null_value(&val1))
		RASTER3D_ARRAY_ACCESS(grad_x, array->sx - 1, row, depth) = 0;
	    else
		RASTER3D_ARRAY_ACCESS(grad_x, array->sx - 1, row, depth) =
			(3 * val2 - 4 * val1 + val0) / (2 * step[0]);

	    /* row */
	    for (col = 1; col < array->sx - 1; col++) {
		val0 = RASTER3D_ARRAY_ACCESS(array, col - 1, row, depth);
		val1 = RASTER3D_ARRAY_ACCESS(array, col, row, depth);
		val2 = RASTER3D_ARRAY_ACCESS(array, col + 1, row, depth);
		if (Rast_is_d_null_value(&val1))
		    Rast_set_null_value(
			    &RASTER3D_ARRAY_ACCESS(grad_x, col, row, depth),
			    1, DCELL_TYPE);
		else if (Rast_is_d_null_value(&val0) || Rast_is_d_null_value(&val2))
		    RASTER3D_ARRAY_ACCESS(grad_x, col, row, depth) = 0;
		else
		    RASTER3D_ARRAY_ACCESS(grad_x, col, row, depth) =
			    (val2 - val0) / (2 * step[0]);
	    }
	}
    }
    for (depth = 0; depth < array->sz; depth++) {
	for (col = 0; col < array->sx; col++) {
	    /* col start */
	    val0 = RASTER3D_ARRAY_ACCESS(array, col, 0, depth);
	    val1 = RASTER3D_ARRAY_ACCESS(array, col, 1, depth);
	    val2 = RASTER3D_ARRAY_ACCESS(array, col, 2, depth);
	    if (Rast_is_d_null_value(&val0))
		Rast_set_null_value(&RASTER3D_ARRAY_ACCESS(grad_y, col, 0, depth),
				    1, DCELL_TYPE);
	    else if (Rast_is_d_null_value(&val1) || Rast_is_d_null_value(&val2))
		RASTER3D_ARRAY_ACCESS(grad_y, col, 0, depth) = 0;
	    else
		RASTER3D_ARRAY_ACCESS(grad_y, col, 0, depth) =
			-(-3 * val0 + 4 * val1 - val2) / (2 * step[1]);

	    /* col end */
	    val0 = RASTER3D_ARRAY_ACCESS(array, col, array->sy - 3, depth);
	    val1 = RASTER3D_ARRAY_ACCESS(array, col, array->sy - 2, depth);
	    val2 = RASTER3D_ARRAY_ACCESS(array, col, array->sy - 1, depth);
	    if (Rast_is_d_null_value(&val2))
		Rast_set_null_value(
			&RASTER3D_ARRAY_ACCESS(grad_y, col, array->sy - 1, depth),
			1, DCELL_TYPE);
	    else if (Rast_is_d_null_value(&val0) || Rast_is_d_null_value(&val1))
		RASTER3D_ARRAY_ACCESS(grad_y, col, array->sy - 1, depth) = 0;
	    else
		RASTER3D_ARRAY_ACCESS(grad_y, col, array->sy - 1, depth) =
			-(3 * val2 - 4 * val1 + val0) / (2 * step[1]);

	    /* col */
	    for (row = 1; row < array->sy - 1; row++) {
		val0 = RASTER3D_ARRAY_ACCESS(array, col, row - 1, depth);
		val1 = RASTER3D_ARRAY_ACCESS(array, col, row, depth);
		val2 = RASTER3D_ARRAY_ACCESS(array, col, row + 1, depth);
		if (Rast_is_d_null_value(&val1))
		    Rast_set_null_value(
			    &RASTER3D_ARRAY_ACCESS(grad_y, col, row, depth),
			    1, DCELL_TYPE);
		else if (Rast_is_d_null_value(&val0) || Rast_is_d_null_value(&val2))
		    RASTER3D_ARRAY_ACCESS(grad_y, col, row, depth) = 0;
		else
		    RASTER3D_ARRAY_ACCESS(grad_y, col, row, depth) =
			    -(val2 - val0) / (2 * step[1]);
	    }
	}
    }
    for (row = 0; row < array->sy; row++) {
	for (col = 0; col < array->sx; col++) {
	    /* vertical col start */
	    val0 = RASTER3D_ARRAY_ACCESS(array, col, row, 0);
	    val1 = RASTER3D_ARRAY_ACCESS(array, col, row, 1);
	    val2 = RASTER3D_ARRAY_ACCESS(array, col, row, 2);
	    if (Rast_is_d_null_value(&val0))
		Rast_set_null_value(&RASTER3D_ARRAY_ACCESS(grad_z, col, row, 0),
				    1, DCELL_TYPE);
	    else if (Rast_is_d_null_value(&val1) || Rast_is_d_null_value(&val2))
		RASTER3D_ARRAY_ACCESS(grad_z, col, row, 0) = 0;
	    else
		RASTER3D_ARRAY_ACCESS(grad_z, col, row, 0) =
			(-3 * val0 + 4 * val1 - val2) / (2 * step[2]);

	    /* vertical col end */
	    val0 = RASTER3D_ARRAY_ACCESS(array, col, row, array->sz - 3);
	    val1 = RASTER3D_ARRAY_ACCESS(array, col, row, array->sz - 2);
	    val2 = RASTER3D_ARRAY_ACCESS(array, col, row, array->sz - 1);
	    if (Rast_is_d_null_value(&val2))
		Rast_set_null_value(
			&RASTER3D_ARRAY_ACCESS(grad_z, col, row, array->sz - 1),
			1, DCELL_TYPE);
	    else if (Rast_is_d_null_value(&val0) || Rast_is_d_null_value(&val1))
		RASTER3D_ARRAY_ACCESS(grad_z, col, row, array->sz - 1) = 0;
	    else
		RASTER3D_ARRAY_ACCESS(grad_z, col, row, array->sz - 1) =
			(3 * val2 - 4 * val1 + val0) / (2 * step[2]);
	    /* vertical col */
	    for (depth = 1; depth < array->sz - 1; depth++) {
		val0 = RASTER3D_ARRAY_ACCESS(array, col, row, depth - 1);
		val1 = RASTER3D_ARRAY_ACCESS(array, col, row, depth);
		val2 = RASTER3D_ARRAY_ACCESS(array, col, row, depth + 1);
		if (Rast_is_d_null_value(&val1))
		    Rast_set_null_value(
			    &RASTER3D_ARRAY_ACCESS(grad_z, col, row, depth),
			    1, DCELL_TYPE);
		else if (Rast_is_d_null_value(&val0) || Rast_is_d_null_value(&val2))
		    RASTER3D_ARRAY_ACCESS(grad_z, col, row, depth) = 0;
		else
		    RASTER3D_ARRAY_ACCESS(grad_z, col, row, depth) =
			    (val2 - val0) / (2 * step[2]);
	    }
	}
    }
}