Unreal Engine 5 Documentation has been moved to the Epic Developer Community

Goals

In this Quick Start guide, you will go through the steps to calibrate lens distortion and the nodal point offset , using the Camera Calibration plugin in a production environment.

Objectives

• Connect your camera to Unreal Engine (UE) so it provides a live video feed.

• Calibrate lens distortion using the Camera Calibration plugin.

• Calibrate the nodal point offset of the tracking system to the lens using the Camera Calibration plugin.

1 - Required Setup

For this guide, you will use a production camera, an optical camera tracking system, and an AJA Kona 5 for source video input.

A master clock is optional to supply a timecode and sync to the AJA Kona 5. In a production environment, it is recommended that the production camera and the camera tracking system be supplied with the sync and timecode as well. You will need them if you want to proceed with a CG composite over live video to make sure the layers are synchronized. Optionally, you can stream the focus, aperture, and focal length to UE using the Preston Live Link Plugin or the Live Link Master Lockit Plugin.

1. Create a new Unreal Engine project. Select the Film, Television, and Lived Events category and click Next .

2. Select the Virtual Production template and click Next .

3. Enter the file location and project name, and click Create Project .

4. Once the editor is loaded, click Settings > Plugins to open the Plugins Menu .

5. Select the Virtual Production category and enable the Camera Calibration and LiveLink plugins. Select Yes on the pop-up box and click Restart Now to restart the editor.

Section Results

You enabled the Camera Calibration and LiveLink plugins and restarted the editor. You are now ready to continue with the calibration process.

2 - Creating your Media Profile

You can use a Media Profile to set up video source input and output, as well as the timecode and sync format. In this section, you will create a new Media Profile to set these parameters.

You will only need the video source from the production camera to set lens distortion and nodal offset calibration.The timecode and sync are not required, but it is important to know how to set them up in a Media Profile for synchronizing a CG composite to a video source.

1. Click Media Profile > New Empty Media Profile to open the Media Profile window.

   1. Select MediaProfile and click Select .

   2. Choose a destination folder and enter a name for your profile.

   3. Click Save .

2. Expand the Media Sources category under Inputs and click on the MediaSource-01 dropdown. Select the Aja Media Source option.

3. Expand the AJA category and click the Configuration dropdown. Select your Device , Source , Resolution , Standard , and Frame Rate . Click Apply .

4. Click the Timecode Format dropdown and select your format. LTC is the timecode embedded in the video source.

5. Enable the Is sRGBInput checkbox to convert YUV to RGB.

Timecode Setup

1. Scroll down to the Timecode Provider section.

   1. Enable the Override Project Settings checkbox.

   2. Click the Timecode Provider dropdown and select AJA SDI Input from the list.

   3. Enable the Use Dedicated Pin checkbox (this is the Dedicated TC cable on the breakout cable attached to the AJA Kona 5).

2. Click the LTConfiguration dropdown to expand it and select your Device , LTC Index , and Frame Rate . Click Apply .

Genlock Setup

1. Scroll down to the Genlock section.

   1. Enable the Override Project Settings checkbox.

   2. Click the Custom Time Step dropdown and select AJA SDI Input from the list.

   3. Enable the Use Reference in checkbox.

2. Click the Configuration dropdown and select your Device , Source , Resolution , Standard , and Frame Rate . Click Apply .

3. Click Apply and Save on the toolbar to save your changes.

Section Results

In this section you created a new Media Profile, and configured the video source input. You also added the optional Timecode and Genlock for syncing if a master clock is being used at this stage.

3 - Creating a Lens File

The Lens File provides the calculation and storage of distortion and nodal offset data, specific to each lens-to-camera combination. We recommend you create a new Lens File if the lens, tracking object location, or the camera body changes.

1. Right-click in the Content Browser and click Miscellaneous > Lens File to create a new Lens File.

2. Double-click the Lens File in the Content Browser to open it.

3. Under the Viewport Settings section, change the Transparency to 0.0 . This controls the transparency of the CG elements over the video source image.

   • A Transparency of 0 hides all CG elements.

   • A Transparency of 1 shows the CG elements only.

4. Click the Camera dropdown and select the connected camera from the list. Click the Media Source dropdown and select the Media Profile you created earlier.

