cars 1.0.0rc1__cp313-cp313-musllinux_1_2_i686.whl

cars/pipelines/parameters/sensor_loaders/slurp_classif_loader.py

@@ -0,0 +1,86 @@
+# !/usr/bin/env python
+# coding: utf8
+#
+# Copyright (c) 2024 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 module contains the ClassifSensorLoader class.
+"""
+
+from json_checker import Checker
+
+from cars.core import inputs
+from cars.core.utils import make_relative_path_absolute
+from cars.pipelines.parameters import sensor_inputs_constants as sens_cst
+from cars.pipelines.parameters.sensor_loaders.pivot_classif_loader import (
+    PivotClassifSensorLoader,
+)
+from cars.pipelines.parameters.sensor_loaders.sensor_loader import SensorLoader
+from cars.pipelines.parameters.sensor_loaders.sensor_loader_template import (
+    SensorLoaderTemplate,
+)
+
+
+@SensorLoader.register("slurp_classification")
+class SlurpClassifSensorLoader(SensorLoaderTemplate):
+    """
+    SLURP sensor loader
+    """
+
+    def check_conf(self, conf):
+        """
+        Check configuration
+
+        :param conf: configuration to check
+
+        :return: overloaded configuration
+        :rtype: dict
+        """
+        if isinstance(conf, str):
+            overloaded_conf = {}
+            image_path = make_relative_path_absolute(conf, self.config_dir)
+            overloaded_conf[sens_cst.INPUT_PATH] = image_path
+        else:
+            raise TypeError(f"Input {conf} is not a string")
+
+        sensor_schema = {
+            sens_cst.INPUT_PATH: str,
+        }
+
+        # Check conf
+        checker = Checker(sensor_schema)
+        checker.validate(overloaded_conf)
+
+        return overloaded_conf
+
+    def set_pivot_format(self):
+        """
+        Transform input configuration to pivot format and store it
+        """
+        pivot_config = {
+            sens_cst.INPUT_PATH: self.used_config[sens_cst.INPUT_PATH],
+        }
+        pivot_config["values"] = inputs.rasterio_get_classif_values(
+            self.used_config[sens_cst.INPUT_PATH]
+        )
+        # Remove value 0 because it corresponds to unclassified data
+        pivot_config["values"].remove(0)
+        pivot_sensor_loader = PivotClassifSensorLoader(
+            pivot_config, self.config_dir
+        )
+        self.pivot_format = pivot_sensor_loader.get_pivot_format()

cars/pipelines/pipeline.py

@@ -0,0 +1,119 @@
+#!/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 module contains class pipeline factory.
+"""
+
+import logging
+from typing import Dict, Union
+
+
+class Pipeline:
+    """
+    Pipeline factory:
+    A class designed for registered all available Cars Pipeline and
+    instantiate when needed.
+
+    """
+
+    # Dict (pipeline_name:str, class: object) containing registered
+    # pipelines
+    available_pipeline = {}
+
+    def __new__(
+        cls,
+        pipeline_name: str,
+        cfg: Dict[str, Union[str, int]],
+        config_dir,
+    ):
+        """
+        Return the instance of pipeline associated with the pipeline
+        name given as parameter
+
+        :param pipeline_name: name of the pipeline.
+        :type pipeline_name: str
+        :param cfg: configuration {'matching_cost_method': value}
+        :type cfg: dictionary
+        :param config_dir: path to dir containing json or yaml file
+        :type config_dir: str
+        """
+
+        return cls.create_pipeline(pipeline_name, cfg, config_dir)
+
+    @classmethod
+    def create_pipeline(
+        cls, name: str, cfg: Dict[str, Union[str, int]], config_dir
+    ):
+        """Factory command to create the pipeline
+        Return the instance of pipeline associated with the pipeline
+        name given as parameter
+
+        :param pipeline_name: name of the pipeline.
+        :type pipeline_name: str
+        :param cfg: cars input configuration
+        :type cfg: dictionary
+        :param config_dir: path to dir containing json
+        :type config_dir: str
+        """
+
+        pipeline = None
+        try:
+            pipeline_class = cls.available_pipeline[name]
+
+        except KeyError as kerr:
+            logging.error("No pipeline named {0} supported".format(name))
+            raise NameError(
+                "No pipeline named {0} supported".format(name)
+            ) from kerr
+
+        pipeline = pipeline_class(cfg, config_dir)
+
+        return pipeline
+
+    @classmethod
+    def print_available_pipelines(cls):
+        """
+        Print all registered pipelines
+        """
+
+        for pipeline_name in cls.available_pipeline:
+            print(pipeline_name)
+
+    @classmethod
+    def register(cls, *pipeline_names: str):
+        """
+        Allows to register the pipeline with its name
+        :param pipeline_name: the pipelines to be registered
+        :type pipeline_name: string
+        """
+
+        def decorator(app):
+            """
+            Registers the class in the available methods
+            :param app: the app class to be registered
+            :type app: object
+            """
+            for pipeline_name in pipeline_names:
+                cls.available_pipeline[pipeline_name] = app
+            return app
+
+        return decorator

