Clarisse 4.0 SP8 SDK  4.0.0.0.8
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Functions
Python Image Savers

This set of function helpers allows you to save Clarisse images in Python. More...

Functions

def clarisse_helper.save_image
 Save the specified image at the specified filename with the specified format and return True if sucessful.
 
def clarisse_helper.save_exr16
 Save the specified image at the specified filename as a 16-bit (float) EXR.
 
def clarisse_helper.save_exr32
 Save the specified image at the specified filename as a 32-bit (float) EXR.
 
def clarisse_helper.save_jpg
 Save the specified image at the specified filename as a JPG.
 
def clarisse_helper.save_bmp
 Save the specified image at the specified filename as a BMP.
 
def clarisse_helper.save_tga
 Save the specified image at the specified filename as a TGA.
 
def clarisse_helper.save_png8
 Save the specified image at the specified filename as a 8-bit PNG.
 
def clarisse_helper.save_png16
 Save the specified image at the specified filename as a 16-bit PNG.
 
def clarisse_helper.save_tif8
 Save the specified image at the specified filename as a 8-bit TIF.
 
def clarisse_helper.save_tif16
 Save the specified image at the specified filename as a 16-bit TIF.
 
def clarisse_helper.save_tif32
 Save the specified image at the specified filename as a 32-bit TIF.
 

Detailed Description

This set of function helpers allows you to save Clarisse images in Python.

Function Documentation

def clarisse_helper.save_bmp (   image,
  filename,
  lut_name = "" 
)

Save the specified image at the specified filename as a BMP.

Return True if successful.

Parameters
imageimage to be saved (ImageHandle or ImageCanvas).
filenameSaved image path string without image format extension.
lutname – By default, "sRGB" lut is applied to the image prior saving.
Returns
The rendered image is returned as an ImageHandle
def clarisse_helper.save_exr16 (   image,
  filename,
  lut_name = "",
  compression = 1 
)

Save the specified image at the specified filename as a 16-bit (float) EXR.

Return True if successful.

Parameters
imageimage to be saved (ImageHandle or ImageCanvas).
filenameSaved image path string without image format extension.
lutname – By default, "sRGB" lut is applied to the image prior saving.
compression– Compression mode (for openexr only). Default is no compression.
Returns
The rendered image is returned as an ImageHandle
def clarisse_helper.save_exr32 (   image,
  filename,
  lut_name = "",
  compression = 1 
)

Save the specified image at the specified filename as a 32-bit (float) EXR.

Return True if successful.

Parameters
imageimage to be saved (ImageHandle or ImageCanvas).
filenameSaved image path string without image format extension.
lutname – By default, "sRGB" lut is applied to the image prior saving.
compression– Compression mode (for openexr only). Default is no compression.
Returns
The rendered image is returned as an ImageHandle
def clarisse_helper.save_image (   image,
  filename,
  format,
  lut_name = "",
  compression = 1 
)

Save the specified image at the specified filename with the specified format and return True if sucessful.

Parameters
imageimage to be saved (ImageHandle or ImageCanvas).
filenameSaved image path string without image format extension.
formatSaved file format. Supported formats are defined in the ImageIOFileFormat::Save enum.
lutname – By default, "sRGB" lut is applied to the image prior saving.
compression– Compression mode (for openexr only). Default is no compression.
Returns
The rendered image is returned as an ImageHandle
def clarisse_helper.save_jpg (   image,
  filename,
  lut_name = "" 
)

Save the specified image at the specified filename as a JPG.

Return True if successful.

Parameters
imageimage to be saved (ImageHandle or ImageCanvas).
filenameSaved image path string without image format extension.
lutname – By default, "sRGB" lut is applied to the image prior saving.
Returns
The rendered image is returned as an ImageHandle
def clarisse_helper.save_png16 (   image,
  filename,
  lut_name = "" 
)

Save the specified image at the specified filename as a 16-bit PNG.

Return True if successful.

Parameters
imageimage to be saved (ImageHandle or ImageCanvas).
filenameSaved image path string without image format extension.
lutname – By default, "sRGB" lut is applied to the image prior saving.
Returns
The rendered image is returned as an ImageHandle
def clarisse_helper.save_png8 (   image,
  filename,
  lut_name = "" 
)

Save the specified image at the specified filename as a 8-bit PNG.

Return True if successful.

Parameters
imageimage to be saved (ImageHandle or ImageCanvas).
filenameSaved image path string without image format extension.
lutname – By default, "sRGB" lut is applied to the image prior saving.
Returns
The rendered image is returned as an ImageHandle
def clarisse_helper.save_tga (   image,
  filename,
  lut_name = "" 
)

Save the specified image at the specified filename as a TGA.

Return True if successful.

Parameters
imageimage to be saved (ImageHandle or ImageCanvas).
filenameSaved image path string without image format extension.
lutname – By default, "sRGB" lut is applied to the image prior saving..
Returns
The rendered image is returned as an ImageHandle
def clarisse_helper.save_tif16 (   image,
  filename,
  lut_name = "" 
)

Save the specified image at the specified filename as a 16-bit TIF.

Return True if successful.

Parameters
imageimage to be saved (ImageHandle or ImageCanvas).
filenameSaved image path string without image format extension.
lutname – By default, "sRGB" lut is applied to the image prior saving.
Returns
The rendered image is returned as an ImageHandle
def clarisse_helper.save_tif32 (   image,
  filename,
  lut_name = "" 
)

Save the specified image at the specified filename as a 32-bit TIF.

Return True if successful

Parameters
imageimage to be saved (ImageHandle or ImageCanvas).
filenameSaved image path string without image format extension.
lutname – By default, "sRGB" lut is applied to the image prior saving.
Returns
The rendered image is returned as an ImageHandle
def clarisse_helper.save_tif8 (   image,
  filename,
  lut_name = "" 
)

Save the specified image at the specified filename as a 8-bit TIF.

Return True if successful.

Parameters
imageimage to be saved (ImageHandle or ImageCanvas).
filenameSaved image path string without image format extension.
lutname – By default, "sRGB" lut is applied to the image prior saving..
Returns
The rendered image is returned as an ImageHandle