Skip to main content

Read Image

Controlled node

Overview​

The Read Image node retrieves an image file from the project library and loads it into the workflow as a Jimp image object. This node is the entry point for image processing workflows, allowing you to read stored images for manipulation, analysis, or AI vision tasks.

The node accepts a file reference from the library, downloads the image from storage, and outputs a Jimp image object that can be processed by other image manipulation nodes such as Resize Image, Crop Image, or AI Vision Write.

Inputs​

InputTypeDescriptionDefault
RunEventFires when the node starts running-
FileFileSourceThe image file to read from the library. Accepts any image format supported by Jimp (JPEG, PNG, BMP, TIFF, GIF).-

Outputs​

OutputTypeDescription
DoneEventFires when the image has been successfully loaded
OutputDataContains the Jimp image object for further processing

Runtime Behavior and Defaults​

  • File Selection: The node accepts a single file reference (maxFiles: 1) from the project library. The file must have a valid id and name property.
  • Image Loading: Uses Jimp to read the image from storage and create a manipulable image object.
  • Error Handling: If no file is provided, the project ID cannot be determined, or the file cannot be read, the node outputs undefined.
  • Supported Formats: Supports all image formats compatible with Jimp including JPEG, PNG, BMP, TIFF, and GIF.

Example Usage​

Basic Image Reading​

Connect a file picker or library file reference to the File input and trigger the Run event to load the image:

[Start] → [Read Image] → [Resize Image] → [Write To Library]
            ↑                ↑
         File input      Image data

AI Vision Analysis​

Use Read Image to prepare images for AI vision tasks:

[Library File] → [Read Image] → [AI Vision Write] → [Show]
                      ↑                ↑
                   Image object      Analysis result

Image Processing Pipeline​

Chain multiple image operations together:

[Read Image] → [Resize Image] → [Greyscale Image] → [Write To Library]
Image Object

The output is a Jimp image object that maintains the image in memory for processing. Connect this output directly to other image manipulation nodes without needing to save intermediate files.