OpticalCalibrator
Properties
applyAlignment : int
Apply the alignment of the currently selected plan or result to the stage via open module
Options: {0: ‘None’, 1: ‘Plan’, 2: ‘Result’}
backupResults : List[OptiCalResult]
Additional RigCheck Results that should never be deleted. Any Result in this backup list, as well as the Current and Fallback Result are considered ‘in use’.
UserName: Additional Results to keep
cameraBandwidthGbit : float
Total network bandwidth allocation for physical machine vision cameras in Gigabits per second.
This will be divided evenly among all active cameras in a plan.
Each camera is further limited by the practical 1-Gbit port limit of 920 Mbit/s.
To avoid dropped packets set this to:
- around 0.85 for a 1-Gbit switch
- around 1.8-8.5 for a 10-Gbit switch (higher if more cameras are active)
Minimum: 0.16 Gbit/s, Maximum: 25 Gbit/s, Default: 0.85 Gbit/s.
UserName: MV Network Bandwidth (Gbit/s)
cameraBandwidthMode : int
Whether camera bandwidth is automatically managed or not
Options: {0: ‘Manual’, 1: ‘Auto’}
discoveryAdapterName : str
fallbackResult : OptiCalResult
A previous successful RigCheck Result, for fallback. The ‘Revert to Fallback’ action will switch to this, applying its calibration and alignment.
UserName: Fallback Result
manageOnlyInternalProcesses : int
Whether d3 only stop its own camera server processes, or also externally launched ones.
nDaysToKeepResults : int
Number of days for which to keep RigCheck Results. Any unused Results older than this will be removed during cleanup.
Default: 14 days.
UserName: Days to keep Results
plan : OptiCalStagePlan
The OmniCal Plan for execution at this venue.
UserName: Capture Plan
renderFrameDelay : int
Delay in [frames] between setting OmniCal render state and assuming visible projector output for camera capture. Try values above 5 if the downstream signal chain has additional delays.‘
report : OptiCalReport
resetAndRescanTask : OptiCalTask (Read-Only)
result : OptiCalResult
Currently active RigCheck Result (if any).
UserName: Result
showCode : int
simulateProjectorLensDistortion : bool
simulateProjectorWarpGrid : bool
simulateStackedProjectorOutputs : bool
testSimulatedProjectorWarps : bool
testWarpGridSize : Int2
visualisation : int
Turn visualisation of certain OmniCal results on or off.
visualisationSource : int
Whether to visualise currently selected Capture Plan or RigCheck Result
UserName: Visualisation Source
Methods
canDeleteResults(self) -> bool
/** Whether cleaning up RigCheck Results is currently possible (i.e. whether OmniCal is already busy). */
canExecutePlan(self) -> bool
/** Whether it is possible to run RigCheck to execute the current Plan. Returns false if OmniCal is busy, setup is not complete, or camera discovery is off. */
canExecutePlanIgnoreDiscovery(self) -> bool
/** Whether it is possible to run RigCheck to execute the current Plan. Returns false if OmniCal is busy or setup is not complete. */
canRevertResult(self) -> bool
/** Whether reverting a RigCheck Result is currently possible (a Fallback Result is valid, loaded and calibrated). */
cannotDeleteResultsReason(self) -> str
/** Translated message describing why RigCheck Results cannot be cleaned up at the moment. */
cannotExecutePlanReason(self) -> str
/** Translated message describing why Plan cannot be executed at the moment. */
cannotRevertResultReason(self) -> str
/** Translated message describing why the RigCheck Result cannot be reverted at the moment. */
clearMeshDataCache(self)
clearRenderedObjects(self)
deleteOldResults(self) -> bool
/** Deletes all Results that are not in use and that are older than the number of days configured in Designer. */
disableWarps(self)
executePlan(self) -> OptiCalTask
findOldResults(self, nDaysToKeepResults: int) -> List[Path]
/** Find all RigCheck Results that are considered ‘old’, i.e. that are not in use and that are older than the specified number of days. */
findResultsToKeep(self, nDaysToKeepResults: int) -> List[Path]
/** Find all RigCheck Results that are not considered ‘old’, i.e. that are in use or newer than the specified number of days. */
getObject(self) -> OpticalCalibratorObject
isBusy(self) -> bool
isCapturing(self) -> bool
noResultsToDeleteMessage(self) -> str
/** Message detailing why no RigCheck Results get deleted with current settings. */
renderStageFromCamera(self, cameraMats: CameraMats, widgetViewMat: Mat, imageScale: Vec2, imageCentre: Vec2, stageRenderOpacity: float)
renderWireframeFromCamera(self, mesh: Mesh, worldMat: Mat, cameraMats: CameraMats, widgetViewMat: Mat, imageScale: Vec2, imageCentre: Vec2, wireframeParams: WireframeRenderParams)
requestResetAndRescan(self) -> OptiCalTask
revertResult(self)
/** Revert current RigCheck Result to the last successful one, and apply its Calibration and Alignment to the Stage. */