# image module

Image module.

Contains all classes and enums related to image controls.

class mrv2.image.AlphaBlend

  Members:

  kNone

  Straight

  Premultiplied

  property name

class mrv2.image.Background

  Members:

  Transparent

  Solid

  Checkers

  Gradient

  property name

class mrv2.image.BackgroundOptions

  Background options.

  property checkersColor0

    Checkers Color0 `mrv2.image.Color4f`..

  property checkersColor1

    Checkers Color1 `mrv2.image.Color4f`..

  property checkersSize

    Checkers Size `mrv2.math.Size2i`..

  property type

    Background type `mrv2.image.Background`..

class mrv2.image.Channels

  Members:

  Color

  Red

  Green

  Blue

  Alpha

  Lumma

  property name

class mrv2.image.EXRDisplay

  EXR display values.

  property defog

    Defog value.

  property enabled

    Enabled EXR display.

  property exposure

    Exposure value.

  property kneeHigh

    kneeHigh value.

  property kneeLow

    kneeLow value.

class mrv2.image.EnvironmentMapType

  Members:

  None

  Spherical

  Cubic

  property name

class mrv2.image.ImageFilter

  Members:

  Nearest

  Linear

  property name

class mrv2.image.InputVideoLevels

  Members:

  FromFile

  FullRange

  LegalRange

  property name

class mrv2.image.LUTOrder

  Members:

  PostColorConfig

  PreColorConfig

  property name

class mrv2.image.PixelType

  Members:

  kNone

  L_U8

  L_U16

  L_U32

  L_F16

  L_F32

  LA_U8

  LA_U16

  LA_U32

  LA_F16

  LA_F32

  RGB_U8

  RGB_U16

  RGB_U32

  RGB_F16

  RGB_F32

  RGBA_U8

  RGBA_U16

  RGBA_U32

  RGBA_F16

  RGBA_F32

  YUV_420P_U8

  YUV_422P_U8

  YUV_444P_U8

  YUV_420P_U16

  YUV_422P_U16

  YUV_444P_U16

  property name

class mrv2.image.Stereo3DInput

  Members:

  kNone

  Image

  property name

class mrv2.image.Stereo3DOutput

  Members:

  Anaglyph

  Scanlines

  Columns

  Checkerboard

  Glasses

  property name

class mrv2.image.VideoLevels

  Members:

  FullRange

  LegalRange

  property name

class mrv2.image.YUVCoefficients

  Members:

  REC709

  BT2020

  property name

mrv2.image.backgroundOptions() → mrv2.image.BackgroundOptions

  Gets the current background options.

mrv2.image.ocioConfig() → str

  Gets the current OCIO config file.

mrv2.image.ocioIcs() → str

  Gets the current input color space.

mrv2.image.ocioIcsList() → list[str]

  Gets a list of all input color spaces.

mrv2.image.ocioLook() → str

  Gets the current OCIO look.

mrv2.image.ocioLookList() → list[str]

  Gets a list of all OCIO looks.

mrv2.image.ocioView() → str

  Gets the current Display/View.

mrv2.image.ocioViewList() → list[str]

  Gets the list of Displays/Views.

mrv2.image.setBackgroundOptions(arg0: mrv2.image.BackgroundOptions) → None

  Sets the current background options.

mrv2.image.setOcioConfig(arg0: str) → None

  Sets the current OCIO config file.

mrv2.image.setOcioIcs(ics: str) → None

  Set the input color space.

mrv2.image.setOcioLook(look: str) → None

  Set the OCIO look by name.

mrv2.image.setOcioView(view: str) → None

  Set an OCIO Display/View.

class mrv2.image.Color4f

  Image mirroring.

  r = float

    Red Channel.

  g = float

    Green Channel.

  b = float

    Blue Channel.

  a = float

    Alpha Channel.

class mrv2.image.Mirror

  Image mirroring.

  x = bool

    Flip image on X.

  y = bool

    Flip image on Y.

class mrv2.image.Color

  Color values.

  enabled = bool

    Enabled Levels.

  add = mrv2.math.Vector3f

    Add a `mrv2.math.Vector3f` to image.

  brightness = mrv2.math.Vector3f

    Change a `mrv2.math.Vector3f` of brightness to image.

  contrast = mrv2.math.Vector3f

    Change a `mrv2.math.Vector3f` of contrast to image.

  saturation = mrv2.math.Vector3f

    Change a `mrv2.math.Vector3f` of saturation to image.

  tint = float

    Change tint of image to image between 0 and 1.

  invert = bool

    Invert the color values.

class mrv2.image.Levels

  Levels values.

  enabled = bool

    Enabled Levels.

  inLow = float

    In Low Level value.

  inHigh = float

    In High Level value.

  gamma = float

    Gamma Level value.

  outLow = float

    Out Low Level value.

  outHigh = float

    Out High Level value.

class mrv2.image.ImageFilters

  Image filters.

  minify = mrv2.image.ImageFilter

    Minify filter `mrv2.image.ImageFilter`.

  magnify = mrv2.image.ImageFilter

    Magnify filter `mrv2.image.ImageFilter`.

class mrv2.image.SoftClip

  Soft clip value.

  enabled = bool

    Enabled Soft Clip.

  value = float

    Soft clip value.

class mrv2.image.DisplayOptions

  Display options.

  channels = mrv2.image.Channels

    Color channels `mrv2.image.Channels`.

  mirror = mrv2.image.Mirror

    Mirror on X, Y or both `mrv2.image.Mirror`.

  color = mrv2.image.Color

    Color options `mrv2.image.Color`.

  levels = mrv2.image.Levels

    Levels options `mrv2.image.Levels`.

  softClip = mrv2.image.SoftClip

    Soft Clip options `mrv2.image.SoftClip`..

class mrv2.image.LUTOptions

  LUT options.

  fileName = str

    LUT filename.

  order = mrv2.image.LUTOrder

    LUT transformation order.

class mrv2.image.ImageOptions

  Image options.

  videoLevels = mrv2.image.InputVideoLevels

    Video Levels.

  alphaBlend = mrv2.image.AlphaBlend

    Alpha blending algorithm

  imageFilters = mrv2.image.ImageFilters

    Image Filters

class mrv2.image.EnvironmentMapOptions

  EnvironmentMap options.

  type = mrv2.image.EnvironmentMapType

    Environment Map type.

  horizontalAperture = float

    Horizontal aperture

  verticalAperture = float

    Vertical aperture

  focalLength = float

    Focal Length

  rotateX = float

    Rotation on X

  rotateY = float

    Rotation on Y

  subdivisionX = int

    Subdivision on X

  subdivisionY = int

    Subdivision on Y

  spin = bool

    Spin

class mrv2.image.Stereo3DOptions

  Stereo3D options.

  input = mrv2.image.Stereo3DInput

    Stereo 3d input `mrv2.image.StereoInput`..

  output = mrv2.image.Stereo3DOutput

    Stereo 3d output `mrv2.image.StereoOutput`..

  eyeSeparation = float

    Separation between left and right eye.

  swapEyes = bool

    Swap left and right eye