Skip to main content

Defining the Future of 3D Machine Vision

Project description

Copyright (c) 2019, Zivid AS All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description: # Zivid Python

Zivid Python is the official Python package for Zivid 3D cameras. Read more about Zivid at [zivid.com](https://www.zivid.com/).

[![Build Status](https://img.shields.io/azure-devops/build/zivid-devops/376f5fda-ba80-4d6c-aaaa-cbcd5e0ad6c0/2/master.svg)](https://dev.azure.com/zivid-devops/zivid-python/_build/latest?definitionId=2&branchName=master)

<figure><p align=”center”><img src=”https://www.zivid.com/hs-fs/hubfs/images/www/ZividOnePlus.jpg?width=500&name=ZividOnePlus.jpg”></p></figure>

Contents: [Installation](#installation) | [Quick Start](#quick-start) | [Examples](#examples) | [Versioning](#versioning) | [License](#license) | [Support](#support) | [Test Matrix](#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 FilesZividbin`.

### Using PIP

The easiest way to install the package is to use PIP.

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

#### Old PIP

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

pip install scikit-build cmake ninja

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

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](#examples) section.

### Using camera emulation

If you do not have a camera, you can use the MiscObjects.zdf file in [ZividSampleData.zip](http://www.zivid.com/software/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](samples) directory.

## Versioning

This python module is using [PEP 440](https://www.python.org/dev/peps/pep-0440) 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 reccomended to also update to the latest [Zivid SDK](http://www.zivid.com/software). Refer to the [Test Matrix](#test-matrix) for supported version.

## License

This project is licensed, see the [LICENSE](LICENSE) file for details.

## Support

Please visit [Zivid Knowledge Base](http://help.zivid.com) 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.3.0 |
Ubuntu 16.04 | 3.5 | 1.3.0 |
Fedora 30 | 3.7 | 1.3.0 |
Arch Linux* | latest | latest |
Windows 10* | 3.5, 3.6, 3.7 | 1.3.0 |

[*] Only build, no unit testing.

Platform: UNKNOWN Description-Content-Type: text/markdown

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for zivid, version 0.9.1.1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size zivid-0.9.1.1.3.0-cp36-cp36m-win_amd64.whl (329.5 kB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size zivid-0.9.1.1.3.0-cp37-cp37m-win_amd64.whl (329.4 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size zivid-0.9.1.1.3.0.tar.gz (156.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page