pandora2d.matching_cost.pandora

This module contains functions associated to the matching cost computation step.

Classes

PandoraMatchingCostMethods

Matching Cost class

Module Contents

class pandora2d.matching_cost.pandora.PandoraMatchingCostMethods(cfg: dict)[source]

Bases: pandora2d.matching_cost.base.BaseMatchingCost

Matching Cost class

pandora_matching_cost_[source]

grid: xarray.Dataset | None = None[source]

property cfg: dict[str, str | int | list[int]][source]

Get used configuration

Returns:: cfg: dictionary with all parameters

property schema[source]

check_conf(cfg: dict) → dict[str, str][source]: Check the matching cost configuration and raise error if float precision is float64

property window_size: int[source]

Get window_size, parameter specific to pandora

Returns:: window_size: window used to compute correlation

property _subpix: int[source]

Get subpix, parameter specific to pandora

Returns:: subpix: subpix used

property _spline_order: int[source]

Get spline_order, parameter specific to pandora

Returns:: spline_order: spline_order used

property margins: pandora.margins.Margins[source]: Get margins from pandora correlation measurement

get_config_for_pandora(cfg: dict) → dict[str, str][source]

Get configuration for matching_cost in pandora

Parameters:: cfg – user_config for matching cost pandora2d
Returns:: cfg: matching cost pandora configuration

allocate(img_left: xarray.Dataset, img_right: xarray.Dataset, cfg: dict, margins: pandora2d.margins.Margins = None) → None[source]

Allocate the cost volume for pandora

Parameters:

img_left – xarray.Dataset containing : - im : 2D (row, col) xarray.DataArray - msk : 2D (row, col) xarray.DataArray
img_right – xarray.Dataset containing : - im : 2D (row, col) xarray.DataArray - msk : 2D (row, col) xarray.DataArray
cfg – matching_cost computation configuration
margins – refinement margins

Returns:

None

set_shifted_right_images(img_right: xarray.Dataset) → None[source]

Compute shifted by subpix right image and assign shifted_right_images attribute.

Parameters:: img_right – xarray.Dataset containing : - im : 2D (row, col) xarray.DataArray - msk : 2D (row, col) xarray.DataArray
Returns:: None

compute_cost_volumes(img_left: xarray.Dataset, img_right: xarray.Dataset, margins: pandora2d.margins.Margins = None) → xarray.Dataset[source]

Computes the cost volumes

Parameters:

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

Returns:

cost_volumes: 4D Dataset containing the cost_volumes