🖥
🖥
🖥
🖥
AugeLab Studio Manual
English
Ask or search…
K
Comment on page

Multi Image Write

Node_Multi_Image_Write Documentation

The Node_Multi_Image_Write in AugeLab Studio allows you to save multiple input images to disk. It provides the ability to define the output folder path, file name, and write condition for each image. This documentation will provide an overview of the node's functionality and how to use it effectively.

Node Overview

The Node_Multi_Image_Write node enables you to save multiple input images to disk. It is particularly useful when you need to save a sequence of images generated during image processing or computer vision tasks.

Node Properties

  • Node Title: Multi Image Write
  • Node ID: OP_NODE_MULTI_IMAGE_WRITE
  • Tooltip: Save multiple input images when input condition is active with defined path and filename

Inputs

The Node_Multi_Image_Write node has four input sockets:
  1. 1.
    Folder Path: Connect the folder path where the images will be saved. If no input is provided, the current working directory will be used as the default folder path.
  2. 2.
    File Name: Connect the file name for the images. Each image will be saved with a unique file name by appending an index number to the base file name. If no input is provided, the default file name will be "image".
  3. 3.
    Write Condition: Connect a boolean value that determines whether the images should be saved or not. If the condition is True, the images will be saved; otherwise, they will be skipped. If no input is provided, the default condition is False.
  4. 4.
    Input Image List: Connect a list of input images that you want to save. Each image should be of type Generic. If any input image in the list is None, it will be skipped and not saved.

Outputs

The Node_Multi_Image_Write node does not have any output sockets.

Node Configuration

The Node_Multi_Image_Write node does not have any additional configuration parameters.

Usage

  1. 1.
    Drag and drop the Node_Multi_Image_Write node from the node library onto the canvas in AugeLab Studio.
  2. 2.
    Connect the folder path to the "Folder Path" input socket. If no input is provided, the current working directory will be used.
  3. 3.
    Connect the file name to the "File Name" input socket. Each image will be saved with a unique file name by appending an index number to the base file name. If no input is provided, the default file name will be "image".
  4. 4.
    Connect the write condition to the "Write Condition" input socket. If the condition is True, the images will be saved; otherwise, they will be skipped. If no input is provided, the default condition is False.
  5. 5.
    Connect a list of input images to the "Input Image List" input socket. Each image should be of type Generic. If any input image in the list is None, it will be skipped and not saved.
  6. 6.
    Run your project or trigger the execution of the node.
  7. 7.
    The node will save the input images to the specified folder path with the defined file names, based on the provided write condition.

Example

Let's walk through an example to illustrate how the Node_Multi_Image_Write node works.
  1. 1.
    Drag and drop the Node_Multi_Image_Write node onto the canvas.
  2. 2.
    Connect the folder path where you want to save the images to the "Folder Path" input socket.
  3. 3.
    Connect the file name for the images to the "File Name" input socket.
  4. 4.
    Connect a boolean value that determines whether to save the images or not to the "Write Condition" input socket.
  5. 5.
    Connect a list of input images to the "Input Image List" input socket.
  6. 6.
    Run your project or trigger the execution of the node.
  7. 7.
    The node will save the input images to the specified folder path with the defined file names, based on the provided write condition.

Notes

  • The Node_Multi_Image_Write node allows you to save multiple input images to disk.
  • Ensure that you provide valid inputs for the folder path, file name, write condition, and input image list.
  • If any input image in the list is None, it will be skipped and not saved.
  • The images will be saved as PNG files with unique file names based on the provided file name and an index number appended to it.
That concludes the documentation for the Node_Multi_Image_Write node in AugeLab Studio. This node offers a convenient way to save multiple input images to disk, providing flexibility in managing and processing image sequences.