Raster (Groovy Documentation)

geoscript.layer.Raster

All Implemented Interfaces and Traits:

Renderable
```
class Raster
extends java.lang.Object
```
A Raster
Authors:
Jared Erickson

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`Raster.Divide`
`static class`	`Raster.Subtract`

Properties Summary

Properties
Type	Name and description
`private GridCoverage2D`	`coverage` A GeoScript Raster wraps a GeoTools GridCoverage2D
`private Format`	`format` The Format
`Projection`	`proj`
`private Style`	`style` The Style
`java.lang.Object`	`value`

Constructor Summary

Constructors
Constructor and description
`Raster (List data, Bounds bounds)` Create a new Raster from a List of List of float values
`Raster (GridCoverage2D coverage, Format format)` Create a Raster from a GeoTools GridCoverage2D.
`Raster (java.awt.image.RenderedImage image, Bounds bounds)` Create a Raster from an Image and Bounds
`Raster (Bounds bounds, int width, int height, List bands)` Create a new Raster form a Bounds, image size, and List of Bands
`Raster ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Raster`	`absolute()` Create a new Raster by calculating the absolute value for every cell.
	`Raster`	`add(Raster other)` Add this Raster with another Raster Parameters: `other` - Another a Raster Returns: A new Raster
	`Raster`	`add(double value)` Add a constant value to this Raster Parameters: `value` - The constant number Returns: A new Raster
	`Raster`	`add(List values)` Add a List of constant values to this Raster Parameters: `values` - The List of constant numbers Returns: A new Raster
	`boolean`	`contains(java.awt.Point point)` Determine whether this Raster contains the geographic Point Parameters: `point` - The Point Returns: Whether this Raster contains the geographic Point
	`boolean`	`contains(int x, int y)` Determine whether this Raster contains the pixel coordinates Parameters: `x` - The x pixel coordinate `y` - The y pixel coordinate Returns: Whether this Raster contains the pixel coordinates
	`Layer`	`contours(int band, java.lang.Object intervalOrLevels, boolean simplify, boolean smooth, Bounds bounds)` Create contours Parameters: `band` - The Raster band `intervalOrLevels` - The contour interval or a List of levels `simplify` - Whether to simplify the contours `smooth` - Whether to smooth the contours Returns: A Layer
	`Raster`	`convolve(int radius)` Calculate a convoluted version of the current Raster Parameters: `radius` - The kernel radius Returns: A Raster
	`Raster`	`convolve(int width, int height)` Calculate a convoluted version of the current Raster Parameters: `width` - The kernel width `height` - The height width Returns: A Raster
	`Raster`	`createShadedRelief(Map options, double scale, double altitude, double azimuth)` Create a shaded relief Raster from the current Raster Parameters: `options` - The optional named parameters.
	`Raster`	`crop(Bounds bounds)` Crop this Raster Parameters: `bounds` - The Bounds Returns: A new Raster
	`Raster`	`crop(Geometry geometry)` Crop this Raster Parameters: `geometry` - The Geometry Returns: A new Raster
	`Raster`	`crop(int x1, int y1, int x2, int y2)` Crop this Raster using pixel coordinates Parameters: `x1` - The x of the min pixel `y1` - The y of the min pixel `x2` - The x of the max pixel `y2` - The y of the max pixel Returns: A new Raster
	`void`	`dispose()` Dispose of this Raster
	`Raster`	`div(Raster other)` Divide this Raster by another Raster Parameters: `other` - The other Raster Returns: A new Raster
	`Raster`	`div(double value)` Divide this Raster by a constant value Parameters: `value` - The constant value Returns: A new Raster
	`Raster`	`div(List values)` Divide this Raster by a List of constant values Parameters: `values` - A List of constant values Returns: A new Raster
	`Raster`	`divide(Raster other)` Divide this Raster by another Raster Parameters: `other` - The other Raster Returns: A new Raster
	`Raster`	`divide(double value)` Divide this Raster by a constant value Parameters: `value` - The constant value Returns: A new Raster
	`Raster`	`divide(List values)` Divide this Raster by a List of constant values Parameters: `values` - A List of constant values Returns: A new Raster
	`void`	`eachCell(Map options, Closure closure)` Call the Closure for each cell in this Raster Parameters: `Named` - parameters bounds = The x,y,w,h List band = The band to get values from outside = The value for cells that land outside the Raster order = The order imagexy or tilexy `closure` - The Closure to call which is passed the value, the pixel x, and the pixel y
	`void`	`eachWindow(Map options, Closure closure)` Call the Closure for each window of values in this Raster Parameters: `options` - Named parameters bounds = The x,y,w,h as a List window = The size of the window (w,h) key = The key [x,y] steps = The x and y steps outside = The value for cells that land outside the Raster `closure` - The Closure to call which is passed the values, the pixel x, and the pixel y
	`List`	`eval(java.awt.Point point, java.lang.String type)` Get the value of the Raster at the given geographic Location.
	`List`	`eval(int x, int y, java.lang.String type)` Get the value of the Raster at the given pixel Location.
	`Raster`	`exp()` Create a new Raster by calculating the exponential value for every cell.
	`Layer`	`extractFootPrint(Map options)` Extract the foot print of this Raster as a vector Layer Parameters: `options` - Optional named parameters: exclusionRange: A List of Maps with min and max values used to exclude values from the search.
	`List`	`getAt(java.lang.Object p)` Get the value of the Raster at the given geographic Location or pixel location.
	`List`	`getBands()` Get the List of Bands Returns: The List of Bands
	`List`	`getBlockSize()` Get the block size Returns: The block size [w,h]
	`Bounds`	`getBounds()` Get the Bounds Returns: The Bounds
	`java.awt.image.BufferedImage`	`getBufferedImage()` Get a BufferedImage Returns: A BufferedImage
	`int`	`getCols()` Get the number of columns Returns: The number of columns
	`java.awt.image.Raster`	`getData()` Get the underlying java.awt.image.Raster Returns: The java.awt.image.Raster
	`Map`	`getExtrema()` Calculate the min and max values for each band in this Raster.
	`Histogram`	`getHistogram(Map options)` Get a Histogram for this Raster Parameters: `options` - Optional named parameters can include low, high, and numBins low: The low value high: The high value numBins: The number of bins Returns: A Histogram
	`java.awt.image.RenderedImage`	`getImage()` Get the RenderedImage Returns: The RenderedImage
	`List`	`getMapLayers(Bounds bounds, List size)`
	`double`	`getMaxValue(int band)` Get the maximum value for a band.
	`double`	`getMinValue(int band)` Get the minimum value for a band.
	`java.lang.String`	`getName()` Get the Raster's name Returns: The name
	`Map`	`getNeighbors(java.lang.Object p, int band)` Get the value of the neighboring cells: NW N NE E SE S SE W Parameters: `p` - The Point or Pixel `band` - The band (defaults to 0) Returns: A Map of neighboring cell values
	`List`	`getPixel(java.awt.Point p)` Get pixel coordinates from the geographic Point Parameters: `p` - The geographic Point Returns: A List of pixel coordinates
	`List`	`getPixelSize()` Get the pixel size Returns: The pixel size [w,h]
	`java.awt.Point`	`getPoint(int x, int y)` Get a geographic Point from pixel coordinates Parameters: `x` - The x pixel coordinate `y` - The y pixel coordinate Returns: A geographic Point
	`Layer`	`getPointLayer(Map options)` Convert this Raster into a Layer of Points Parameters: `options` - Optional named parameters: proj: The target Projection scale: The scale interpolation: The Interpolation algorithm emisphere: Whether to add the emisphere or not Returns: A Layer
	`Layer`	`getPolygonLayer(Map options)` Convert this Raster to a Layer of polygons.
	`Projection`	`getProj()` Get the Projection Returns: The Projection
	`int`	`getRows()` Get the number of rows Returns: The number rows
	`List`	`getSize()` Get the size [w,h] or [columns,rows] Returns: The size [w,h] or [columns,rows]
	`java.lang.Object`	`getValue(java.lang.Object p, int band, java.lang.String type)` Get the value at the given geographic location (Point) or pixel location ([x,y]) for the given band Parameters: `p` - The Point or Pixel (list x,y) `band` - The band zero based `type` - The type of value to return (double, float, int, byte, boolean, default) Returns: The value
	`java.lang.Object`	`getValue(int x, int y, int band, java.lang.String type)` Get the value at the given pixel location ([x,y]) for the given band Parameters: `x` - The pixel x `y` - The pixel y `band` - The band zero based `type` - The type of value to return (double, float, int, byte, boolean, default) Returns: The value
	`List`	`getValues(int x, int y, int w, int h, int band, boolean flat)` Get a List of values from the Raster Parameters: `x` - The pixel x or col to start from `y` - The pixel y or row to start from `w` - The number of columns `h` - The number of rows `band` - The band to get values from (defaults to 0) `flat` - Whether the List should be returned flat (true, the default) or with nested Lists (false) Returns: A List of values
	`java.lang.String`	`getValuesAsString(Map options, int x, int y, int w, int h, int band)` Get values as a String Parameters: `options` - Optional named parameters (prettyPrint = false \| true) `x` - The pixel x or col to start from `y` - The pixel y or row to start from `w` - The number of columns `h` - The number of rows `band` - The band to get values from (defaults to 0) Returns: A String of values
	`Raster`	`invert()` Create a new Raster by inverting the values of this Raster Returns: A new Raster
	`Raster`	`log()` Create a new Raster by calculating the log value for every cell.
	`static Raster`	`merge(Map options, List rasters)` Merge a List of Rasters into one Raster
	`Raster`	`minus(Raster other)` Subtract this Raster from an other Raster Parameters: `other` - The other Raster Returns: A new Raster
	`Raster`	`minus(double value)` Subtract this Raster from a constant value Parameters: `value` - The constant value Returns: A new Raster
	`Raster`	`minus(List values)` Subtract this Raster from a List of constant values Parameters: `values` - The List of constant values Returns: A new Raster
	`Raster`	`minusFrom(double value)` Subtract a constant value from this Raster Parameters: `value` - The constant value Returns: A new Raster
	`Raster`	`minusFrom(List values)` Subtract a List of constant values from this Raster Parameters: `values` - The List of constant values Returns: A new Raster
	`static Raster`	`mosaic(Map options, List rasters)` Mosaic a List of Rasters into a single Raster Parameters: `options` - options Optional named parameters: bounds = The final Bounds size = The final size of the Raster `rasters` - The List of Rasters Returns: A new Raster
	`Raster`	`multiply(Raster other)` Multiple this Raster with another Raster
	`Raster`	`multiply(List values)` Multiply this Raster by a List of constant values Parameters: `values` - The list of constant values Returns: A new Raster
	`Raster`	`multiply(double value)` Multiply this Raster by a constant value Parameters: `values` - The constant value Returns: A new Raster
	`Raster`	`negative()` Create a new Raster by inverting the values of this Raster.
	`Raster`	`normalize()` Calculate a normalized version of the current Raster Returns: A Raster
	`Raster`	`plus(Raster other)` Add this Raster with another Raster
	`Raster`	`plus(double value)` Add a constant value to this Raster Parameters: `value` - The constant number Returns: A new Raster
	`Raster`	`plus(List values)` Add a List of constant values to this Raster Parameters: `values` - The List of constant numbers Returns: A new Raster
	`void`	`putAt(java.lang.Object p, java.lang.Object value)` Set the value for the given Point or Pixel Parameters: `p` - The Point or Pixel (as List of xy coordinates) `value` - The new value
	`Raster`	`reclassify(Map options, List ranges)` Reclassify this Raster with a List of ranges.
	`void`	`render()` Render the Raster in a simple GUI
	`Raster`	`reproject(Projection proj)` Reproject this Raster to another Projection creating a new Raster Parameters: `proj` - The Projection Returns: A new Raster
	`Raster`	`resample(Map options)` Resample this Raster Parameters: `options` - Optional named parameters can include: bbox: A geographic Bounds rect: A List of 4 pixel coordinates representing a rectangle.
	`Raster`	`scale(float x, float y, float xTrans, float yTrans, java.lang.String interpolation)` Scale this Raster Parameters: `x` - The scale factor along the x axis `y` - The scale factor along the y axis `xTrans` - The x translation `yTrans` - The y translation `interpolation` - The interpolation method (bicubic, bicubic2, bilinear, nearest) Returns: A new scaled Raster
	`Raster`	`selectBands(List bands, int visibleBand)` Create a new Raster with selection of Bands Parameters: `bands` - The indices of the selected bands `visibleBand` - The visible band Returns: A new Raster
	`void`	`setProj(java.lang.Object projection)` Set the Projection of this Raster (reprojecting if necessary) Parameters: `projection` - The Projection
	`void`	`setValue(java.lang.Object p, java.lang.Object value, int band)` Set the value for the given Point or Pixel Parameters: `p` - The Point or Pixel (as List of xy coordinates) `value` - The new value `band` - The band (defaults to 0)
	`Raster`	`stylize(Style sym)` Create a new Raster with styling baked in.
	`Raster`	`stylize()` Create a new Raster with current styling baked in.
	`Raster`	`transform(Map options)` Transform this Raster using an Affine Transformation.
	`Layer`	`zonalStatistics(int band, Layer zones, Raster classification)` Calculate the zonal statistics of this Raster Parameters: `band` - The band `zones` - A Layer of polygons representing the zones `classification` - An optional Raster whose values are used as classes Returns: A Layer with statistics (count, min, max, sum, avg, stddev, and optionally classification)

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - private GridCoverage2D coverage
    
    A GeoScript Raster wraps a GeoTools GridCoverage2D
  - private Format format
    
    The Format
  - Projection proj
  - private Style style
    
    The Style
  - java.lang.Object value
