Start | Index | Overview • PREV | UP | NEXT

net.simplace.processors.RasterStatisticsProcessor

This processor is based on Geotools and creates statistical information on a geo data object (org.geotools.coverage.grid.GridCoverage2D or de.schmitzm.geotools.styling.StyledGridCoverageInterface) into memory. The informations are stored in out parameters under the key of the base map using postfixes.
Required input parameters:

Key map.key: Parameter key to the base map to be analyzed. If no key is specified the base map must be provided by key basemap.key in the parameter map.
Key zones.key (optional): Parameter key to a map which defines zones for the analyzed map (equal raster value means equal zone). If not specified, the zone map is taken from parameter key zonemap.key. If no map is found under that key at all, no zones are used (complete base map is one zone)
Key histogram_steps (optional, default 20): Only applicable when NOT using zones. Defines the (maximum) number of histogram classes. If a negative value is set, a histogram class is created for ALL raster values. Use value 0 to disable the histogram calculation for the processor!

Currently following information is put to output parameters:

Common information (see net.simplace.util.service.GeotoolsHelper.putGridParametersToParameterMap(Object, String, net.simplace.util.FWObservable, boolean):
Key .easting: longitude of the eastern grid border (as string)
Key .northing: latitude of the northern grid border (as string)
Key .westing: longitude of the western grid border (as string)
Key .southing: latitude of the southern grid border (as string)
Key .widthLon: grid width in longitude metric (as string)
Key .heightLat: grid height in latitude metric (as string)
Key .resolutionLon: cell width in longitude metric (as string)
Key .resolutionLat: cell height in latitude metric (as string)
Key .columns: column count of the raster (as string)
Key .rows: row count of the raster (as string)
Key .crs: org.opengis.referencing.crs.CoordinateReferenceSystem of the grid
Key .crsWKT: org.opengis.referencing.crs.CoordinateReferenceSystem of the grid as WKT definition
Only provides when using zones:
Key .zoneCount: count of zones defined by the zone map
Key .cellCountMap: zone histogram as java.util.SortedMapSortedMap in the following format:
key = ""
value = number of cells in zone with value
Under the special key "" the total cell count of the zone is provided.
Key .avgMap: average value of each zone as java.util.SortedMapSortedMap, where the key specifies the zone number and the value the average.
Key .sumMap: sum of all values for each zone as java.util.SortedMapSortedMap, where the key specifies the zone number and the value the sum.
Only provides when NO zones are used:
Key .maxValue: maximum cell value of the grid (exclusive NoData-cells)
Key .minValue: minimum cell value of the grid (exclusive NoData-cells)
Key .avgValue: average cell value of the grid (exclusive NoData-cells)
Key .histogram: histogram as java.util.SortedMapSortedMap, where the key specifies the histogram class and the value the cell count.
Key .cellCount: count of not NoData-cells

See also: de.schmitzm.geotools.grid.GridUtil.determineStatistic(GridCoverage2D, int, int, Integer), de.schmitzm.geotools.grid.GridUtil.determineZoneStatistic(GridCoverage2D, int, GridCoverage2D, int)

public class RasterStatisticsProcessor extends
net.simplace.util.pipeline.FWProcessor {
// Public Constructors
public RasterStatisticsProcessor();

// Constants
public static final String BASEMAP_KEY;
public static final String BASEMAP_KEY_DEFAULT;
public static final String ZONEMAP_KEY;
public static final String ZONEMAP_KEY_DEFAULT;
public static final String HISTOGRAM_STEPS;
// Public Instance Variables
public String iMapKey;
public String iZoneMapKey;
public int iHistogramSteps;

// Public Instance Methods

public boolean checkInParameterMap(); // Defines
net.simplace.util.pipeline.FWProcessor

Checks whether the in-parameter contains all required parameters.

// Protected Instance Methods

protected boolean process() throws PipeLineException; // Defines
net.simplace.util.pipeline.FWProcessor

Calculated the arithmetical rule specified by the in-channel parameters. First all in-channel parameters are checked.

aInObject some object (is not used!)

returns ever {@code true}

}

Hierarchy: java.lang.Object - net.simplace.util.pipeline.FWProcessor - RasterStatisticsProcessor