3D Bounding Box Annotation Tool (3D-BAT) 项目教程

1. 项目目录结构及介绍

3d-bat/
├── assets/
├── css/
├── models/
├── scripts/
├── src/
├── tutorial_videos/
├── .gitignore
├── LICENSE
├── README.md
├── bower.json
├── config.json
├── favicon.ico
├── index.d.ts
├── package.json
├── requirements.txt
├── tsconfig.json
└── webpack.config.js

目录结构介绍

• assets/: 存放项目所需的静态资源文件。
• css/: 存放项目的样式文件。
• models/: 存放项目中使用的模型文件。
• scripts/: 存放项目的脚本文件。
• src/: 存放项目的主要源代码文件。
• tutorial_videos/: 存放项目的教程视频文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• bower.json: Bower 包管理器配置文件。
• config.json: 项目的配置文件。
• favicon.ico: 项目的图标文件。
• index.d.ts: 项目的 TypeScript 声明文件。
• package.json: Node.js 项目的配置文件。
• requirements.txt: Python 依赖包配置文件。
• tsconfig.json: TypeScript 配置文件。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

启动文件

• index.d.ts: 这是项目的入口文件，负责启动整个应用程序。

启动步骤

1. 安装 npm:

   • Linux: sudo apt-get install npm
   • Windows: 下载 Node.js
   • Mac: 安装 Node.js 和 npm

2. 克隆仓库:

   git clone https://github.com/walzimmer/3d-bat.git
   cd 3d-bat
   

3. 安装 Python 依赖包:

   conda create -n 3d-bat python==3.11.3
   conda activate 3d-bat
   pip install -r requirements.txt
   conda install -c conda-forge nodejs==10.13.0
   

4. 安装 Node.js 依赖包:

   npm install
   

5. 启动后端服务器:

   npm run start-server
   

6. 启动标注工具应用程序:

   npm run start
   

   启动后，index.html 文件将在指定的浏览器中打开（默认是 Chromium 浏览器）。默认浏览器可以在 package.json 文件的第 32 行进行更改：

   "start": "webpack serve --inline --open chromium-browser"
   

3. 项目的配置文件介绍

配置文件

• config.json: 这是项目的主要配置文件，包含了项目的各种配置选项。

配置文件内容

{
  "key1": "value1",
  "key2": "value2",
  ...
}

配置文件说明

• key1: 配置项1的值。
• key2: 配置项2的值。

通过修改 config.json 文件中的配置项，可以调整项目的运行参数和行为。

---

以上是 3D Bounding Box Annotation Tool (3D-BAT) 项目的教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。