Scripting API

<<UseGraphiteWorkspaceTheme Main Index UserForums>>
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

UserDefinedFilter

Script Name: UserDefinedFilter
Name: UserDefinedFilter
Library: CmdStandard
Description: Apply a user defined convolution kernel to the image. Kernels can be as large as 7x7. The kernel can be applied to individual color channels or to a greyscale representation of the image.
Status bar text: Apply a user defined filter to the image
Tool tip text: User Defined Filter
Undo text: User Defined Filter
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
Use red channelApplyToRedEnumeration (Boolean)If this value is true, the filter is applied to the red channel of the image. This value is ignored if ApplyToGrey is true.NoTrue
BiasBiasIntegerThe bias value is added to the result pixel after the matrix and divisor are processed. It has the effect of shifting all pixels by a constant amount.No0-100000100000
Use green channelApplyToGreenEnumeration (Boolean)If this value is true, the filter is applied to the green channel of the image. If the ApplyToGrey value is true, this value is ignored.NoTrue
DivisorDivisorIntegerThe divisor is used to divide the result pixel after the matrix has been applied. It allows you to simulate the user of real numbers as filter coefficients.No1-100000100000
Use grey valuesApplyToGreyEnumeration (Boolean)If true, the kernel is applied to the grey values in the image. The image type is not changed, but all pixels will be shades of grey. If this value is true, the specification of red, green and blue channel is ignored.NoFalse
Use blue channelApplyToBlueEnumeration (Boolean)If this value is true, the filter is applied to the blue channel of the image. If the ApplyToGrey value is true, this value is ignored.NoTrue
KernelKernelTupleA kernel is a tuple with 7 elements, each of which is itself a tuple of 7 integers. The outer tuples are rows in the kernel.No0
General SettingsGeneralSettingsParameter RepositoryContains parameters that control the execution of the command.No
 
Command Attributes:
IsExternal: true
IsUndoable: true
ProcessChanges: true
FinalizeTransient: true
ShowInEffectsBrowser: true
This command is safe for execution in a processing thread.: true
 
Resource Attributes:
HasWinPlacement: true
IsPreviewable: true
IsProofable: true
HelpID:32892
DlgHasPresets: true
DlgHasRandomize: true
IsEditable: true