API Reference#
This section contains a detailed description of the functions, modules, and objects included in pysdic. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts.
The API is organized into several sections, each corresponding to a specific aspect of the package:
Core Functions
This section provide the API reference for the core functions of the package without requesting the package implemented objects. These functions are used to perform various operations on meshes, integration points, images, cameras, and views directly on NumPy arrays.
Objects Reference
This section provide the API reference for the objects implemented in the package. These objects are used to store and manipulate geometrical entities such as point clouds, meshes, integration points, images, cameras, and views.
Blender Integration
This section provide the API reference for the classes and functions to generate and manipulate 3D scenes in Blender. This integration allows users to visualize and analyze SDIC results within the Blender environment.
Workflow Integration
This section provide the API reference for the workflow functions on the specific objects of the package. These functions are used to perform SDIC for a given configuration.