Binning Operator Description

Overview

Name:	`Binning`
Full name:	`org.esa.beam.binning.operator.BinningOp`
Purpose:	Performs spatial and temporal aggregation of pixel values into 'bin' cells
Version:	0.8.2

Description

An operator that is used to perform spatial and temporal aggregations into "bin" cells for any number of source product. The output is either a file comprising the resulting bins or a reprojected "map" of the bin cells represented by a usual data product.

Unlike most other operators, that can compute single {@link org.esa.beam.framework.gpf.Tile tiles}, the binning operator processes all of its source products in its {@link #initialize()} method.

Sources

Name	Description
`sourceProducts`	The source products to be binned. Must be all of the same structure. If not given, the parameter 'sourceProductPaths' must be provided.

Parameters

Name	Data Type	Default	Description	Constraints
`sourceProductPaths`	`String[]`		A comma-separated list of file paths specifying the source products. Each path may contain the wildcards '*' (matches recursively any directory), '' (matches any character sequence in path names) and '?' (matches any single character).
`region`	`Geometry`		The considered geographical region as a geometry in well-known text format (WKT). If not given, the geographical region will be computed according to the extents of the input products.
`startDate`	`String`		The start date. If not given, taken from the 'oldest' source product. Products that have a start date before the start date given by this parameter are not considered.	format: yyyy-MM-dd
`endDate`	`String`		The end date. If not given, taken from the 'youngest' source product. Products that have an end date after the end date given by this parameter are not considered.	format: yyyy-MM-dd
`outputBinnedData`	`boolean`	`true`	If true, a SeaDAS-style, binned data NetCDF file is written in addition to the target product. The output file name will be -bins.nc
`outputTargetProduct`	`boolean`	`true`	If true, a target is product. Set this to 'false' if only a binned product is needed.
`binningConfig`	`BinningConfig`		The configuration used for the binning process. Specifies the binning grid, any variables and their aggregators.	not null
`formatterConfig`	`FormatterConfig`		The configuration used for the output formatting process.	not null
`metadataPropertiesFile`	`File`	`./metadata.properties`	The name of the file containing metadata key-value pairs (google "Java Properties file format").
`metadataTemplateDir`	`File`	`.`	The name of the directory containing metadata templates (google "Apache Velocity VTL format").
`useSpatialDataDay`	`boolean`	`false`	Applies a sensor-dependent, spatial data-day definition to the given time range. The decision, whether a source pixel contributes to a bin or not, is a functions of the pixel's observation longitude and time.If true, the parameters 'startDate', 'endDate' must also be given.
`minDataHour`	`Double`		The time in hours of a day (0 to 24) at which a given sensor has a minimum number of observations at the date line (the 180 degree meridian). Only used if parameters 'startDate' and 'useSpatialDataDay' are set.