cars/pipelines/pipeline_constants.py

@@ -0,0 +1,31 @@
+#!/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 module contains the constants used for all pipelines
+"""
+
+# Sensor input
+
+INPUT = "input"
+OUTPUT = "output"
+APPLICATIONS = "applications"
+ADVANCED = "advanced"
+ORCHESTRATOR = "orchestrator"

cars/pipelines/pipeline_template.py

@@ -0,0 +1,139 @@
+#!/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 module contains class pipeline template for
+templating the pipeline concept.
+"""
+
+from abc import ABCMeta, abstractmethod
+
+from json_checker import Checker, OptionalKey
+
+# CARS imports
+from cars.orchestrator import orchestrator
+from cars.pipelines import pipeline_constants
+
+# Disable pylint error: too few public method
+
+
+class PipelineTemplate(metaclass=ABCMeta):  # pylint: disable=R0903
+    """
+    Class for general specification of an pipeline
+    """
+
+    def check_orchestrator(self, conf):
+        """
+        Check the configuration of orchestrator
+
+        :param conf: configuration of orchestrator
+        :type conf: dict
+        :return: overloaded orchestrator conf
+        :rtype: dict
+        """
+
+        with orchestrator.Orchestrator(
+            orchestrator_conf=conf, out_dir=None, launch_worker=False
+        ) as orchestrator_obj:
+            conf = orchestrator_obj.get_conf()
+        return conf
+
+    def check_global_schema(self, conf):
+        """
+        Check the given global configuration
+
+        :param conf: configuration
+        :type conf: dict
+        """
+
+        # Validate inputs
+        global_schema = {
+            pipeline_constants.INPUT: dict,
+            pipeline_constants.OUTPUT: dict,
+            OptionalKey(pipeline_constants.APPLICATIONS): dict,
+            OptionalKey(pipeline_constants.ORCHESTRATOR): dict,
+            OptionalKey(pipeline_constants.ADVANCED): dict,
+        }
+
+        checker_inputs = Checker(global_schema)
+        checker_inputs.validate(conf)
+
+    @abstractmethod
+    def check_inputs(self, conf, config_json_dir=None):
+        """
+        Check the inputs given
+
+        :param conf: configuration of inputs
+        :type conf: dict
+        :param config_json_dir: directory of used json, if
+            user filled paths with relative paths
+        :type config_json_dir: str
+
+        :return: overloader inputs
+        :rtype: dict
+        """
+
+    @abstractmethod
+    def check_output(self, conf):
+        """
+        Check the output given
+
+        :param conf: configuration of output
+        :type conf: dict
+
+        :return overloader output
+        :rtype : dict
+        """
+
+    @abstractmethod
+    def check_applications(self, conf, key=None, res=None, last_res=False):
+        """
+        Check the given configuration for applications
+
+        :param conf: configuration of applications
+        :type conf: dict
+        """
+
+    @abstractmethod
+    def run(self):
+        """
+        Run pipeline
+        """
+
+
+def _merge_resolution_conf_rec(conf1, conf2):
+    """
+    Merge secondary configuration on primary one
+
+    :param conf1: configuration
+    :type conf1: dict
+    :param conf2: configuration
+    :type conf2: dict
+
+    :return: merged conf
+    :rtype: dict
+
+    """
+    for key in conf2.keys():
+        if key in conf1:
+            if isinstance(conf1[key], dict) and isinstance(conf2[key], dict):
+                _merge_resolution_conf_rec(conf1[key], conf2[key])
+        else:
+            conf1[key] = conf2[key]

cars/pipelines/unit/__init__.py

@@ -0,0 +1,26 @@
+#!/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 unit pipeline module init file
+"""
+
+# Cars imports
+from cars.pipelines.unit import unit_pipeline  # noqa: F401