Source code for cars.conf.input_parameters

#!/usr/bin/env python
# coding: utf8
#
# Copyright (c) 2020 Centre National d'Etudes Spatiales (CNES).
#
# This file is part of CARS
# (see https://github.com/CNES/cars).
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""
This input module refers to parameters and configuration inputs
"""
# Standard imports
import json
import logging
import os
from typing import Any, Dict

# Third party imports
from json_checker import And, OptionalKey, Or

# CARS imports
from cars.core.inputs import rasterio_can_open
from cars.core.utils import make_relative_path_absolute

# tag for static conf file
STATIC_PARAMS_TAG = "static_parameters"

# Type for input configuration json
ConfigType = Dict[str, Any]




def read_input_parameters(filename: ConfigType) -> ConfigType:
    """
    Read an input parameters json file.
    Relative paths will be made absolute.

    :param filename: Path to json file
    :type filename: ConfigType

    :return: The dictionary read from file
    :rtype: ConfigType
    """
    config = {}
    with open(filename, "r", encoding="utf-8") as fstream:
        # Load json file
        config = json.load(fstream)
        json_dir = os.path.abspath(os.path.dirname(filename))
        # make potential relative paths absolute
        for tag in [
            IMG1_TAG,
            IMG2_TAG,
            MODEL1_TAG,
            MODEL2_TAG,
            MASK1_TAG,
            MASK2_TAG,
            COLOR1_TAG,
            SRTM_DIR_TAG,
        ]:
            if tag in config:
                config[tag] = make_relative_path_absolute(config[tag], json_dir)
    return config





def create_img_tag_from_product_key(product_key: str):
    """
    Create images tags from IMG_TAG_ROOT and the given product key
    :param product_key: PRODUCT1_KEY or PRODUCT2_KEY
    :return: IMG1_TAG or IMG2_TAG
    """
    if product_key not in [PRODUCT1_KEY, PRODUCT2_KEY]:
        logging.warning(
            "product_key shall be {} or {}".format(PRODUCT1_KEY, PRODUCT2_KEY)
        )

    return "{}{}".format(IMG_TAG_ROOT, product_key)





def create_model_tag_from_product_key(product_key: str):
    """
    Create images tags from MODEL_TAG_ROOT and the given product key
    :param product_key: PRODUCT1_KEY or PRODUCT2_KEY
    :return: MODEL1_TAG or MODEL2_TAG
    """
    if product_key not in [PRODUCT1_KEY, PRODUCT2_KEY]:
        logging.warning(
            "product_key shall be {} or {}".format(PRODUCT1_KEY, PRODUCT2_KEY)
        )
    return "{}{}".format(MODEL_TAG_ROOT, product_key)





def create_model_type_tag_from_product_key(product_key: str):
    """
    Create images tags from MODEL_TAG_ROOT and the given product key
    :param product_key: PRODUCT1_KEY or PRODUCT2_KEY
    :return: MODEL1_TAG or MODEL2_TAG
    """
    if product_key not in [PRODUCT1_KEY, PRODUCT2_KEY]:
        logger = logging.getLogger()
        logger.warning(
            "product_key shall be {} or {}".format(PRODUCT1_KEY, PRODUCT2_KEY)
        )
    return "{}{}".format(MODEL_TYPE_TAG_ROOT, product_key)



# tags for input parameters
INPUT_SECTION_TAG = "input"
PRODUCT1_KEY = "1"
PRODUCT2_KEY = "2"
IMG_TAG_ROOT = "img"
MODEL_TAG_ROOT = "model"
MODEL_TYPE_TAG_ROOT = "model_type"
IMG1_TAG = create_img_tag_from_product_key(PRODUCT1_KEY)
IMG2_TAG = create_img_tag_from_product_key(PRODUCT2_KEY)
MODEL1_TAG = create_model_tag_from_product_key(PRODUCT1_KEY)
MODEL2_TAG = create_model_tag_from_product_key(PRODUCT2_KEY)
MODEL1_TYPE_TAG = create_model_type_tag_from_product_key(PRODUCT1_KEY)
MODEL2_TYPE_TAG = create_model_type_tag_from_product_key(PRODUCT2_KEY)
SRTM_DIR_TAG = "srtm_dir"
COLOR1_TAG = "color1"
MASK1_TAG = "mask1"
MASK2_TAG = "mask2"
CLASSIFICATION1_TAG = "classification1"
CLASSIFICATION2_TAG = "classification2"
NODATA1_TAG = "nodata1"
NODATA2_TAG = "nodata2"
DEFAULT_ALT_TAG = "default_alt"
USE_EPIPOLAR_A_PRIORI = "use_epipolar_a_priori"
EPIPOLAR_A_PRIORI = "epipolar_a_priori"

# Schema for former input configuration json (TODO : remove)
INPUT_CONFIGURATION_SCHEMA = {
    IMG1_TAG: And(str, rasterio_can_open),
    IMG2_TAG: And(str, rasterio_can_open),
    OptionalKey(SRTM_DIR_TAG): And(str, Or(os.path.isfile, os.path.isdir)),
    OptionalKey(COLOR1_TAG): And(str, rasterio_can_open),
    OptionalKey(MASK1_TAG): And(str, rasterio_can_open),
    OptionalKey(MASK2_TAG): And(str, rasterio_can_open),
    OptionalKey(DEFAULT_ALT_TAG): float,
    OptionalKey(DEFAULT_ALT_TAG): float,
    NODATA1_TAG: int,
    NODATA2_TAG: int,
    OptionalKey(USE_EPIPOLAR_A_PRIORI): bool,
    OptionalKey(EPIPOLAR_A_PRIORI): dict,
}