Operators

Operators for color and reposition effects.

class lablib.operators.BaseOperator

Base class for all operators.

Currently this is only used for type checking.

class lablib.operators.ColorOperator

Base class for color operators.

Currently this is only used for type checking.

abstract classmethod from_node_data(data)

An abstract classmethod for returning a ColorOperator from node data.

Parameters:

data (dict) – The node data.

Returns:

The color operator object.

Return type:

ColorOperator

abstract to_ocio_obj()

Converts the object to native OCIO object.

Raises:

NotImplementedError – This method must be implemented in the subclass.

class lablib.operators.CornerPin2D(from1=<factory>, from2=<factory>, from3=<factory>, from4=<factory>, to1=<factory>, to2=<factory>, to3=<factory>, to4=<factory>)

Operator for corner pinning images.

Danger

This operator is not yet tested or used in the codebase.

from1

The first corner of the source image.

Type:

List[float]

from2

The second corner of the source image.

Type:

List[float]

from3

The third corner of the source image.

Type:

List[float]

from4

The fourth corner of the source image.

Type:

List[float]

to1

The first corner of the destination image.

Type:

List[float]

to2

The second corner of the destination image.

Type:

List[float]

to3

The third corner of the destination image.

Type:

List[float]

to4

The fourth corner of the destination image.

Type:

List[float]

classmethod from_node_data(data)

Create CornerPin2D from node data.

data

The node data.

Type:

dict

Returns:

The corner pin object.

Return type:

CornerPin2D

to_oiio_args()

Gets the arguments for oiiotool.

Returns:

Arguments for OIIO.

Return type:

List[str]

class lablib.operators.Crop(box=<factory>)

Operator for cropping images.

box

The crop box.

Type:

List[int]

classmethod from_node_data(data)

Create a Crop object from node data.

data

The node data.

Type:

dict

Returns:

The crop object.

Return type:

Crop

to_oiio_args()

Gets the arguments for oiiotool.

Returns:

Arguments for OIIO.

Return type:

List[int]

class lablib.operators.Mirror2(flop=False, flip=False)

Operator for mirroring images.

Todo

This should be Mirror2 -> Mirror2D looking at CornerPin2D.

flop

Mirror vertically.

Type:

bool

flip

Mirror horizontally.

Type:

bool

classmethod from_node_data(data)

Create Mirror2 from node data.

data

The node data.

Type:

dict

Returns:

The mirror object.

Return type:

Mirror2

to_oiio_args()

Gets the arguments for oiiotool.

Returns:

Arguments for OIIO.

Return type:

List[str]

class lablib.operators.OCIOCDLTransform(file=None, cccid='', direction=0, interpolation='linear', offset=<factory>, power=<factory>, slope=<factory>, saturation=1.0)

Foundry Hiero Timeline soft effect node class.

Note

Since this node class combines two of OCIO classes (FileTransform and CDLTransform), we will separate them here within OCIOCDLTransform.to_ocio_obj().

file

Path to the LUT file.

Type:

Optional[str]

direction

The direction. Defaults to 0.

Type:

int

cccid

The cccid. Defaults to “”.

Type:

str

offset

The offset. Defaults to [0.0, 0.0, 0.0].

Type:

List[float]

power

The power. Defaults to [1.0, 1.0, 1.0].

Type:

List[float]

slope

The slope. Defaults to [0.0, 0.0, 0.0].

Type:

List[float]

saturation

The saturation. Defaults to 1.0.

Type:

float

interpolation

The interpolation. Defaults to “linear”.

Type:

str

file = None

classmethod from_node_data(data)

Create OCIOCDLTransform from node data.

Parameters:

data (dict) –

The node data. List of expected but not required keys: - file (str): Path to the LUT file. - direction (int): The direction.

Defaults to 0.

• cccid (str): The cccid.

  Defaults to “”.

• offset (List[float]): The offset.

  Defaults to [0.0, 0.0, 0.0].

• power (List[float]): The power.

  Defaults to [1.0, 1.0, 1.0].

• slope (List[float]): The slope.

  Defaults to [0.0, 0.0, 0.0].

