Collocate Operator Description

Overview

Name:	`Collocate`
Full name:	`org.esa.snap.collocation.CollocateOp`
Purpose:	Collocates two products based on their geo-codings.
Version:	1.2

Description

This operator is used to spatially collocate two data products. It requires two source products, a {@code master} product which provides the Coordinate reference system and grid into which the raster data sets of the {@code slave} product are resampled to.

Sources

Name	Description
`master`	The source product which serves as master.
`slaveProduct`	The source product which serves as slave.
`sourceProducts`	The source product which serves as slave.

Parameters

Name	Data Type	Default	Description
`sourceProductPaths`	`String[]`		A comma-separated list of file paths specifying the source products
`masterProductName`	`String`		The name of the master product.
`targetProductName`	`String`	`_collocated`	The name of the target product
`targetProductType`	`String`	`COLLOCATED`	The product type string for the target product (informal)
`copySecondaryMetadata`	`boolean`	`false`	Copies also the metadata of the secondary (slave) products to the target
`renameMasterComponents`	`boolean`	`true`	Whether or not components of the master product shall be renamed in the target product.
`renameSlaveComponents`	`boolean`	`true`	Whether or not components of the slave product shall be renamed in the target product.
`masterComponentPattern`	`String`	`${ORIGINAL_NAME}_M`	The text pattern to be used when renaming master components.
`slaveComponentPattern`	`String`	`${ORIGINAL_NAME}_S${SLAVE_NUMBER_ID}`	The text pattern to be used when renaming slave components.
`resamplingType`	`ResamplingType`	`NEAREST_NEIGHBOUR`	The method to be used when resampling the slave grid onto the master grid.