Rename organization/repository

.dockerignore

@@ -4,7 +4,7 @@
 .idea/
 .vscode/
 
-# not needed for building OpenVSLAM
+# not needed for building
 Dockerfile*
 LICENSE
 README.md

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,15 +8,17 @@ assignees: ''
 ---
 
 <!--
-For general questions, please ask on https://github.com/OpenVSLAM-Community/openvslam/discussions.
+For general questions, please ask on https://github.com/stella-cv/stella_vslam/discussions.
 Please complete the following information.
 -->
 
 ## Describe the bug
 <!-- A clear and concise description of what the bug is. -->
 
 ## To Reproduce
+
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -35,13 +37,14 @@ Camera:
 ## Screenshots or videos
 <!-- If applicable, add screenshots to help explain your problem. -->
 
-## Environment:
- - Hardware: [e.g. PC, Raspberry Pi 4, Jetson Nano]
- - CPU: [e.g. Intel Core i7-11700]
- - OS: [e.g. Ubuntu 20.04]
- - Commit id: [e.g. openvslam=577cb04d9245aa68b0905212293a802292d01787, openvslam_ros=fdbd287d80a3a5cc4ac1a143dc937adb4697b120]
- - Install procedure: [docker or native]
- - dataset: [e.g. EuRoC MH_01]
+## Environment
+
+- Hardware: [e.g. PC, Raspberry Pi 4, Jetson Nano]
+- CPU: [e.g. Intel Core i7-11700]
+- OS: [e.g. Ubuntu 20.04]
+- Commit id: [e.g. stella_vslam=577cb04d9245aa68b0905212293a802292d01787, stella_vslam_ros=fdbd287d80a3a5cc4ac1a143dc937adb4697b120]
+- Install procedure: [docker or native]
+- dataset: [e.g. EuRoC MH_01]
 
 ## Additional context
 <!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,7 +8,7 @@ assignees: ''
 ---
 
 <!--
-For general questions, please ask on https://github.com/OpenVSLAM-Community/openvslam/discussions
+For general questions, please ask on https://github.com/stella-cv/stella_vslam/discussions
 -->
 
 ## Is your feature request related to a problem?

.github/workflows/main.yml

@@ -41,7 +41,7 @@ jobs:
       run:
         shell: bash
     container:
-      image: ghcr.io/ymd-stella/openvslam-community/openvslam:latest
+      image: ghcr.io/ymd-stella/stella-cv/stella_vslam:latest
     steps:
       - uses: actions/checkout@v2
       - name: cmake and make with pangolin viewer
@@ -62,7 +62,7 @@ jobs:
       run:
         shell: bash
     container:
-      image: ghcr.io/ymd-stella/openvslam-community/openvslam:latest
+      image: ghcr.io/ymd-stella/stella-cv/stella_vslam:latest
     steps:
       - uses: actions/checkout@v2
       - name: cmake and make
@@ -205,7 +205,7 @@ jobs:
       run:
         shell: bash
     container:
-      image: ghcr.io/ymd-stella/openvslam-community/openvslam:latest
+      image: ghcr.io/ymd-stella/stella-cv/stella_vslam:latest
     steps:
       - uses: actions/checkout@v2
       - name: cmake and make
@@ -235,14 +235,14 @@ jobs:
       run:
         shell: bash
     container:
-      image: ghcr.io/ymd-stella/openvslam-community/ros:foxy-ros-base
+      image: ghcr.io/ymd-stella/stella-cv/ros:foxy-ros-base
     steps:
       - uses: actions/checkout@v2
       - name: build ros2 packages
         run: |
           mkdir -p /ros_ws/src
-          cp -r . /ros_ws/src/openvslam
-          cd /ros_ws/src/openvslam
+          cp -r . /ros_ws/src/stella_vslam
+          cd /ros_ws/src/stella_vslam
           git submodule update -i --recursive
           cd ../..
           rosdep update

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "3rd/FBoW"]
 	path = 3rd/FBoW
