# Docs

Published 2024-01-30

# Data variable usage

The plugin will use the following data variable values:

The cropped image frame defined by the settings.

The full image from the display.

The original image. THIS SHOULD NOT BE EDITED!

# Example

import cv2
def plugin(data):
    frame = data["frame"]
    frameFull = data["frameFull"]
    frameOriginal = data["frameOriginal"] # Frame original should not be edited!

    # Most plugins will edit the frame value for the future. This is because the ShowImage plugin will show the final frame value.
    frame = cv2.cvtColor(frame, cv2.COLOR_BGR2GRAY) # Make it grayscale for example

    # Return the data variable
    data["frame"] = frame
    return data