5. Under the Lens Info section, enter the Lens Model Name. A recommended naming convention combines the camera body name and the focal length.

6. Add the Lens Serial Number if available. Add the Lens Model (only spherical lens models are supported at this time). Enter the Sensor Dimensions to match your camera.

7. Click Save Lens Information .

Properties Summary

At the bottom of the Lens File window you will find a summary of the current properties applied to the Lens File. Most of the properties show as blank or N/A at this stage. These properties will update as you continue with the calibration process.

Section Results

In this section you created a new Lens File and added the lens and camera information.

4 - Creating your Virtual Live Link Subject

A Virtual Live Link Subject is used to manually input the focus, aperture, and focal length values in the absence of a device that is used to stream these values. If you are using a Preston MDR Unit (Section 7) or an Ambient Master Lockit Plus device (Section 8) to stream lens data to UE, proceed to the relevant section to set these up.

In this section, you will create a new Live Link Virtual Subject to manually input the values for focus, iris, and zoom.

1. Right-click in the Content Browser and select Live Link > Blueprint Virtual Subject .

   1. Select the Live Link Camera Role from the dropdown and click OK**.

   2. Double-click the virtual subject asset in the Content Browser to open it.

2. Click + Variable to add a new variable. Name the variable Focus . Go to the Details panel and set the Variable Type to Float . Enable the Instance Editable checkbox.

3. Repeat the above step twice to create two additional Float variables named Zoom and Iris .

4. Right-click in the Event Graph then search for and select Update Virtual Subject Static Data .

   1. Connect the Update Virtual Subject Static Data node to the Event On Initialize node.

   2. Right-click the Static Data pin in the Update Virtual Subject Static Data node and select Split Struct Pin .

5. Enable the Focal Length , Aperture and Focus Distance checkboxes, as seen below.

6. Right-click in the Event Graph then search for and select Update Virtual Subject Frame Data .

   1. Connect the Update Virtual Subject Frame Data node to the Event On Update node.

   2. Right-click the Frame Data input pin in the Update Virtual Subject Frame Data node and select Split Struct Pin . This event is triggered on every tick and will be used to update the FIZ data available for each frame.

7. Connect the Zoom variable to the Focal Length input pin.

   1. Connect the Iris variable to the Aperture input pin.

   2. Connect the Focus variable to the Focus Distance input pin.

   3. Compile and Save the Blueprint.

Section Results

In this section you created a new Live Link Virtual Subject and configured it so it can be used to manually input Focus, Iris, and Zoom to your CineCamera Actor.

5 - Connecting your Sources to Live Link

In this section you will use Live Link to connect a Virtual Subject and an Optitrack source used to track the camera.

1. Go to Window > Live Link to open the Live Link window.

2. To add the camera tracking, click + Source > OptiTrack Source and click Create .

3. To add the Live Link Virtual Subject, click + Source > Add Virtual Subject . Select the Virtual Subject created in the previous section and click Add .

4. To manually input Focus , Iris, and Zoom values, select the Virtual Camera in the Live Link window and input the values under the Default section.

5. Select your CineCamera Actor in the World Outliner and go to the Details panel. Click + Add Component and search for then select Live Link Component Controller . Rename the component to LiveLinkComponentControllerFiz.

6. Inside the Details panel, scroll down to the Live Link section and click the Subject Representation dropdown. Select the Virtual Camera from the list.

7. Repeat the previous step to add another Live Link Controller component, and rename it LiveLinkComponentControllerTracking .

8. In the Details panel, click the Subject Representation dropdown. Select the physical camera from the list. In this example, it is the Alexa_LF_A being streamed over Live Link from Motive.

Section Results

In this section, you connected the Live Link Virtual Subject and the Optitrack Live Link to the CineCamera Actor.

6 - Evaluating Sync and Timecode with a Timed Data Monitor (Optional)

This is an optional section for users that will use timecode and sync with the Kona 5 and want to evaluate the source inputs. You can also adjust the timing offsets and buffers to make sure the CG elements are in sync with the video source and tracking data.

1. Click Settings > Plugins to open the Plugins Menu .

2. Select the Virtual Production category and enable the Timed Data Monitor plugin. Select Yes on the popup box and click Restart Now to restart the editor.

