pyPoly2d¶
Poly2d is a data structure meant to capture 1D functions of the form
where
\(N_y\) and \(N_x\) are the orders of the polynomial in azimuth (y) and range (x).
\(\mu_y\) and \(\mu_x\) are the means.
\(\sigma_y\) and \(\sigma_x\) are the norms.
\([c_{00}, c_{01}, ..., c_{N_yN_x}]\) is the set of coefficients.
Factory¶
from isce3.core import poly2d
obj = poly2d(**kwds)
Documentation¶
-
class
isce3.core.Poly2d.Poly2d¶ Wrapper for pyPoly2d.
-
azimuthMean¶ Return azimuth mean.
- Returns
azimuth mean of the polynomial.
- Return type
float
-
azimuthNorm¶ Return azimuth norm.
- Returns
azimuth norm
- Return type
float
-
azimuthOrder¶ Returns azimuth order.
- Returns
Azimuth order of polynomial
- Return type
int
-
static
bind(pyPoly2d poly)¶ Creates a pyPoly2d object that acts as a reference to an existing pyPoly2d instance.
-
coeffs¶ Return polynomial coefficients.
Note
This method returns an actual reference to the array of coefficients. Modifying contents will affect data at C++ level and deleting the C++ datastructure will impact the returned array.
- Returns
List of coefficients
- Return type
numpy.array
-
dPrint()¶ Debug print of underlying C++ structure.
- Returns
None
-
eval(double azi, double rng)¶ Evaluate polynomial at given point.
- Parameters
azi (float) – Azimuth coordinate
rng (float) – Range coordinate
- Returns
Value of polynomial at (azi, rng)
- Return type
float
-
getCoeff(int row, int col)¶ Get polynomial coefficient using row and col indices.
- Parameters
row (int) – Index in azimuth direction
col (int) – Index in range direction
- Returns
Value of coefficient
- Return type
float
-
printPoly()¶ Debug print function of underlying C++ structure.
-
rangeMean¶ Return range mean.
- Returns
range mean
- Return type
float
-
rangeNorm¶ Return range norm
- Returns
range norm
- Return type
float
-
rangeOrder¶ Return the range order of polynomial.
- Returns
Range order of polynomial.
- Return type
int
-
setCoeff(int row, int col, double val)¶ Set polynomial coefficient using row and col indices.
- Parameters
row (int) – Index in azimuth direction
col (int) – Index in range direction
val (float) – Value of coefficient
- Returns
None
-