- Constructor Detail
  - Raster(List data, Bounds bounds)
    
    Create a new Raster from a List of List of float values
    Parameters:
    data - A List of Lists of float values
    bounds - The geographic Bounds
  - Raster(GridCoverage2D coverage, Format format)
    
    Create a Raster from a GeoTools GridCoverage2D.
    Parameters:
    coverage - The GeoTools GridCoverage2D
    format - The Format
  - Raster(java.awt.image.RenderedImage image, Bounds bounds)
    
    Create a Raster from an Image and Bounds
    Parameters:
    image - The image
    bounds - The Bounds
  - Raster(Bounds bounds, int width, int height, List bands)
    
    Create a new Raster form a Bounds, image size, and List of Bands
    Parameters:
    bounds - A Bounds with a Projection
    width - The Raster width
    height - The Raster height
    bands - A List of Bands
  - Raster()
- Method Detail
  - Raster absolute()
    
    Create a new Raster by calculating the absolute value for every cell.
    Returns:
    A new Raster
  - Raster add(Raster other)
    
    Add this Raster with another Raster
    Parameters:
    other - Another a Raster
    Returns:
    A new Raster
  - Raster add(double value)
    
    Add a constant value to this Raster
    Parameters:
    value - The constant number
    Returns:
    A new Raster
  - Raster add(List values)
    
    Add a List of constant values to this Raster
    Parameters:
    values - The List of constant numbers
    Returns:
    A new Raster
  - boolean contains(java.awt.Point point)
    
    Determine whether this Raster contains the geographic Point
    Parameters:
    point - The Point
    Returns:
    Whether this Raster contains the geographic Point
  - boolean contains(int x, int y)
    
    Determine whether this Raster contains the pixel coordinates
    Parameters:
    x - The x pixel coordinate
    y - The y pixel coordinate
    Returns:
    Whether this Raster contains the pixel coordinates
  - Layer contours(int band, java.lang.Object intervalOrLevels, boolean simplify, boolean smooth, Bounds bounds)
    
    Create contours
    Parameters:
    band - The Raster band
    intervalOrLevels - The contour interval or a List of levels
    simplify - Whether to simplify the contours
    smooth - Whether to smooth the contours
    Returns:
    A Layer
  - Raster convolve(int radius)
    
    Calculate a convoluted version of the current Raster
    Parameters:
    radius - The kernel radius
    Returns:
    A Raster
  - Raster convolve(int width, int height)
    
    Calculate a convoluted version of the current Raster
    Parameters:
    width - The kernel width
    height - The height width
    Returns:
    A Raster
  - Raster createShadedRelief(Map options, double scale, double altitude, double azimuth)
    
    Create a shaded relief Raster from the current Raster
    Parameters:
    options - The optional named parameters.
    
    resX = The x resolution (defaults to 0.5d)
    
    resY = The y resolution (defaults to 0.5d)
    
    zetaFactor = The zeta factor (defaults to 1.0d)
    
    algorithm = The algorithm ZEVENBERGEN_THORNE | ZEVENBERGEN_THORNE_COMBINED | DEFAULT | COMBINED
    scale - The scale 1 or 10000
    altitude - The altitude in degrees 65
    azimuth - The azimuth in degrees 75
    Returns:
    A new Raster
  - Raster crop(Bounds bounds)
    
    Crop this Raster
    Parameters:
    bounds - The Bounds
    Returns:
    A new Raster
  - Raster crop(Geometry geometry)
    
    Crop this Raster
    Parameters:
    geometry - The Geometry
    Returns:
    A new Raster
  - Raster crop(int x1, int y1, int x2, int y2)
    
    Crop this Raster using pixel coordinates
    Parameters:
    x1 - The x of the min pixel
    y1 - The y of the min pixel
    x2 - The x of the max pixel
    y2 - The y of the max pixel
    Returns:
    A new Raster
  - void dispose()
    
    Dispose of this Raster
  - Raster div(Raster other)
    
    Divide this Raster by another Raster
    Parameters:
    other - The other Raster
    Returns:
    A new Raster
  - Raster div(double value)
    
    Divide this Raster by a constant value
    Parameters:
    value - The constant value
    Returns:
    A new Raster
  - Raster div(List values)
    
    Divide this Raster by a List of constant values
    Parameters:
    values - A List of constant values
    Returns:
    A new Raster
  - Raster divide(Raster other)
    
    Divide this Raster by another Raster
    Parameters:
    other - The other Raster
    Returns:
    A new Raster
  - Raster divide(double value)
    
    Divide this Raster by a constant value
    Parameters:
    value - The constant value
    Returns:
    A new Raster
  - Raster divide(List values)
    
    Divide this Raster by a List of constant values
    Parameters:
    values - A List of constant values
    Returns:
    A new Raster
  - void eachCell(Map options, Closure closure)
    
    Call the Closure for each cell in this Raster
    Parameters:
    Named - parameters
    
    bounds = The x,y,w,h List
    
    band = The band to get values from
    
    outside = The value for cells that land outside the Raster
    
    order = The order imagexy or tilexy
    closure - The Closure to call which is passed the value, the pixel x, and the pixel y
  - void eachWindow(Map options, Closure closure)
    
    Call the Closure for each window of values in this Raster
    Parameters:
    options - Named parameters
    
    bounds = The x,y,w,h as a List
    
    window = The size of the window (w,h)
    
    key = The key [x,y]
    
    steps = The x and y steps
    
    outside = The value for cells that land outside the Raster
    closure - The Closure to call which is passed the values, the pixel x, and the pixel y
  - List eval(java.awt.Point point, java.lang.String type)
    
    Get the value of the Raster at the given geographic Location. If the Raster contains multiple bands a Collection of values, one for each band, will be returned.
    Parameters:
    point - The Point where we want a value from the Raster
    type - The type of value to return (double, float, int, byte, boolean, default)
    Returns:
    A value
  - List eval(int x, int y, java.lang.String type)
    
    Get the value of the Raster at the given pixel Location. If the Raster contains multiple bands a Collection of values, one for each band, will be returned.
    Parameters:
    x - The pixel x coordinate
    y - The pixel y coordinate
    type - The type of value to return (double, float, int, byte, boolean, default)
    Returns:
    A value
  - Raster exp()
    
    Create a new Raster by calculating the exponential value for every cell.
    Returns:
    A new Raster
  - Layer extractFootPrint(Map options)
    
    Extract the foot print of this Raster as a vector Layer
    Parameters:
    options - Optional named parameters:
    
    exclusionRange: A List of Maps with min and max values used to exclude values from the search.
    
    thresholdArea: A number used to exclude small Polygons
    
    computeSimplifiedFootprint: Whether to compute a simplified footprint or not
    
    simplifierFactor: A number used to simplify the geometry.
    
    removeCollinear: Whether to remove collinear coordinates.
    
    forceValid: Whether to force creation of valid polygons.
    
    loadingType: The image loading type (DEFERRED or IMMEDIATE)
    Returns:
    A Layer
  - List getAt(java.lang.Object p)
    
    Get the value of the Raster at the given geographic Location or pixel location. If the Raster contains multiple bands a Collection of values, one for each band, will be returned.
    Parameters:
    point - The Point where we want a value from the Raster
    Returns:
    A value
  - List getBands()
    
    Get the List of Bands
    Returns:
    The List of Bands
  - List getBlockSize()
    
    Get the block size
    Returns:
    The block size [w,h]
  - Bounds getBounds()
    
    Get the Bounds
    Returns:
    The Bounds
  - java.awt.image.BufferedImage getBufferedImage()
    
    Get a BufferedImage
    Returns:
    A BufferedImage
  - int getCols()
    
    Get the number of columns
    Returns:
    The number of columns
  - java.awt.image.Raster getData()
    
    Get the underlying java.awt.image.Raster
    Returns:
    The java.awt.image.Raster
  - Map getExtrema()
    
    Calculate the min and max values for each band in this Raster.
    Returns:
    A Map containing the min and max values
  - Histogram getHistogram(Map options)
    
    Get a Histogram for this Raster
    Parameters:
    options - Optional named parameters can include low, high, and numBins
    
    low: The low value
    
    high: The high value
    
    numBins: The number of bins
    Returns:
    A Histogram
  - java.awt.image.RenderedImage getImage()
    
    Get the RenderedImage
    Returns:
    The RenderedImage
  - @java.lang.OverrideOverride List getMapLayers(Bounds bounds, List size)
  - double getMaxValue(int band)
    
    Get the maximum value for a band. It first tries to get the value from the Band's metadata and then calculates it from the actual data.
    Parameters:
    band - The Band index
    Returns:
    A maximum value
  - double getMinValue(int band)
    
    Get the minimum value for a band. It first tries to get the value from the Band's metadata and then calculates it from the actual data.
    Parameters:
    band - The Band index
    Returns:
    A minimum value
  - java.lang.String getName()
    
    Get the Raster's name
    Returns:
    The name
  - Map getNeighbors(java.lang.Object p, int band)
    
    Get the value of the neighboring cells: NW N NE E SE S SE W
    Parameters:
    p - The Point or Pixel
    band - The band (defaults to 0)
    Returns:
    A Map of neighboring cell values
  - List getPixel(java.awt.Point p)
    
    Get pixel coordinates from the geographic Point
    Parameters:
    p - The geographic Point
    Returns:
    A List of pixel coordinates
  - List getPixelSize()
    
    Get the pixel size
    Returns:
    The pixel size [w,h]
  - java.awt.Point getPoint(int x, int y)
    
    Get a geographic Point from pixel coordinates
    Parameters:
    x - The x pixel coordinate
    y - The y pixel coordinate
    Returns:
    A geographic Point
  - Layer getPointLayer(Map options)
    
    Convert this Raster into a Layer of Points
    Parameters:
    options - Optional named parameters:
    
    proj: The target Projection
    
    scale: The scale
    
    interpolation: The Interpolation algorithm
    
    emisphere: Whether to add the emisphere or not
    Returns:
    A Layer
  - Layer getPolygonLayer(Map options)
    
    Convert this Raster to a Layer of polygons.
    Parameters:
    options - Optional named parameters may include:
    
    band: The band defaults to 0
    
    insideEdges: Whether to include the inside edges or not. Defaults to true
    
    roi: The Geometry region of interest. Defaults to null.
    
    noData: The List of no data values. Defaults to null.
    
    range: A List of range Maps with min, minIncluded, max, and maxIncluded keys. Defaults to null.
    Returns:
    A Layer of polygons
  - Projection getProj()
    
    Get the Projection
    Returns:
    The Projection
  - int getRows()
    
    Get the number of rows
    Returns:
    The number rows
  - List getSize()
    
    Get the size [w,h] or [columns,rows]
    Returns:
    The size [w,h] or [columns,rows]
  - java.lang.Object getValue(java.lang.Object p, int band, java.lang.String type)
    
    Get the value at the given geographic location (Point) or pixel location ([x,y]) for the given band
    Parameters:
    p - The Point or Pixel (list x,y)
    band - The band zero based
    type - The type of value to return (double, float, int, byte, boolean, default)
    Returns:
    The value
  - java.lang.Object getValue(int x, int y, int band, java.lang.String type)
    
    Get the value at the given pixel location ([x,y]) for the given band
    Parameters:
    x - The pixel x
    y - The pixel y
    band - The band zero based
    type - The type of value to return (double, float, int, byte, boolean, default)
    Returns:
    The value
  - List getValues(int x, int y, int w, int h, int band, boolean flat)
    
    Get a List of values from the Raster
    Parameters:
    x - The pixel x or col to start from
    y - The pixel y or row to start from
    w - The number of columns
    h - The number of rows
    band - The band to get values from (defaults to 0)
    flat - Whether the List should be returned flat (true, the default) or with nested Lists (false)
    Returns:
    A List of values
  - java.lang.String getValuesAsString(Map options, int x, int y, int w, int h, int band)
    
    Get values as a String
    Parameters:
    options - Optional named parameters (prettyPrint = false | true)
    x - The pixel x or col to start from
    y - The pixel y or row to start from
    w - The number of columns
    h - The number of rows
    band - The band to get values from (defaults to 0)
    Returns:
    A String of values
  - Raster invert()
    
    Create a new Raster by inverting the values of this Raster
    Returns:
    A new Raster
  - Raster log()
    
    Create a new Raster by calculating the log value for every cell.
    Returns:
    A new Raster
  - static Raster merge(Map options, List rasters)
    
    Merge a List of Rasters into one Raster
    Returns:
    Parameters:
    options - Optional named parameters:
    
    roi = regional of interest (a Geometry)
    
    transform = how to choose the grid to world transform (FIRST, LAST, INDEX)
    
    index = The index value of the Raster to choose when transform = INDEX
    
    rasters - A List of Rasters to merge
  - Raster minus(Raster other)
    
    Subtract this Raster from an other Raster
    Parameters:
    other - The other Raster
    Returns:
    A new Raster
  - Raster minus(double value)
    
    Subtract this Raster from a constant value
    Parameters:
    value - The constant value
    Returns:
    A new Raster
  - Raster minus(List values)
    
    Subtract this Raster from a List of constant values
    Parameters:
    values - The List of constant values
    Returns:
    A new Raster
  - Raster minusFrom(double value)
    
    Subtract a constant value from this Raster
    Parameters:
    value - The constant value
    Returns:
    A new Raster
  - Raster minusFrom(List values)
    
    Subtract a List of constant values from this Raster
    Parameters:
    values - The List of constant values
    Returns:
    A new Raster
  - static Raster mosaic(Map options, List rasters)
    
    Mosaic a List of Rasters into a single Raster
    Parameters:
    options - options Optional named parameters:
    
    bounds = The final Bounds
    
    size = The final size of the Raster
    rasters - The List of Rasters
    Returns:
    A new Raster
  - Raster multiply(Raster other)
    
    Multiple this Raster with another Raster
    def r3 = r1 * r2
    
    Parameters:
    other - Another a Raster
    Returns:
    A new Raster
  - Raster multiply(List values)
    
    Multiply this Raster by a List of constant values
    Parameters:
    values - The list of constant values
    Returns:
    A new Raster
  - Raster multiply(double value)
    
    Multiply this Raster by a constant value
    Parameters:
    values - The constant value
    Returns:
    A new Raster
  - Raster negative()
    
    Create a new Raster by inverting the values of this Raster. Overrides the - operator
