Calibration interfaces. More...

#include "ZRCSDKTypes.h"

Data Structures
struct	CameraBoundaryConfigurationNot
	Camera boundary configuration notification. More...

class	ICalibrationHelperSink
	Calibration helper event callback. More...

class	ICalibrationHelper
	Calibration helper interface. More...

Enumerations
enum class	IDCalibrationAction { IDCalibrationActionAdjustCamera , IDCalibrationActionCameraControl , IDCalibrationActionReadyToMove , IDCalibrationActionStartToMove , IDCalibrationActionFinishMoveToCheckResult , IDCalibrationActionAcceptCalibrationResult , IDCalibrationActionStopCalibration , IDCalibrationActionAskIfNeedSetCameraBoundary , IDCalibrationActionSwitchBoundaryCamera , IDCalibrationActionAdjustCameraBoundary , IDCalibrationActionVerifyBoundaryResults , IDCalibrationActionPreAcceptBoundary , IDCalibrationActionAcceptBoundaryResult , IDCalibrationActionPreviewIDBoundary }
	IDCalibration action type. Here are more detailed structural descriptions. More...

enum class	CBConfigurationAction { CBConfigurationActionFeatureIntroduce , CBConfigurationActionAdjustCamera , CBConfigurationActionReadyToMove , CBConfigurationActionStartToMove , CBConfigurationActionGetMoveResult , CBConfigurationActionAdjustCameraBoundary , CBConfigurationActionVerifyBoundaryResults , CBConfigurationActionConfigureFinish , CBConfigurationActionAcceptResult , CBConfigurationActionStopConfiguration }
	CBConfigurationAction action. Here are more detailed structural descriptions. More...

enum	CameraBoundaryConfigurationResult { CameraBoundaryConfigurationResultUpdateCameraInfo = 0 , CameraBoundaryConfigurationResultBoundarySuccess , CameraBoundaryConfigurationResultBoundaryFailed , CameraBoundaryConfigurationResultBoundaryStop }
	Camera boundary configuration result. Here are more detailed structural descriptions. More...

Detailed Description

Calibration interfaces.

Since: Added in ZRC SDK 6.1.0.

How to call the APIs to calibrate Intelligent Director(ID) and configure Camera Boundary(CB):

How to call the APIs to calibrate Intelligent Director:
1. You need to select 2 or 3 cameras for the Intelligent Director mode through calling the SelectIntelligentDirectorCamera API;
2. Call the StartIntelligentDirectorCalibration API to start the Intelligent Director Calibration;
3. When the current calibration action changes, you will receive the OnIntelligentDirectorCalibrationActionChanged sink, includes the available actions, call the APIs to continue;
4. After calling the IDCalibrationActionAcceptCalibrationResult API, calibration is done. You continue to configure id Camera Boundary if supported;
5. After calling the IDCalibrationActionAcceptBoundaryResult API, ID Camera Boundary is done. Configure Intelligent Director successfully;
6. Call the StopIntelligentDirectorCalibration API to cancel the calibration at any time.
How to call the APIs to configure Camera Boundary:
1. Camera Boundary is used to configure the main camera's boundary;
2. Call the StartCameraBoundaryConfiguration API to start the Camera Boundary Configuration;
3. When the current configuration action changes, you will receive the OnCameraBoundaryConfigurationActionChanged sink, includes the available actions, call the APIs to continue;
4. After calling the CBConfigurationActionAcceptResult API, Camera Boundary is done. Configure Camera Boundary successfully;
5. Call the StopCameraBoundaryConfiguration API to cancel the configuration at any time.

