Integration Guide

This page shows how JefeChecks preferences and loading options can be customized with the command line
and environment variables.

This allows TDs to write scripts that can launch JefeCheck with the options needed by each project automatically.

1. Command Line Arguments
2. Environment Variables
3. LUT Formats and custom LUT creation.
   3.1 Truelight .cub files
   3.2 JefeCheck .tga 3D LUT Format
   3.3 JefeCheck .lut 1D LUT Format

4. Nuke integration script to replace default flipbook.


Command Line arguments

You can load files directly from the command line using the following options
You can specify a filename and parameters for up to 4 sequences, the first sequence will be loaded into track A, the second into B etc.

The first time an option is encountered, it will be applied to track A, the second time to trackB, etc. or viewport 1, then viewport 2 etc if the option affects a viewport instead of a track.

-h [ --help ] produce help message
-f [ --from ] Start loading from this frame (track option)
-t [ --to ] Stop loading at this frame (track option)
-s [ --scale ] Scales to load sequences in percentages (100, 50 etc) (track option)
-r [ --frameRate ] Frame rate for playback (global option)
-x [ --fx ] FX Stack (viewport option)
-l [ --lut ] LUT for Viewport (viewport option)

Examples:

jefecheck /home/images/sequence1.0001.dpx
Loads sequence1 into track A, trying to find all frames that belong to the same sequence as 0001 (0000,0002,0003 etc)

jefecheck /home/images/sequence1.0001.dpx /home/images/sequence2.0001.dpx -r 24
Loads sequence1 into track A , and sequence2 into track B.
Set target Frames per Seconds for playback to 24 FPS.

jefecheck /home/images/sequence1.0001.dpx -f 12 -t 45 /home/images/sequence2.0001.dpx -f 520 -t 530
Loads sequence1 , frames 12 through 45 into track A , and sequence2 into track B frames 520 through 530

jefecheck /home/images/sequence1.####.dpx -f 12 -t 45
Loads sequence1 , using 4 padding 0's in the sequence from frame 12 through frame 45.
Important: When using # to specify padding, the range must be explicitly states with the -f and -t options.

jefecheck /home/images/sequence1.0001.dpx -s 100 /home/images/sequence2.0001.dpx -s 50
Loads sequence1 into track A at 100% scale and sequence2 into track B at 50% scale.
If we hadn't specifiesd a scale after sequence1, -s 50 would have been applied to track A instead of track B.
This means that the argument's position do not matter, only their position relative to other arguments of the same name:

We could first specify all the sequences names, and then specify all the scales or ranges like this and it would have the same effect:
jefecheck /home/images/sequence1.0001.dpx /home/images/sequence2.0001.dpx -s 100 -s 50


jefecheck /home/images/sequence1.0001.dpx -x /home/fxStacks/myDiffMatteAndColorCorrectionStac.fxs
Loads sequence1 into track A and applies the FX stack stored in myDiffMatteAndColorCorrectionStac.fxs file to viewport 1.


jefecheck /home/images/sequence1.0001.dpx -l LogToLinToSRGB.lut
Loads sequence1 into track A and sets the LUT for viewport 1 to LogToLinToSRGB.lut.
Important: The argument to the LUT parameter is the name of the LUT file (not the whole path).
The LUT should be in the JefeCheck LUT path or loaded previously by using the LUT manager and being set the auto-load.


Environment Variables

JefeCheck uses the following envorinment variables to modify it's behaviour.
JEFECHECK_LUT_PATH
(e.g. /home/myLUTs/) Overrides the default LUT path. Supported LUT formats will be loaded from this locations.

JEFECHECK_FX_PATH
(e.g. /home/myFXs/) Overrides the default FX path. FX files will be loaded from this locations.

JEFECHECK_DEFAULT_BROWSE_PATH
(e.g. /home/projectFiles/projectA/images/) Overrides the default browse path.
When a user clicks on the browse button when loading a sequence, the file browser will open up in this path.

JEFECHECK_DEFAULT_LUT
(e.g. LogToLinToSRGB.lut) Overrides the default LUT applied to all viewports defined in the LUT Manager window. If another LUT is specified using the command line arguments, that one takes precedence.


LUT Formats and custom LUT creation.

Truelight .cub files (3D LUT)
JefeCheck supports Truelight .cub 3D cubes. We have teste cube resolutions 16x16x16 and 32x32x32 but higher resolutions should work fine.
Click here for a sample of a supported .cub file. This LUT creates a negative of the image.

Truelight .cub files for a particular color correction can be generated from The Foundry's Nuke using a CMS node and exporting it as a .cub file.

JefeCheck .tga 3D LUT Format


UnitCube.tga

JefeCheck has a native 3D lut format that can replicate basically any color pipeline with a certain degree of acuracy.
The LUT is simply a small 64x64 pixels tga image that contains color samples for a 16x16x16 color cube.

To replcate a color correction, simple put this color patch through the pipeline and render it out to another tga file of the same size. This effectively bakes the color correction into the patch. The pipeline can be a Nuke color correction, Shake, Photoshop, or any other software that can read, alter and write an image.

You then load the rendered tga file back into JefeCheck by placing it in the LUT folder or loading it through the LUT Manager. JefeCheck will use the patch to create a 3D LUT that can be used in JefeCheck.

It is important to use the UnitCube.tga file and save to a tga file again since it is a lossless format.

LUTs exported from Nuke as tga file are also supported in sizes 16x16x16, which yield images of 448x448 pixels. They are very similar to JefeCheck's 3D LUT format, but use more pixels per sample.

JefeCheck .lut 1D LUT Format
JefeCheck has a native 1D lut format that is a simple as can be.

1D LUTs simply take single floating point input value, and output another floating point value. When you apply a 1D LUT to an image, each color component is assed
through the LUT independently.

A 1D LUT therefore can be described simply by a list input and output numbers. The JefeCheck 1D LUT format (.lut extension) is just a text file containing the ouput values, the input values are implicitly derived from the position in the text file. The file must contain the following information:

  • Header: #JefeCheck LUT Header v1.0
  • Number of entries in the LUT (usually 256 for 8 bit LUTs, 1024 for 10 bit etc)
  • Input Bithdepth (deprecated but still necessary for compatibility): This complements the number of entries (8 for 8 bit, 10 for 10 bit etc)
  • Output Bitdepth (deprecated but still necessary for compatibility): The range of the output values in bits (8, 10, 16)
  • Entries: The actual values. These are the output values, THEY MUST BE NORMALIZED, meaning the output values must be in the range 0.0 to 1.0.
    For an 8 bit LUT, there would be 256 entries: the first value would be the output value for 0, the second for 1, the third for 2 etc…. up to the last value, which would be the output value for 255.

    A truncated LUT that creates a negative of the image is shown here, for the whole version click here
#JefeCheck LUT Header v1.0
256
8
8
1.0000
0.9961
0.9922
0.9882

0.0078
0.0039
0.0000

Nuke and Maya integration scripts to replace default flipbooks.

Coming soon!

 

 

 

Copyright (c) 2007-2012 JefeCorp S.A. de C.V. All rights reserved.