pandora2d.estimation.phase_cross_correlation

This module contains functions associated to the phase cross correlation method used in the estimation step.

Classes

PhaseCrossCorrelation

PhaseCrossCorrelation class allows to perform estimation

Module Contents

class pandora2d.estimation.phase_cross_correlation.PhaseCrossCorrelation(cfg: dict)[source]

Bases: pandora2d.estimation.estimation.AbstractEstimation

PhaseCrossCorrelation class allows to perform estimation

_RANGE_COL = 5[source]

_RANGE_ROW = 5[source]

_SAMPLE_FACTOR = 1[source]

cfg[source]

_range_col[source]

_range_row[source]

_sample_factor[source]

_estimation_method[source]

check_conf(cfg: dict) → dict[source]

Check the estimation configuration

Parameters:: cfg – user_config for refinement
Returns:: cfg: global configuration

compute_estimation(img_left: xarray.Dataset, img_right: xarray.Dataset) → tuple[dict, dict, numpy.ndarray, dict][source]

Compute the phase cross correlation method

Parameters:

img_left – xarray.Dataset containing : - im : 2D (row, col) xarray.DataArray
img_right – xarray.Dataset containing : - im : 2D (row, col) xarray.DataArray

Returns:

row disparity: list col disparity: list Calculated shifts: np.ndarray Extra information about estimation: dict