Intelligent Director Calibration workflows

 1. Calibrate Intelligent Director:

                                                  +--→ IDCalibrationActionAdjustCamera ←------------→ IDCalibrationActionCameraControl
                                                  |                  ↕
                                                  |    IDCalibrationActionReadyToMove ←---------+        
                                                  |                  ↓                          |
                                                  +----IDCalibrationActionStartToMove           |
                                                                     ↓                          |
                        +---------------------------IDCalibrationActionFinishMoveToCheckResult--+
                        ↓                                            ↓                       
     IDCalibrationActionAcceptCalibrationResult   IDCalibrationActionAskIfNeedSetCameraBoundary ←---------------------+
                                                                     ↕                                                |
                        +-------------------------→ IDCalibrationActionPreviewIDBoundary                              |
                        |                                            ↓                                                |
                        |     +------------------------------------------------------------------------------------+  |
                        |     | IDCalibrationActionSwitchBoundaryCamera ←→ IDCalibrationActionAdjustCameraBoundary |--+
                        |     +------------------------------------------------------------------------------------+
                        |                                            ↓
                        +--------------------------IDCalibrationActionVerifyBoundaryResults
                                                                     ↓
                                                    IDCalibrationActionPreAcceptBoundary
                                                                     ↓
                                                   IDCalibrationActionAcceptBoundaryResult 

 2. Recalibrate Intelligent Director:

     a. if the camera boundary in Intelligent Director Calibration has not been set:

                                                       IDCalibrationActionAdjustCamera -------------→ recalibrate Intelligent Director according to 1. Calibrate Intelligent Director.
                                                                     ↓                     
                                                  IDCalibrationActionAskIfNeedSetCameraBoundary ←---------------------+
                                                                     ↕                                                |
                        +-------------------------→ IDCalibrationActionPreviewIDBoundary                              |
                        |                                            ↓                                                |
                        |     +------------------------------------------------------------------------------------+  |
                        |     | IDCalibrationActionSwitchBoundaryCamera ←→ IDCalibrationActionAdjustCameraBoundary |--+
                        |     +------------------------------------------------------------------------------------+
                        |                                            ↓
                        +--------------------------IDCalibrationActionVerifyBoundaryResults
                                                                     ↓
                                                    IDCalibrationActionPreAcceptBoundary
                                                                     ↓
                                                   IDCalibrationActionAcceptBoundaryResult 


     b. if the camera boundary in Intelligent Director Calibration has been set:

                    +--------------------------------→ IDCalibrationActionAdjustCamera -------------→ recalibrate Intelligent Director according to 1. Calibrate Intelligent Director.                   
                    |                                                ↕
                    |                               IDCalibrationActionPreviewIDBoundary ←-----------------------------+                           
                    |                                                ↓                                                 |
                    |         +------------------------------------------------------------------------------------+   |
                    +---------| IDCalibrationActionSwitchBoundaryCamera ←→ IDCalibrationActionAdjustCameraBoundary |   |
                              +------------------------------------------------------------------------------------+   |
                                                                     ↓                                                 |
                                                   IDCalibrationActionVerifyBoundaryResults----------------------------+
                                                                     ↓
                                                    IDCalibrationActionPreAcceptBoundary
                                                                     ↓
                                                   IDCalibrationActionAcceptBoundaryResult

==========================================================================

Camera Boundary Configuration workflows

 1. Configure Camera Boundary:

                                                    CBConfigurationActionFeatureIntroduce
                                                                     ↕
                                                 +--→ CBConfigurationActionAdjustCamera ←---------+
                                                 |                   ↕                            |
                                                 |    CBConfigurationActionReadyToMove ←------+   |
                                                 |                   ↓                        |   |
                                                 +----CBConfigurationActionStartToMove        |   |
                                                                     ↓                        |   |
                                           +-------→ CBConfigurationActionGetMoveResult-------+---+
                                           |                         ↓                        |
                                           |  +-→ CBConfigurationActionAdjustCameraBoundary---+
                                           |  |    |                 |
                                           |  +----+                 ↓
                                           +------CBConfigurationActionVerifyBoundaryResults
                                                                     ↓
                                                    CBConfigurationActionConfigureFinish
                                                                     ↓
                                                     CBConfigurationActionAcceptResult 


 2. Reconfigure Camera Boundary:

                                                    CBConfigurationActionFeatureIntroduce ←------------→ start over Camera Boundary according to 1. Configure Camera Boundary.  
                                                                     ↓
                      +---------------------------CBConfigurationActionVerifyBoundaryResults
                      ↓                                              ↕
      CBConfigurationActionConfigureFinish       +--→ CBConfigurationActionAdjustCamera ←---------+
                      ↓                          |                   ↕                            |
      CBConfigurationActionAcceptResult          |    CBConfigurationActionReadyToMove ←------+   |
                                                 |                   ↓                        |   |
                                                 +----CBConfigurationActionStartToMove        |   |
                                                                     ↓                        |   |
                                           +-------→ CBConfigurationActionGetMoveResult-------+---+
                                           |                         ↓                        |
                                           |  +-→ CBConfigurationActionAdjustCameraBoundary---+
                                           |  |    |                 |
                                           |  +----+                 ↓
                                           +------CBConfigurationActionVerifyBoundaryResults
                                                                     ↓
                                                    CBConfigurationActionConfigureFinish
                                                                     ↓
                                                     CBConfigurationActionAcceptResult

Definition in file ICalibrationHelper.h.

Enumeration Type Documentation

