Infield Correction CLI tool

Contents

• Infield Correction CLI tool

  • CLI function overview

  • Verify

  • Correct

  • Read

  • Reset

CLI function overview

• verify: this function uses a single capture to determine the local dimension trueness of the point cloud where the Zivid calibration board is placed.

• correct: this function is used to determine the necessary parameters for improving the accuracy of the point cloud using captures of the Zivid calibration board. This will return a post-correction error as 1σ statistical certainty over the working distance the images were captured.

• reset: using reset will remove any infield correction that has been applied in previous correct instances. It is not required to do a reset before doing a new infield correction.

• read: the read function will return the last time an infield correction was written to the camera.

Verify

1. Place the board in the desired location.

2. Run the verify function using the command line: ZividExperimentalInfieldCorrection verify.

Correct

1. In order to align the board correctly it is recommended to use Zivid in live mode. The first time aligning the board for the infield correction, align the checkerboard at the closest point you want to capture for infield correction. Try to have the board as parallel as possible to the coordinate system in the camera and make sure the entire board is visible in the camera frame.

2. Call the infield correction tool using the terminal on the computer as ZividExperimentalInfieldCorrection correct (don’t forget to disconnect from the camera in Zivid Studio).

   1. On the Windows OS, the tool will be in PATH if Zivid was added to PATH during installation, otherwise, the CLI tool is found under C:\Program Files\Zivid\bin.

   2. On Linux, the CLI tool is in the main PATH.

3. If the board is too far out of the orientation or of poor quality to provide sufficient data, the CLI tool will inform you of the potential setup issue:

   1. Board is too tilted in X, Y, or Z plane.

   2. Not all of the feature points are detectable.

   3. The fiducial marker is not visible.

   4. The image of the board is of too poor quality to provide sufficient data.

4. When finished taking the captures for infield correction, the program will use the data to generate correction parameters. The information returned from completion include:

   1. Estimated new maximum dimension trueness error for the majority of the FOV.

   2. The range at which this error is expected dependent on the distances at which the correction images were taken.

   3. If satisfied with the correction output, then choose to apply the correction parameters to the camera.

Read

ZividExperimentalInfieldCorrection read

Use the read function to check when the last correction was written to the camera. This will return the date and time of the last correction applied to the camera.

Reset

ZividExperimentalInfieldCorrection reset

Use the reset function to remove the correction that has been applied to the camera. This will reset the camera to only having the Zivid factory calibration. It is not necessary to remove a correction before testing and applying a new one.