Skip to content

ImageNodeOptixDenoiser

ImageNodeOptixDenoiser#

(Optix Denoiser)

Go to User page.

Description#

Denoise the image using OptiX denoiser.

Public Attributes#

Type Name Visual Hint Description
reference (ImageNode) a VISUAL_HINT_DEFAULT Define the A image.
double strength VISUAL_HINT_PERCENTAGE Control the strength of the denoiser output. It basically performs an over operation of the denoised output over the input image. When set to 100% you get the full output from the denoise image. When set to 0% you get the original input image.
bool use_albedo VISUAL_HINT_DEFAULT Use the albedo AOV to guide the denoiser to improve the results. Note that sometimes this can introduce some artefacts leading to an image degradation.
bool use_world_normal VISUAL_HINT_DEFAULT Use the world_normal AOV to guide even further the denoiser. Note that you can only enable normals if the Raw Color is enabled.
string albedo_AOV VISUAL_HINT_TAG Choose the name of the image channel layer you wish to use as raw color.
string world_normal_AOV VISUAL_HINT_TAG Choose the name of the image channel layer you wish to use as world normal.

Inherited Public Attributes#

Type Name Visual Hint Description
bool thumbnail VISUAL_HINT_DEFAULT Enable/Disable the display of the node thumbnail in the Build View.
double thumbnail_size VISUAL_HINT_DEFAULT Set the size of the thumbnail in the Build View.
long caching VISUAL_HINT_DEFAULT Cache result of this node
action clear_cache VISUAL_HINT_DEFAULT Clear the internal image cached by the node. If you clear the image cache, the node will request an evaluation when displayed by the Image View.
bool pass_through VISUAL_HINT_DEFAULT Enable pass through. If enabled, the node returns the input specified as Master Input.
string master_input VISUAL_HINT_TAG Define which input should be returned by the node if Pass Through is enabled.

CID#

