/StereoPipeline

The NASA Ames Stereo Pipeline is a suite of automated geodesy & stereogrammetry tools designed for processing planetary imagery captured from orbiting and landed robotic explorers on other planets.

Primary LanguageC++Apache License 2.0Apache-2.0

Ames Stereo Pipeline (ASP)

Documentation Status

The NASA Ames Stereo Pipeline (ASP) is a suite of free and open source automated geodesy and stereogrammetry tools designed for processing stereo images captured from satellites (around Earth and other planets), robotic rovers, aerial cameras, and historical images, with and without accurate camera pose information.

ASP produces cartographic products, including digital terrain models (DTMs, synonymus with digital elevation models, DEMs), ortho-projected images, 3D models, and bundle-adjusted networks of cameras. These data products are suitable for science analysis, mission planning, and public outreach.

Installation

Precompiled binaries are available for the stable releases and the current development build. Stereo Pipeline can also be compiled from source, but this is not recommended.

Precompiled Binaries (Linux and macOS)

Simply download the appropriate distribution for your operating system, extract, and run the executables in the bin subdirectory.

See the NEWS.rst file for the most recent additions.

To permanently add the ASP executable subdirectory to your PATH, you can add the following line to your shell configuration (e.g., ~/.bashrc), replacing /path/to/StereoPipeline/bin with the location on your filesystem: export PATH=${PATH}:/path/to/StereoPipeline/bin

ISIS Users: Please install USGS ISIS version 3.8.0 or later if you would like to process NASA non-terrestrial images. Users wishing to process Earth images, such as Digital Globe, satellites with RPC cameras, or various frame/pinhole cameras do not need to download anything else.

Compiling from Source

Given the relatively complex configuration, we do not recommend building from source for most users. Detailed instructions are available in the documentation.

Documentation

The primary source of documentation is the Stereo Pipeline Book, the versions for the Latest Stable and Current Development versions are linked above. The contents of the book are provided as PDFs with each distribution, but are also available at https://stereopipeline.readthedocs.io.

The book includes a gentle introduction to using the Stereo Pipeline, documentation for each tool, and example processing workflows for many supported sensors.

A PDF version of the book is bundled with the binary distributions (named asp_book.pdf), and the ReStructured Text source files are distributed in the docs/ subdirectory.

Support and User Community

All bugs, feature requests, user questions, and general discussion can be posted on the ASP support forum.

We also encourage the posting of Issues on the GitHub repo (most such items posted on the forum will typically be converted to an Issue there for the developers to work on), as well as pull requests.

Credits

ASP was developed within the Autonomous Systems and Robotics area of the Intelligent Systems Division at NASA's Ames Research Center. It leverages the Intelligent Robotics Group's (IRG) extensive experience developing surface reconstruction and tools for planetary exploration (e.g., the Mars Pathfinder and Mars Exploration Rover missions, and rover autonomy). It has also been developed in collaboration with the Adaptive Control and Evolvable Systems (ACES) group, and draws on their experience developing computer vision techniques for autonomous vehicle control systems.

See the AUTHORS.rst file for a complete list of developers.

Citation

In general, please use this reference for the Ames Stereo Pipeline:

Beyer, Ross A., Oleg Alexandrov, and Scott McMichael. 2018. The Ames Stereo Pipeline: NASA's open source software for deriving and processing terrain data, Earth and Space Science, 5. https://doi.org/10.1029/2018EA000409.

If you are using ASP for application to Earth Images, or need a reference which details the quality of the output, then we suggest also referencing:

Shean, D. E., O. Alexandrov, Z. Moratto, B. E. Smith, I. R. Joughin, C. C. Porter, Morin, P. J. 2016. An automated, open-source pipeline for mass production of digital elevation models (DEMs) from very high-resolution commercial stereo satellite imagery. ISPRS Journal of Photogrammetry and Remote Sensing, 116. https://doi.org/10.1016/j.isprsjprs.2016.03.012.

In addition to the recommended citation, we ask that you also cite the DOI for the specific version of ASP that you used for processing. Every new release of ASP will have its own unique DOI, which can be found at this URL: https://zenodo.org/badge/latestdoi/714891

Additional details for how to cite ASP in your published work can be found in the ASP documentation.

License

See LICENSE file for the full text of the license that applies to ASP.

Copyright (c) 2009-2020, United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All rights reserved.

ASP is 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.

Third-Party Libraries

This distribution may include some bundled third-party software as a convenience to the user. This software, located in the thirdparty/ directory of the source code release, is not covered by the above-mentioned distribution agreement or copyright. Binary releases distribute third party software in both the bin and lib directories. See the included documentation for detailed copyright and license information for any third-party software or check the THIRDPARTYLICENSES file. In addition, various pieces of ASP depend on additional third-party libraries that the user is expected to have installed.