Save Image

## Save Image

Save the input image to the hard drive.

## Module Principle
This module saves the input image to the hard drive in jpg or png format.

## Usage Scenarios
This module is suitable for scenarios where images collected by the camera need to be saved for simulation testing or product traceability.

### Pre-Sequence Modules
The pre-sequence module for this module is generally the Camera Image Acquisition module.

## Parameter Configuration Description
### Save Path
The path to save the image on the hard drive.
### Save Type
* Save All: This mode saves all input images.
* Save Qualified: This mode saves the input image only when the boolean input is true.
* Save Unqualified: This mode saves the input image only when the boolean input is false.
### Image Source
* Input Image: This mode saves the image as the image of the input port.
* Display Window: This mode saves the image as a screenshot of the image display window, including the drawing information of the window.
### Image Format
* JPG: This format occupies less space but the image quality is slightly worse.
* PNG: This format occupies more space but the image quality is better.
### Image Quality
JPG format image quality parameter. The larger the value, the clearer the image and the larger the space occupied.
### Compression Level
PNG format image quality parameter. The smaller the value, the clearer the image and the larger the space occupied.
### Grouping Basis
* None: Images are not grouped when saved to the hard drive.
* Month: Images are saved in grouping folders created by year and month under the specified path.
* Day: Images are saved in grouping folders created by year, month, and day under the specified path.
* Hour: Images are saved in grouping folders created by year, month, day, and hour under the specified path.
* Minute: Images are saved in grouping folders created by year, month, day, hour, and minute under the specified path.
### Image Deletion Type
* Auto: The software automatically deletes saved video files and grouping folders according to the settings.
* Manual: The software will not actively delete saved video files and grouping folders, requiring the user to manually delete them.
### Image Name
* Time + OK/NG: The software automatically generates the saved image name based on the time and boolean input value according to the settings.
* External Introduction: Externally input the name of the saved image. The input image name cannot contain characters such as \ / : * ? " < > |.
### Image Clearing Threshold
The threshold for automatically deleting saved images.
### Synchronous Save
When the software executes this module, it needs to wait for the image saving operation to complete before this module ends running; when unchecked, it is asynchronous saving, which means that when executing this module, the image saving is put in the background to run, and the running of this module ends without waiting for it to complete.

## Output Description
### Run Result
Whether the image was saved successfully.
### Saved Image Name
The name of the image saved to the hard drive during this detection.

## Precautions
1. When the image name is introduced externally, it cannot contain \ / : * ? " < > | and escape characters.

---

Click here to jump to the corresponding Chinese manual page: [Save Image](/doc/243)