Source code for pandora2d.Pandora2d

#!/usr/bin/env python
#
# Copyright (c) 2026 Centre National d'Etudes Spatiales (CNES).
#
# This file is part of PANDORA2D
#
#     https://github.com/CNES/Pandora2D
#
# 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 general function to run Pandora 2D pipeline.
"""

# Disable following error:
# Module name "Pandora2d" doesn't conform to snake_case naming style
# pylint: disable=invalid-name

import argparse
from importlib.metadata import version
from pathlib import Path

import pandora2d


[docs] def get_parser(): """ ArgumentParser for Pandora 2D :return parser """ parser = argparse.ArgumentParser( description="Image Registration framework that computes 2D displacement maps from a pair of images taken over" " the same scene.", epilog=f"%(prog)s {version('pandora2d')}", ) parser.add_argument( "config", type=Path, help="path to a json file containing the input/output file paths and \ algorithm parameters", ) parser.add_argument( "-v", "--verbose", help="Increase output verbosity (-v displays logs at info level and -vv displays logs at debug level)", action="count", default=0, ) parser.add_argument("-V", "--version", action="version", version=f"%(prog)s {version('pandora2d')}") return parser
[docs] def main(): """ Call Pandora2D's main """ # Get parser parser = get_parser() args = parser.parse_args() # Run the Pandora 2D pipeline pandora2d.main(args.config, args.verbose)
if __name__ == "__main__": main()