Image - Adjust

Declaration

Description:

Adjusts the color, gamma, brightness or contrast settings of an image.

Practical Usage

Used to correct or enhance a digital image that may be off color by adjusting color temperature, contrast, brightness and gama.

Parameters

General

Property	Type	Required	Default	Markup	Description
Source	Text	Yes	(Empty)	SOURCEIMAGE="c:\temp\source.jpg"	The path and file name of the source image to adjust. Supported image formats are JPEG, PNG, BMP, TIFF and GIF.
Destination	Text	Yes	(Empty)	DESTINATIONIMAGE="c:\temp\dest.jpg"	The path and file name of the destination image. This allows you to save your file under a new path, name and/or type to avoid overwriting the source (original) file. To overwrite the source file, enter its original path and file name. Note: If performing an overwrite, make sure to set the Overwrite if exists parameter to YES (enabled) in the File Options properties. This will allow matching files found in the destination folder to be overwritten.
Adjust	Text (options)	No	Color	ADJUST="color" ADJUST="gama" ADJUST="brightness" ADJUST="contrast"	The image property to adjust. The available options are: Color (default) - The color properties of the image will be adjusted. Gama - The gama level of the image will be adjusted. Brightness - The brightness settings of the image will be adjusted. Contrast - The contrast settings of the image will be adjusted.
Color model	Text (options)	No	HSB	COLORMODEL="hsb" COLORMODEL="rgb"	The color model to implement for adjusting color. This parameter is active only if the Adjust parameter is set to Color. The available options are: HSB (default) - A color model composed of hue, saturation and brightness levels. RGB - A color model which red, green and blue light are added together in various ways to reproduce a broad array of colors.
Hue	Number	No	0	HUE="10"	The hue level. This parameter is active only if the Adjust parameter is set to Color and the Color model parameter is set to HSB. The default value is 0.
Saturation	Number	No	100	SATURATION="110"	The saturation level (represents the amount of gray in proportion to the hue). This parameter is active only if the Adjust parameter is set to Color and the Color model parameter is set to HSB. The default value is 100.
Brightness	Number	No	0	BRIGHTNESS="10"	The brightness intensity. This parameter is active only if the Adjust parameter is set to Color and the Color model parameter is set to HSB or if the Adjust parameter is set to Brightness. The default value is 0.
Contrast	Number	No	0	CONTRAST="20"	The contrast level. This parameter is active only if the Adjust parameter is set to Contrast. The default value is 0.
Red	Number	No	0	RED="10"	The red value. This parameter is active only if the Adjust parameter is set to Color and the Color model parameter is set to RGB or if the Adjust parameter is set to Gama. The default value is 0.
Green	Number	No	0	GREEN="10"	The green value. This parameter is active only if the Adjust parameter is set to Color and the Color model parameter is set to RGB or if the Adjust parameter is set to Gama. The default value is 0.
Blue	Number	No	0	BLUE="20"	The blue value. This parameter is active only if the Adjust parameter is set to Color and the Color model parameter is set to RGB or if the Adjust parameter is set to Gama. The default value is 0.

Advanced

Property	Type	Required	Default	Markup	Description
Create and populate dataset	Text	No	(Empty)	DATASET="datasetName"	The name of a dataset to create and populate with information about this activity's results. For more details, see Datasets below.

File Options

