Skip to content
Official Python package for Zivid 3D cameras
Python C++ Shell CMake
Branch: master
Clone or download
knatten Merge pull request #15 from zivid/gitignore-vim
Add vim swap files to .gitignore
Latest commit 4f62959 Aug 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
continuous-integration
doc Improved documentation with direct link to VS 2017 Jul 4, 2019
modules
samples
scripts Initial commit Jul 1, 2019
src
test Initial commit Jul 1, 2019
.clang-format Initial commit Jul 1, 2019
.clang-tidy
.darglint Initial commit Jul 1, 2019
.flake8 Initial commit Jul 1, 2019
.flake8-packaged-files Initial commit Jul 1, 2019
.gitignore
.pylintrc Initial commit Jul 1, 2019
CMakeLists.txt Initial commit Jul 1, 2019
LICENSE Initial commit Jul 1, 2019
MANIFEST.in Make using old PIP easier Jul 2, 2019
README.md Removed html from readme Jul 16, 2019
ZividAPIConfig.yml Initial commit Jul 1, 2019
azure-pipelines.yml Initial commit Jul 1, 2019
pyproject.toml Make using old PIP easier Jul 2, 2019
pytest.ini Initial commit Jul 1, 2019
setup.py Added classifiers for Python and Engineering to setup.py Jul 2, 2019

README.md

Zivid Python

Zivid Python is the official Python package for Zivid 3D cameras. Read more about Zivid at zivid.com.

Build Status PyPI Package Zivid Image


Contents: Installation | Quick Start | Examples | Versioning | License | Support | Test Matrix


Installation

Dependencies

Windows users also needs to make sure that the Zivid SDK installation folder is in system PATH before using the package, not only the terminal PATH variable. The default install location that should be added to system PATH is C:\Program Files\Zivid\bin.

Using PIP

The easiest way to install Zivid Python is to use PIP.

On some systems Python 3 pip is called pip3. In this guide we assume it is called pip.

When using PIP version 19 or higher build dependencies are handled automatically.

Installation may take some time since the setup.py script will download additional dependencies and compile C++ source code in the background.

pip install zivid

Old PIP

If you are using a version of PIP older than version 19 please manually install the dependencies listed in pyproject.toml before installing zivid.

pip install scikit-build cmake ninja
pip install zivid

Quick Start

Launch a Python interpreter and run the following code.

import zivid
app = zivid.Application()
camera = app.connect_camera()
frame = camera.capture()
frame.save("my-frame.zdf")

For more advanced usage see the Examples section.

Using camera emulation

If you do not have a camera, you can use the MiscObjects.zdf file in ZividSampleData.zip to emulate a camera.

import zivid
app = zivid.Application()
camera = app.create_file_camera("path/to/MiscObjects.zdf")
frame = camera.capture()
frame.save("my-frame.zdf")

Examples

Standalone example programs can be found in the samples directory.

Versioning

This python module is using PEP 440 for versioning. The features available in the module depends on the Zivid SDK version used when building the module. When updating this Python package it is recommended to also update to the latest Zivid SDK. Refer to the Test Matrix for supported version.

The version number of the Zivid Python module consists of six numbers. The three first numbers of the version is the semantic version of the code in this repository. The last three numbers is the version of the underlying Zivid SDK library used by the Python module.

Version breakdown

                                    Zivid SDK version = 1.4.1 (semantic version)
                                    v v v
Zivid Python module version = 1.0.0.1.4.1
                              ^ ^ ^
                              Wrapper code version = 1.0.0 (semantic version)

PyPI

When installing using PIP it is possible to specify the required version. This can be useful if upgrading Zivid SDK is not desired, but you want to update Zivid Python.

Install latest version of Zivid Python using latest version of Zivid SDK

pip install zivid

Install version 1.0.0 of Zivid Python using latest version of Zivid SDK

pip install zivid==1.0.0

Install version 1.0.0 of Zivid Python using Zivid SDK version 1.4.0

pip install zivid==1.0.0.1.4.0

Install version 1.0.0 of Zivid Python using Zivid SDK version 1.3.0

pip install zivid==1.0.0.1.3.0

Support for older versions of Zivid SDK will be discontinued when they are no longer compatible with latest version of the wrapper code.

License

This project is licensed, see the LICENSE file for details.

Support

Please visit Zivid Knowledge Base for general information on using Zivid 3D cameras. If you cannot find a solution to your issue, please contact support@zivid.com.

Test matrix

Operating System Python version Zivid SDK version
Ubuntu 18.04 3.6 1.4.0
Ubuntu 16.04 3.5 1.4.0
Fedora 30 3.7 1.4.0
Arch Linux* latest latest
Windows 10* 3.5, 3.6, 3.7 1.4.0

[*] Only build, no unit testing.

You can’t perform that action at this time.