xdem.coreg.Coreg.fit#
- Coreg.fit(reference_elev, to_be_aligned_elev, inlier_mask=None, bias_vars=None, weights=None, subsample=None, transform=None, crs=None, z_name='z', verbose=False, random_state=None, **kwargs)[source]#
Estimate the coregistration transform on the given DEMs.
- Parameters:
reference_elev (
Union[ndarray[Any,dtype[floating[Any]]],MaskedArray[Any,dtype[floating[Any]]],TypeVar(RasterType, bound= Raster),GeoDataFrame]) – Reference elevation, either a DEM or an elevation point cloud.to_be_aligned_elev (
Union[ndarray[Any,dtype[floating[Any]]],MaskedArray[Any,dtype[floating[Any]]],TypeVar(RasterType, bound= Raster),GeoDataFrame]) – To-be-aligned elevation, either a DEM or an elevation point cloud.inlier_mask (
ndarray[Any,dtype[bool_]] |Mask|None) – Mask or boolean array of areas to include (inliers=True).bias_vars (
dict[str,Union[ndarray[Any,dtype[floating[Any]]],MaskedArray[Any,dtype[floating[Any]]],TypeVar(RasterType, bound= Raster)]] |None) – Auxiliary variables for certain bias correction classes, as raster or arrays.weights (
ndarray[Any,dtype[floating[Any]]] |None) – Array of weights for the coregistration.subsample (
float|int|None) – Subsample the input to increase performance. <1 is parsed as a fraction. >1 is a pixel count.transform (
Affine|None) – Transform of the reference elevation, only if provided as 2D array.crs (
CRS|None) – CRS of the reference elevation, only if provided as 2D array.z_name (
str) – Column name to use as elevation, only for point elevation data passed as geodataframe.verbose (
bool) – Print progress messages.random_state (
None|RandomState|Generator|int) – Random state or seed number to use for calculations (to fix random sampling).
- Return type:
TypeVar(CoregType, bound= Coreg)