```
 def invertedRaster = -raster
 
```
    Returns:
    A new Raster
  - Raster normalize()
    
    Calculate a normalized version of the current Raster
    Returns:
    A Raster
  - Raster plus(Raster other)
    
    Add this Raster with another Raster
    def r3 = r1 + r2
    
    Parameters:
    other - Another a Raster
    Returns:
    A new Raster
  - Raster plus(double value)
    
    Add a constant value to this Raster
    Parameters:
    value - The constant number
    Returns:
    A new Raster
  - Raster plus(List values)
    
    Add a List of constant values to this Raster
    Parameters:
    values - The List of constant numbers
    Returns:
    A new Raster
  - void putAt(java.lang.Object p, java.lang.Object value)
    
    Set the value for the given Point or Pixel
    Parameters:
    p - The Point or Pixel (as List of xy coordinates)
    value - The new value
  - Raster reclassify(Map options, List ranges)
    
    Reclassify this Raster with a List of ranges.
    Parameters:
    options - Optional named parameters can include the band to reclassify and the noData value.
    
    band: The band (defaults to 0)
    
    noData: The NO DATA value (defaults to 0)
    ranges - The List of Ranges contains one or more Maps with min, max, and value keys.
    Returns:
    A new Raster
  - void render()
    
    Render the Raster in a simple GUI
  - Raster reproject(Projection proj)
    
    Reproject this Raster to another Projection creating a new Raster
    Parameters:
    proj - The Projection
    Returns:
    A new Raster
  - Raster resample(Map options)
    
    Resample this Raster
    Parameters:
    options - Optional named parameters can include:
    
    bbox: A geographic Bounds
    
    rect: A List of 4 pixel coordinates representing a rectangle.
    
    size: A List resulting width and height
    Returns:
    A new Raster
  - Raster scale(float x, float y, float xTrans, float yTrans, java.lang.String interpolation)
    
    Scale this Raster
    Parameters:
    x - The scale factor along the x axis
    y - The scale factor along the y axis
    xTrans - The x translation
    yTrans - The y translation
    interpolation - The interpolation method (bicubic, bicubic2, bilinear, nearest)
    Returns:
    A new scaled Raster
  - Raster selectBands(List bands, int visibleBand)
    
    Create a new Raster with selection of Bands
    Parameters:
    bands - The indices of the selected bands
    visibleBand - The visible band
    Returns:
    A new Raster
  - void setProj(java.lang.Object projection)
    
    Set the Projection of this Raster (reprojecting if necessary)
    Parameters:
    projection - The Projection
  - void setValue(java.lang.Object p, java.lang.Object value, int band)
    
    Set the value for the given Point or Pixel
    Parameters:
    p - The Point or Pixel (as List of xy coordinates)
    value - The new value
    band - The band (defaults to 0)
  - Raster stylize(Style sym)
    
    Create a new Raster with styling baked in.
    Parameters:
    style - The Style/Symobolizer
    Returns:
    A new Raster
  - Raster stylize()
    
    Create a new Raster with current styling baked in.
    Returns:
    A new Raster
  - Raster transform(Map options)
    
    Transform this Raster using an Affine Transformation.
    Parameters:
    options - The named parameters
    
    scalex = The scale x parameter
    
    scaley = The scale y parameter
    
    shearx = The shear x parameter
    
    sheary = The shear y parameter
    
    translatex = The translate x parameter
    
    translatey = The translate y parameter
    
    nodata = The nodata values
    
    interpolation = The Interpolate algorithm (NEAREST, BILINEAR, BICUBIC2, BICUBIC)
    Returns:
    A transformed Raster
  - Layer zonalStatistics(int band, Layer zones, Raster classification)
    
    Calculate the zonal statistics of this Raster
    Parameters:
    band - The band
    zones - A Layer of polygons representing the zones
    classification - An optional Raster whose values are used as classes
    Returns:
    A Layer with statistics (count, min, max, sum, avg, stddev, and optionally classification)

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Raster

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private GridCoverage2D coverage

