pandora2d.estimation.estimation

This module contains functions associated to the estimation computation step.

Classes

AbstractEstimation

Abstract Estimation class

Module Contents

class pandora2d.estimation.estimation.AbstractEstimation

Abstract Estimation class

__metaclass__

estimation_methods_avail: dict

_estimation_method = None

cfg: dict | None = None

classmethod register_subclass(short_name: str) → collections.abc.Callable[[type[Self]], type[Self]]

Allows to register the subclass with its short name

Parameters:

short_name – the subclass to be registered

desc() → None

Describes the estimation method :return: None

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

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

Return:row disparity:

Dict col disparity: Dict Calculated shifts: list Extra information about estimation : dict

static update_cfg_with_estimation(cfg: dict, disp_col: dict, disp_row: dict, shifts: numpy.ndarray, extra_dict: dict = None) → dict

Save calculated shifts in a configuration dictionary

Parameters:

• cfg – user configuration

• disp_col – dict with init and range for disparity in column

• disp_row – dict with init and range for disparity in row

• shifts – computed global shifts between left and right

• extra_dict – Dictionary containing extra information about estimation

Returns:

cfg: global configuration