OptiCalStagePlan

Base class (inherits properties and methods): Resource

Subclasses: OptiCalResult

Properties

alertSettings : OmniCalAlertSettings

This plan’s configuration for optional features that provide OmniCal guidance or alert to potential issues.

alignmentData : AlignmentData

alignmentObjects : List[Object]

Stage objects to use for alignment in addition to the Plan’s projection surfaces

UserName: Additional alignment objects

blobDetectionSettings : BlobDetectionSettings

calibrationResultsSummary : CalibrationResultsSummary (Read-Only)

This plan’s OmniCal results for all cameras and projectors, including aggregate score.

calibrationSettings : CalibrationSettings

cameras : List[OptiCalCameraPlan]

UserName: Cameras

captureSettings : CaptureSettings

captureViewSettings : CaptureViewSettings

deformationSettings : ObjectDeformationSettings

gridErrors : List[GridAlignmentErrorData]

isSimulated : int

Switch between simulated cameras and physical machine vision cameras.
This may toggle Camera Discovery, depending on whether other systems (API, GUI) request it or not.

UserName: Use simulated cameras

projectors : List[Projector]

UserName: Projectors

quickAlignViewSettings : QuickAlignViewSettings

report : OptiCalReport (Read-Only)

rigCheckAlignmentData : AlignmentData

Methods

addAlignmentDataPose(self) -> AlignmentDataPose

alignmentFromCamerasAndProjectors(self, bProjectors: bool) -> Mat

alignmentFromData(self, ad: AlignmentData) -> Mat

alignmentPoseCapturePath(self, poseName: str) -> Path

alignmentPoseNamePrefix(self) -> str

applyAlignmentToStage(self, alignMat: Mat)

applyManualAlignment(self)

applyMobileCamParams(self)

cameraImageRotation(self, camName: str) -> int

capturePath(self) -> Path

cleanupMobileCams(self)

distortPoint(self, p: Vec2, camName: str) -> Vec2

enableMobileCamStats(self, cam: MobileCam, enable: bool)

enableMobileCamStatsAll(self, enable: bool)

enableMobileCamStreaming(self, enable: bool)

ensureMasterScreensAreValid(self)

estimateAlignmentBasic(self) -> Mat

findCameraPlan(self, cameraName: str) -> OptiCalCameraPlan

getAlignmentImageBasePose(self, camName: str, guideLines: bool) -> DxTexture

getAlignmentImagePose(self, camName: str, guideLines: bool, poseName: str) -> DxTexture

getAlignmentObjects(self) -> List[Object]

getAlignmentObjectsWithChangedMeshes(self) -> List[Object]

getAutoApplyDeformObjects(self) -> List[Object]

getCameraMats(self, camName: str) -> CameraMats

getCameraNames(self) -> List[str]

getGridImage(self, camName: str, iDisplay: int) -> DxTexture

getProjectionSurfaces(self) -> List[Screen2]

hasActiveCamerasAndProjectors(self) -> bool

hasCalibration(self) -> bool

hasCapture(self) -> bool

hasStackedProjector(self) -> bool

isCalibrating(self) -> bool

isCameraCalibrated(self, cameraName: str) -> bool

isCapturing(self) -> bool

isDeforming(self, objectUid: int) -> bool

isExecuting(self) -> bool

isLoadedFromFiles(self) -> bool

isRunning(self) -> bool

makeProjectorRestorer(self, restoreShutterStates: bool) -> ProjectorRestorer

makeVirtualCamComms(self) -> VirtualCameraCommunication

nAliveMVPlanCameras(self) -> int

/** The number of MV cameras from this plan that are currently alive. */

nCameraPlans(self) -> int

requestCalibrate(self) -> OptiCalTask

requestCapture(self, resume: bool) -> OptiCalTask

requestDeform(self, deformationSettings: ObjectDeformationSettingsPair) -> OptiCalTask

requestDeformObjects(self, objects: List[Object]) -> OptiCalTask

requestExecute(self) -> OptiCalTask

requestGridImage(self, camName: str, iDisplay: int)

requestUpdateStackingWarps(self) -> OptiCalTask

resetProjectors(self)

setCameraImageRotation(self, camName: str, angle: int)

setMobileCamBandwidth(self)

setStackedProjectorShutters(self, open: bool)

undistortPoint(self, p: Vec2, camName: str) -> Vec2

undistortTexture(self, camName: str, dxt: DxTexture) -> DxTexture

updateAlignmentData(self)

updateCaptureSettings(self)

updatePoseMasterScreenData(self, pose: AlignmentDataPose)

validateCapture(self) -> bool