PixEx Operator Description

Overview

Name:	`PixEx`
Full name:	`org.esa.snap.pixex.PixExOp`
Purpose:	Extracts pixels from given locations and source products.
Version:	1.3

Description

This operator is used to extract pixels from given locations and source products. It can also create sub-scenes containing all locations found in the source products and create KMZ files which contain the locations found in a source product.

Sources

Name	Description
`sourceProducts`	The source products from which pixels shall be extracted.

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).
`exportBands`	`Boolean`	`true`	Specifies if bands are to be exported
`exportTiePoints`	`Boolean`	`true`	Specifies if tie-points are to be exported
`exportMasks`	`Boolean`	`true`	Specifies if masks are to be exported
`coordinates`	`Coordinate[]`		The geo-coordinates
`timeDifference`	`String`		The acceptable time difference compared to the time given for a coordinate. The format is a number followed by (D)ay, (H)our or (M)inute. If no time difference is provided, all input products are considered regardless of their time.
`coordinatesFile`	`File`		Path to a file containing geo-coordinates. BEAM's placemark files can be used.
`matchupFile`	`File`		Path to a CSV-file containing geo-coordinates associated with measurements accordingto BEAM CSV format specification
`windowSize`	`Integer`	`1`	Side length of surrounding window (uneven)
`outputDir`	`File`		The output directory.	not null
`outputFilePrefix`	`String`	`pixEx`	The prefix is used to name the output files.
`expression`	`String`		Band maths expression (optional). Defines valid pixels.
`exportExpressionResult`	`Boolean`	`true`	If true, the expression result is exported per pixel, otherwise the expression is used as filter (all pixels in given window must be valid).
`aggregatorStrategyType`	`String`	`no aggregation`	If the window size is larger than 1, this parameter describes by which method a single value shall be derived from the pixels.	value set: [no aggregation, mean, min, max, median]
`exportSubScenes`	`boolean`	`false`	If set to true, sub-scenes of the regions, where pixels are found, are exported.
`subSceneBorderSize`	`int`	`0`	An additional border around the region where pixels are found.
`exportKmz`	`boolean`	`false`	If set to true, a Google KMZ file will be created, which contains the coordinates where pixels are found.
`extractTimeFromFilename`	`boolean`	`false`	If set to true, the sensing start and sensing stop should be extracted from the filename of each input product.
`dateInterpretationPattern`	`String`	`yyyyMMdd`	Describes how a date/time section inside a product filename should be interpreted. E.G. yyyyMMdd_HHmmss
`filenameInterpretationPattern`	`String`	`${startDate}${endDate}*`	Describes how the filename of a product should be interpreted.
`includeOriginalInput`	`boolean`	`false`	Determines if the original input measurements shall be included in the output.
`scatterPlotVariableCombinations`	`VariableCombination[]`		Array of 2-tuples of variable names; for each of these tuples a scatter plot will be exported.