GeometryClipper.ClipRaster Methods
Clips rasters against polygons.
Overload List
| Name | Description | |
|---|---|---|
 Public method | ClipRaster(RasterGeometry raster, PolygonGeometry polygon, RasterClipOperation operation) | Clips a RasterGeometry against a PolygonGeometry. |
| Public method | ClipRaster(RasterGeometry raster, MultiPolygonGeometry polygons, RasterClipOperation operation) | Clips a RasterGeometry against a MultiPolygonGeometry. |
ClipRaster(RasterGeometry raster, PolygonGeometry polygon, RasterClipOperation operation)
Clips a RasterGeometry against a PolygonGeometry.Syntax
public static RasterGeometry ClipRaster (
RasterGeometry raster,
PolygonGeometry polygon,
RasterClipOperation operation
)Parameters
A raster to clip.
A polygon to clip raster against.
The clip operation to perform.
Return Value
A null reference meaning that nothing remains, or a modified raster with some cells clipped away; see Remarks.
Remarks
Since a raster geometry is always rectangular, the raster cells that should be clipped away cannot literally be removed, but will be filled with something invisible. For an RGB or RGBA raster, this will be a completely transparent color, so an RGB raster is automatically converted to RGBA before clipping. For a purely numeric raster or a raster containing indexes into a color table, the invisible value will be the UndefinedValue. If an Undefined value is not specified for the input raster, the method will specify the largest representable cell value as the Undefined value of the output raster. While doing this, the method will also, if possible, extend the bit depth of the raster from 8 to 16 bit or from 16 to 32 bit, to avoid specifying an Undefined value that may occur in the input raster.
ClipRaster(RasterGeometry raster, MultiPolygonGeometry polygons, RasterClipOperation operation)
Clips a RasterGeometry against a MultiPolygonGeometry.Syntax
public static RasterGeometry ClipRaster (
RasterGeometry raster,
MultiPolygonGeometry polygons,
RasterClipOperation operation
)Parameters
A raster to clip.
A multipolygon to clip raster against.
The clip operation to perform.
Return Value
A null reference meaning that nothing remains, or a modified raster with some cells clipped away; see Remarks.
Remarks
Since a raster geometry is always rectangular, the raster cells that should be clipped away cannot literally be removed, but will be filled with something invisible. For an RGB or RGBA raster, this will be a completely transparent color, so an RGB raster is automatically converted to RGBA before clipping. For a purely numeric raster or a raster containing indexes into a color table, the invisible value will be the UndefinedValue. If an Undefined value is not specified for the input raster, the method will specify the largest representable cell value as the new Undefined value of the output raster. While doing this, the method will also, if possible, extend the bit depth of the raster from 8 to 16 bit or from 16 to 32 bit, to avoid specifying a new Undefined value that may occur in the input raster.
Platforms
Windows, Linux, Android