◆ CameraBoundaryConfigurationResult

enum CameraBoundaryConfigurationResult

Camera boundary configuration result. Here are more detailed structural descriptions.

Enumerator
CameraBoundaryConfigurationResultUpdateCameraInfo	Update camera info.
CameraBoundaryConfigurationResultBoundarySuccess	Boundary success.
CameraBoundaryConfigurationResultBoundaryFailed	Boundary failed.
CameraBoundaryConfigurationResultBoundaryStop	Boundary stop.

Definition at line 195 of file ICalibrationHelper.h.

{
    CameraBoundaryConfigurationResultUpdateCameraInfo = 0,  
    CameraBoundaryConfigurationResultBoundarySuccess,       
    CameraBoundaryConfigurationResultBoundaryFailed,        
    CameraBoundaryConfigurationResultBoundaryStop,          
};

◆ CBConfigurationAction

enum class CBConfigurationAction

strong

CBConfigurationAction action. Here are more detailed structural descriptions.

, CB(Camera Boundary).

Enumerator
CBConfigurationActionFeatureIntroduce	Feature introduce.
CBConfigurationActionAdjustCamera	Adjust camera. You can adjust camera position through the ICameraControlHelper::ControlLocalCamera API when you are in this action.
CBConfigurationActionReadyToMove	Ready to move.
CBConfigurationActionStartToMove	Start to move.
CBConfigurationActionGetMoveResult	Get move result.
CBConfigurationActionAdjustCameraBoundary	Adjust camera boundary.
CBConfigurationActionVerifyBoundaryResults	Verify boundary results.
CBConfigurationActionConfigureFinish	Configure finish.
CBConfigurationActionAcceptResult	Accept result.
CBConfigurationActionStopConfiguration	Stop configuration.

Definition at line 177 of file ICalibrationHelper.h.

{
    CBConfigurationActionFeatureIntroduce,          
    CBConfigurationActionAdjustCamera,              
    CBConfigurationActionReadyToMove,               
    CBConfigurationActionStartToMove,               
    CBConfigurationActionGetMoveResult,             
    CBConfigurationActionAdjustCameraBoundary,      
    CBConfigurationActionVerifyBoundaryResults,     
    CBConfigurationActionConfigureFinish,           
    CBConfigurationActionAcceptResult,              
    CBConfigurationActionStopConfiguration,         
};

◆ IDCalibrationAction

enum class IDCalibrationAction

strong

IDCalibration action type. Here are more detailed structural descriptions.

, ID(Intelligent Director).

Enumerator
IDCalibrationActionAdjustCamera	Adjust camera.
IDCalibrationActionCameraControl	Camera control. You can adjust camera position through the ICameraControlHelper::ControlLocalCamera API when you are in this action.
IDCalibrationActionReadyToMove	Ready to move.
IDCalibrationActionStartToMove	Start to move.
IDCalibrationActionFinishMoveToCheckResult	Finish move to check result.
IDCalibrationActionAcceptCalibrationResult	Accept calibration result.
IDCalibrationActionStopCalibration	Stop calibration.
IDCalibrationActionAskIfNeedSetCameraBoundary	Ask if need set camera boundary.
IDCalibrationActionSwitchBoundaryCamera	Switch boundary camera.
IDCalibrationActionAdjustCameraBoundary	Adjust camera boundary.
IDCalibrationActionVerifyBoundaryResults	Verify boundary results.
IDCalibrationActionPreAcceptBoundary	Pre-accept boundary result.
IDCalibrationActionAcceptBoundaryResult	Accept boundary result.
IDCalibrationActionPreviewIDBoundary	Preview ID boundary.

Definition at line 153 of file ICalibrationHelper.h.

{
    IDCalibrationActionAdjustCamera,              
    IDCalibrationActionCameraControl,             
    IDCalibrationActionReadyToMove,               
    IDCalibrationActionStartToMove,               
    IDCalibrationActionFinishMoveToCheckResult,   
    IDCalibrationActionAcceptCalibrationResult,   
    IDCalibrationActionStopCalibration,           
 
    // boundary
    IDCalibrationActionAskIfNeedSetCameraBoundary,  
    IDCalibrationActionSwitchBoundaryCamera,        
    IDCalibrationActionAdjustCameraBoundary,        
    IDCalibrationActionVerifyBoundaryResults,       
    IDCalibrationActionPreAcceptBoundary,           
    IDCalibrationActionAcceptBoundaryResult,        
    IDCalibrationActionPreviewIDBoundary,           
};

Data Structures