color_get.c

Go to the documentation of this file.

/*!
 * \file lib/raster/color_get.c
 *
 * \brief Raster Library - Get colors from a raster map.
 *
 * SPDX-FileCopyrightText: 2001-2009 GRASS Development Team
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * \author Original author CERL
 */
 
#include <grass/gis.h>
#include <grass/raster.h>
 
/*!
 * \brief Gets color from raster map
 *
 * Looks up the rgb colors for <i>rast</i> in the color table
 * <i>colors</i>.
 *
 * The <i>red, green</i>, and <i>blue</i> intensities for the color
 * associated with category <i>n</i> are extracted from the
 * <i>colors</i> structure. The intensities will be in the range 0 -
 * 255. Also works for null cells.
 *
 * \param rast raster cell value
 * \param[out] red red value
 * \param[out] grn green value
 * \param[out] blu blue value
 * \param colors pointer to Colors structure which holds color info
 * \param map_type map type (CELL, FCELL, DCELL)
 *
 * \return 1 if color is set
 * \return 0 if color is not set
 */
int Rast_get_color(const void *rast, int *red, int *grn, int *blu,
                   struct Colors *colors, RASTER_MAP_TYPE map_type)
{
    unsigned char r, g, b, set;
 
    Rast_lookup_colors(rast, &r, &g, &b, &set, 1, colors, map_type);
 
    *red = (int)r;
    *grn = (int)g;
    *blu = (int)b;
 
    return (int)set;
}
 
/*!
 * \brief Gets color from raster map (CELL)
 *
 * Looks up the rgb colors for <i>rast</i> in the color table
 * <i>colors</i>.
 *
 * \param rast raster cell value
 * \param[out] red red value
 * \param[out] grn green value
 * \param[out] blu blue value
 * \param colors pointer to Colors structure which holds color info
 *
 * \return 1 if color is set
 * \return 0 if color is not set
 */
int Rast_get_c_color(const CELL *rast, int *red, int *grn, int *blu,
                     struct Colors *colors)
{
    return Rast_get_color(rast, red, grn, blu, colors, CELL_TYPE);
}
 
/*!
 * \brief Gets color from raster map (FCELL)
 *
 * Looks up the rgb colors for <i>rast</i> in the color table
 * <i>colors</i>.
 *
 * \param rast raster cell value
 * \param[out] red red value
 * \param[out] grn green value
 * \param[out] blu blue value
 * \param colors pointer to Colors structure which holds color info
 *
 * \return 1 if color is set
 * \return 0 if color is not set
 */
int Rast_get_f_color(const FCELL *rast, int *red, int *grn, int *blu,
                     struct Colors *colors)
{
    return Rast_get_color(rast, red, grn, blu, colors, FCELL_TYPE);
}
 
/*!
 * \brief Gets color from raster map (DCELL)
 *
 * Looks up the rgb colors for <i>rast</i> in the color table
 * <i>colors</i>.
 *
 * \param rast raster cell value
 * \param[out] red red value
 * \param[out] grn green value
 * \param[out] blu blue value
 * \param colors pointer to Colors structure which holds color info
 *
 * \return 1 if color is set
 * \return 0 if color is not set
 */
int Rast_get_d_color(const DCELL *rast, int *red, int *grn, int *blu,
                     struct Colors *colors)
{
    return Rast_get_color(rast, red, grn, blu, colors, DCELL_TYPE);
}
 
/*!
 * \brief Gets color for null value.
 *
 * Puts the red, green, and blue components of <i>colors</i> for the
 * NULL-value into <i>red, grn, and blu</i>.
 *
 * \param[out] red red value
 * \param[out] grn green value
 * \param[out] blu blue value
 * \param colors pointer to Colors structure which holds color info
 */
void Rast_get_null_value_color(int *red, int *grn, int *blu,
                               const struct Colors *colors)
{
    if (colors->null_set) {
        *red = (int)colors->null_red;
        *grn = (int)colors->null_grn;
        *blu = (int)colors->null_blu;
    }
    else if (colors->undef_set) {
        *red = (int)colors->undef_red;
        *grn = (int)colors->undef_grn;
        *blu = (int)colors->undef_blu;
    }
    else
        *red = *blu = *grn = 255; /* white */
}
 
/*!
 * \brief Gets default color.
 *
 * Puts the red, green, and blue components of the <tt>"default"</tt>
 * color into <i>red, grn, and blu</i>.
 *
 * \param[out] red red value
 * \param[out] grn green value
 * \param[out] blu blue value
 * \param colors pointer to Colors structure which holds color info
 */
void Rast_get_default_color(int *red, int *grn, int *blu,
                            const struct Colors *colors)
{
    if (colors->undef_set) {
        *red = (int)colors->undef_red;
        *grn = (int)colors->undef_grn;
        *blu = (int)colors->undef_blu;
    }
    else
        *red = *blu = *grn = 255; /* white */
}