Property	Type	Required	Default	Markup	Description
Include sub-folders	Yes/No	No	No	SUBFOLDERS="YES"	If set to YES, denotes that, if present, sub-folders should be searched for files matching the mask specified in the Source parameter. If set to NO (default), sub-folders are ignored. Only files that exist in the root of the source folder will be searched.
Preserve folder structure	Yes/No	No	Yes	KEEPFOLDERSTRUCT="NO"	If set to YES (default), sub-folders found in the source folder will be created in the destination folder and source files will be copied into their respective folders. If set to NO, sub-folders will not be created. Files that exist in these sub-folders will be copied into the root of the source folder instead. This parameter is active only if the Include Sub-folders parameter is set to YES.
Include empty sub-folders	Yes/No	No	No	EMPTYFOLDERS="YES"	If set to YES, sub-folders found in the source folder will be created in the destination folder even if they do not contain any files. If set to NO (default), empty sub-folders are ignored. This parameter is active only if the Include Sub-folders parameter is set to YES.
Only folder structure	Yes/No	No	No	ONLYFOLDERSTRUCT="YES"	If set to YES, sub-folders found in the source folder will be created in the destination folder but files that reside in these sub-folders will not be copied. This parameter is set to NO by default and is active only if the Include Sub-folders parameter is set to YES. Note: Setting this parameter to YES causes all other folder-specific parameters to be ignored.
Overwrite if Exist	Yes/No	No	No	OVERWRITE="YES"	If set to YES, matching files found in the destination folder are to be overwritten. If set to NO (default), an error will occur as a result of a matching file found.
Only if Newer	Yes/No	No	No	ISNEWER="YES"	If set to YES, only source files that are newer than those that match in the destination are to be overwritten folder will overwrite existing files. If set to NO (default), all matching files found in the destination folder will be overwritten regardless of their date properties. This parameter is active only if the Overwrite if Exists parameter is set to YES.
Only if exist in destination	Yes/No	No	No	ONLYIFEXIST="YES"	If set to YES, only files that already exist in the destination folder will be copied from the source folder. All other files, regardless of whether they match the mask or other parameter settings will be bypassed. This parameter is set to NO by default and becomes active only if the Overwrite if Exist parameter is set to YES.
Overwrite read-only files	Yes/No	No	No	OVERWRITEREADONLY="YES"	If set to YES, matching files found in the destination folder will be overwritten even if they are marked with the read-only attribute. If set to NO (default), read-only files are not overwritten. This parameter is active only if the Overwrite if Exist parameter is set to YES.
Overwrite hidden files	Yes/No	No	No	OVERWRITEHIDDEN="YES"	If set to YES, matching files found in the destination folder will be overwritten even if they are marked with the hidden attribute. If set to NO (default), hidden files are not overwritten. This parameter is active only if the Overwrite if Exist parameter is set to YES.
Turn archive attribute off	Yes/No	No	No	ARCHIVETURNOFF="YES"	If set to YES, archive attribute of the source files will be switched OFF. The Windows archive attribute is generally used to track whether a file has been backed-up. Turning the source file's archive attribute off indicates to many backup programs that the file has already been backed-up. This parameter is set to NO by default.
Exclude mask	Text	No	(Empty)	EXCLUDE="*.txt"	Causes this action to omit files matching the mask(s) specified. File names or wildcard masks may be used. Multiple entries may be specified by separating them with a pipe symbol (\|), for example: .txt\|.bak
Only if newer than	Date	No	(Empty)	ISNEWERTHAN= "%DateSerial(2001,10,12) + TimeSerial(00,00,00)%"	If enabled, causes this action to only act on files that are newer than the date/time specified. If this parameter is left blank or disabled (default), file dates are ignored. Click the Custom button to select from a list of pre-defined date parameters. Enable the Expression option to allow entry of a date/time expression.
Only if older than	Date	No	(Empty)	ISOLDERTHAN= "%DateSerial(2001,10,12) + TimeSerial(00,00,00)%"	If enabled, causes this action to only act on files that are older than the date/time specified. If this parameter is left blank or disabled (default), file dates are ignored. Click the Custom button to select from a list of pre-defined date parameters. Enable the Expression option to allow entry of a date/time expression.

File Filter

Property

Type

Required

Default

Markup

Description

Attributes

Text (Options)

(Empty)

ATTRFILTER="+R+A-H" (read-only & archive files will be affected but not hidden files)
ATTRFILTER="-S+H+E" (hidden and encrypted files will be affected but not system files)

Instructs the activity to filter which files it should act on based on whether the file's original attribute settings match the attribute settings specified in this parameter. For example, if the Read-only attribute is set to Off (in visual mode) or "-R" (in AML mode) , only source files with the Read-only attribute turned off will be affected. Source files with Read-only turned on will be ignored. In visual mode, a group of controls are provided to assist in the selection of attribute settings. In AML mode, a single text item must be entered that contains the original attribute mask of the files you wish to affect. Available Options are:

R—Read-only - Specifying On or "+R" causes files with this attribute turned on to be included. Specifying Off or "-R" causes files with this attribute turned off to be included. Specifying Doesn't matter or excluding the letter (default) causes this attribute to be ignored.
A—Archive - Specifying On or "+A" causes files with this attribute turned on to be included. Specifying Off or "-A" causes files with this attribute turned off to be included. Specifying Doesn't matter or excluding the letter (default) causes this attribute to be ignored.
S—System - Specifying On or "+S" causes files with this attribute turned on to be included. Specifying Off or "-S" causes files with this attribute turned off to be included. Specifying Doesn't matter or excluding the letter (default) causes this attribute to be ignored.
H—Hidden - Specifying On or "+H" causes files with this attribute turned on to be included. Specifying Off or "-H" causes files with this attribute turned off to be included. Specifying Doesn't matter or excluding the letter (default) causes this attribute to be ignored.
C—Compression - Specifying On or "+C" causes files with this attribute turned on to be included. Specifying Off or "-C" causes files with this attribute turned off to be included. Specifying Doesn't matter or excluding the letter (default) causes this attribute to be ignored.
E-Encrypted - Specifying On or "+E" causes files with this attribute turned on to be included. Specifying Off or "-E" causes files with this attribute turned off to be included. Specifying Doesn't matter or excluding the letter (default) causes this attribute to be ignored.

Description

Error Causes

On Error

Datasets

A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset with the following fields (rows):

Name	Type	Return Value
theDataset.Destination	Text	The path and file name of the output file.
theDataset.Message	Number	If theDataset.Result returns 1, this field returns a description of the error that occurred. If theDataset.Result returns 0, this field is left blank.
theDataset.Result	Number	The runtime result of this activity. If 0 is returned, this activity ran successfully. If1 is returned, this activity failed with an error.
theDataset.Source	Text	The path and filename of the source (original) file.

Example

NOTE: The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: Apply "Brightness" adjustment to -20 on image "c:\temp\sampleImage.jpg" and save into image "c:\temp\sampleImage2.jpg".

This help file is for the Advanced Workflow Engine v10. For other versions, please refer to http://help.globalscape.com/help/index.html

(If the Index and Contents are hidden, click the icon in the top left corner.)

If this help topic did not help you, try searching the Knowledgebase.
For the most up-to-date information, to view version history, updates, and activation instructions, visit the Support Center at http://www.globalscape.com/support-home.
For information about Globalscape, visit www.globalscape.com.

Last modified: 28-Jun-19 at 14:01:14