SoPostEffectDepthHalo

InventorModule

author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	SoRenderers
definition	SoRenderers.def

Purpose

The SoPostEffectDepthHalo module renders a depth based halo as an effect for the SoPostEffectRenderer module.

It basically implements the algorithm described in the paper “Image Enhancement by Unsharp Masking the Depth Buffer”, Thomas Luft, Carsten Colditz, Oliver Deussen.

Parameter Fields

Field Index

Back Color: Color	Front Color: Color
Back Factor: Float	Front Factor: Float
Background Halo: Bool	Intensity: Float
Blur Iterations: Integer	Precision: Enum
Blur Kernel Size: Integer	Resize Mode: Enum
colorBufferName: String	Sample Distance: Float
depthBufferName: String
Enabled: Bool

Visible Fields

Enabled

name: enabled, type: Bool, default: TRUE

If checked, the effect is enabled.

Blur Kernel Size

name: blurKernelSize, type: Integer, default: 32, minimum: 3, maximum: 32

Sets the blur kernel size for the low pass filtering of the depth buffer.

Sample Distance

name: sampleDistance, type: Float, default: 1, minimum: 1, maximum: 32

Sets the sample distance for the low pass blur.

Blur Iterations

name: blurIterations, type: Integer, default: 1, minimum: 1, maximum: 32

Sets the number of blur iterations (with growing sample distance per iteration).

Intensity

name: intensity, type: Float, default: 1, minimum: 0, maximum: 10

Sets the overall intensity of the effect.

Background Halo

name: backgroundHalo, type: Bool, default: TRUE

If checked, empty background receives the effect.

Front Factor

name: frontFactor, type: Float, default: 1, minimum: 0, maximum: 5

Sets the factor for the part of the halo that is in the front.

Back Factor

name: backFactor, type: Float, default: 1, minimum: 0, maximum: 5

Sets the factor for the part of the halo that is in the back.

Front Color

name: frontColor, type: Color, default: 0 0 0

Sets the color for the front halo.

Back Color

name: backColor, type: Color, default: 0 0 0

Sets the color for the back halo.

Resize Mode

name: resizeMode, type: Enum, default: Average2x2

Defines the downsample factor for the low pass filtered depth buffer.

Values:

Title	Name
Average2x2	Average2x2
Average3x3	Average3x3
Average4x4	Average4x4

Precision

name: precision, type: Enum, default: High

Defines the precision of the blurred depth buffers that are used.

Values:

Title	Name	Description
Low	Low	Very low, can show banding artifacts.
Medium	Medium	Should provide adequate quality.
High	High	Highest possible precision.

Hidden Fields

colorBufferName

name: colorBufferName, type: String, default: colorBuffer

depthBufferName

name: depthBufferName, type: String, default: depthBuffer