pyBSM

pyBSM是一个基于Python的传感器建模工具。它提供了对通过不同成像系统模拟图像形成过程有用的常用组件。

本仓库在LeMaster和Eismann创建原始pyBSM包以建模图像系统[1]的工作基础上构建，以及LeMaster等人在验证pyBSM包[2]方面的研究。

安装

以下步骤假设已本地获取源代码树。

通过pip安装当前版本

pip install pybsm

或者，您也可以使用Poetry

poetry install --sync --with dev-linting,dev-testing,dev-docs

更多安装文档请参阅此处。

使用前述命令安装不会安装OpenCV。虽然pyBSM仍可运行，但仍有一些函数需要OpenCV。

安装带有OpenCV的pyBSM有两种选择：图形或无头。图形将安装opencv-python作为OpenCV实现，而无头将安装opencv-python-headless作为OpenCV实现。

要使用opencv-python安装pybsm

• 使用pip

pip install pybsm[graphics]

• 使用Poetry

poetry install --sync --with dev-linting,dev-testing,dev-docs --extras graphics

要使用opencv-python-headless安装pybsm

• 使用pip

pip install pybsm[headless]

• 使用Poetry

poetry install --sync --with dev-linting,dev-testing,dev-docs --extras headless

入门指南

我们在./examples/目录中提供了基于Jupyter笔记本的多个示例，以展示在不同环境下使用pyBSM包的方法。

文档

版本和最新主分支的文档快照托管在ReadTheDocs上。

基于Sphinx的文档也可以在本地构建，以获取最新的参考信息。

# Install dependencies
poetry install --sync --with dev-linting,dev-testing,dev-docs 
# Navigate to the documentation root.
cd docs
# Build the docs.
poetry run make html
# Open in your favorite browser!
firefox _build/html/index.html

开发者工具

pre-commit钩子
pre-commit钩子用于确保任何代码都符合所有必要的代码检查和格式化指南。安装后，它将在提交之前始终运行，以确保所有提交都遵循标准，但您也可以手动运行检查而不提交。如果您想要即使存在错误也进行提交，可以在提交命令中添加--no-verify。

安装pre-commit钩子

# Ensure that all dependencies are installed  
poetry install --sync --with dev-linting,dev-testing,dev-docs
# Initialize pre-commit for the repository  
poetry run pre-commit install  
# Run pre-commit check on all files  
poetry run pre-commit run --all-files

贡献

• 我们遵循JATIC软件开发计划中概述的一般指南。
• 我们使用Git Flow分支策略。
• 有关详细发布信息，请参阅docs/release_process.rst。
• 有关其他贡献信息，请参阅CONTRIBUTING.md。

许可证

Apache 2.0

联系方式

主要研究员：Brian Hu（Kitware）@brian.hu

产品负责人：Austin Whitesell（MITRE）@awhitesell

敏捷主管/技术负责人：Brandon RichardWebster（Kitware）@b.richardwebster

副技术负责人：Emily Veenhuis（Kitware）@emily.veenhuis

参考文献

[1] LeMaster, Daniel A. 和 Michael T. Eismann. “pyBSM：一种用于建模图像系统的Python包”. Society of Photo-Optical Instrumentation Engineers (SPIE) 会议系列，由Eric J. Kelmelis编辑，第10204卷，2017年，第1020405页，https://doi.org10.1117/12.2262561. Society of Photo-Optical Instrumentation Engineers (SPIE) 会议系列。

[2] LeMaster, Daniel，等人。验证pyBSM：一种用于建模图像系统的Python包。2018年5月，第19页，https://doi.org10.1117/12.2305228。