Bentley Systems

Reality Analysis API Overview

The Reality Analysis API enables AI/ML-based detection and analysis of objects or features in 2D and 3D reality data such as photos, maps, meshes, or point clouds by using ContextScenes to define data and Detectors (machine learning models) to run analysis jobs that produce annotated results stored within the Reality Management Service.

Table of contents

Collapse

v2

REST API Overview

Overview Context Scenes Detectors Tutorials Samples

Reference

View All

Changelog

Reality Analysis

Download API definition

Reality Analysis API

The Reality Analysis API provides the ability to run Artificial Intelligence / Machine Learning (AI/ML) on photos, maps, meshes or point clouds. It can detect objects or features in 2D and 3D for defect analysis, image anonymization, image indexing, asset management, mobile mapping, aerial surveying, and more.

Reality Analysis is articulated around Reality Data and Jobs. Reality Data are the data be to analyzed (photos, maps, meshes or point clouds). To describe on which data the analysis should be run and potentially some extra metadata (e.g. photo positions), we introduce a new type of Reality Data named ContextScenes. The analysis usually requires one or more Machine Learning models (e.g. a deep learning neural network). We call them Detectors. Given ContextScenes and Detectors, a Reality Analysis job produces different kinds of annotations (e.g. detected objects), which we store again in a ContextScene.

All the above mentioned reality data are stored via the Reality Management Service. The rest of the presentation assumes that you are familiar with the Reality Management API.

The Tutorials section, along with the API Reference, provides an excellent starting point for exploring Reality Analysis. Before we recommend reading:

Reality Analysis emits a realityAnalysis.jobCompleted.v2 iTwin event when a job completes. By creating a webhook with the Webhooks API, you can receive a callback at a specified endpoint whenever this event occurs.

Was this page helpful?

Like iconYesDislike iconNo