ILMaskRegion Interface Reference

This interface expose APIs to create/modify a mask region object. More...

Inheritance diagram for ILMaskRegion:

Public Member Functions
void	SetMask (ILImage *mask, double tlx, double tly)
Public Member Functions inherited from ILRegion
ILCompoundRegion *	Add (ILRegion *other)
void	Drag (LPVRoiHandle roiHandle, int x, int y, double zoomX, double zoomY, double panX, double panY)
void	Draw (HDC hdc, BOOL drawHandles, double zoomX, double zoomY, double panX, double panY)
void	EnableHandle (LPVRoiHandle roiHandle, BOOL enabled)
LPVRoiHandle	HitTest (int x, int y, double zoomX, double zoomY, double panX, double panY)
ILCompoundRegion *	Intersect (ILRegion *other)
ILCompoundRegion *	Invert ()
void	MapFromImage (double imagePointX, double imagePointY, double *regionPointX, double *regionPointY)
ILObject *	MapObjectFromImage (ILObject *imageObject)
ILObject *	MapObjectToImage (ILObject *regionObject)
void	MapToImage (double regionPointX, double regionPointY, double *imagePointX, double *imagePointY)
void	ReduceImage (ILImage *image, ILImage **newImage, ILImage **newMask)
ILRegion *	Rotate (double da)
ILRegion *	RotateAndTranslate (double x, double y, double newX, double newY, double da)
ILRegion *	Scale (double factorX, double factorY)
ILCompoundRegion *	Subtract (ILRegion *other)
ILImage *	ToMask (int w, int h)
ILRegion *	Translate (double offsetX, double offsetY)
ILCompoundRegion *	Union (ILRegion *other)
ILCompoundRegion *	XOR (ILRegion *other)
Public Member Functions inherited from ILObject
ILObject *	Copy ()
LPVErrorCode	Load (LString filename)
void	Reset ()
LPVErrorCode	Save (LString filename)
BOOL	Valid ()

Additional Inherited Members
Properties inherited from ILRegion
LPVInterpolationMethod	InterpolationMethod [get, set]
	The interpolation method used in image reduction.
double	ReduceAngle [get, set]
	The angle of the reduced result. By default, it's 0. A non-zero value means we'll rotated the reduced result image by the angle clockwise. More...
double	ReduceScale [get, set]
	The scale of the reduced result. By default, it's 1. Change this value to scale the reduced result image. More...

Detailed Description

This interface expose APIs to create/modify a mask region object.

White pixels on the mask image represent pixels should be included in the region, while black pixels represent the ones should be excluded. To use this interface, you should create a LMaskRegion object.

Example Code

C++

ILMaskRegionPtr maskRoi = LMaskRegion::Create();
maskRoi->SetPlacement(mask_img, 0, 0);

C#

LMaskRegion maskRoi = new LMaskRegion();
maskRoi.SetPlacement(mask_img, 0, 0);

COM

ILMaskRegionPtr maskRoi = LMaskRegion::Create();
// or, ILMaskRegionPtr maskRoi(__uuidof(LMaskRegion)), for absence of built-in Create functions (before 2.2.0)
maskRoi->SetPlacement(mask_img, 0, 0);

Member Function Documentation

SetMask()

void SetMask	(	ILImage *	mask,
		double	tlx,
		double	tly
	)

Set the mask image, place its left-top corner at the given position.

Parameters

[in]	mask	The mask image
[in]	tlx	The x-coordinate of the top-left corner of the mask region.
[in]	tly	The y-coordinate of the top-left corner of the mask region.