ImageFilterCutOff

ImageFilterCutOff#

(Cut Off)

Category: ImageFilter
Default object name: cut_off
Inherits from: ProjectItem > ImageFilter > PixelFilter

No corresponding User page.

Description#

Add cutoff to the image.

Public Attributes#

Type	Name	Visual Hint	Description
`long`	`high_cut_off_mode`	`VISUAL_HINT_DEFAULT`	Select the parameter on which the high cut-off value will be applied.
`double`	`high_cut_off_value`	`VISUAL_HINT_PERCENTAGE`	High cut off value.
`long`	`low_cut_off_mode`	`VISUAL_HINT_DEFAULT`	Select the parameter on which the low cut-off value will be applied.
`double`	`low_cut_off_value`	`VISUAL_HINT_PERCENTAGE`	Low cut off value.

Inherited Public Attributes#

Type	Name	Visual Hint	Description
`bool`	`channel_r`	`VISUAL_HINT_DEFAULT`	Whether this filter affects the red channel or not.
`bool`	`channel_g`	`VISUAL_HINT_DEFAULT`	Whether this filter affects the green channel or not.
`bool`	`channel_b`	`VISUAL_HINT_DEFAULT`	Whether this filter affects the blue channel or not.
`bool`	`channel_a`	`VISUAL_HINT_DEFAULT`	Whether this filter affects the alpha channel or not.
`bool`	`channel_z`	`VISUAL_HINT_DEFAULT`	Whether this filter affects the Z channel or not.

CID#

class "ImageFilterCutOff" "PixelFilter" {
    #version 0.9
    icon "../icons/object_icons/filter_cut_off.iconrc"
    category "ImageFilter"
    doc "Add cutoff to the image."
    long "high_cut_off_mode" {
        doc "Select the parameter on which the high cut-off value will be applied."
        preset "Off" "0"
        preset "Hue" "1"
        preset "Saturation" "2"
        preset "Brightness" "3"
        preset "Red" "4"
        preset "Green" "5"
        preset "Blue" "6"
        value 3
    }
    percentage "high_cut_off_value" {
        doc "High cut off value."
        slider yes
        ui_range yes 0.0 1
        value 1
    }
    long "low_cut_off_mode" {
        doc "Select the parameter on which the low cut-off value will be applied."
        preset "Off" "0"
        preset "Hue" "1"
        preset "Saturation" "2"
        preset "Brightness" "3"
        preset "Red" "4"
        preset "Green" "5"
        preset "Blue" "6"
        value 3
    }
    percentage "low_cut_off_value" {
        doc "Low cut off value."
        slider yes
        ui_range yes 0.0 1
        value 0.0
    }
}