pandora2d.img_tools

This module contains functions associated to raster images.

Module Contents

Classes

Datasets

NamedTuple to store left and right datasets.

Functions

create_datasets_from_inputs(→ Datasets)	Read image and return the corresponding xarray.DataSet
check_disparities(→ None)	Do various check against disparities properties.
check_disparity_presence(input_config)	Check that disparity keys are not missing from input_config.
check_disparity_types(→ None)	Check that disparity is a Sequence of length 2.
check_min_max_disparity(→ None)	Check that min disparity is lower than max disparity.
add_left_disparity_grid(→ xarray.Dataset)	Add left disparity to dataset.
add_right_disparity_grid(→ xarray.Dataset)	Add right disparity to dataset.
add_disparity_grid(→ xarray.Dataset)	Add disparity to dataset
shift_img_pandora2d(→ xarray.Dataset)	Return a Dataset that contains the shifted right images
get_roi_processing(→ dict)	Return a roi which takes disparities into account

class pandora2d.img_tools.Datasets

Bases: NamedTuple

NamedTuple to store left and right datasets.

left: xarray.Dataset

right: xarray.Dataset

pandora2d.img_tools.create_datasets_from_inputs(input_config: Dict, roi: Dict = None) → Datasets

Read image and return the corresponding xarray.DataSet

Parameters:

• input_config (dict) – configuration used to create dataset.

• roi (dict) –

  dictionary with a roi

  ”col”: {“first”: <value - int>, “last”: <value - int>}, “row”: {“first”: <value - int>, “last”: <value - int>}, “margins”: [<value - int>, <value - int>, <value - int>, <value - int>]

  with margins : left, up, right, down

Returns:

Datasets NamedTuple with two attributes left and right each containing a xarray.DataSet containing the variables :

• im: 2D (row, col) or 3D (band_im, row, col) xarray.DataArray float32

• col_disparity: 3D (disp, row, col) xarray.DataArray float32

• row_disparity: 3D (disp, row, col) xarray.DataArray float32

Return type:

Datasets

pandora2d.img_tools.check_disparities(input_config: Dict) → None

Do various check against disparities properties.

Parameters:

input_config – configuration used to create dataset.

Raises:

SystemExit – If any check fails.

pandora2d.img_tools.check_disparity_presence(input_config)

Check that disparity keys are not missing from input_config.

Parameters:

input_config – configuration used to create dataset.

Raises:

SystemExit – if one or both keys are missing

pandora2d.img_tools.check_disparity_types(disparity: Any) → None

Check that disparity is a Sequence of length 2. :param disparity: disparity to check :type disparity: Any

Raises:

SystemExit – if it does not meet requirements

pandora2d.img_tools.check_min_max_disparity(disparity: List[int]) → None

Check that min disparity is lower than max disparity.

Parameters:

disparity (List[int]) – disparity to check

Raises:

SystemExit – if min > max

pandora2d.img_tools.add_left_disparity_grid(dataset: xarray.Dataset, configuration: Dict) → xarray.Dataset

Add left disparity to dataset.

Parameters:

• dataset (xr.Dataset) – dataset to add disparity grid to

• configuration (Dict) – configuration with information about disparity

Returns:

dataset : updated dataset

Return type:

xr.Dataset

pandora2d.img_tools.add_right_disparity_grid(dataset: xarray.Dataset, configuration: Dict) → xarray.Dataset

Add right disparity to dataset.

Parameters:

• dataset (xr.Dataset) – dataset to add disparity grid to

• configuration (Dict) – configuration with information about disparity

Returns:

dataset : updated dataset

Return type:

xr.Dataset

pandora2d.img_tools.add_disparity_grid(dataset: xarray.Dataset, col_disparity: List[int], row_disparity: List[int]) → xarray.Dataset

Add disparity to dataset

Parameters:

• dataset (xr.Dataset) – xarray dataset

• col_disparity (List of ints) – Disparity interval for columns

• row_disparity (List of ints) – Disparity interval for rows

Returns:

dataset : updated dataset

Return type:

xr.Dataset

pandora2d.img_tools.shift_img_pandora2d(img_right: xarray.Dataset, dec_row: int) → xarray.Dataset

Return a Dataset that contains the shifted right images

Parameters:

• img_right (xr.Dataset) – right Dataset image containing : - im : 2D (row, col) xarray.Datasat

• dec_row (int) – the value of shifting for dispy

Returns:

img_right_shift: Dataset containing the shifted image

Return type:

xr.Dataset

pandora2d.img_tools.get_roi_processing(roi: dict, col_disparity: List[int], row_disparity: List[int]) → dict

Return a roi which takes disparities into account

Parameters:

• roi (Dict) –

  roi in config file

  ”col”: {“first”: <value - int>, “last”: <value - int>}, “row”: {“first”: <value - int>, “last”: <value - int>}, “margins”: [<value - int>, <value - int>, <value - int>, <value - int>] with margins : left, up, right, down

• col_disparity (List[int]) – min and max disparities for columns.

• row_disparity (List[int]) – min and max disparities for rows.