SaveImageOpenEXR Node Documentation

Overview

The SaveImageOpenEXR node in the ComfyUI-Marigold library is designed to save images in the OpenEXR format. OpenEXR is a high dynamic range (HDR) image file format suitable for use in visual effects and animation, providing superior color and depth range representation compared to standard image formats like PNG or JPEG.

Purpose

The primary purpose of the SaveImageOpenEXR node is to facilitate the storage of images with their full color and depth information. This preservation is especially useful in workflows involving 3D modeling or visual effects where high-quality image data is paramount.

Inputs

The SaveImageOpenEXR node accepts the following inputs:

1. Images: A batch of images that you want to save. These images should be in the desired format and pixel layout compatible with OpenEXR.

2. Filename Prefix: A string to act as the prefix for the saved image filenames. By default, this is set to "ComfyUI_EXR", but users can customize it as needed to organize their output files.

Outputs

The SaveImageOpenEXR node produces a single output:

• File URL: A string that provides the path to the saved EXR image. This path can be used to locate and view the file through interfaces that support it, including direct view links.

Workflow Integration

In ComfyUI workflows, the SaveImageOpenEXR node is generally used as an output node at the end of a pipeline that processes images. It can be integrated into workflows for:

• Depth estimation and 3D reconstruction processes where maintaining depth information is crucial.
• Visual effects workflows where full color and depth range are required for realistic rendering.
• Any processing pipeline where the quality and range of image data cannot be compromised.

Special Features and Considerations

OpenEXR and Compatibility

• The node allows for saving an image with 32-bit floating-point precision, which is beneficial for capturing a broad range of depth and intensity values.
• The default method for saving images relies on OpenEXR and its Python bindings. However, if these are not available, the node gracefully attempts to use OpenCV instead, provided that OpenCV has been configured for OpenEXR support.

Handling Multiple Batches

• When saving files, the node is capable of handling batches of images, automatically generating unique filenames by appending an incrementing counter to the specified filename prefix.
• This ensures that no images are overwritten and allows for easy organization and retrieval of processed outputs.

Dependencies and Setup

• Ensure that either OpenEXR or OpenCV is installed for the node to function properly. The node checks for the availability of these libraries and uses whichever is available to handle the saving process.

Usage Tips

• Allocate adequate storage space as OpenEXR images can occupy significant disk space due to their high fidelity and large dynamic range.
• Utilize meaningful filename prefixes to improve the manageability of the saved files, especially in complex workflows that generate a large number of output images.

By utilizing the SaveImageOpenEXR node, users can ensure that all relevant image data is preserved in a format that supports further high-quality processing and analysis.