Quick Start: Mask ML

< Previous | Contents | Manuals Home | Boris FX | Next >

Quick Start: Mask ML

Mask ML is a powerful machine-learning–driven masking tool integrated into SynthEyes. It streamlines object isolation and improves match-moving accuracy by automatically tracking and masking moving objects—so you can focus on solving your shot without having to manually rotoscope or draw garbage mattes. This brief guide will help you get started with Mask ML quickly.

Open Your Shot and Launch MaskML Start SynthEyes

From the SynthEyes main menu, select File > New (or File > Import > Shot) and open your shot.

Go to the Roto Masking Panel

Select Roto Masking from the top toolbar.

Click the Mask ML button in the Roto Masking panel. (Alternatively, you can go to the main menu: Track > Mask ML.)

The Mask ML dialog now appears.


image

Create a new Mask ML layer

By default, Layer1 is created upon launching Mask ML. Give it a descriptive name, especially if you plan multiple layers.

Add Object Samples

With Add Object Samples selected, click directly in the viewer on the object you want Mask ML to isolate.

You can also drag out a Rectangle to select an area that has several related components.

Keyframe as Needed

If the mask slips later in the timeline, scrub to that frame and again select your object.

Mask ML will interpolate between keyframes, making your mask track smoothly over time.


image


Configure Masking Range and Export Settings Masking Range

Choose how many frames to process: Entire Shot (default), Playback Range, or a Custom Range (set First Frame and Last Frame to mask only part of the shot).

Limiting the range saves time if the object only appears during a portion of the shot.

Mask Filename Template

Adjust the folder and filename pattern in Mask Filename template using tags if needed. (See Filename Template Tags and Project Tags Manager in the User Manual or in the bottom right of the preferences panel).

Or, click Browse to pick a location. Keep the “(MASKLAYER)” tag in there.

Layer names will be expanded automatically in the template as the layer is written

Show Live Mask

Enabled by default. It displays mask results as they are generated.

Turn it off if you want faster performance while Mask ML processes (no live updates).

Write Garbage Matte also

If enabled, Mask ML will output a single combined garbage matte for all layers in the same output folder.

Useful if you need one big matte in external compositing tools.


image

Write the Masks

When you are satisfied with your mattes:

Write Current Layer to output only the currently selected layer.

All layers to output every Mask ML layer you have created.

Mask ML will generate the mask frames to the designated location and automatically add them into SynthEyes’s Roto Masking panel—ready to be used for isolating objects in your camera solve.


image


Proceed to the Track and Solve

Return to the main SynthEyes tracking workflow (for example, the Summary panel or an Auto-Track workflow).

The newly created masks will isolate the masked objects from your 2D tracking.

Perform your camera solve as usual—moving objects or obstructions are masked out, leading to a cleaner track and more reliable 3D solution.

NOTE : Go to File > Batch Export to submit multiple shots for Mask ML matte generation, tracking, and solving in a single batch. You can then continue working on other tasks while SynthEyes processes everything in the background. Just submit your shots, hit Start Batch Processing, and SynthEyes will handle the rest. Batch processing will use any exporters you have set up in Multi-Export.

Tips for Best Results

Pick a clear reference frame where your object is fully visible when first adding object samples.

Use a different layer for different objects: two layers for two actors, three layers for three trees.

Using one or a few points usually works well even if the object contains several distinct regions, such as different shirt and pants for an actor or actress or a box with different sides. For a compact object with multiple regions such as a box, you might also try a bounding rectangle—sweep out a rectangle roughly enclosing the object to be tracked.

The exact placement of points or the rectangle isn’t important to this process; there’s generally no reason to make fine adjustments. If you need to do so, delete and recreate the point or rectangle.

Use keyframes sparingly—only add them if the mask is noticeably inaccurate later in the shot.

Name your layers descriptively to stay organized, especially with multiple objects.

Shorten the Masking Range if you only need part of the shot, saving time and resources.

Preview your masks to verify they track correctly before proceeding to the final solve.


That’s it! You’ve quickly isolated objects with Mask ML and can now continue your match-move workflow with fewer obstructions in your scene. Enjoy the significant time savings and the cleaner results that Mask ML provides.

©2025 Boris FX, Inc. — UNOFFICIAL — Converted from original PDF.