PIX4Dengine SDK data model

The PIX4Dengine SDK data model is composed of a set of data types representing the inputs and outputs of processing algorithms. Some of these may also be used as inputs to file exporters. Examples are input cameras, calibrated cameras, calibrated scene, densified point cloud, etc.

Due to the manner in which pix4dvortex has evoled, these data types can be roughly grouped into two categories: classes corresponding to the publicly documented OPF data model, and ones that are specific to pix4dvortex. This difference is mainly historical: pix4dvortex predates the OPF specification, and in the long term the goal is for all of the data model to be expressed purely in terms of OPF types. The distinction is also useful because users may use the public OPF specification pages directly for the most accurate, up to date documentation. Furthermore, OPF presents interoperability opportunities between pix4dvortex and other PIX4D products, typically through the serialized representation of OPF objects.

Both categories are further explained in the following sections.

dmodel: OPF compatible data model

Module dmodel contains OPF compatible classes, which are inputs and outputs of processing algorithms. In many cases, OPF data types have inter-dependencies and have limited usability in isolation. For this reason, they may be bundled together in “OPF composites” (for instance, input projected cameras or calibrated cameras have positions that require the corresponding scene reference frame to be correctly geo-positioned). “OPF composites” form part of the pix4dvortex specific data model, described below.

For more information, see the OPF data model API documentation section and OPF documentation for main dmodel types.

pix4dvortex specific data model

This refers to processing input and output data types that are pix4dvortex specific. These can be either composites of dmodel classes (i.e. classes containing two or more pix4dvortex.dmodel objects), or independent from OPF. For more information, see the pix4dvortex data model API documentation section.

Note

In the long term the pix4dvortex data model should be purely expressed in terms of OPF classes, either directly or through composites thereof. The current mix is largely due to the timing of the publication and internal adoption of OPF, and the need to maintain backwards compatibility when implementing changes to pix4dvortex.