| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

Functions
Raster functions

## Functions

TL_DLL TeRaster * | TeRasterClipping (TeRaster *whole, TePolygonSet &mask, TeProjection *geomProj, const string &clipName, double background, const string &decId="")

## Detailed Description

A set of functions that manipulates raster representations

## Function Documentation

TL_DLL TeRaster* TeRasterClipping | ( | TeRaster * | whole,
|  | TePolygonSet & | mask,
|  | TeProjection * | geomProj,
|  | const string & | clipName,
|  | double | background,
|  | const string & | decId = `""`
| ) |  |

Clips a raster representation using a polygon set as a mask

Parameters:

  whole | pointer to the raster to be clipped
  mask | the polygon set used as the mask to clip the raaster
  geomProj | pointer the projection of the polygons used as mask
  clipName | name of the file (or database table) that will contains the clipped raster
  background | value to be used as the background of the clipped raster
  decId | optional parameter that explicitly indicates the decoder (or format) used to generate the clipped raster

Returns:
  a pointer to the generated clipped raster if it succeed or a null pointer otherwise.

If the decId is equal to "DB" it is assumed that the clipped raster will be generated in the same database as the input raster. If the input raster is not in a database, the routine returns a error.

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines