Skip to content

Latest commit

 

History

History
146 lines (85 loc) · 4.86 KB

ImageLayer.rst

File metadata and controls

146 lines (85 loc) · 4.86 KB
Raw

NatronEngine

ImageLayer

Synopsis

A small object representing a layer of an image. For example, the base image layer is the color layer, or sometimes called "RGBA". Some other default layers include ForwardMotion, BackwardMotion, DisparityLeft,DisparityRight, etc... .

See detailed<ImageLayer.details> description...

Functions

  • def ImageLayer<NatronEngine.ImageLayer.ImageLayer> (layerName,componentsPrettyName,componentsName)
  • def isColorPlane<NatronEngine.ImageLayer.isColorPlane> ()
  • def getNumComponents<NatronEngine.ImageLayer.getNumComponents> ()
  • def getLayerName<NatronEngine.ImageLayer.getLayerName> ()
  • def getComponentsNames<NatronEngine.ImageLayer.getComponentsNames> ()
  • def getComponentsPrettyName<NatronEngine.ImageLayer.getComponentsPrettyName> ()
  • def getNoneComponents<NatronEngine.ImageLayer.getNoneComponents> ()
  • def getRGBAComponents<NatronEngine.ImageLayer.getRGBAComponents> ()
  • def getRGBComponents<NatronEngine.ImageLayer.getRGBComponents> ()
  • def getAlphaComponents<NatronEngine.ImageLayer.getAlphaComponents> ()
  • def getBackwardMotionComponents<NatronEngine.ImageLayer.getBackwardMotionComponents> ()
  • def getForwardMotionComponents<NatronEngine.ImageLayer.getForwardMotionComponents> ()
  • def getDisparityLeftComponents<NatronEngine.ImageLayer.getDisparityLeftComponents> ()
  • def getDisparityRightComponents<NatronEngine.ImageLayer.getDisparityRightComponents> ()

Detailed Description

A Layer is constituted of a layer name and a set of channel names (also called components). You can get a sequence with all the channels in the layer with the function getComponentsNames()<NatronEngine.ImageLayer.getComponentsNames>. For some default layers, the components may be represented by a prettier name for the end-user, such as DisparityLeft instead of XY. When the ImageLayer does not have a pretty name, its pretty name will just be a concatenation of all channel names in order.

There is one special layer in Natron: the color layer. It be represented as 3 different types: RGBA, RGB or Alpha. If the ImageLayer is a color layer, the method isColorPlane()<NatronEngine.ImageLayer.isColorPlane> will return True

Member functions description

NatronEngine.ImageLayer.ImageLayer(layerName,componentsPrettyName,componentsName)

param layerName

str<NatronEngine.std::string>

Make a new image layer with the given layer name, optional components pretty name and the set of channels (also called components) in the layer.

NatronEngine.ImageLayer.isColorPlane()

rtype

bool<PySide.QtCore.bool>

Returns True if this layer is a color layer, i.e: it is RGBA, RGB or alpha. The color layer is what is output by default by all nodes in Natron.

NatronEngine.ImageLayer.getNumComponents()

rtype

int<PySide.QtCore.int>

Returns the number of channels in this layer. Can be between 0 and 4 included.

NatronEngine.ImageLayer.getLayerName()

rtype

str<NatronEngine.std::string>

Returns the layer name

NatronEngine.ImageLayer.getComponentsNames()

rtype

Sequence

Returns a sequence with all channels in this layer in order

NatronEngine.ImageLayer.getComponentsPrettyName()

rtype

str<NatronEngine.std::string>

Returns the channels pretty name. E.g: DisparityLeft instead of XY

NatronEngine.ImageLayer.getNoneComponents()

rtype

ImageLayer<NatronEngine.ImageLayer>

Returns the default "none" layer

NatronEngine.ImageLayer.getRGBAComponents()

rtype

ImageLayer<NatronEngine.ImageLayer>

Returns the default "RGBA" layer

NatronEngine.ImageLayer.getRGBComponents()

rtype

ImageLayer<NatronEngine.ImageLayer>

Returns the default "RGB" layer

NatronEngine.ImageLayer.getAlphaComponents()

rtype

ImageLayer<NatronEngine.ImageLayer>

Returns the default "Alpha" layer

NatronEngine.ImageLayer.getBackwardMotionComponents()

rtype

ImageLayer<NatronEngine.ImageLayer>

Returns the default "Backward" layer

NatronEngine.ImageLayer.getForwardMotionComponents()

rtype

ImageLayer<NatronEngine.ImageLayer>

Returns the default "Forward" layer

NatronEngine.ImageLayer.getDisparityLeftComponents()

rtype

ImageLayer<NatronEngine.ImageLayer>

Returns the default "DisparityLeft" layer

NatronEngine.ImageLayer.getDisparityRightComponents()

rtype

ImageLayer<NatronEngine.ImageLayer>

Returns the default "DisparityRight" layer