private Format format

Projection proj

private Style style

java.lang.Object value

Constructor Detail

Raster(List data, Bounds bounds)

Raster(GridCoverage2D coverage, Format format)

Raster(java.awt.image.RenderedImage image, Bounds bounds)

Raster(Bounds bounds, int width, int height, List bands)

Raster()

Method Detail

Raster absolute()

Raster add(Raster other)

Raster add(double value)

Raster add(List values)

boolean contains(java.awt.Point point)

boolean contains(int x, int y)

Layer contours(int band, java.lang.Object intervalOrLevels, boolean simplify, boolean smooth, Bounds bounds)

Raster convolve(int radius)

Raster convolve(int width, int height)

Raster createShadedRelief(Map options, double scale, double altitude, double azimuth)

Raster crop(Bounds bounds)

Raster crop(Geometry geometry)

Raster crop(int x1, int y1, int x2, int y2)

void dispose()

Raster div(Raster other)

Raster div(double value)

Raster div(List values)

Raster divide(Raster other)

Raster divide(double value)

Raster divide(List values)

void eachCell(Map options, Closure closure)

void eachWindow(Map options, Closure closure)

List eval(java.awt.Point point, java.lang.String type)

List eval(int x, int y, java.lang.String type)

Raster exp()

Layer extractFootPrint(Map options)

