org.esa.snap.core.dataop.barithm

Class StandardUncertaintyGenerator

java.lang.Object

org.esa.snap.core.dataop.barithm.StandardUncertaintyGenerator

All Implemented Interfaces:

UncertaintyGenerator

public class StandardUncertaintyGenerator
extends Object
implements UncertaintyGenerator

Implementation of an UncertaintyGenerator which generates the Standard Combined Uncertainty according to JCGM 100:2008 (GUM 1995), Chapter 5.

Since:

SNAP 2

Constructor Summary

Constructors

Constructor and Description
StandardUncertaintyGenerator()
StandardUncertaintyGenerator(int order, boolean optimize)

Method Summary

Modifier and Type	Method and Description
String	generateUncertainty(Product product, String relation, String expression) Generates the combined uncertainty for a given band maths expression.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandardUncertaintyGenerator

public StandardUncertaintyGenerator()

StandardUncertaintyGenerator

public StandardUncertaintyGenerator(int order,
                                    boolean optimize)

Method Detail

generateUncertainty

public String generateUncertainty(Product product,
                                  String relation,
                                  String expression)
                           throws ParseException,
                                  UnsupportedOperationException

Description copied from interface: UncertaintyGenerator

Generates the combined uncertainty for a given band maths expression.

Specified by:

generateUncertainty in interface UncertaintyGenerator

Parameters:

product - The data product that serves the referenced rasters in the expression.

relation - Relation name of ancillary variables that represent uncertainties (NetCDF-U 'rel' attribute).

expression - The band maths expression.

Returns:

A new band maths expression representing the combined uncertainty.

Throws:

ParseException

UnsupportedOperationException

See Also:

RasterDataNode.addAncillaryVariable(RasterDataNode, String...), RasterDataNode.setAncillaryRelations(String...)