FXYSum.Linear (SNAP Engine API)

java.lang.Object
- org.esa.snap.core.util.math.FXYSum
- - org.esa.snap.core.util.math.FXYSum.Linear

Enclosing class:

FXYSum
```
public static final class FXYSum.Linear
extends FXYSum
```
Provides an optimized computeZ method for linear polynomials (order = 1).

See Also:

FXYSum.FXY_LINEAR

Nested Class Summary
- Nested classes/interfaces inherited from class org.esa.snap.core.util.math.FXYSum
  FXYSum.BiCubic, FXYSum.BiLinear, FXYSum.BiQuadric, FXYSum.Cubic, FXYSum.Linear, FXYSum.Quadric

Field Summary
- Fields inherited from class org.esa.snap.core.util.math.FXYSum
  FXY_4TH, FXY_BI_4TH, FXY_BI_CUBIC, FXY_BI_LINEAR, FXY_BI_QUADRATIC, FXY_CUBIC, FXY_LINEAR, FXY_QUADRATIC

Constructor Summary

Constructors
Constructor Description

Linear()

Linear(double[] coefficients)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`computeZ(double x, double y)`	Computes this sum of function terms z(x,y) = sum(c[i] f[i](x,y), i=0, n-1)*.

Methods inherited from class org.esa.snap.core.util.math.FXYSum
appendCFunctionCodeBody, appendCFunctionCodeEnd, appendCFunctionCodePart, appendCFunctionCodeStart, approximate, computeZ, createCFunctionCode, createCopy, createFXYSum, getCoefficients, getFunctions, getMaxError, getNumTerms, getOrder, getRootMeanSquareError

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Linear
```
public Linear()
```
  - Linear
```
public Linear(double[] coefficients)
```
- Method Detail
  - computeZ
```
public double computeZ(double x,
                       double y)
```
    Description copied from class: FXYSum
    
    Computes this sum of function terms z(x,y) = sum(c[i] * f[i](x,y), i=0, n-1). The method will return zero unless the FXYSum.approximate(double[][], int[]) is called in order to set the coefficient vector c.
    
    Overrides:
    
    computeZ in class FXYSum
    
    Parameters:
    
    x - the x value
    
    y - the y value
    
    Returns:
    
    the z value
    
    See Also:
    
    FXYSum.computeZ(FXY[], double[], double, double)