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

Image Write

Node_Image_Write Documentation

The Node_Image_Write node in AugeLab Studio is used to save an input image to a file when a specified condition is met. This node allows you to define the folder path, file name, and write condition for saving the image. This documentation will provide an overview of the node's functionality and how to use it effectively.

Node Overview

The Node_Image_Write node saves an input image to a file based on the specified conditions. It takes an input image and checks a write condition. If the condition is true, the node saves the image to a file in the specified folder path with the specified file name.

Node Properties

  • Node Title: Image Write
  • Node ID: OP_NODE_IMAGE_WRITE
  • Tooltip: Save input image when input condition is active with defined path and filename

Inputs

The node has four input sockets:
  1. 1.
    Folder Path: Specify the folder path where the image file will be saved. This is a string input socket.
  2. 2.
    File Name: Specify the name of the image file to be saved. This is a string input socket.
  3. 3.
    Write Condition: Connect a boolean signal to this input socket. The image will be saved only if the condition is true.
  4. 4.
    Input Image: Connect the input image to this socket. The image data will be saved to a file.

Outputs

The Node_Image_Write node does not have any output sockets.

Node Configuration

The Node_Image_Write node does not have any additional configuration parameters.

Usage

  1. 1.
    Drag and drop the Node_Image_Write node from the node library onto the canvas in AugeLab Studio.
  2. 2.
    Connect the desired inputs to the input sockets of the node:
    • Connect a folder path to the "Folder Path" input socket. This is the location where the image file will be saved.
    • Connect a file name to the "File Name" input socket. This is the name of the image file to be saved.
    • Connect a boolean signal to the "Write Condition" input socket. The image will be saved only if the condition is true.
    • Connect the input image to the "Input Image" socket. This is the image data to be saved.
  3. 3.
    Run your project or trigger the execution of the node.
  4. 4.
    The image will be saved to the specified folder path with the specified file name if the write condition is true and the image data is available.
  5. 5.
    Check the logs for confirmation of the saved image file.

Example

Let's walk through an example to illustrate how the Node_Image_Write node works.
  1. 1.
    Drag and drop the Node_Image_Write node onto the canvas.
  2. 2.
    Connect a folder path to the "Folder Path" input socket. For example, connect a string containing the path to the desired folder where you want to save the image.
  3. 3.
    Connect a file name to the "File Name" input socket. For example, connect a string with the desired name for the image file.
  4. 4.
    Connect a boolean signal to the "Write Condition" input socket. This signal should represent the condition under which you want to save the image. For example, connect a button press signal.
  5. 5.
    Connect the input image data to the "Input Image" socket. This could be the image data obtained from an image processing node or any other source.
  6. 6.
    Run your project or trigger the execution of the node.
  7. 7.
    If the write condition is true and the image data is available, the image will be saved to the specified folder path with the specified file name.
  8. 8.
    Check the logs for confirmation of the saved image file.

Notes

  • The Node_Image_Write node saves an input image to a file based on the specified conditions.
  • Make sure to provide valid inputs for the folder path, file name, write condition, and input image.
  • Check the logs for confirmation of the saved image file.
That concludes the documentation for the Node_Show_Image node in AugeLab Studio. This node provides a convenient way to save input images to files based on specified conditions.