3. Once the editor has reloads, click Window > Developer Tools > Timed Data Monitor to open the Timed Data Monitor window. The Timed Data Monitor is used to monitor the sync and timecode of different devices. It can also be used to synchronize devices using buffers and offsets to the incoming data by evaluating the timecode properties of the devices.

4. Change the Eval Mode to Timecode and enter your Global TC Offset value. In this example, the Global TC Offset value entered was 3 frames, to allow the synchronization between the tracking system and the Video input from the AJA. The buffer size of the tracking system was increased to 50.

Section Results

In this section you learned how to use the Timed Data Monitor plugin to set the timecode and Global TC Offset of your Kona 5.

7 - Connecting your Preston System (Optional)

If you are using a Preston system with your production camera, follow the steps on the Connecting your Preston system guide.

8 - Connecting Smart Lens Using Master Lockit Plus (Optional)

If you are connecting a Smart lens using an Ambient Master Lockit Plus device, follow the Connecting your Master Lockit System guide.

9 - Calculating Lens Distortion

To calculate lens distortion, you will need a physical checkerboard printed and mounted on a rigid surface to hold in view of the production camera. You can also use a checkerboard image displayed on a tablet. A CG checkerboard will be created to match the properties of the physical checkerboard.

1. On the Place Actors tab, click the Virtual Production category and drag the Checkerboard Actor into your level.

2. Select the Checkerboard Actor in the World Outliner window.

   1. Go to the Details panel and scroll down to the Calibration section.

   2. Enter the Number of Corner Rows .

   3. Enter the Number of Corner Columns .

   4. Enter the Square Side Length in cm.

   5. These values need to match the physical Checkerboard being used.

3. The example above uses a physical checkerboard containing 7 row corners and 11 column corners. Each square side is 4.5cm in length. This image shows the checkerboard used in the example.

4. Initially there aren't any materials assigned to the checkerboard. Click the Odd Cube Material and Even Cube Material dropdowns and select the desired Materials. If your physical checkerboard starts with a black square in the top left, then that will be the Odd Cube Material color.

5. Select your CineCamera Actor in the World Outliner window.

   1. Select the Live Link Controller Component previously created to receive FIZ data.

   2. Go to the Details panel, scroll down to the Camera Role dropdown, and open it.

   3. In the Camera Calibration section, click the Lens File dropdown and select the Lens File you created earlier.

6. Double-click the Lens File in the Content Browser to open it and click the Lens Distortion tab.

7. Place the checkerboard in front of the camera as shown below.

8. Go to the Lens Distortion section.

   1. Click the Lens Distortion Algo dropdown and select Lens Distortion Checkerboard .

   2. Click the Checkerboard dropdown and select the Checkerboard Actor created earlier.

   3. Enable the Show Detection checkbox. This will create a preview image each time an image is created for use in calculating lens distortion.

9. Click on the viewport to start the calibration process and create the first image to be used.

10. Move the Checkerboard around the camera field of view and continue to click the image to capture a calibration picture. Make sure to move the Checkerboard's location enough times to cover the field of view with overlapping images.

11. After collecting enough images (minimum of 4 is required), click Add To Lens Distortion Calibration , then click OK on the Lens Calibration Info dialog box.

12. You will now see the Distortion Parameters update at the bottom of the window.

Section Results

In this section, you set up your CG checkerboard to match your physical checker board, captured images of your physical checkerboard, and used this to add lens distortion calibration data to your lens file and camera. Optionally, you created a distortion profile that changed over different focus distances.

10 - Confirming Lens Distortion

To check the lens Distortion, you can use the Nodal Offset tab. In this case the untracked CG checkerboard in your scene will be moved to the camera and will overlay the video feed. If the CG overlay matches the Video feed the calculation is visually confirmed.

1. Click the Nodal Offset tab and go to the Nodal Offset section.

   1. Click the Nodal Offset Algo dropdown and select Nodal Offset Checkerboard .

   2. Click the Checkerboard dropdown and select your Checkerboard Actor .

2. Click the image to populate all the corner data from the calibration. Click Apply To Calibrator . This will move the CG Checkerboard actor to the camera.

