AddSpotlight Method

Description:

Produces a "spotlight" effect for the image referenced by pPage object within the circle specified by radius and (centerX, centerY) parameters. It leaves the pixels within the circle unchanged while darkening the surrounding pixels by reducing their intensity. Use darkenBy parameter to specify the reduction in intensity of the surrounding pixels. Use smoothing parameter to specify the amount of smoothing at the perimeter of the circle. Setting smoothing to 0 will leave the sharpest edge.

This method takes into account the ROI settings of pPage object, that are accessible via the IGPage Object.ROI Property. By default ROI is set to the entire image.

Syntax:

      AddSpotlight (pPage As IGPage, centerX As Long, centerY As Long,
radius As Long, darkenBy As Long, smoothing As Long)

Parameters:

Name	Description
pPage	Reference to IGPage Object for which to add the spotlight.
centerX	X coordinate of the circle center to get a spotlight effect.
centerY	Y coordinate of the circle center to get a spotlight effect.
radius	Circle radius in pixels.
darkenBy	Reduction in intensity of the surrounding pixels.
smoothing	Value between 0 and 255 specifying how much smoothing to apply at the edges. 0 gives the sharpest edge, > 0 gives the smoother edges.

Return Value:

N/A

Bits Per Pixel:

8-bit gray level, 9-16-bit gray level, 24, and 32

Sample:

Ip_Fx