xdem.coreg.AffineCoreg

class xdem.coreg.AffineCoreg(subsample=1.0, matrix=None, meta=None)

Generic affine coregistration class.

Builds additional common affine methods on top of the generic Coreg class. Made to be subclassed.

__init__(subsample=1.0, matrix=None, meta=None)

Instantiate a generic AffineCoreg method.

Methods

__init__([subsample, matrix, meta])	Instantiate a generic AffineCoreg method.
apply(elev[, bias_vars, resample, ...])	Apply the estimated transform to a DEM.
centroid()	Get the centroid of the coregistration, if defined.
copy()	Return an identical copy of the class.
error(reference_elev, to_be_aligned_elev[, ...])	Calculate the error of a coregistration approach.
fit(reference_elev, to_be_aligned_elev[, ...])	Estimate the coregistration transform on the given DEMs.
fit_and_apply(reference_elev, to_be_aligned_elev)	Estimate and apply the coregistration to a pair of elevation data.
from_matrix(matrix)	Instantiate a generic Coreg class from a transformation matrix.
from_translation([x_off, y_off, z_off])	Instantiate a generic Coreg class from a X/Y/Z translation.
residuals(reference_elev, to_be_aligned_elev)	Calculate the residual offsets (the difference) between two DEMs after applying the transformation.
to_matrix()	Convert the transform to a 4x4 transformation matrix.

Attributes

is_affine	Check if the transform be explained by a 3D affine transform.
meta	Metadata dictionary of the coregistration.