-	url = https://github.com/OpenVSLAM-Community/FBoW.git
+	url = https://github.com/stella-cv/FBoW.git

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.1)
-project(openvslam LANGUAGES CXX C)
+project(stella_vslam LANGUAGES CXX C)
 
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
@@ -21,7 +21,7 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
 endif()
 message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
 
-option(BUILD_SHARED_LIBS "Build OpenVSLAM as a shared library" ON)
+option(BUILD_SHARED_LIBS "Build stella_vslam as a shared library" ON)
 
 # ----- Build selection -----
 
@@ -119,27 +119,27 @@ message(STATUS "Use OpenCV ${OpenCV_VERSION}")
 include(CMakePackageConfigHelpers)
 
 # Generate cmake configuration scripts
-set(OPENVSLAM_GENERATED_DIR ${CMAKE_CURRENT_BINARY_DIR}/generated)
-set(OPENVSLAM_VERSION_CONFIG ${OPENVSLAM_GENERATED_DIR}/${PROJECT_NAME}ConfigVersion.cmake)
-set(OPENVSLAM_PROJECT_CONFIG ${OPENVSLAM_GENERATED_DIR}/${PROJECT_NAME}Config.cmake)
-set(OPENVSLAM_TARGETS_EXPORT_NAME ${PROJECT_NAME}Targets)
-set(OPENVSLAM_CONFIG_INSTALL_DIR lib/cmake/${PROJECT_NAME})
-set(OPENVSLAM_NAMESPACE "${PROJECT_NAME}::")
-set(OPENVSLAM_VERSION 0.3.0)
+set(STELLA_VSLAM_GENERATED_DIR ${CMAKE_CURRENT_BINARY_DIR}/generated)
+set(STELLA_VSLAM_VERSION_CONFIG ${STELLA_VSLAM_GENERATED_DIR}/${PROJECT_NAME}ConfigVersion.cmake)
+set(STELLA_VSLAM_PROJECT_CONFIG ${STELLA_VSLAM_GENERATED_DIR}/${PROJECT_NAME}Config.cmake)
+set(STELLA_VSLAM_TARGETS_EXPORT_NAME ${PROJECT_NAME}Targets)
+set(STELLA_VSLAM_CONFIG_INSTALL_DIR lib/cmake/${PROJECT_NAME})
+set(STELLA_VSLAM_NAMESPACE "${PROJECT_NAME}::")
+set(STELLA_VSLAM_VERSION 0.3.0)
 
 # Create a version config file