3. Go to the Viewport Settings section and change the Transparency value from 0 to 1 to verify the Checkerboard Actor matches the physical checkerboard in the camera viewport.

Section Results

In this section, you verified the lens distortion calculation by matching the CG Checkerboard Actor to the physical checkerboard in the camera's viewport.

11 - Creating a Tracked Object for Nodal Offset Calibration

The nodal offset accounts for the difference between the axis of the tracked camera and the axis of the actual nodal point of the lens/camera combination being calibrated. If the lens is changed or the tracking device on the camera is moved, a new nodal point offset will need to be calculated.

In order to calculate the nodal offset to be applied to the Cine Camera, you will need to create a physically tracked object. A CG model needs to be made of this tracked object. In this example, the physical checkerboard that was used previously had tracking markers added to it. A CG model was created to match the tracked checkerboard and was set up for optical tracking. The CG checkerboard is imported into UE for use in the next steps.

1. Right-click in the Content Browser and select Blueprint Class under the Create Basic Asset section.

   1. Click Actor on the Pick Parent Class window.

   2. Name the Blueprint Checkerboard_TRK .

2. Double-click the Checkerboard_TRK Blueprint in the Content Browser to open it.

   1. Go to the Components window and click + Add Component .

   2. Search for then select Static Mesh .

3. Go to the Details panel and scroll down to the Static Mesh section. Click the Static Mesh dropdown and search for then select Checkerboard_mesh from the list.

4. With the Static Mesh component selected, go to the Components window and click + Add Component .

   1. Search for then select Calibration Point .

   2. Name the component Top_Left .

5. Inside the Viewport , place the Top_Left component on the top left point in the checkerboard, as seen below.

6. Duplicate the Top_Left component four times and name the new copies Bottom_Left , Bottom_Right , Top_Right , and Center . Place those components in their corresponding locations on the checkerboard mesh. Compile and Save the Blueprint.

7. Drag the Checkerboard_TRK Blueprint to your level and go to the Details panel.

   1. Click + Add Component and search for then select Live Link Controller .

   2. Select the Live Link Controller component and scroll down to the Live Link section.

   3. Click the Subject Representation dropdown and select Checkerboard .

Section Results

In this section you created a new Checkerboard Actor and added five Calibration Points - Top Left, Bottom Left, Bottom Right, Top Right, and Center.

12- Calculating Nodal Offset

The nodal offset applies an offset to the CG Cine camera to account for the actual nodal point of the lens being used on the physical camera.

The Camera Calibration plugin calculates the nodal offset by having the tracked object move to different positions in front of the physical production camera. In this example, the Checkerboard Actor has calibration points which are collected and used to calculate the nodal offset.

1. Double-click the Lens File in the Content Browser to open it.

   1. Click the Nodal Offset tab and go to the Nodal Offset** section.

   2. Click the Nodal Offset Algo dropdown and select Nodal Offset Points Method .

   3. Click the Calibrator dropdown and select the Checkerboard_TRK Actor.

2. Click on the checkerboard image in the viewport to match the location of each Calibration Point. For example, click the bottom right corner of the checkerboard to match the Bottom_Right Calibration Point .

   The Calibration Points will update automatically as you click on the image.

3. Move the tracked checkerboard to 5 to 8 different positions in front of the camera and acquire a set of calibration points at each position.

4. When you are finished, click Add To Nodal Offset Calibration .

5. Check that the nodal offset has been applied correctly by checking the properties of nodal offset applied.

6. Change the transparency from 0 to 0.5. The CG element of the tracked checkerboard should overlay exactly the checkerboard in the live video.

7. Pan the tracked camera and move it around the tracked checkerboard and the CG version should stay correctly superimposed over the physical checkerboard in the live video feed.

8. If you did not set up a timecode and genlock, and adjusted synchronization using the Timed Data Monitor, there may be lag in the CG element as you move. When you stop moving the camera, the CG element will line up again.

Section Results

In this section you collected calibration point values by clicking the checkerboard image to match each calibration point. After enough calibration points were collected by moving the tracked checkerboard around, you applied the nodal offset to the camera parent. Lastly, you verified that the nodal offset was correct by checking that the CG version of the checkerboard was overlaid on the real version in the video source correctly.