cars 1.0.0rc3__cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

cars/cars.py

@@ -0,0 +1,179 @@
+#!/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.
+#
+"""
+Main CARS Command Line Interface
+user main argparse wrapper to CARS 3D pipelines submodules
+"""
+
+# Standard imports
+# TODO refactor but keep local functions for performance and remove pylint
+# pylint: disable=import-outside-toplevel
+import argparse
+import json
+import logging
+import os
+import sys
+import warnings
+
+import yaml
+
+# CARS imports
+from cars import __version__
+from cars.core import cars_logging
+from cars.orchestrator.cluster import log_wrapper
+
+
+def cars_parser() -> argparse.ArgumentParser:
+    """
+    Main CLI argparse parser function
+    It builds argparse objects and constructs CLI interfaces parameters.
+
+    :return: CARS arparse CLI interface object
+    """
+    # Create cars cli parser from argparse
+    # use @file to use a file containing parameters
+    parser = argparse.ArgumentParser(
+        "cars", description="CARS: CNES Algorithms to Reconstruct Surface"
+    )
+
+    parser.add_argument("conf", type=str, help="Inputs Configuration File")
+
+    parser.add_argument(
+        "--loglevel",
+        default="PROGRESS",
+        choices=("DEBUG", "INFO", "PROGRESS", "WARNING", "ERROR", "CRITICAL"),
+        help="Logger level (default: WARNING. Should be one of "
+        "(DEBUG, INFO, PROGRESS, WARNING, ERROR, CRITICAL)",
+    )
+
+    # General arguments at first level
+    parser.add_argument(
+        "--version",
+        "-v",
+        action="version",
+        version="%(prog)s {version}".format(version=__version__),
+    )
+
+    return parser
+
+
+def main_cli(args, dry_run=False):  # noqa: C901
+    """
+    Main for command line management
+
+    :param dry_run: activate only arguments checking
+    """
+
+    # TODO : refactor in order to avoid a slow argparse
+    # Don't move the local function imports for now
+
+    # Main try/except to catch all program exceptions
+    from cars.pipelines.pipeline import Pipeline
+
+    try:
+        # Check file extension and load configuration
+        config_path = args.conf
+        ext = os.path.splitext(config_path)[1].lower()
+        if ext == ".json":
+            with open(config_path, "r", encoding="utf8") as fstream:
+                config = json.load(fstream)
+        elif ext in [".yaml", ".yml"]:
+            with open(config_path, "r", encoding="utf8") as fstream:
+                config = yaml.safe_load(fstream)
+        else:
+            raise ValueError("Configuration file must be .json or .yaml/.yml")
+
+        # Cars 0.9.0 API change, check if the configfile seems to use the old
+        # API by looking for the deprecated out_dir key
+        # TODO this check can be removed after cars 0.10.0
+        if config.get("output", {}).get("out_dir"):
+
+            # throw an exception if both out_dir and directory are defined
+            if "directory" in config["output"]:
+                raise RuntimeError("both directory and out_dir keys defined")
+            # stacklevel -> main_cli()
+            warnings.warn(
+                "Deprecated key 'out_dir' found in output configuration. "
+                "Replacing it with key 'directory'",
+                FutureWarning,
+                stacklevel=2,
+            )
+            config["output"]["directory"] = config["output"]["out_dir"]
+            del config["output"]["out_dir"]
+
+        config_dir = os.path.abspath(os.path.dirname(config_path))
+        pipeline_name = config.get("pipeline", "default")
+
+        if not isinstance(pipeline_name, str):
+            pipeline_name = "default"
+
+        # Logging configuration with args Loglevel
+        loglevel = getattr(args, "loglevel", "PROGRESS").upper()
+        out_dir = config["output"]["directory"]
+
+        cars_logging.setup_logging(
+            loglevel,
+            out_dir=os.path.join(out_dir, "logs"),
+            pipeline=pipeline_name,
+        )
+
+        logging.debug("Show argparse arguments: {}".format(args))
+
+        # Generate pipeline and check conf
+        cars_logging.add_progress_message("Check configuration...")
+        used_pipeline = Pipeline(pipeline_name, config, config_dir)
+        cars_logging.add_progress_message("CARS pipeline is started.")
+        if not dry_run:
+            # run pipeline
+            used_pipeline.run(args)
+
+        # Generate summary of tasks
+        if pipeline_name != "default":
+            log_wrapper.generate_summary(
+                os.path.join(out_dir, "logs"),
+                used_pipeline.used_conf,
+                config["pipeline"],
+                clean_worker_logs=True,
+            )
+
+        cars_logging.add_progress_message(
+            "CARS has successfully completed the pipeline."
+        )
+
+    except BaseException:
+        # Catch all exceptions, show debug traceback and exit
+        logging.exception("CARS terminated with following error")
+        sys.exit(1)
+
+
+def main():
+    """
+    Main initial cars cli entry point
+    Configure and launch parser before main_cli function
+    """
+    # CARS parser
+    parser = cars_parser()
+    args = parser.parse_args(args=None if sys.argv[1:] else ["--help"])
+    main_cli(args)
+
+
+if __name__ == "__main__":
+    main()

cars/conf/__init__.py

@@ -0,0 +1,23 @@
+#!/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.
+#
+"""
+CARS conf module init file
+"""

cars/conf/geoid/egm96.grd.hdr

@@ -0,0 +1,15 @@
+ENVI
+samples = 1441
+lines   = 721
+bands   = 1
+header offset = 24
+file type = ENVI Standard
+data type = 4
+interleave = bsq
+sensor type = Unknown
+byte order = 1
+wavelength units = Unknown
+map info = {Geographic Lat/Lon, 1, 1,-0.125, 90.125, 0.25, 0.25,WGS-84}
+coordinate system string = {GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]}
+band names = {
+Band 1}

cars/conf/input_parameters.py

@@ -0,0 +1,156 @@
+#!/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,
+}

cars/conf/mask_cst.py

@@ -0,0 +1,35 @@
+#!/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.
+#
+"""
+CARS mask module
+"""
+
+# Standard imports
+
+
+# CARS imports
+
+# Specific values
+# 0 = valid pixels
+# 255 = value used as no data during the rectification in the epipolar geometry
+VALID_VALUE = 0
+NO_DATA_IN_EPIPOLAR_RECTIFICATION = 255
+PROTECTED_VALUES = [NO_DATA_IN_EPIPOLAR_RECTIFICATION]

cars/core/__init__.py

@@ -0,0 +1,23 @@
+#!/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.
+#
+"""
+CARS core module init file
+"""