xdem.coreg.Tilt

xdem.coreg.Tilt#

class xdem.coreg.Tilt(subsample=500000.0)[source]#

Tilt alignment.

Estimates an 2-D plan correction between the difference of two elevation datasets. This is close to a rotation alignment at small angles, but introduces a scaling at large angles.

The tilt parameters are stored in the self.meta key “fit_parameters”, with associated polynomial function in the key “fit_func”.

__init__(subsample=500000.0)[source]#

Instantiate a tilt correction object.

Parameters:

subsample (int | float) – Subsample the input for speed-up. <1 is parsed as a fraction. >1 is a pixel count.

Methods

__init__([subsample])

Instantiate a tilt correction object.

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.