PIX4Dengine Cloud API - FAQ

 

What is the PIX4Dengine Cloud API?

PIX4Dengine Cloud is a set of programming modules accessible via Application Programming Interfaces (APIs) for extracting critical information from images, empowering customization, automation and integration into any enterprise system and reality-capture workflow for photogrammetry.

It runs on our secure cloud, powered by AWS, and it is compatible with other Pix4D solutions.

What are the differences between PIX4Dengine Cloud API and PIX4Dengine SDK?

• The API is a programming interface running on Pix4D’s proprietary Amazon S3 infrastructure, while the SDK is a programming interface used on premise. Unlike the SDK, the API does not demand powerful servers or in-house development and IT teams.
• The SDK is delivered in the form of an installable package that can be downloaded from the Pix4D website, while no software download and installation are required to use the API.
• The API is accessible from any major programming language while the SDK is based on Python.
• The API can also give access to the PIX4Dcloud Advanced interface which makes it easier to visualize your data, and allows for project sharing.
• The SDK provides greater flexibility and customization in terms of processing.

Where can I find the product documentation?

The complete PIX4Dengine Cloud API documentation, which also includes example guides, is available here.

How to try the PIX4Dengine Cloud API?

To start testing the PIX4Dengine Cloud API a PIX4Dengine Cloud Trial license is needed. Please contact our sales team.

Demo projects might come in handy. They are available here without the need of a Pix4D account or a valid license/subscription. You can also download real photogrammetry data choosing from our online Example projects - real photogrammetry data.

Which license do I need to use the PIX4Dengine Cloud API?

To work with the PIX4Dengine Cloud API, a PIX4Dengine Cloud license is required.

How can I purchase a PIX4Dengine Cloud license?

To obtain a license, reach out to our sales team.

How does the billing work?

Billing is mainly based on the volume of processed gigapixels (PGP), which is a function of the number of images and the resolution of those images submitted for calibration. For more information, contact our sales team.

How can I view a log of all processing activity?

The processing activity (number of projects, project size, time per project, etc.) generated via the API can be viewed from the License management page. For more information: How to check the activity list in PIX4Dengine?

I am using a proxy, a firewall. How should I configure them?

If a proxy server is used or a firewall exists, some exceptions should be added. Read more at Proxy / firewall configuration when working with PIX4Dcloud.

What are the inputs and outputs when working with the PIX4Dengine Cloud API?

Inputs of a project created with the PIX4Dengine Cloud API can be:

• Input images (RGB, multispectral)
• GCPs and CPs with their image marks
• Files for online visualization
• Processing templates

Outputs of a project retrieved with the PIX4Dengine Cloud API can be:

• The single files built from the photogrammetric processing (dense point cloud, 3D Textured Mesh, DSM, DTM, orthomosaic, contour lines, index maps, etc.) or project outputs in bulk or as an archive. More information here.
• Project reports (quality reports and processing logs). More information here.
• Volume computations
• An embedded view and a share link to the project

What processing options are available? Is it possible to process with custom templates and how?

Currently, there are four different types of processing:

• Standard processing with PIX4Dmapper: Processing with PIX4Dmapper allows computing with different parameters called "templates". Depending on the type of flight and the desired outputs, a different template can be selected.
  • With a default template
  • With a user-defined template: Custom ones can also be defined, similarly to what can be done in PIX4Dmapper.
• Vegetation projects: Specific for projects with little texture in the images and the terrain is relatively flat, for example, crop fields or airports.
• Mobile processing: For images (and depth data optionally) captured by the PIX4Dcatch. This photogrammetric pipeline is optimized for this type of data and produces better and faster results. It can be used with images, or if your mobile device is equipped with a LiDAR scanner, the pipeline will use both images and depth data in the process. The outputs generated after processing are Orthophoto, DSM, point cloud, and 3D mesh.
• Building reconstruction projects: For images captured from oblique flights around targets with featureless facades, such as walls of a uniform color and texture, the building reconstruction pipeline can provide higher-quality results than standard processing would otherwise.

For more information, read here.

Can the processing status be checked?

Yes, the processing state can be checked via the API. More information here.

Are there any notifications when the processing finishes?

Yes, email notifications are sent by default. They can be disabled if not necessary.

Is the AutoGCPs module available with the PIX4Dengine Cloud API?

Yes, the AutoGCPs module is available via the API. It is also available via the PIX4Dcloud Advanced UI. For more information about how to use the functionality via the API, visit the official documentation.

Is it possible to have the PIX4Dcloud UI in our application?

It is possible to display the 2D and 3D views with the PIX4Dcloud user interface in your own application upon request. More information here. Please contact our sales team to enable this feature.

Is my data protected?

Data is end-to-end encrypted during transport (TLS) and at rest (AES256) in AWS S3. Data of a single user is stored separately from the data of other users. Pix4D cares about privacy and does not claim any ownership of the users' data. Find more information in our Terms of Use.

Where are my datasets processed and stored?

Each account is assigned to a regional cluster of servers that process and store your projects. This cluster can be changed in the Account Settings. More information in Where are my datasets processed and stored.

What happens if multiple projects are processed simultaneously, should I expect delays?

Depending on the load to the servers, computational resources are dynamically allocated to mitigate the peak load. Client requests are distributed and queued across the different servers of the same cluster in a manner that optimizes the load balance. Please inform us in advance if you plan to process an extraordinary number of projects on a specific date.

What is the expected level of services?

Minor maintenance operations are scheduled daily without service degradation. Major maintenance operations are scheduled with advanced notice. Unscheduled incidents are communicated via the Pix4D services status page. Subscribe to updates here.

What is the highest number of images that can be processed with the PIX4Dengine Cloud API?

Technically, a project cannot consist of more than 10000 images, but, in general, one has to consider the server's capabilities in relation to the project characteristics. For more information: How many images can PIX4Dcloud servers process?

Besides these technical limitations, there are no restrictions on the number of projects and images that can be processed and stored per month with a PIX4Dengine Cloud license.

What happens to my projects when the PIX4Dengine Cloud license expires?

Projects are kept on Pix4D servers according to the PIX4Dcloud storage expiration policy.

Which support service can Pix4D offer with a PIX4Dengine Cloud license?

Standard technical support is included with a PIX4Dengine Cloud license. Premium support with guaranteed response time, as per contract, can be opted for as a payable add-on. For more information about the different services: Pix4D Support.

How can I get technical support for the PIX4Dengine Cloud API?

Pix4D customers and trial holders: For technical questions, contact our support team.
Not a customer yet? For technical questions, contact sales.

Is there training for the PIX4Dengine Cloud API?

Currently, Pix4D can provide integration support with a PIX4Dengine Cloud API specialist but does not have a formal training service.