Introduction#

The Phase One SDK consists of two separate SDKs: the CameraSDK and the ImageSDK.

The CameraSDK is used to control the camera. E.g., getting and setting properties like aperture, shutter time, mirror status, etc., getting LiveView stream data, capturing images, and receiving the captured images from the camera.

The ImageSDK is used to read the images captured. E.g., image metadata extraction, image writing to tiff, and image pipelines for decoding, conversion, cropping, and scaling. Plus, there are specialized functions for stitching and stacking PAS images.

The SDKs are not dependent on each other and can be used separately.

Note

This document is not a camera guide or camera documentation. Documentation and manuals for Phase One products (such as the cameras) can be found on our website: www.phaseone.com.

Reading Guide#

The first part of this guide introduces the SDKs through an example. Then, it provides a classic “Getting Started” guide that shows how to set up, build, and run an SDK-based project.

Then, we introduce the components surrounding the SDKs through an overview of how the CameraSDK and ImageSDK can be used together. These sections are not code-specific.

Later, we describe CameraSDK and ImageSDK, respectively. These sections examine the available features and provide code examples.

References#

After the SDKs’ features and concepts are introduced, we have the coding references. These are the “source code” documentation for every class, method, and data type. Everything in the references is also available in the C++ header files and as C# XML docs.

Appendices#

Lastly, appendices will detail how the SDKs approach error handling and parallelism in ImageSDK, sample code, and more.