Camorph 项目使用教程

1. 项目目录结构及介绍

Camorph 项目是一个 Python 工具箱，用于转换不同的相机参数约定。以下是项目的目录结构及各部分功能介绍：

camorph/
├── docs/                       # 项目文档存放目录
├── thirdPartyLegalNotices/     # 第三方法律声明文件
├── .gitignore                  # Git 忽略文件列表
├── Header.png                  # 项目封面图片
├── LICENSE.txt                 # 项目许可证文件
├── Makefile                    # 项目构建文件
├── README.md                   # 项目说明文件
├── camorph_cli.bat              # Camorph 命令行界面批处理文件（Windows）
├── camorph_linux.yml            # Camorph 配置文件（Linux）
├── camorph_win.yml              # Camorph 配置文件（Windows）
├── main.py                     # 项目主 Python 脚本
├── make.bat                    # 项目构建批处理文件（Windows）
├── pyproject.toml              # Python 项目配置文件
├── requirements.txt            # 项目依赖文件
└── stats/                      # 项目统计信息目录

• docs/: 包含项目的文档。
• thirdPartyLegalNotices/: 存放与第三方软件相关的法律声明。
• .gitignore: 指定 Git 忽略跟踪的文件和目录。
• Header.png: 项目封面图片。
• LICENSE.txt: 项目所使用的许可证信息。
• Makefile: 项目的构建指令文件。
• README.md: 项目的简要介绍和说明。
• camorph_cli.bat: 在 Windows 系统中运行命令行界面的批处理文件。
• camorph_linux.yml 和 camorph_win.yml: 分别为 Linux 和 Windows 系统的配置文件。
• main.py: 项目的主 Python 脚本，包含了 Camorph 的主要功能。
• make.bat: 在 Windows 系统中构建项目的批处理文件。
• pyproject.toml: Python 项目的配置文件，用于定义项目信息和依赖。
• requirements.txt: 项目所需的 Python 库依赖。
• stats/: 存放项目的统计信息。

2. 项目的启动文件介绍

项目的启动主要是通过 main.py 文件来进行的。以下是 main.py 文件的主要功能：

• 定义了 Camorph 的命令行接口（CLI）。
• 提供了读取、可视化以及写入相机参数的功能。

在命令行中，可以通过以下命令启动 Camorph 的 CLI：

python -m camorph -h

这会显示帮助信息，解释各种命令行参数的使用方法。

3. 项目的配置文件介绍

项目的配置文件主要用于设置项目运行时的环境和参数。以下是对两个配置文件的简要介绍：

• camorph_linux.yml 和 camorph_win.yml: 这两个 YAML 文件包含了针对不同操作系统的配置信息。用户可以在这里设置输入输出路径、相机文件的格式等。

配置文件的示例内容可能如下：

# camorph_linux.yml
input_path: /path/to/input
output_path: /path/to/output
input_format: colmap
output_format: fbx

用户需要根据自己的需求修改这些配置参数，以适应不同的使用场景。在运行 Camorph 之前，确保配置文件中的路径和格式设置是正确的。