Comment on page

Check Area

Check Area Node Documentation

The Check Area node in AugeLab Studio allows you to select an area on an image and check if input coordinates are inside that area. It provides the flexibility to define a region of interest (ROI) and determine if specific points or objects fall within that ROI.

Node Overview

The Check Area node takes an image and position coordinates as inputs and provides the following outputs:
  1. 1.
    Area Coordinates: The coordinates of the selected area.
  2. 2.
    Object In Area?: A boolean value indicating whether any input coordinates fall within the selected area.
  3. 3.
    Detection Count: The number of input coordinates detected within the selected area.

Node Properties

  • Node Title: Check Area
  • Node ID: OP_NODE_CHECK_AREA

Inputs

The Check Area node has the following input sockets:
  1. 1.
    Image: The image on which the area selection will be performed.
  2. 2.
    Position Coordinate(s): The position coordinate(s) or object location(s) to be checked if they fall within the selected area. This can be a single coordinate or a list/tuple of coordinates.

Outputs

The Check Area node has the following output sockets:
  1. 1.
    Area Coordinates: The coordinates of the selected area. This output can be used for visualization or further analysis.
  2. 2.
    Object In Area?: A boolean value indicating whether any input coordinates fall within the selected area. It will be True if any input coordinate falls within the area, and False otherwise.
  3. 3.
    Detection Count: The number of input coordinates detected within the selected area.

Usage

  1. 1.
    Drag and drop the Check Area node from the node library onto the canvas in AugeLab Studio.
  2. 2.
    Connect the image on which the area selection will be performed to the Image input socket of the Check Area node.
  3. 3.
    Connect the position coordinate(s) or object location(s) to be checked to the Position Coordinate(s) input socket of the Check Area node. This can be a single coordinate or a list/tuple of coordinates.
  4. 4.
    Run the pipeline.
  5. 5.
    Click and drag on the image within the Check Area node to define the area of interest (ROI). The selected area will be highlighted with a green rectangle.
  6. 6.
    The Check Area node will check if the input coordinates fall within the selected area.
  7. 7.
    The coordinates of the selected area, the boolean value indicating whether any input coordinates fall within the area, and the number of input coordinates detected within the area will be outputted from their respective output sockets.
  8. 8.
    Retrieve the outputs for further analysis or processing.

Notes

  • The Check Area node allows you to define an area of interest (ROI) on an image and check if specific coordinates fall within that ROI.
  • The node provides visual feedback by highlighting the selected area and marking the coordinates that fall within it on the image.
  • You can connect various nodes in AugeLab Studio after the Check Area node to perform different operations based on whether the input coordinates fall within the selected area or not.
That concludes the documentation for the Check Area node in AugeLab Studio. Use this node to select an area on an image and check if input coordinates fall within that area.