List getAt(java.lang.Object p)

List getBands()

List getBlockSize()

Bounds getBounds()

java.awt.image.BufferedImage getBufferedImage()

int getCols()

java.awt.image.Raster getData()

Map getExtrema()

Histogram getHistogram(Map options)

java.awt.image.RenderedImage getImage()

@java.lang.OverrideOverride List getMapLayers(Bounds bounds, List size)

double getMaxValue(int band)

double getMinValue(int band)

java.lang.String getName()

Map getNeighbors(java.lang.Object p, int band)

List getPixel(java.awt.Point p)

List getPixelSize()

java.awt.Point getPoint(int x, int y)

Layer getPointLayer(Map options)

Layer getPolygonLayer(Map options)

Projection getProj()

int getRows()

List getSize()

java.lang.Object getValue(java.lang.Object p, int band, java.lang.String type)

java.lang.Object getValue(int x, int y, int band, java.lang.String type)

List getValues(int x, int y, int w, int h, int band, boolean flat)

java.lang.String getValuesAsString(Map options, int x, int y, int w, int h, int band)

Raster invert()

Raster log()

static Raster merge(Map options, List rasters)

Raster minus(Raster other)

Raster minus(double value)

Raster minus(List values)

Raster minusFrom(double value)

Raster minusFrom(List values)