Rotobot Openfx Plugin Documentation Release 1.4.0 Sam
Total Page:16
File Type:pdf, Size:1020Kb
Rotobot OpenFX Plugin Documentation Release 1.4.0 Sam Hodge May 30, 2020 Contents: 1 Frequenty Asked Questions (FAQs)1 1.1 How accurate is Rotobot?........................................1 1.2 Why is it so slow?............................................1 1.3 What is the colour space to get the best detection?...........................1 1.4 Why does my 5K image take so long?..................................2 1.5 How do I install Rotobot?........................................2 1.6 What is that glitch?............................................2 1.7 How do I install a license?........................................2 2 User Guides 3 2.1 Rotobot Segmentation..........................................3 2.2 Rotobot Instance Segmentation.....................................3 2.3 Rotobot Person..............................................3 2.3.1 Input and Output are RGB and RGBA.............................4 2.3.2 Input Colorspace........................................4 2.4 Create a mask using Rotobot Segmentation...............................4 2.5 Isolate and seperate an indivdual using Rotobot Instance Segmentation................5 2.6 Create a soft mask using Trimap.....................................5 3 System Adminstration Docs 7 3.1 Functional description..........................................7 3.1.1 Details of OpenFX Plugins...................................7 3.1.2 Caching of computation....................................8 3.1.3 Details of CUDA compatibility.................................8 3.1.3.1 CUDA Toolkit is installed with CuDNN dependency.................8 3.1.3.2 CuDNN is always called the same thing.......................8 3.1.4 Rotobot Compatibility Table.................................. 11 3.1.5 Details of memory requirements for models.......................... 12 3.1.6 Multi GPU Performance.................................... 12 3.1.7 Limitations of Resolution.................................... 12 3.1.8 Colour Space information.................................... 13 3.1.9 Details of Environment variables................................ 13 3.2 Systems Administration Guide...................................... 13 3.2.1 Installation........................................... 14 3.2.1.1 Default Install Locations............................... 14 3.2.2 Components Installed...................................... 14 3.2.2.1 Deep Learning Models................................ 14 i 3.2.2.2 Open FX Folder/Bundle................................ 14 3.2.2.3 Shared Libraries.................................... 15 3.2.2.4 Main OpenFX Plugin................................. 15 3.2.2.5 License Files...................................... 15 3.2.3 Installation on a single computer................................ 16 3.2.3.1 Windows........................................ 16 3.2.3.2 MacOS......................................... 16 3.2.3.3 Linux.......................................... 16 3.2.4 Network installation...................................... 16 3.2.4.1 Linux.......................................... 16 3.2.4.2 Rez example file.................................... 18 3.2.5 Reporting a fault........................................ 18 3.2.6 Requesting a feature...................................... 18 4 Choosing an Installer for Rotobot 19 4.1 Install packages Guidance........................................ 19 5 Licensing 21 5.1 Node locked license with a license file.................................. 22 5.2 Floating license with a server executable using license file and the clients pointing to server..... 22 5.2.1 Server.............................................. 22 5.2.2 Client.............................................. 22 5.3 Requesting a trial license......................................... 23 5.3.1 How to find a hostid to sign a trial license........................... 23 5.3.2 How to find your rlmhostid on Windows:........................... 23 5.3.3 How to find your rlmhostid on macOS:............................. 24 5.3.4 How to find your rlmhostid on Linux:............................. 24 5.4 Node Locked license installation..................................... 25 5.4.1 Installing a node locked license on Windows manually.................... 25 5.4.2 Installing a node locked license on macOS........................... 25 5.4.3 Installing a node locked license on Linux........................... 27 5.5 Floating license installation....................................... 28 5.5.1 Running the License Server................................... 28 5.5.2 Installing a RLM service on Windows............................. 28 5.5.3 Running the RLM Server as a Service on Linux........................ 30 5.5.4 Running the RLM Server as a Service on macOS....................... 30 5.6 RLM web server............................................. 30 5.7 Annual License renewal......................................... 31 6 Indices and tables 33 ii CHAPTER 1 Frequenty Asked Questions (FAQs) 1.1 How accurate is Rotobot? It depends. Rotobot Instance Segmentation is very inaccurate when the category detected is large in screen size, Rotobot Seg- mentation is more accurate but more expensive to calculate, Rotobot Trimap can give soft edges and is even more expensive to calculate. None of the above is a replacement for hours of hand Rotoscoping getting a perfect edge. It is intended as a place holder so you can get started and see what needs to be improved. Rotobot makes pixel based masks rather than splines that can be adjusted and animated by changing a small number of animated keyframe values, to improve on Rotobot mask you will need to use paint techniques. 1.2 Why is it so slow? Deep Neural networks are large computations. If you have ever created a blur operation, you will know the larger the blur amount the longer it will take to compute. The calculations in a convolutional neural network do the equivalent computation of many many blur operations. These computations are stored as variables of the deep learning model that has trained for days on a large pool of data on some specialised hardware. Often the first frame of computation will need to load this model up and present it to the computer or the computer’s graphic’s card so the first initialisation will have some “spin up time”. After the first frame subsequent frames will take less time. So if you need to choose a batch size of how many frames to compute before starting the program again, choose a larger batch size, so you can spread the “spin up time” across the cost of the batch of frames. Similarly if you swap between one node and another, this moving memory from one place to another can be inefficient, if you can compute and write to disk and then look up the disk result, things will be faster overall, rather than connecting results from volatile memory. 1.3 What is the colour space to get the best detection? Assuming your are compositing in a scene linear colour space such as ACEScg. 1 Rotobot OpenFX Plugin Documentation, Release 1.4.0 As a rule of thumb, if your image looks pale with the lookup table and looks natural without the lookup table, this is the expected input Rotobot detection for a Display sRGB image. So pixel values for a neutral grey will be approximately 0.5. 1.4 Why does my 5K image take so long? The internals of the current version of Rotobot only support images of less than 2049 x 2049. It will be interpolated back to the input resolution but no additional detail will be added. A better approach would be to scale your image down to approximately 1080p use Rotobot and then resize the result. 1.5 How do I install Rotobot? Installing Rotobot is a matter of putting your details into the web store and choosing the appropriate installer. You will receive an email with the download details. If you use a “ten minute email” you are in violation of the end user license agreement. You will be unable to gain a trial license to remove the watermark. Once you have downloaded the product, administrator rights are required for a simple installation, advanced installa- tion can be done without administrator privileges and will require reading of the System Administrator docs. There are few choices to make during the installation apart from the location where you would like to put the software, the default location makes sense in most situations. Please read the End User License Agreement because by installing the software you are entering into an agreement with Kognat Pty. Ltd. that is legally binding. 1.6 What is that glitch? The watermark will appear and checkers and random brightly coloured squares, these are not GPU artefacts but intellectual copyright protection. Purchase of a license will remove the watermark 1.7 How do I install a license? Please see the System Administrator notes. Kognat staff are in the process of simplifying the process, soon installing a license will be as easy as downloading a license installer and running the installer. But as there are both node locked licenses and client-server based floating license. The answer to “How do I install a license?” is “It depends on the license you are installing and your operating system” Be patient while we support your needs and level of aptitude with your operating system and complexity of your studio’s needs. 2 Chapter 1. Frequenty Asked Questions (FAQs) CHAPTER 2 User Guides Rotobot should be fairly self explanatory to use. There are a number of checkboxes with an english category label which represent a red green or blue colour channel. 2.1 Rotobot Segmentation Pixels that belong to that