Raster Library - Get mask information. More...

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

Include dependency graph for mask_info.c:

Go to the source code of this file.

Functions
char *	Rast_mask_info (void)
	Get a printable text with information about raster mask. More...

char *	Rast_mask_name (void)
	Retrieves the name of the raster mask to use. More...

bool	Rast_mask_status (char name, char mapset, bool is_mask_reclass, char reclass_name, char *reclass_mapset)
	Get raster mask status information. More...

int	Rast__mask_info (char name, char mapset)
	Get information about the current mask. More...

bool	Rast_mask_is_present (void)
	Check presence of 2D raster mask. More...

Detailed Description

Raster Library - Get mask information.

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

Author: CERL; Vaclav Petras, NC State University, Center for Geospatial Analytics

Definition in file mask_info.c.

Function Documentation

◆ Rast__mask_info()

int Rast__mask_info	(	char *	name,
		char *	mapset
	)

Get information about the current mask.

Determines the status of the automatic masking and the name of the 2D raster which forms the mask. Typically, mask is raster called MASK in the current mapset, but when used with r.mask, it is usually a reclassed raster, and so when a mask raster is present and it is a reclass raster, the name and mapset of the underlying reclassed raster are returned.

The name and mapset is written to the parameter which need to be defined with a sufficient size, least as char name[GNAME_MAX], mapset[GMAPSET_MAX].

When the masking is not active, -1 is returned and name and mapset are undefined. When the masking is active, 1 is returned and name and mapset will hold the name and mapset of the underlying raster.

Parameters

[out]	name	Name of the raster map used as mask
[out]	mapset	Name of the map's mapset

Returns: 1 if mask is present, -1 otherwise

See also: Rast_mask_status(), Rast_mask_name()

Definition at line 173 of file mask_info.c.

References GMAPSET_MAX, and GNAME_MAX.

Referenced by Rast_mask_info().

◆ Rast_mask_info()

char* Rast_mask_info ( void )

Get a printable text with information about raster mask.

Determines if 2D raster mask is present and returns textual information about the mask suitable for end-user display. The resulting text is translated. Caller is responsible for freeing the memory of the returned string.

Returns: New string with textual information

See also: Rast_mask_status()

Definition at line 34 of file mask_info.c.

References _, G_store(), GMAPSET_MAX, GNAME_MAX, name, Rast__mask_info(), and strcpy.

◆ Rast_mask_is_present()

bool Rast_mask_is_present ( void )

Check presence of 2D raster mask.

Returns: true if mask is present, false otherwise

Definition at line 192 of file mask_info.c.

References G_find_raster2(), name, NULL, and Rast_mask_name().

◆ Rast_mask_name()

char* Rast_mask_name ( void )

Retrieves the name of the raster mask to use.

The returned raster map name is fully qualified, i.e., in the form "name@mapset". The mask name is returned whether the mask is present or not.

This function checks if an environment variable "GRASS_MASK" is set. If it is set, the value of the environment variable is returned as the mask name. If it is not set, the function will default to the mask name "MASK@<mapset>", where <mapset> is the current mapset.

The memory for the returned mask name is dynamically allocated using G_store(). It is the caller's responsibility to free the memory with G_free() when it is no longer needed.

Returns: A dynamically allocated string containing the mask name.

Definition at line 72 of file mask_info.c.

References G_fully_qualified_name(), G_mapset(), and NULL.

Referenced by Rast__check_for_auto_masking(), and Rast_mask_is_present().

◆ Rast_mask_status()

bool Rast_mask_status	(	char *	name,
		char *	mapset,
		bool *	is_mask_reclass,
		char *	reclass_name,
		char *	reclass_mapset
	)

Get raster mask status information.

is_mask_reclass is a pointer to a bool variable which will be set to true if mask raster is a reclass and false otherwise.

If you are not interested in the underlying reclassified raster map, pass NULL pointers for the three reclass parameters:

Rast_mask_status(name, mapset, NULL, NULL, NULL);

NULL

#define NULL

Definition: ccmath.h:32

Rast_mask_status

bool Rast_mask_status(char *, char *, bool *, char *, char *)

Get raster mask status information.

Definition: mask_info.c:133

name

const char * name

Definition: named_colr.c:6