class "ImageNodeOptixDenoiser" "ImageNode" {
    #license {
        flavor "advanced"
    }
    #version 0.9
    icon "../icons/object_icons/image_node_reformat.iconrc"
    category "Image"
    doc "Denoise the image using OptiX denoiser."
    attribute_group "input" {
        reference "a" {
            doc "Define the A image."
            filter "ImageNode"
            dirtiness_pass_through yes
            value ""
        }
    }
    attribute_group "options" {
        percentage "strength" {
            doc "Control the strength of the denoiser output. It basically performs an over operation of the denoised output over the input image. When set to 100% you get the full output from the denoise image. When set to 0% you get the original input image."
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 1
        }
        bool "use_albedo" {
            doc "Use the albedo AOV to guide the denoiser to improve the results. Note that sometimes this can introduce some artefacts leading to an image degradation."
            value no
        }
        bool "use_world_normal" {
            doc "Use the world_normal AOV to guide even further the denoiser. Note that you can only enable normals if the Raw Color is enabled."
            value no
        }
        tag "albedo_AOV" {
            doc "Choose the name of the image channel layer you wish to use as raw color."
            filter "aov_groups"
            read_only yes
            preset "coordinates" "1"
            preset "diagnostics_pbr_diffuse_sample-count" "2"
            preset "diagnostics_pbr_diffuse_sample-count_transmission" "3"
            preset "diagnostics_pbr_diffuse_sample-count_reflection" "4"
            preset "diagnostics_pbr_glossy_sample-count" "5"
            preset "diagnostics_pbr_glossy_sample-count_transmission" "6"
            preset "diagnostics_pbr_glossy_sample-count_reflection" "7"
            preset "diagnostics_pbr_specular_sample-count" "8"
            preset "diagnostics_pbr_specular_sample-count_transmission" "9"
            preset "diagnostics_pbr_specular_sample-count_reflection" "10"
            preset "diagnostics_pbr_spec-gloss_sample-count" "11"
            preset "diagnostics_pbr_spec-gloss_sample-count_transmission" "12"
            preset "diagnostics_pbr_spec-gloss_sample-count_reflection" "13"
            preset "diagnostics_pbr_subsurface_sample-count" "14"
            preset "diagnostics_pbr_volume_sample-count" "15"
            preset "diagnostics_pbr_light_sample-count" "16"
            preset "motion_vector" "17"
            preset "camera_normal" "18"
            preset "camera_position" "19"
            preset "world_normal" "20"
            preset "albedo" "21"
            preset "depth" "22"
            preset "pbr_diffuse" "23"
            preset "pbr_diffuse_transmission" "24"
            preset "pbr_diffuse_transmission_k" "25"
            preset "pbr_diffuse_transmission_i" "26"
            preset "pbr_diffuse_transmission_i_direct" "27"
            preset "pbr_diffuse_transmission_i_indirect" "28"
            preset "pbr_diffuse_reflection" "29"
            preset "pbr_diffuse_reflection_k" "30"
            preset "pbr_diffuse_reflection_i" "31"
            preset "pbr_diffuse_reflection_i_direct" "32"
            preset "pbr_diffuse_reflection_i_indirect" "33"
            preset "pbr_glossy" "34"
            preset "pbr_glossy_transmission" "35"
            preset "pbr_glossy_transmission_k" "36"
            preset "pbr_glossy_transmission_i" "37"
            preset "pbr_glossy_transmission_i_direct" "38"
            preset "pbr_glossy_transmission_i_indirect" "39"
            preset "pbr_glossy_reflection" "40"
            preset "pbr_glossy_reflection_k" "41"
            preset "pbr_glossy_reflection_i" "42"
            preset "pbr_glossy_reflection_i_direct" "43"
            preset "pbr_glossy_reflection_i_indirect" "44"
            preset "pbr_specular" "45"
            preset "pbr_specular_transmission" "46"
            preset "pbr_specular_transmission_k" "47"
            preset "pbr_specular_transmission_i" "48"
            preset "pbr_specular_reflection" "49"
            preset "pbr_specular_reflection_k" "50"
            preset "pbr_specular_reflection_i" "51"
            preset "pbr_spec-gloss" "52"
            preset "pbr_spec-gloss_transmission" "53"
            preset "pbr_spec-gloss_reflection" "54"
            preset "pbr_subsurface" "55"
            preset "pbr_subsurface_k" "56"
            preset "pbr_subsurface_i" "57"
            preset "pbr_subsurface_i_direct" "58"
            preset "pbr_subsurface_i_indirect" "59"
            preset "pbr_volume" "60"
            preset "pbr_volume_k" "61"
            preset "pbr_volume_i" "62"
            preset "pbr_volume_i_direct" "63"
            preset "pbr_volume_i_indirect" "64"
            preset "pbr_emission" "65"
            preset "pbr_light_direction" "66"
            preset "pbr_light_radiance" "67"
            preset "luminosity" "68"
            preset "opacity" "69"
            preset "pbr_volume_density" "70"
            preset "pbr_volume_attenuation" "71"
            preset "pbr_catcher_opacity" "72"
            preset "pbr_catcher_diffuse" "73"
            preset "pbr_catcher_diffuse_transmission" "74"
            preset "pbr_catcher_diffuse_reflection" "75"
            preset "pbr_catcher_glossy" "76"
            preset "pbr_catcher_glossy_transmission" "77"
            preset "pbr_catcher_glossy_reflection" "78"
            preset "pbr_catcher_specular" "79"
            preset "pbr_catcher_specular_transmission" "80"
            preset "pbr_catcher_specular_reflection" "81"
            preset "pbr_catcher_spec-gloss" "82"
            preset "pbr_catcher_spec-gloss_transmission" "83"
            preset "pbr_catcher_spec-gloss_reflection" "84"
            preset "pbr_catcher_subsurface" "85"
            preset "pbr_catcher_volume" "86"
            preset "diagnostics_ray-count" "87"
            preset "diagnostics_camera_sample-count" "88"
            preset "diagnostics_camera_heat-map" "89"
            preset "cryptomatte_material" "90"
            preset "cryptomatte_material00" "91"
            preset "cryptomatte_material01" "92"
            preset "cryptomatte_material02" "93"
            preset "cryptomatte_object" "94"
            preset "cryptomatte_object00" "95"
            preset "cryptomatte_object01" "96"
            preset "cryptomatte_object02" "97"
            preset "cryptomatte_asset" "98"
            preset "cryptomatte_asset00" "99"
            preset "cryptomatte_asset01" "100"
            preset "cryptomatte_asset02" "101"
            preset "lpe_diffuse_reflection_albedo" "102"
            preset "lpe_diffuse_reflection_direct" "103"
            preset "lpe_diffuse_reflection_indirect" "104"
            preset "lpe_diffuse_transmission_albedo" "105"
            preset "lpe_diffuse_transmission_direct" "106"
            preset "lpe_diffuse_transmission_indirect" "107"
            preset "lpe_direct" "108"
            preset "lpe_glossy_reflection_albedo" "109"
            preset "lpe_glossy_reflection_direct" "110"
            preset "lpe_glossy_reflection_indirect" "111"
            preset "lpe_glossy_transmission_albedo" "112"
            preset "lpe_glossy_transmission_direct" "113"
            preset "lpe_glossy_transmission_indirect" "114"
            preset "lpe_indirect" "115"
            preset "lpe_spec-gloss_reflection_albedo" "116"
            preset "lpe_spec-gloss_reflection_direct" "117"
            preset "lpe_spec-gloss_reflection_indirect" "118"
            preset "lpe_spec-gloss_transmission_albedo" "119"
            preset "lpe_spec-gloss_transmission_direct" "120"
            preset "lpe_spec-gloss_transmission_indirect" "121"
            preset "lpe_specular_reflection_albedo" "122"
            preset "lpe_specular_reflection_direct" "123"
            preset "lpe_specular_reflection_indirect" "124"
            preset "lpe_specular_transmission_albedo" "125"
            preset "lpe_specular_transmission_direct" "126"
            preset "lpe_specular_transmission_indirect" "127"
            preset "lpe_subsurface_albedo" "128"
            preset "lpe_subsurface_direct" "129"
            preset "lpe_subsurface_indirect" "130"
            preset "lpe_volume_albedo" "131"
            preset "lpe_volume_direct" "132"
            preset "lpe_volume_indirect" "133"
            value "albedo"
        }
        tag "world_normal_AOV" {
            doc "Choose the name of the image channel layer you wish to use as world normal."
            filter "aov_groups"
            read_only yes
            preset "coordinates" "1"
            preset "diagnostics_pbr_diffuse_sample-count" "2"
            preset "diagnostics_pbr_diffuse_sample-count_transmission" "3"
            preset "diagnostics_pbr_diffuse_sample-count_reflection" "4"
            preset "diagnostics_pbr_glossy_sample-count" "5"
            preset "diagnostics_pbr_glossy_sample-count_transmission" "6"
            preset "diagnostics_pbr_glossy_sample-count_reflection" "7"
            preset "diagnostics_pbr_specular_sample-count" "8"
            preset "diagnostics_pbr_specular_sample-count_transmission" "9"
            preset "diagnostics_pbr_specular_sample-count_reflection" "10"
            preset "diagnostics_pbr_spec-gloss_sample-count" "11"
            preset "diagnostics_pbr_spec-gloss_sample-count_transmission" "12"
            preset "diagnostics_pbr_spec-gloss_sample-count_reflection" "13"
            preset "diagnostics_pbr_subsurface_sample-count" "14"
            preset "diagnostics_pbr_volume_sample-count" "15"
            preset "diagnostics_pbr_light_sample-count" "16"
            preset "motion_vector" "17"
            preset "camera_normal" "18"
            preset "camera_position" "19"
            preset "world_normal" "20"
            preset "albedo" "21"
            preset "depth" "22"
            preset "pbr_diffuse" "23"
            preset "pbr_diffuse_transmission" "24"
            preset "pbr_diffuse_transmission_k" "25"
            preset "pbr_diffuse_transmission_i" "26"
            preset "pbr_diffuse_transmission_i_direct" "27"
            preset "pbr_diffuse_transmission_i_indirect" "28"
            preset "pbr_diffuse_reflection" "29"
            preset "pbr_diffuse_reflection_k" "30"
            preset "pbr_diffuse_reflection_i" "31"
            preset "pbr_diffuse_reflection_i_direct" "32"
            preset "pbr_diffuse_reflection_i_indirect" "33"
            preset "pbr_glossy" "34"
            preset "pbr_glossy_transmission" "35"
            preset "pbr_glossy_transmission_k" "36"
            preset "pbr_glossy_transmission_i" "37"
            preset "pbr_glossy_transmission_i_direct" "38"
            preset "pbr_glossy_transmission_i_indirect" "39"
            preset "pbr_glossy_reflection" "40"
            preset "pbr_glossy_reflection_k" "41"
            preset "pbr_glossy_reflection_i" "42"
            preset "pbr_glossy_reflection_i_direct" "43"
            preset "pbr_glossy_reflection_i_indirect" "44"
            preset "pbr_specular" "45"
            preset "pbr_specular_transmission" "46"
            preset "pbr_specular_transmission_k" "47"
            preset "pbr_specular_transmission_i" "48"
            preset "pbr_specular_reflection" "49"
            preset "pbr_specular_reflection_k" "50"
            preset "pbr_specular_reflection_i" "51"
            preset "pbr_spec-gloss" "52"
            preset "pbr_spec-gloss_transmission" "53"
            preset "pbr_spec-gloss_reflection" "54"
            preset "pbr_subsurface" "55"
            preset "pbr_subsurface_k" "56"
            preset "pbr_subsurface_i" "57"
            preset "pbr_subsurface_i_direct" "58"
            preset "pbr_subsurface_i_indirect" "59"
            preset "pbr_volume" "60"
            preset "pbr_volume_k" "61"
            preset "pbr_volume_i" "62"
            preset "pbr_volume_i_direct" "63"
            preset "pbr_volume_i_indirect" "64"
            preset "pbr_emission" "65"
            preset "pbr_light_direction" "66"
            preset "pbr_light_radiance" "67"
            preset "luminosity" "68"
            preset "opacity" "69"
            preset "pbr_volume_density" "70"
            preset "pbr_volume_attenuation" "71"
            preset "pbr_catcher_opacity" "72"
            preset "pbr_catcher_diffuse" "73"
            preset "pbr_catcher_diffuse_transmission" "74"
            preset "pbr_catcher_diffuse_reflection" "75"
            preset "pbr_catcher_glossy" "76"
            preset "pbr_catcher_glossy_transmission" "77"
            preset "pbr_catcher_glossy_reflection" "78"
            preset "pbr_catcher_specular" "79"
            preset "pbr_catcher_specular_transmission" "80"
            preset "pbr_catcher_specular_reflection" "81"
            preset "pbr_catcher_spec-gloss" "82"
            preset "pbr_catcher_spec-gloss_transmission" "83"
            preset "pbr_catcher_spec-gloss_reflection" "84"
            preset "pbr_catcher_subsurface" "85"
            preset "pbr_catcher_volume" "86"
            preset "diagnostics_ray-count" "87"
            preset "diagnostics_camera_sample-count" "88"
            preset "diagnostics_camera_heat-map" "89"
            preset "cryptomatte_material" "90"
            preset "cryptomatte_material00" "91"
            preset "cryptomatte_material01" "92"
            preset "cryptomatte_material02" "93"
            preset "cryptomatte_object" "94"
            preset "cryptomatte_object00" "95"
            preset "cryptomatte_object01" "96"
            preset "cryptomatte_object02" "97"
            preset "cryptomatte_asset" "98"
            preset "cryptomatte_asset00" "99"
            preset "cryptomatte_asset01" "100"
            preset "cryptomatte_asset02" "101"
            preset "lpe_diffuse_reflection_albedo" "102"
            preset "lpe_diffuse_reflection_direct" "103"
            preset "lpe_diffuse_reflection_indirect" "104"
            preset "lpe_diffuse_transmission_albedo" "105"
            preset "lpe_diffuse_transmission_direct" "106"
            preset "lpe_diffuse_transmission_indirect" "107"
            preset "lpe_direct" "108"
            preset "lpe_glossy_reflection_albedo" "109"
            preset "lpe_glossy_reflection_direct" "110"
            preset "lpe_glossy_reflection_indirect" "111"
            preset "lpe_glossy_transmission_albedo" "112"
            preset "lpe_glossy_transmission_direct" "113"
            preset "lpe_glossy_transmission_indirect" "114"
            preset "lpe_indirect" "115"
            preset "lpe_spec-gloss_reflection_albedo" "116"
            preset "lpe_spec-gloss_reflection_direct" "117"
            preset "lpe_spec-gloss_reflection_indirect" "118"
            preset "lpe_spec-gloss_transmission_albedo" "119"
            preset "lpe_spec-gloss_transmission_direct" "120"
            preset "lpe_spec-gloss_transmission_indirect" "121"
            preset "lpe_specular_reflection_albedo" "122"
            preset "lpe_specular_reflection_direct" "123"
            preset "lpe_specular_reflection_indirect" "124"
            preset "lpe_specular_transmission_albedo" "125"
            preset "lpe_specular_transmission_direct" "126"
            preset "lpe_specular_transmission_indirect" "127"
            preset "lpe_subsurface_albedo" "128"
            preset "lpe_subsurface_direct" "129"
            preset "lpe_subsurface_indirect" "130"
            preset "lpe_volume_albedo" "131"
            preset "lpe_volume_direct" "132"
            preset "lpe_volume_indirect" "133"
            value "world_normal"
        }
    }
    attribute_group "ModuleImageNodeInput.a" {
        doc "a"
    }
}