• saturation (float): The saturation.

  Defaults to 1.0.

• interpolation (str): The interpolation.

  Defaults to “linear”.

Returns:

The OCIOCDLTransform object.

Return type:

OCIOCDLTransform

to_ocio_obj()

Returns native OCIO FileTransform and CDLTransform object.

Returns:

Either OCIO

CDLTransform or FileTransform object. If file is not provided, CDLTransform will be returned.

Return type:

Union[OCIO.FileTransform, OCIO.CDLTransform]

class lablib.operators.OCIOColorSpace(in_colorspace='ACES - ACEScg', out_colorspace='ACES - ACEScg')

Foundry Hiero Timeline soft effect node class.

in_colorspace

The input colorspace. Defaults to “ACES - ACEScg”.

Type:

str

out_colorspace

The output colorspace. Defaults to “ACES - ACEScg”.

Type:

str

classmethod from_node_data(data)

Create OCIOColorSpace from node data.

Parameters:

data (dict) – The node data.

Return type:

OCIOColorSpace

to_ocio_obj()

Returns native OCIO ColorSpaceTransform object.

Returns:

The OCIO ColorSpaceTransform object.

Return type:

OCIO.ColorSpaceTransform

class lablib.operators.OCIOFileTransform(file='', cccid='', direction=0, interpolation='linear')

Class for handling OCIO FileTransform effects.

Note

Reads Foundry Hiero Timeline soft effect node class.

file

Path to the LUT file.

Type:

str

cccid

Path to the cccid file.

Type:

str

direction

The direction. Defaults to 0.

Type:

int

interpolation

The interpolation. Defaults to “linear”.

Type:

str

classmethod from_node_data(data)

Create OCIOFileTransform from node data.

Note

Reads Foundry Hiero Timeline soft effect node data.

Would it be cool if we’d had a way to interface other DCC node data? Would they even be so much different?

Parameters:

data (dict) – The node data. List of expected but not required keys: - file (str): Path to the LUT file. - cccid (str): Path to the cccid file. - direction (int): The direction. Defaults to 0. - interpolation (str): The interpolation. Defaults to “linear”.

Returns:

The OCIOFileTransform object.

Return type:

OCIOFileTransform

to_ocio_obj()

Converts the object to native OCIO object.

Returns:

The OCIO FileTransform object in a list.

Return type:

OCIO.FileTransform

class lablib.operators.RepositionOperator

Base class for reposition operators.

Currently this is only used for type checking.

abstract classmethod from_node_data(data)

An abstract method for returning a reposition operator from node data.

data

The node data.

Type:

dict

Returns:

The reposition operator.

Return type:

RepositionOperator

abstract to_oiio_args()

An abstract method for returning the arguments for oiiotool.

Returns:

Arguments for OIIO.

Return type:

List[str]

class lablib.operators.Transform(translate=<factory>, rotate=0.0, scale=<factory>, center=<factory>, invert=False, skewX=0.0, skewY=0.0, skew_order='XY')

Transform operator for repositioning images.

Note

The transformations are applied in the following order: translate, rotate, scale, center, invert, skewX, skewY.

The Transform.skew_order parameter determines the order in which the skewX and skewY transformations are applied.

translate

The translation vector.

Type:

List[float]

rotate

The rotation angle in degrees.

Type:

float

scale

The scaling vector.

Type:

List[float]

center

The center of the transformation.

Type:

List[float]

invert

Invert the transformation.

Type:

bool

skewX

The skew in the X direction.

Type:

float

skewY

The skew in the Y direction.

Type:

float

skew_order

The order in which the skewX and skewY transformations are applied.

Type:

str

classmethod from_node_data(data)

Create a Transform object from node data.

data

The node data.

Type:

dict

Returns:

The transform object.

Return type:

Transform

to_oiio_args()

Gets the arguments for oiiotool.

Uses lablib.lib to work with transformation matrices.

Returns:

Arguments for OIIO.

Return type:

List[str]

lablib.operators.get_direction(direction)

Get the direction for OCIO FileTransform.

lablib.operators.direction

The direction.

Type:

Union[str, int]

Returns:

The direction.

Return type:

int