-write_basic_package_version_file(${OPENVSLAM_VERSION_CONFIG}
-                                 VERSION ${OPENVSLAM_VERSION}
+write_basic_package_version_file(${STELLA_VSLAM_VERSION_CONFIG}
+                                 VERSION ${STELLA_VSLAM_VERSION}
                                  COMPATIBILITY SameMajorVersion)
 # Create a project config file
-configure_file(${PROJECT_SOURCE_DIR}/cmake/Config.cmake.in ${OPENVSLAM_PROJECT_CONFIG} @ONLY)
+configure_file(${PROJECT_SOURCE_DIR}/cmake/Config.cmake.in ${STELLA_VSLAM_PROJECT_CONFIG} @ONLY)
 
 # Install to the specified directory
-install(FILES ${OPENVSLAM_VERSION_CONFIG} ${OPENVSLAM_PROJECT_CONFIG}
-        DESTINATION ${OPENVSLAM_CONFIG_INSTALL_DIR})
-install(EXPORT ${OPENVSLAM_TARGETS_EXPORT_NAME}
-        NAMESPACE ${OPENVSLAM_NAMESPACE}
-        DESTINATION ${OPENVSLAM_CONFIG_INSTALL_DIR})
+install(FILES ${STELLA_VSLAM_VERSION_CONFIG} ${STELLA_VSLAM_PROJECT_CONFIG}
+        DESTINATION ${STELLA_VSLAM_CONFIG_INSTALL_DIR})
+install(EXPORT ${STELLA_VSLAM_TARGETS_EXPORT_NAME}
+        NAMESPACE ${STELLA_VSLAM_NAMESPACE}
+        DESTINATION ${STELLA_VSLAM_CONFIG_INSTALL_DIR})
 
 # Set standard installation directories
 set(RUNTIME_DESTINATION bin)

Dockerfile.desktop

@@ -200,9 +200,9 @@ RUN set -x && \
   cd /tmp && \
   rm -rf *
 
-# OpenVSLAM
-COPY . /openvslam/
-WORKDIR /openvslam/
+# stella_vslam
+COPY . /stella_vslam/
+WORKDIR /stella_vslam/
 RUN set -x && \
   mkdir -p build && \
   cd build && \
@@ -216,5 +216,5 @@ RUN set -x && \
   rm -rf CMakeCache.txt CMakeFiles Makefile cmake_install.cmake example src && \
   chmod -R 777 ./*
 
-WORKDIR /openvslam/build/
+WORKDIR /stella_vslam/build/
 ENTRYPOINT ["/bin/bash"]

Dockerfile.socket

@@ -194,9 +194,9 @@ RUN set -x && \
   cd /tmp && \
   rm -rf *
 
-# OpenVSLAM
-COPY . /openvslam/
-WORKDIR /openvslam/
+# stella_vslam
+COPY . /stella_vslam/
+WORKDIR /stella_vslam/
 RUN set -x && \
   mkdir -p build && \
   cd build && \
@@ -210,5 +210,5 @@ RUN set -x && \
   rm -rf CMakeCache.txt CMakeFiles Makefile cmake_install.cmake example src && \
   chmod -R 777 ./*
 
-WORKDIR /openvslam/build/
+WORKDIR /stella_vslam/build/
 ENTRYPOINT ["/bin/bash"]

LICENSE.fork

@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2022, OpenVSLAM-Community, All rights reserved.
+Copyright (c) 2022, stella-cv, All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

README.md

@@ -1,45 +1,42 @@
-<p align="center">
-<img src="https://raw.githubusercontent.com/OpenVSLAM-Community/openvslam/main/docs/img/logo.png" width="435px">
-</p>
+# stella_vslam
 
-# OpenVSLAM: A Versatile Visual SLAM Framework
-[![CI](https://github.com/OpenVSLAM-Community/openvslam/actions/workflows/main.yml/badge.svg)](https://github.com/OpenVSLAM-Community/openvslam/actions/workflows/main.yml)
-[![Documentation Status](https://readthedocs.org/projects/openvslam-community/badge/?version=latest)](https://openvslam-community.readthedocs.io/en/latest/?badge=latest)
+[![CI](https://github.com/stella-cv/stella_vslam/actions/workflows/main.yml/badge.svg)](https://github.com/stella-cv/stella_vslam/actions/workflows/main.yml)
+[![Documentation Status](https://readthedocs.org/projects/stella-cv/badge/?version=latest)](https://stella-cv.readthedocs.io/en/latest/?badge=latest)
 [![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)
 
 ---
 
-> *NOTE:* This is a community fork of [xdspacelab/openvslam](https://github.com/xdspacelab/openvslam). It was created to continue active development of OpenVSLAM on Jan 31, 2021. The original repository is no longer available. Please read the [official statement of termination](https://github.com/xdspacelab/openvslam/wiki/Termination-of-the-release) carefully and understand it before using this. The similarities with ORB_SLAM2 in the original version have been removed by [#252](https://github.com/OpenVSLAM-Community/openvslam/pull/252). If you find any other issues with the license, please point them out. See [#37](https://github.com/OpenVSLAM-Community/openvslam/issues/37) and [#249](https://github.com/OpenVSLAM-Community/openvslam/issues/249) for discussion so far.
+> *NOTE:* This is a community fork of [xdspacelab/openvslam](https://github.com/xdspacelab/openvslam). It was created to continue active development of OpenVSLAM on Jan 31, 2021. The original repository is no longer available. Please read the [official statement of termination](https://github.com/xdspacelab/openvslam/wiki/Termination-of-the-release) carefully and understand it before using this. The similarities with ORB_SLAM2 in the original version have been removed by [#252](https://github.com/stella-cv/stella_vslam/pull/252). If you find any other issues with the license, please point them out. See [#37](https://github.com/stella-cv/stella_vslam/issues/37) and [#249](https://github.com/stella-cv/stella_vslam/issues/249) for discussion so far.
 
 *Versions earlier than 0.3 are deprecated. If you use them, please use them as a derivative of ORB_SLAM2 under the GPL license.*
 
 ---
 
 ## Overview
 
-[<img src="https://raw.githubusercontent.com/OpenVSLAM-Community/openvslam/main/docs/img/teaser.png" width="640px">](https://arxiv.org/abs/1910.01122)
+[<img src="https://raw.githubusercontent.com/stella-cv/stella_vslam/main/docs/img/teaser.png" width="640px">](https://arxiv.org/abs/1910.01122)
 
 <img src="https://j.gifs.com/81m1QL.gif" width="640px">
 
 [**[PrePrint]**](https://arxiv.org/abs/1910.01122) [**[YouTube]**](https://www.youtube.com/watch?v=Ro_s3Lbx5ms)
 
-OpenVSLAM is a monocular, stereo, and RGBD visual SLAM system.
+stella_vslam is a monocular, stereo, and RGBD visual SLAM system.
 
 ### Features
 
 The notable features are:
 
 - It is compatible with **various type of camera models** and can be easily customized for other camera models.
-- Created maps can be **stored and loaded**, then OpenVSLAM can **localize new images** based on the prebuilt maps.
+- Created maps can be **stored and loaded**, then stella_vslam can **localize new images** based on the prebuilt maps.
 - The system is fully modular. It is designed by encapsulating several functions in separated components with easy-to-understand APIs.
 - We provided **some code snippets** to understand the core functionalities of this system.
 
-One of the noteworthy features of OpenVSLAM is that the system can deal with various type of camera models, such as perspective, fisheye, and equirectangular.
+One of the noteworthy features of stella_vslam is that the system can deal with various type of camera models, such as perspective, fisheye, and equirectangular.
 If needed, users can implement extra camera models (e.g. dual fisheye, catadioptric) with ease.
 For example, visual SLAM algorithm using **equirectangular camera models** (e.g. RICOH THETA series, insta360 series, etc) is shown above.
 
-We provided [documentation](https://openvslam-community.readthedocs.io/) for installation and tutorial.
-The repository for the ROS wrapper is [openvslam_ros](https://github.com/OpenVSLAM-Community/openvslam_ros).
+We provided [documentation](https://stella-cv.readthedocs.io/) for installation and tutorial.
+The repository for the ROS wrapper is [stella_vslam_ros](https://github.com/stella-cv/stella_vslam_ros).
 
 ### Acknowledgements
 
@@ -52,32 +49,26 @@ ProSLAM has implemented a highly modular and easily understood system earlier.
 
 Some code snippets to understand the core functionalities of the system are provided.
 You can employ these snippets for in your own programs.
-Please see the `*.cc` files in `./example` directory or check [Simple Tutorial](https://openvslam-community.readthedocs.io/en/latest/simple_tutorial.html) and [Example](https://openvslam-community.readthedocs.io/en/latest/example.html).
-
-## Motivation
-
-Visual SLAM is regarded as a next-generation technology for supporting industries such as automotives, robotics, and xR. 
-We released OpenVSLAM as an opensource project with the aim of collaborating with people around the world to accelerate the development of this field.
-In return, we hope this project will bring safe and reliable technologies for a better society.
+Please see the `*.cc` files in `./example` directory or check [Simple Tutorial](https://stella-cv.readthedocs.io/en/latest/simple_tutorial.html) and [Example](https://stella-cv.readthedocs.io/en/latest/example.html).
 
 ## Installation
 
-Please see [**Installation**](https://openvslam-community.readthedocs.io/en/latest/installation.html) chapter in the [documentation](https://openvslam-community.readthedocs.io/).
+Please see [**Installation**](https://stella-cv.readthedocs.io/en/latest/installation.html) chapter in the [documentation](https://stella-cv.readthedocs.io/).
 
-[**The instructions for Docker users**](https://openvslam-community.readthedocs.io/en/latest/docker.html) are also provided.
+[**The instructions for Docker users**](https://stella-cv.readthedocs.io/en/latest/docker.html) are also provided.
 
 ## Tutorial
 
-Please see [**Simple Tutorial**](https://openvslam-community.readthedocs.io/en/latest/simple_tutorial.html) chapter in the [documentation](https://openvslam-community.readthedocs.io/).
+Please see [**Simple Tutorial**](https://stella-cv.readthedocs.io/en/latest/simple_tutorial.html) chapter in the [documentation](https://stella-cv.readthedocs.io/).
 
-A sample ORB vocabulary file can be downloaded from [here](https://github.com/OpenVSLAM-Community/FBoW_orb_vocab/raw/main/orb_vocab.fbow).
+A sample ORB vocabulary file can be downloaded from [here](https://github.com/stella-cv/FBoW_orb_vocab/raw/main/orb_vocab.fbow).
 Sample datasets are also provided at [here](https://drive.google.com/open?id=1A_gq8LYuENePhNHsuscLZQPhbJJwzAq4).
 
-If you would like to run visual SLAM with standard benchmarking datasets (e.g. KITTI Odometry dataset), please see [**SLAM with standard datasets**](https://openvslam-community.readthedocs.io/en/latest/example.html#slam-with-standard-datasets) section in the [documentation](https://openvslam-community.readthedocs.io/).
+If you would like to run visual SLAM with standard benchmarking datasets (e.g. KITTI Odometry dataset), please see [**SLAM with standard datasets**](https://stella-cv.readthedocs.io/en/latest/example.html#slam-with-standard-datasets) section in the [documentation](https://stella-cv.readthedocs.io/).
 
 ## Community
 
-Please contact us via [GitHub Discussions](https://github.com/OpenVSLAM-Community/openvslam/discussions) if you have any questions or notice any bugs about the software.
+Please contact us via [GitHub Discussions](https://github.com/stella-cv/stella_vslam/discussions) if you have any questions or notice any bugs about the software.
 
 ## Currently working on
 
@@ -97,23 +88,23 @@ The following files are derived from third-party libraries.
 - `./3rd/json` : [nlohmann/json \[v3.6.1\]](https://github.com/nlohmann/json) (MIT license)
 - `./3rd/popl` : [badaix/popl \[v1.2.0\]](https://github.com/badaix/popl) (MIT license)
 - `./3rd/spdlog` : [gabime/spdlog \[v1.3.1\]](https://github.com/gabime/spdlog) (MIT license)
-- `./src/openvslam/solver/pnp_solver.cc` : part of [laurentkneip/opengv](https://github.com/laurentkneip/opengv) (3-clause BSD license)
-- `./src/openvslam/feature/orb_extractor.cc` : part of [opencv/opencv](https://github.com/opencv/opencv) (3-clause BSD License)
-- `./src/openvslam/feature/orb_point_pairs.h` : part of [opencv/opencv](https://github.com/opencv/opencv) (3-clause BSD License)
+- `./src/stella_vslam/solver/pnp_solver.cc` : part of [laurentkneip/opengv](https://github.com/laurentkneip/opengv) (3-clause BSD license)
+- `./src/stella_vslam/feature/orb_extractor.cc` : part of [opencv/opencv](https://github.com/opencv/opencv) (3-clause BSD License)
+- `./src/stella_vslam/feature/orb_point_pairs.h` : part of [opencv/opencv](https://github.com/opencv/opencv) (3-clause BSD License)
 - `./viewer/public/js/lib/dat.gui.min.js` : [dataarts/dat.gui](https://github.com/dataarts/dat.gui) (Apache License 2.0)
 - `./viewer/public/js/lib/protobuf.min.js` : [protobufjs/protobuf.js](https://github.com/protobufjs/protobuf.js) (3-clause BSD License)
 - `./viewer/public/js/lib/stats.min.js` : [mrdoob/stats.js](https://github.com/mrdoob/stats.js) (MIT license)
 - `./viewer/public/js/lib/three.min.js` : [mrdoob/three.js](https://github.com/mrdoob/three.js) (MIT license)
 
 Please use `g2o` as the dynamic link library because `csparse_extension` module of `g2o` is LGPLv3+.
 
-## Contributors
+## Authors of the original version of OpenVSLAM
 
 - Shinya Sumikura ([@shinsumicco](https://github.com/shinsumicco))
 - Mikiya Shibuya ([@MikiyaShibuya](https://github.com/MikiyaShibuya))
 - Ken Sakurada ([@kensakurada](https://github.com/kensakurada))
 
-## Citation
+## Citation of original version of OpenVSLAM
 
 OpenVSLAM **won first place** at **ACM Multimedia 2019 Open Source Software Competition**.
 
@@ -146,6 +137,6 @@ The preprint can be found [here](https://arxiv.org/abs/1910.01122).
 - Raúl Mur-Artal and Juan D. Tardós. 2017. ORB-SLAM2: an Open-Source SLAM System for Monocular, Stereo and RGB-D Cameras. IEEE Transactions on Robotics 33, 5 (2017), 1255–1262.
 - Dominik Schlegel, Mirco Colosi, and Giorgio Grisetti. 2018. ProSLAM: Graph SLAM from a Programmer’s Perspective. In Proceedings of IEEE International Conference on Robotics and Automation (ICRA). 1–9.
 - Rafael Muñoz-Salinas and Rafael Medina Carnicer. 2019. UcoSLAM: Simultaneous Localization and Mapping by Fusion of KeyPoints and Squared Planar Markers. arXiv:1902.03729.
-- Mapillary AB. 2019. OpenSfM. https://github.com/mapillary/OpenSfM.
+- Mapillary AB. 2019. OpenSfM. <https://github.com/mapillary/OpenSfM>.
 - Giorgio Grisetti, Rainer Kümmerle, Cyrill Stachniss, and Wolfram Burgard. 2010. A Tutorial on Graph-Based SLAM. IEEE Transactions on Intelligent Transportation SystemsMagazine 2, 4 (2010), 31–43.
 - Rainer Kümmerle, Giorgio Grisetti, Hauke Strasdat, Kurt Konolige, and Wolfram Burgard. 2011. g2o: A general framework for graph optimization. In Proceedings of IEEE International Conference on Robotics and Automation (ICRA). 3607–3613.

cmake/Config.cmake.in

@@ -21,7 +21,7 @@ elseif(@BOW_FRAMEWORK@ MATCHES "FBoW")
     find_dependency(fbow)
 endif()
 
-include("${CMAKE_CURRENT_LIST_DIR}/@OPENVSLAM_TARGETS_EXPORT_NAME@.cmake")
+include("${CMAKE_CURRENT_LIST_DIR}/@STELLA_VSLAM_TARGETS_EXPORT_NAME@.cmake")
 
 include_directories("@CMAKE_INSTALL_PREFIX@/include")
 

docs/conf.py

@@ -17,8 +17,8 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'OpenVSLAM'
-copyright = '2019, National Institute of Advanced Industrial Science and Technology (AIST). For the changes after forking, Copyright (C) 2022, OpenVSLAM-Community, All rights reserved.'
+project = 'stella_vslam'
+copyright = '2019, National Institute of Advanced Industrial Science and Technology (AIST). For the changes after forking, Copyright (C) 2022, stella-cv, All rights reserved.'
 author = 'Shinya Sumikura'