This represents the abstract base class for all ROI and image classes. More...

Inheritance diagram for eVision.EBaseROI:

[legend]

Public Member Functions
bool	IsAttached (self)
	Returns true if the ROI is attached to an image.
bool	IsAnROI (self)
	Tests whether this object is an ROI or an image.
bool	HasSubROI (self, eVision.EBaseROI\|None subROI)
	Tests whether this object has a given attached ROI.
eVision.EBaseROI\|None	GetNextSiblingSubROI (self, eVision.EBaseROI\|None subROI)
	This method returns the ROI that is the next sibling of the supplied ROI in the list of sub-ROIs.
eVision.EBaseROI\|None	GetNextROI (self, eVision.EBaseROI\|None startROI)
	Returns the next ROI in the list starting at startROI or null if there is no next ROI.
None	SetImagePtr (self, int width, int height, ctypes.c_void_p imagePointer, int bitsPerRow)
	Sets the pointer to an externally allocated image buffer.
None	SetImagePtr (self, int width, int height, ctypes.c_void_p imagePointer)
	Sets the pointer to an externally allocated image buffer.
None	UseExternalBuffer (self, int width, int height, ctypes.c_void_p buffer, int rowPitch)
	Sets the pointer to an externally allocated image buffer.
ctypes.c_void_p	GetImagePtr (self, int x, int y)
	Returns a pointer to the pixel at given coordinates within the image/ROI.
ctypes.c_void_p	GetImagePtr (self)
	Returns a pointer to the pixel at given coordinates within the image/ROI.
None	CropToImage (self)
	This method reduces the ROI size so that it is completely contained within its topmost parent image bounds (if such an image exists at the top of the hierarchy).
bool	IsVoid (self)
	Tests if the topmost parent image of this hierarchy has a zero size.
None	SetPlacement (self, int originX, int originY, int width, int height)
	Sets the placement of an ROI, relative to its parent ROI/image.
None	SetPlacement (self, eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft, int paddingRight)
	Sets the placement of an ROI, relative to its parent ROI/image.
None	SetPlacement (self, eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft)
	Sets the placement of an ROI, relative to its parent ROI/image.
None	SetPlacement (self, eVision.ERegion region, int paddingTop, int paddingBottom)
	Sets the placement of an ROI, relative to its parent ROI/image.
None	SetPlacement (self, eVision.ERegion region, int paddingTop)
	Sets the placement of an ROI, relative to its parent ROI/image.
None	SetPlacement (self, eVision.ERegion region)
	Sets the placement of an ROI, relative to its parent ROI/image.
None	SetPlacement (self, eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom, int paddingLeft, int paddingRight)
	Sets the placement of an ROI, relative to its parent ROI/image.
None	SetPlacement (self, eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom, int paddingLeft)
	Sets the placement of an ROI, relative to its parent ROI/image.
None	SetPlacement (self, eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom)
	Sets the placement of an ROI, relative to its parent ROI/image.
None	SetPlacement (self, eVision.ERegion region, eVision.EFrame frame, int paddingTop)
	Sets the placement of an ROI, relative to its parent ROI/image.
None	SetPlacement (self, eVision.ERegion region, eVision.EFrame frame)
	Sets the placement of an ROI, relative to its parent ROI/image.
list[eVision._eVision.EBaseROI\|None]	GetSubBaseROIs (self, bool recursive)
	Returns all the children, and possibly recursively all their children, too.
list[eVision._eVision.EBaseROI\|None]	GetSubBaseROIs (self)
	Returns all the children, and possibly recursively all their children, too.
eVision.EDragHandle	HitTest (self, int x, int y, float zoomX, float zoomY, float panX, float panY)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EDragHandle	HitTest (self, int x, int y, float zoomX, float zoomY, float panX)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EDragHandle	HitTest (self, int x, int y, float zoomX, float zoomY)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EDragHandle	HitTest (self, int x, int y, float zoomX)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EDragHandle	HitTest (self, int x, int y)
	Detects if the cursor is placed over one of the dragging handles.
bool	IsPointInside (self, eVision.EPoint position)
	Detects if the position is inside current ROI.
bool	IsPixelInside (self, int x, int y)
	Detects if a pixel (given its x and y coordinates) is inside current ROI.
None	Drag (self, eVision.EDragHandle dragHandle, int x, int y, float zoomX, float zoomY, float panX, float panY)
	Moves the specified handle to a new position and updates all placement parameters of the ROI.
None	Drag (self, eVision.EDragHandle dragHandle, int x, int y, float zoomX, float zoomY, float panX)
	Moves the specified handle to a new position and updates all placement parameters of the ROI.
None	Drag (self, eVision.EDragHandle dragHandle, int x, int y, float zoomX, float zoomY)
	Moves the specified handle to a new position and updates all placement parameters of the ROI.
None	Drag (self, eVision.EDragHandle dragHandle, int x, int y, float zoomX)
	Moves the specified handle to a new position and updates all placement parameters of the ROI.
None	Drag (self, eVision.EDragHandle dragHandle, int x, int y)
	Moves the specified handle to a new position and updates all placement parameters of the ROI.
None	Serialize (self, eVision.ESerializer\|None serializer)
	Serializes the eVision.EBaseROI.
None	Detach (self)
None	Attach (self, eVision.EBaseROI\|None parent)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, int orgX, int orgY, int width, int height)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, int orgX, int orgY, int width)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, int orgX, int orgY)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft, int paddingRight)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, eVision.ERegion region, int paddingTop, int paddingBottom)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, eVision.ERegion region, int paddingTop)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, eVision.ERegion region)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom, int paddingLeft, int paddingRight)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom, int paddingLeft)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, eVision.ERegion region, eVision.EFrame frame, int paddingTop)
	This method attaches the ROI to another ROI or image.
None	Attach (self, eVision.EBaseROI\|None parent, eVision.ERegion region, eVision.EFrame frame)
	This method attaches the ROI to another ROI or image.
None	CopyTo (self, eVision.EBaseROI dest)
	Copies all the data of the current eVision.EBaseROI object into another eVision.EBaseROI object and returns it.
None	SetSize (self, int width, int height)
	Sets the width and height of an ROI/image.
None	SetSize (self, eVision.EBaseROI\|None other)
	Sets the width and height of an ROI/image.
None	DrawFrame (self, eVision.EDrawAdapter\|None graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
None	DrawFrame (self, eVision.EDrawAdapter\|None graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
None	DrawFrame (self, eVision.EDrawAdapter\|None graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
None	DrawFrame (self, eVision.EDrawAdapter\|None graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
None	DrawFrame (self, eVision.EDrawAdapter\|None graphicContext, eVision.EFramePosition framePosition, bool handles)
	Draws a rectangular frame around an image or ROI.
None	DrawFrame (self, eVision.EDrawAdapter\|None graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
None	DrawFrame (self, eVision.EDrawAdapter\|None graphicContext, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
None	DrawFrame (self, eVision.EDrawAdapter\|None graphicContext, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
None	DrawFrame (self, eVision.EDrawAdapter\|None graphicContext, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
None	DrawFrame (self, eVision.EDrawAdapter\|None graphicContext, bool handles)
	Draws a rectangular frame around an image or ROI.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, float zoomX)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EC24Vector\|None c24Vector, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EC24Vector\|None c24Vector, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EC24Vector\|None c24Vector, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EC24Vector\|None c24Vector, float zoomX)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EC24Vector\|None c24Vector)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EBW8Vector\|None bw8Vector, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EBW8Vector\|None bw8Vector, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EBW8Vector\|None bw8Vector, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EBW8Vector\|None bw8Vector, float zoomX)
	Draws an ROI/image in a device context.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EBW8Vector\|None bw8Vector)
	Draws an ROI/image in a device context.
None	Load (self, str path)
	Restores an image stored in the given file.
None	Load (self, eVision.ESerializer\|None serializer)
	Restores an image stored in the given file.
None	Save (self, str path, eVision.EImageFileType type)
	Saves the eVision.EBaseROI object to the given file.
None	Save (self, str path)
	Saves the eVision.EBaseROI object to the given file.
None	Save (self, eVision.ESerializer\|None serializer)
	Saves the eVision.EBaseROI object to the given file.
None	SavePng (self, str path, int compression)
	Saves the eVision.EBaseROI object to the given file, in PNG format.
None	SavePng (self, str path)
	Saves the eVision.EBaseROI object to the given file, in PNG format.
None	SaveJpeg (self, str path, int quality)
	Saves the eVision.EBaseROI object to the given file, in JPEG format.
None	SaveJpeg (self, str path)
	Saves the eVision.EBaseROI object to the given file, in JPEG format.
None	SaveJpeg2K (self, str path, int quality)
	Saves the eVision.EBaseROI object to the given file, in JPEG 2000 format.
None	SaveJpeg2K (self, str path)
	Saves the eVision.EBaseROI object to the given file, in JPEG 2000 format.
eVision.EBaseROI\|None	BaseTopParent (self)
	Returns the image at the top of the hierarchy, or NULL if there is no image on top.
eVision.EBaseROI\|None	BaseImage (self)
	Returns the image associated with this ROI, or NULL if there is no image associated.
eVision.EBaseROI\|None	Parent (self)
	Returns the hierarchical parent of this object.
eVision.EBaseROI\|None	FirstSubROI (self)
	See GetFirstSubROI in the derived classes.
eVision.EBaseROI\|None	NextSiblingROI (self)
	This method returns the ROI that is the next sibling of this ROI.
int	RowPitch (self)
	Gets the pitch of a row (the number of bytes between two vertically adjacent pixels).
int	ColPitch (self)
	Gets the pitch of a column (number of bytes between two horizontally adjacent pixels).
int	BitsPerPixel (self)
	Gets the number of storage bits per pixel.
int	OrgX (self)
	Gets or sets the x-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
	OrgX (self, int value)
	Gets or sets the x-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
int	OrgY (self)
	Gets or sets the y-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
	OrgY (self, int value)
	Gets or sets the y-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
int	Width (self)
	If eVision.EBaseROI is a ROI, gets or sets the width of the ROI.
	Width (self, int value)
	If eVision.EBaseROI is a ROI, gets or sets the width of the ROI.
int	Height (self)
	If eVision.EBaseROI is a ROI, gets or sets the height of the ROI.
	Height (self, int value)
	If eVision.EBaseROI is a ROI, gets or sets the height of the ROI.
int	TotalOrgX (self)
	Gets the x-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.
int	TotalOrgY (self)
	Gets the y-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.
int	TotalWidth (self)
	Gets the width, in pixels, of the ROI topmost parent.
int	TotalHeight (self)
	Gets the height, in pixels, of the ROI topmost parent.
int	PlanesPerPixel (self)
	Gets the number of color components in each pixel of the ROI/image.
eVision.EColorSystem	ColorSystem (self)
	Gets or sets the color system used by this image, as defined by the eVision.EColorSystem enumeration.
	ColorSystem (self, eVision.EColorSystem value)
	Gets or sets the color system used by this image, as defined by the eVision.EColorSystem enumeration.
eVision.EImageType	Type (self)
	Gets the ROI/image pixel type, as defined by the eVision.EImageType enumeration.
str	Author (self)
	Gets or sets the Author attribute of the ROI/image.
	Author (self, str value)
	Gets or sets the Author attribute of the ROI/image.
str	Comment (self)
	Gets or sets the Comment attribute of the ROI/image.
	Comment (self, str value)
	Gets or sets the Comment attribute of the ROI/image.
str	Date (self)
	Gets or sets the Date attribute of the ROI/image.
	Date (self, str value)
	Gets or sets the Date attribute of the ROI/image.
str	Title (self)
	Gets or sets the Title attribute of the ROI/image.
	Title (self, str value)
	Gets or sets the Title attribute of the ROI/image.

Detailed Description

This represents the abstract base class for all ROI and image classes.

Remarks:

License(s): BasicTypes

Member Function Documentation

◆ Attach() [1/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent ROI or image on which to attach the ROI.

◆ Attach() [2/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		eVision.ERegion	region )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
region	Region whose bounding box defines the position and size of the ROI after attachment.

◆ Attach() [3/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		eVision.ERegion	region,
		eVision.EFrame	frame )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
region	Region whose bounding box defines the position and size of the ROI after attachment.
frame	Frame used to transform the region from local to sensor coordinates before computing the bounding box.

◆ Attach() [4/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		eVision.ERegion	region,
		eVision.EFrame	frame,
		int	paddingTop )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
region	Region whose bounding box defines the position and size of the ROI after attachment.
frame	Frame used to transform the region from local to sensor coordinates before computing the bounding box.
paddingTop	Number of pixels added above the bounding box.

◆ Attach() [5/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		eVision.ERegion	region,
		eVision.EFrame	frame,
		int	paddingTop,
		int	paddingBottom )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
region	Region whose bounding box defines the position and size of the ROI after attachment.
frame	Frame used to transform the region from local to sensor coordinates before computing the bounding box.
paddingTop	Number of pixels added above the bounding box.
paddingBottom	Number of pixels added below the bounding box.

◆ Attach() [6/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		eVision.ERegion	region,
		eVision.EFrame	frame,
		int	paddingTop,
		int	paddingBottom,
		int	paddingLeft )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
region	Region whose bounding box defines the position and size of the ROI after attachment.
frame	Frame used to transform the region from local to sensor coordinates before computing the bounding box.
paddingTop	Number of pixels added above the bounding box.
paddingBottom	Number of pixels added below the bounding box.
paddingLeft	Number of pixels added to the left of the bounding box.

◆ Attach() [7/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		eVision.ERegion	region,
		eVision.EFrame	frame,
		int	paddingTop,
		int	paddingBottom,
		int	paddingLeft,
		int	paddingRight )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
region	Region whose bounding box defines the position and size of the ROI after attachment.
frame	Frame used to transform the region from local to sensor coordinates before computing the bounding box.
paddingTop	Number of pixels added above the bounding box.
paddingBottom	Number of pixels added below the bounding box.
paddingLeft	Number of pixels added to the left of the bounding box.
paddingRight	Number of pixels added to the right of the bounding box.

◆ Attach() [8/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		eVision.ERegion	region,
		int	paddingTop )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
region	Region whose bounding box defines the position and size of the ROI after attachment.
paddingTop	Number of pixels added above the bounding box.

◆ Attach() [9/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		eVision.ERegion	region,
		int	paddingTop,
		int	paddingBottom )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
region	Region whose bounding box defines the position and size of the ROI after attachment.
paddingTop	Number of pixels added above the bounding box.
paddingBottom	Number of pixels added below the bounding box.

◆ Attach() [10/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		eVision.ERegion	region,
		int	paddingTop,
		int	paddingBottom,
		int	paddingLeft )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
region	Region whose bounding box defines the position and size of the ROI after attachment.
paddingTop	Number of pixels added above the bounding box.
paddingBottom	Number of pixels added below the bounding box.
paddingLeft	Number of pixels added to the left of the bounding box.

◆ Attach() [11/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		eVision.ERegion	region,
		int	paddingTop,
		int	paddingBottom,
		int	paddingLeft,
		int	paddingRight )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
region	Region whose bounding box defines the position and size of the ROI after attachment.
paddingTop	Number of pixels added above the bounding box.
paddingBottom	Number of pixels added below the bounding box.
paddingLeft	Number of pixels added to the left of the bounding box.
paddingRight	Number of pixels added to the right of the bounding box.

◆ Attach() [12/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		int	orgX,
		int	orgY )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
orgX	When specified, sets the new x-coordinate of the ROI top-left corner.
orgY	When specified, sets the new y-coordinate of the ROI top-left corner.

◆ Attach() [13/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		int	orgX,
		int	orgY,
		int	width )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
orgX	When specified, sets the new x-coordinate of the ROI top-left corner.
orgY	When specified, sets the new y-coordinate of the ROI top-left corner.
width	When specified, sets the new width of the ROI.

◆ Attach() [14/14]

None eVision.EBaseROI.Attach	(		self,
		eVision.EBaseROI \| None	parent,
		int	orgX,
		int	orgY,
		int	width,
		int	height )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters

parent	ROI or image on which to attach the ROI.
orgX	When specified, sets the new x-coordinate of the ROI top-left corner.
orgY	When specified, sets the new y-coordinate of the ROI top-left corner.
width	When specified, sets the new width of the ROI.
height	When specified, sets the new height of the ROI.

◆ Author() [1/2]

str eVision.EBaseROI.Author ( self )

Gets or sets the Author attribute of the ROI/image.

This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ Author() [2/2]

eVision.EBaseROI.Author	(		self,
		str	value )

Gets or sets the Author attribute of the ROI/image.

This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ BaseImage()

eVision.EBaseROI | None eVision.EBaseROI.BaseImage ( self )

Returns the image associated with this ROI, or NULL if there is no image associated.

◆ BaseTopParent()

eVision.EBaseROI | None eVision.EBaseROI.BaseTopParent ( self )

Returns the image at the top of the hierarchy, or NULL if there is no image on top.

Deprecated

Use eVision.EBaseROI.BaseImage instead.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ BitsPerPixel()

int eVision.EBaseROI.BitsPerPixel ( self )

Gets the number of storage bits per pixel.

◆ ColorSystem() [1/2]

eVision.EColorSystem eVision.EBaseROI.ColorSystem ( self )

Gets or sets the color system used by this image, as defined by the eVision.EColorSystem enumeration.

Remarks:

Upon object creation, a default color system is set, compatible with the ROI/image type (eVision.EColorSystem.GrayLevel for gray-level types and eVision.EColorSystem.Rgb for color types).

The color system associated to an image is mainly relevant when working on color images. See eVision.EasyColor (FG) for more information.

◆ ColorSystem() [2/2]

eVision.EBaseROI.ColorSystem	(		self,
		eVision.EColorSystem	value )

Gets or sets the color system used by this image, as defined by the eVision.EColorSystem enumeration.

Remarks:

Upon object creation, a default color system is set, compatible with the ROI/image type (eVision.EColorSystem.GrayLevel for gray-level types and eVision.EColorSystem.Rgb for color types).

The color system associated to an image is mainly relevant when working on color images. See eVision.EasyColor (FG) for more information.

◆ ColPitch()

int eVision.EBaseROI.ColPitch ( self )

Gets the pitch of a column (number of bytes between two horizontally adjacent pixels).

For BW1 (one bit per pixel) images, this value is undefined.

◆ Comment() [1/2]

str eVision.EBaseROI.Comment ( self )

Gets or sets the Comment attribute of the ROI/image.

This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ Comment() [2/2]

eVision.EBaseROI.Comment	(		self,
		str	value )

Gets or sets the Comment attribute of the ROI/image.

This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ CopyTo()

None eVision.EBaseROI.CopyTo	(		self,
		eVision.EBaseROI	dest )

Copies all the data of the current eVision.EBaseROI object into another eVision.EBaseROI object and returns it.

Remarks:

This method copies all the object date to the destination object. The attached ROIs are copied recursively and attached to the destination object. They will be deleted automatically when the destination object is deleted.

When the buffer of the source image has been provided by a call to UseExternalBuffer, the pointer will be copied into the destination image. Both images will thus refer the same external buffer.

Parameters

dest	An eVision.EBaseROI object in which the current eVision.EBaseROI object data have to be copied.

◆ CropToImage()

None eVision.EBaseROI.CropToImage ( self )

This method reduces the ROI size so that it is completely contained within its topmost parent image bounds (if such an image exists at the top of the hierarchy).

This means that, after calling this method, either the ROI has a zero size, or all of its pixels map to valid pixels of the underlying image buffer. If the ROI is already contained within its parent image bounds, then this method does nothing.

◆ Date() [1/2]

str eVision.EBaseROI.Date ( self )

Gets or sets the Date attribute of the ROI/image.

This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ Date() [2/2]

eVision.EBaseROI.Date	(		self,
		str	value )

Gets or sets the Date attribute of the ROI/image.

This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ Detach()

None eVision.EBaseROI.Detach ( self )

◆ Drag() [1/5]

None eVision.EBaseROI.Drag	(		self,
		eVision.EDragHandle	dragHandle,
		int	x,
		int	y )

Moves the specified handle to a new position and updates all placement parameters of the ROI.

Remarks:

If zooming and/or panning were used when drawing the ROI, the same values must be used with eVision.EBaseROI.HitTest and eVision.EBaseROI.Drag.

Parameters

dragHandle	Handle identifier, as defined by eVision.EDragHandle. The value returned by eVision.EBaseROI.HitTest should be used.
x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.

◆ Drag() [2/5]

None eVision.EBaseROI.Drag	(		self,
		eVision.EDragHandle	dragHandle,
		int	x,
		int	y,
		float	zoomX )

Moves the specified handle to a new position and updates all placement parameters of the ROI.

Remarks:

If zooming and/or panning were used when drawing the ROI, the same values must be used with eVision.EBaseROI.HitTest and eVision.EBaseROI.Drag.

Parameters

dragHandle	Handle identifier, as defined by eVision.EDragHandle. The value returned by eVision.EBaseROI.HitTest should be used.
x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.

◆ Drag() [3/5]

None eVision.EBaseROI.Drag	(		self,
		eVision.EDragHandle	dragHandle,
		int	x,
		int	y,
		float	zoomX,
		float	zoomY )

Moves the specified handle to a new position and updates all placement parameters of the ROI.

Remarks:

If zooming and/or panning were used when drawing the ROI, the same values must be used with eVision.EBaseROI.HitTest and eVision.EBaseROI.Drag.

Parameters

dragHandle	Handle identifier, as defined by eVision.EDragHandle. The value returned by eVision.EBaseROI.HitTest should be used.
x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

◆ Drag() [4/5]

None eVision.EBaseROI.Drag	(		self,
		eVision.EDragHandle	dragHandle,
		int	x,
		int	y,
		float	zoomX,
		float	zoomY,
		float	panX )

Moves the specified handle to a new position and updates all placement parameters of the ROI.

Remarks:

If zooming and/or panning were used when drawing the ROI, the same values must be used with eVision.EBaseROI.HitTest and eVision.EBaseROI.Drag.

Parameters

dragHandle	Handle identifier, as defined by eVision.EDragHandle. The value returned by eVision.EBaseROI.HitTest should be used.
x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

◆ Drag() [5/5]

None eVision.EBaseROI.Drag	(		self,
		eVision.EDragHandle	dragHandle,
		int	x,
		int	y,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Moves the specified handle to a new position and updates all placement parameters of the ROI.

Remarks:

If zooming and/or panning were used when drawing the ROI, the same values must be used with eVision.EBaseROI.HitTest and eVision.EBaseROI.Drag.

Parameters

dragHandle	Handle identifier, as defined by eVision.EDragHandle. The value returned by eVision.EBaseROI.HitTest should be used.
x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [1/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext Handle to the device context of the destination window.

◆ Draw() [2/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EBW8Vector \| None	bw8Vector )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
bw8Vector	When supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.

◆ Draw() [3/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EBW8Vector \| None	bw8Vector,
		float	zoomX )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
bw8Vector	When supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

◆ Draw() [4/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EBW8Vector \| None	bw8Vector,
		float	zoomX,
		float	zoomY )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
bw8Vector	When supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

◆ Draw() [5/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EBW8Vector \| None	bw8Vector,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
bw8Vector	When supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [6/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EBW8Vector \| None	bw8Vector,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
bw8Vector	When supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [7/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EC24Vector \| None	c24Vector )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
c24Vector	When supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).

◆ Draw() [8/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EC24Vector \| None	c24Vector,
		float	zoomX )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
c24Vector	When supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

◆ Draw() [9/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EC24Vector \| None	c24Vector,
		float	zoomX,
		float	zoomY )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
c24Vector	When supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

◆ Draw() [10/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EC24Vector \| None	c24Vector,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
c24Vector	When supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [11/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EC24Vector \| None	c24Vector,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
c24Vector	When supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [12/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		float	zoomX )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

◆ Draw() [13/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		float	zoomX,
		float	zoomY )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

◆ Draw() [14/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [15/15]

None eVision.EBaseROI.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws an ROI/image in a device context.

Remarks:

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

◆ DrawFrame() [1/10]

None eVision.EBaseROI.DrawFrame	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		bool	handles )

Draws a rectangular frame around an image or ROI.

Remarks:

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
handles	true if handles are to be drawn.

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ DrawFrame() [2/10]

None eVision.EBaseROI.DrawFrame	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		bool	handles,
		float	zoomX )

Draws a rectangular frame around an image or ROI.

Remarks:

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
handles	true if handles are to be drawn.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ DrawFrame() [3/10]

None eVision.EBaseROI.DrawFrame	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		bool	handles,
		float	zoomX,
		float	zoomY )

Draws a rectangular frame around an image or ROI.

Remarks:

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
handles	true if handles are to be drawn.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ DrawFrame() [4/10]

None eVision.EBaseROI.DrawFrame	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws a rectangular frame around an image or ROI.

Remarks:

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
handles	true if handles are to be drawn.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ DrawFrame() [5/10]

None eVision.EBaseROI.DrawFrame	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws a rectangular frame around an image or ROI.

Remarks:

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
handles	true if handles are to be drawn.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ DrawFrame() [6/10]

None eVision.EBaseROI.DrawFrame	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EFramePosition	framePosition,
		bool	handles )

Draws a rectangular frame around an image or ROI.

Remarks:

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
framePosition	Positioning of the frame relative to the ROI.
handles	true if handles are to be drawn.

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ DrawFrame() [7/10]

None eVision.EBaseROI.DrawFrame	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EFramePosition	framePosition,
		bool	handles,
		float	zoomX )

Draws a rectangular frame around an image or ROI.

Remarks:

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
framePosition	Positioning of the frame relative to the ROI.
handles	true if handles are to be drawn.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ DrawFrame() [8/10]

None eVision.EBaseROI.DrawFrame	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EFramePosition	framePosition,
		bool	handles,
		float	zoomX,
		float	zoomY )

Draws a rectangular frame around an image or ROI.

Remarks:

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
framePosition	Positioning of the frame relative to the ROI.
handles	true if handles are to be drawn.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ DrawFrame() [9/10]

None eVision.EBaseROI.DrawFrame	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EFramePosition	framePosition,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws a rectangular frame around an image or ROI.

Remarks:

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
framePosition	Positioning of the frame relative to the ROI.
handles	true if handles are to be drawn.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ DrawFrame() [10/10]

None eVision.EBaseROI.DrawFrame	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EFramePosition	framePosition,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws a rectangular frame around an image or ROI.

Remarks:

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Parameters

graphicContext	Handle to the device context of the destination window.
framePosition	Positioning of the frame relative to the ROI.
handles	true if handles are to be drawn.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ FirstSubROI()

eVision.EBaseROI | None eVision.EBaseROI.FirstSubROI ( self )

See GetFirstSubROI in the derived classes.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

Reimplemented in eVision.EROIBW16, eVision.EROIBW32, eVision.EROIBW32f, eVision.EROIBW8, eVision.EROIC24, eVision.EROIC24A, and eVision.EROIC48.

◆ GetImagePtr() [1/2]

ctypes.c_void_p eVision.EBaseROI.GetImagePtr ( self )

Returns a pointer to the pixel at given coordinates within the image/ROI.

Remarks:

This method returns the memory address of the byte that contains the pixel (or address that contains the first byte of the pixel if it is bigger than one byte).

If the pixel coordinates are not specified, the method returns the address of the top-left pixel of the ROI/image.

◆ GetImagePtr() [2/2]

ctypes.c_void_p eVision.EBaseROI.GetImagePtr	(		self,
		int	x,
		int	y )

Returns a pointer to the pixel at given coordinates within the image/ROI.

Remarks:

This method returns the memory address of the byte that contains the pixel (or address that contains the first byte of the pixel if it is bigger than one byte).

If the pixel coordinates are not specified, the method returns the address of the top-left pixel of the ROI/image.

Parameters

x	The pixel x-coordinate.
y	The pixel y-coordinate.

◆ GetNextROI()

eVision.EBaseROI \| None eVision.EBaseROI.GetNextROI	(		self,
		eVision.EBaseROI \| None	startROI )

Returns the next ROI in the list starting at startROI or null if there is no next ROI.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

Reimplemented in eVision.EROIBW16, eVision.EROIBW32, eVision.EROIBW32f, eVision.EROIBW8, eVision.EROIC24, eVision.EROIC24A, and eVision.EROIC48.

◆ GetNextSiblingSubROI()

eVision.EBaseROI \| None eVision.EBaseROI.GetNextSiblingSubROI	(		self,
		eVision.EBaseROI \| None	subROI )

This method returns the ROI that is the next sibling of the supplied ROI in the list of sub-ROIs.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ GetSubBaseROIs() [1/2]

list[eVision._eVision.EBaseROI | None] eVision.EBaseROI.GetSubBaseROIs ( self )

Returns all the children, and possibly recursively all their children, too.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ GetSubBaseROIs() [2/2]

list[eVision._eVision.EBaseROI \| None] eVision.EBaseROI.GetSubBaseROIs	(		self,
		bool	recursive )

Returns all the children, and possibly recursively all their children, too.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

Parameters

recursive true to retrieve all sub-ROIs recursively. false otherwise.

◆ HasSubROI()

bool eVision.EBaseROI.HasSubROI	(		self,
		eVision.EBaseROI \| None	subROI )

Tests whether this object has a given attached ROI.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

Parameters

subROI Sub ROI to find.

◆ Height() [1/2]

int eVision.EBaseROI.Height ( self )

If eVision.EBaseROI is a ROI, gets or sets the height of the ROI.

Otherwise, if eVision.EBaseROI is an image, gets or sets the height of the image (SetHeight has the same effect as eVision.EBaseROI.SetSize).

Remarks:

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ Height() [2/2]

eVision.EBaseROI.Height	(		self,
		int	value )

If eVision.EBaseROI is a ROI, gets or sets the height of the ROI.

Otherwise, if eVision.EBaseROI is an image, gets or sets the height of the image (SetHeight has the same effect as eVision.EBaseROI.SetSize).

Remarks:

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ HitTest() [1/5]

eVision.EDragHandle eVision.EBaseROI.HitTest	(		self,
		int	x,
		int	y )

Detects if the cursor is placed over one of the dragging handles.

Remarks:

Returns a handle identifier, as defined by eVision.EDragHandle. If zooming and/or panning were used when drawing the ROI, the same values must be used with eVision.EBaseROI.HitTest and eVision.EBaseROI.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.

◆ HitTest() [2/5]

eVision.EDragHandle eVision.EBaseROI.HitTest	(		self,
		int	x,
		int	y,
		float	zoomX )

Detects if the cursor is placed over one of the dragging handles.

Remarks:

Returns a handle identifier, as defined by eVision.EDragHandle. If zooming and/or panning were used when drawing the ROI, the same values must be used with eVision.EBaseROI.HitTest and eVision.EBaseROI.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.

◆ HitTest() [3/5]

eVision.EDragHandle eVision.EBaseROI.HitTest	(		self,
		int	x,
		int	y,
		float	zoomX,
		float	zoomY )

Detects if the cursor is placed over one of the dragging handles.

Remarks:

Returns a handle identifier, as defined by eVision.EDragHandle. If zooming and/or panning were used when drawing the ROI, the same values must be used with eVision.EBaseROI.HitTest and eVision.EBaseROI.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

◆ HitTest() [4/5]

eVision.EDragHandle eVision.EBaseROI.HitTest	(		self,
		int	x,
		int	y,
		float	zoomX,
		float	zoomY,
		float	panX )

Detects if the cursor is placed over one of the dragging handles.

Remarks:

Returns a handle identifier, as defined by eVision.EDragHandle. If zooming and/or panning were used when drawing the ROI, the same values must be used with eVision.EBaseROI.HitTest and eVision.EBaseROI.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

◆ HitTest() [5/5]

eVision.EDragHandle eVision.EBaseROI.HitTest	(		self,
		int	x,
		int	y,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Detects if the cursor is placed over one of the dragging handles.

Remarks:

Returns a handle identifier, as defined by eVision.EDragHandle. If zooming and/or panning were used when drawing the ROI, the same values must be used with eVision.EBaseROI.HitTest and eVision.EBaseROI.Drag.

Parameters

x	x-coordinate of the mouse cursor.
y	y-coordinate of the mouse cursor.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

◆ IsAnROI()

bool eVision.EBaseROI.IsAnROI ( self )

Tests whether this object is an ROI or an image.

◆ IsAttached()

bool eVision.EBaseROI.IsAttached ( self )

Returns true if the ROI is attached to an image.

◆ IsPixelInside()

bool eVision.EBaseROI.IsPixelInside	(		self,
		int	x,
		int	y )

Detects if a pixel (given its x and y coordinates) is inside current ROI.

Remarks:

For more information about image coordinate systems, please check eVision conventions.

Parameters

x	x-coordinate of the pixel.
y	y-coordinate of the pixel.

◆ IsPointInside()

bool eVision.EBaseROI.IsPointInside	(		self,
		eVision.EPoint	position )

Detects if the position is inside current ROI.

Remarks:

For more information about image coordinate systems, please check eVision conventions.

Parameters

position Position to be tested.

◆ IsVoid()

bool eVision.EBaseROI.IsVoid ( self )

Tests if the topmost parent image of this hierarchy has a zero size.

Remarks:

For an image, this method returns true if the image size is zero.

For an ROI, this method returns true if the topmost parent image size is zero or if there is no topmost image.

◆ Load() [1/2]

None eVision.EBaseROI.Load	(		self,
		eVision.ESerializer \| None	serializer )

Restores an image stored in the given file.

Remarks:

When loading, an image is resized if need be. On the opposite, an ROI cannot be resized, and the sizes must match. The image contents around the ROI remains unchanged. If a serializer is used, then the Euresys proprietary file format is expected. This format preserves attributes and sub-ROIs. See Supported Image File Types for details about supported files. See Image File Access - Save, Load - for details about file format and compatibility. When loading a color image file into a gray-level image, the conversion equation will depend on the current eVision.ERgbStandard set.

Parameters

serializer The eVision.ESerializer file-like object that is read from.

Reimplemented in eVision.EROIBW32f, and eVision.EROIBW32f.

◆ Load() [2/2]

None eVision.EBaseROI.Load	(		self,
		str	path )

Restores an image stored in the given file.

Remarks:

When loading, an image is resized if need be. On the opposite, an ROI cannot be resized, and the sizes must match. The image contents around the ROI remains unchanged. If a serializer is used, then the Euresys proprietary file format is expected. This format preserves attributes and sub-ROIs. See Supported Image File Types for details about supported files. See Image File Access - Save, Load - for details about file format and compatibility. When loading a color image file into a gray-level image, the conversion equation will depend on the current eVision.ERgbStandard set.

Parameters

path	Full path of the file.

Reimplemented in eVision.EROIBW32f, and eVision.EROIBW32f.

◆ NextSiblingROI()

eVision.EBaseROI | None eVision.EBaseROI.NextSiblingROI ( self )

This method returns the ROI that is the next sibling of this ROI.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

Reimplemented in eVision.EROIBW16, eVision.EROIBW32, eVision.EROIBW32f, eVision.EROIBW8, eVision.EROIC24, eVision.EROIC24A, and eVision.EROIC48.

◆ OrgX() [1/2]

int eVision.EBaseROI.OrgX ( self )

Gets or sets the x-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.

Remarks:

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ OrgX() [2/2]

eVision.EBaseROI.OrgX	(		self,
		int	value )

Gets or sets the x-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.

Remarks:

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ OrgY() [1/2]

int eVision.EBaseROI.OrgY ( self )

Gets or sets the y-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.

Remarks:

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ OrgY() [2/2]

eVision.EBaseROI.OrgY	(		self,
		int	value )

Gets or sets the y-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.

Remarks:

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ Parent()

eVision.EBaseROI | None eVision.EBaseROI.Parent ( self )

Returns the hierarchical parent of this object.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of ROI and Image classes.

To test if an ROI is attached or not you can also use eVision.EBaseROI.IsAttached.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

Reimplemented in eVision.EROIBW16, eVision.EROIBW32, eVision.EROIBW32f, eVision.EROIBW8, eVision.EROIC24, eVision.EROIC24A, and eVision.EROIC48.

◆ PlanesPerPixel()

int eVision.EBaseROI.PlanesPerPixel ( self )

Gets the number of color components in each pixel of the ROI/image.

◆ RowPitch()

int eVision.EBaseROI.RowPitch ( self )

Gets the pitch of a row (the number of bytes between two vertically adjacent pixels).

This is also valid for BW1 images (one bit per pixel).

◆ Save() [1/3]

None eVision.EBaseROI.Save	(		self,
		eVision.ESerializer \| None	serializer )

Saves the eVision.EBaseROI object to the given file.

Remarks:

By default, (if no format is specified), the file format is determined from the file extension. If a serializer is used, then the Euresys proprietary file format is used. This format preserves attributes and sub-ROIs. See Supported Image File Types for details about supported files. See Image File Access - Save, Load - for details about file format and compatibility.

Parameters

serializer The eVision.ESerializer file-like object that is written to.

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ Save() [2/3]

None eVision.EBaseROI.Save	(		self,
		str	path )

Saves the eVision.EBaseROI object to the given file.

Remarks:

By default, (if no format is specified), the file format is determined from the file extension. If a serializer is used, then the Euresys proprietary file format is used. This format preserves attributes and sub-ROIs. See Supported Image File Types for details about supported files. See Image File Access - Save, Load - for details about file format and compatibility.

Parameters

path	The full path of the destination file.

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ Save() [3/3]

None eVision.EBaseROI.Save	(		self,
		str	path,
		eVision.EImageFileType	type )

Saves the eVision.EBaseROI object to the given file.

Remarks:

By default, (if no format is specified), the file format is determined from the file extension. If a serializer is used, then the Euresys proprietary file format is used. This format preserves attributes and sub-ROIs. See Supported Image File Types for details about supported files. See Image File Access - Save, Load - for details about file format and compatibility.

Parameters

path	The full path of the destination file.
type	File format, as defined by eVision.EImageFileType. If not specified, the file format is determined from the file extension.

Reimplemented in eVision.EROIBW32f, eVision.EROIBW32f, and eVision.EROIBW32f.

◆ SaveJpeg() [1/2]

None eVision.EBaseROI.SaveJpeg	(		self,
		str	path )

Saves the eVision.EBaseROI object to the given file, in JPEG format.

Remarks:

See Image File Access - Save, Load - for details about file format and quality.

Parameters

path	The full path of the destination file.

Reimplemented in eVision.EROIBW32f, and eVision.EROIBW32f.

◆ SaveJpeg() [2/2]

None eVision.EBaseROI.SaveJpeg	(		self,
		str	path,
		int	quality )

Saves the eVision.EBaseROI object to the given file, in JPEG format.

Remarks:

See Image File Access - Save, Load - for details about file format and quality.

Parameters

path	The full path of the destination file.
quality	JPEG quality, between 0 and 100 (100 is the best quality). The default value is 75.

Reimplemented in eVision.EROIBW32f, and eVision.EROIBW32f.

◆ SaveJpeg2K() [1/2]

None eVision.EBaseROI.SaveJpeg2K	(		self,
		str	path )

Saves the eVision.EBaseROI object to the given file, in JPEG 2000 format.

Remarks:

See Image File Access - Save, Load - for details about file format and quality.

Parameters

path	The full path of the destination file.

Reimplemented in eVision.EROIBW32f, and eVision.EROIBW32f.

◆ SaveJpeg2K() [2/2]

None eVision.EBaseROI.SaveJpeg2K	(		self,
		str	path,
		int	quality )

Saves the eVision.EBaseROI object to the given file, in JPEG 2000 format.

Remarks:

See Image File Access - Save, Load - for details about file format and quality.

Parameters

path	The full path of the destination file.
quality	JPEG 2000 quality, between 1 and 512. The default value is 16.

Reimplemented in eVision.EROIBW32f, and eVision.EROIBW32f.

◆ SavePng() [1/2]

None eVision.EBaseROI.SavePng	(		self,
		str	path )

Saves the eVision.EBaseROI object to the given file, in PNG format.

Remarks:

See Image File Access - Save, Load - for details about file format and quality.

Parameters

path	The full path of the destination file.

Reimplemented in eVision.EROIBW32f, and eVision.EROIBW32f.

◆ SavePng() [2/2]

None eVision.EBaseROI.SavePng	(		self,
		str	path,
		int	compression )

Saves the eVision.EBaseROI object to the given file, in PNG format.

Remarks:

See Image File Access - Save, Load - for details about file format and quality.

Parameters

path	The full path of the destination file.
compression	PNG compression, between 1 and 9 (1 is the fastest and 9 is the best compression). The default value is 1.

Reimplemented in eVision.EROIBW32f, and eVision.EROIBW32f.

◆ Serialize()

None eVision.EBaseROI.Serialize	(		self,
		eVision.ESerializer \| None	serializer )

Serializes the eVision.EBaseROI.

Reimplemented in eVision.EImageBW16, eVision.EImageBW32, eVision.EImageBW8, eVision.EImageC24, eVision.EImageC24A, eVision.EImageC48, eVision.EROIBW16, eVision.EROIBW32, eVision.EROIBW32f, eVision.EROIBW8, eVision.EROIC24, eVision.EROIC24A, and eVision.EROIC48.

◆ SetImagePtr() [1/2]

None eVision.EBaseROI.SetImagePtr	(		self,
		int	width,
		int	height,
		ctypes.c_void_p	imagePointer )

Sets the pointer to an externally allocated image buffer.

Remarks:

This call is only valid on an image. An ROI gets its buffer from its parent while an image normally allocates a pixel buffer automatically. The pointer to this buffer refers to the top left pixel of the image. The next pixels are stored contiguously, row by row, from top to bottom and from left to right.

Padding at the end of a row may be used, but it must lead to rows that are multiple of 4 bytes. This method overrides the internally allocated image buffer of the eVision.EBaseROI.

As long as the image accesses this buffer, it must not be deleted.

Deprecated

Use eVision.EBaseROI.UseExternalBuffer instead.

Deprecated in version 26.2. Scheduled to be removed in version 27.6.

Parameters

width	The width of the supplied buffer, in pixels.
height	The height of the supplied buffer, in pixels.
imagePointer	The pointer (aligned on 4 bytes) to the buffer, which must be large enough to hold the image.

◆ SetImagePtr() [2/2]

None eVision.EBaseROI.SetImagePtr	(		self,
		int	width,
		int	height,
		ctypes.c_void_p	imagePointer,
		int	bitsPerRow )

Sets the pointer to an externally allocated image buffer.

Remarks:

This call is only valid on an image. An ROI gets its buffer from its parent while an image normally allocates a pixel buffer automatically. The pointer to this buffer refers to the top left pixel of the image. The next pixels are stored contiguously, row by row, from top to bottom and from left to right.

Padding at the end of a row may be used, but it must lead to rows that are multiple of 4 bytes. This method overrides the internally allocated image buffer of the eVision.EBaseROI.

As long as the image accesses this buffer, it must not be deleted.

Deprecated

Use eVision.EBaseROI.UseExternalBuffer instead.

Deprecated in version 26.2. Scheduled to be removed in version 27.6.

Parameters

width	The width of the supplied buffer, in pixels.
height	The height of the supplied buffer, in pixels.
imagePointer	The pointer (aligned on 4 bytes) to the buffer, which must be large enough to hold the image.
bitsPerRow	The total number of bits contained in a row, padding included. Using the value 0 (default) means that this size is computed from the buffer width and the pixel size plus a padding with the smallest possible value that leads to a multiple of 4 bytes (32 bits), which is the minimum padding accepted by this method.

◆ SetPlacement() [1/11]

None eVision.EBaseROI.SetPlacement	(		self,
		eVision.ERegion	region )

Sets the placement of an ROI, relative to its parent ROI/image.

Remarks:

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Parameters

region Region whose bounding box defines the new position and size of the ROI.

◆ SetPlacement() [2/11]

None eVision.EBaseROI.SetPlacement	(		self,
		eVision.ERegion	region,
		eVision.EFrame	frame )

Sets the placement of an ROI, relative to its parent ROI/image.

Remarks:

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Parameters

region	Region whose bounding box defines the new position and size of the ROI.
frame	Frame used to define the input region.

◆ SetPlacement() [3/11]

None eVision.EBaseROI.SetPlacement	(		self,
		eVision.ERegion	region,
		eVision.EFrame	frame,
		int	paddingTop )

Sets the placement of an ROI, relative to its parent ROI/image.

Remarks:

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Parameters

region	Region whose bounding box defines the new position and size of the ROI.
frame	Frame used to define the input region.
paddingTop	Number of pixels added above (or removed from, if negative) the bounding box.

◆ SetPlacement() [4/11]

None eVision.EBaseROI.SetPlacement	(		self,
		eVision.ERegion	region,
		eVision.EFrame	frame,
		int	paddingTop,
		int	paddingBottom )

Sets the placement of an ROI, relative to its parent ROI/image.

Remarks:

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Parameters

region	Region whose bounding box defines the new position and size of the ROI.
frame	Frame used to define the input region.
paddingTop	Number of pixels added above (or removed from, if negative) the bounding box.
paddingBottom	Number of pixels added below (or removed from, if negative) the bounding box.

◆ SetPlacement() [5/11]

None eVision.EBaseROI.SetPlacement	(		self,
		eVision.ERegion	region,
		eVision.EFrame	frame,
		int	paddingTop,
		int	paddingBottom,
		int	paddingLeft )

Sets the placement of an ROI, relative to its parent ROI/image.

Remarks:

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Parameters

region	Region whose bounding box defines the new position and size of the ROI.
frame	Frame used to define the input region.
paddingTop	Number of pixels added above (or removed from, if negative) the bounding box.
paddingBottom	Number of pixels added below (or removed from, if negative) the bounding box.
paddingLeft	Number of pixels added to the left of (or removed from, if negative) the bounding box.

◆ SetPlacement() [6/11]

None eVision.EBaseROI.SetPlacement	(		self,
		eVision.ERegion	region,
		eVision.EFrame	frame,
		int	paddingTop,
		int	paddingBottom,
		int	paddingLeft,
		int	paddingRight )

Sets the placement of an ROI, relative to its parent ROI/image.

Remarks:

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Parameters

region	Region whose bounding box defines the new position and size of the ROI.
frame	Frame used to define the input region.
paddingTop	Number of pixels added above (or removed from, if negative) the bounding box.
paddingBottom	Number of pixels added below (or removed from, if negative) the bounding box.
paddingLeft	Number of pixels added to the left of (or removed from, if negative) the bounding box.
paddingRight	Number of pixels added to the right of (or removed from, if negative) the bounding box.

◆ SetPlacement() [7/11]

None eVision.EBaseROI.SetPlacement	(		self,
		eVision.ERegion	region,
		int	paddingTop )

Sets the placement of an ROI, relative to its parent ROI/image.

Remarks:

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Parameters

region	Region whose bounding box defines the new position and size of the ROI.
paddingTop	Number of pixels added above (or removed from, if negative) the bounding box.

◆ SetPlacement() [8/11]

None eVision.EBaseROI.SetPlacement	(		self,
		eVision.ERegion	region,
		int	paddingTop,
		int	paddingBottom )

Sets the placement of an ROI, relative to its parent ROI/image.

Remarks:

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Parameters

region	Region whose bounding box defines the new position and size of the ROI.
paddingTop	Number of pixels added above (or removed from, if negative) the bounding box.
paddingBottom	Number of pixels added below (or removed from, if negative) the bounding box.

◆ SetPlacement() [9/11]

None eVision.EBaseROI.SetPlacement	(		self,
		eVision.ERegion	region,
		int	paddingTop,
		int	paddingBottom,
		int	paddingLeft )

Sets the placement of an ROI, relative to its parent ROI/image.

Remarks:

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Parameters

region	Region whose bounding box defines the new position and size of the ROI.
paddingTop	Number of pixels added above (or removed from, if negative) the bounding box.
paddingBottom	Number of pixels added below (or removed from, if negative) the bounding box.
paddingLeft	Number of pixels added to the left of (or removed from, if negative) the bounding box.

◆ SetPlacement() [10/11]

None eVision.EBaseROI.SetPlacement	(		self,
		eVision.ERegion	region,
		int	paddingTop,
		int	paddingBottom,
		int	paddingLeft,
		int	paddingRight )

Sets the placement of an ROI, relative to its parent ROI/image.

Remarks:

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Parameters

region	Region whose bounding box defines the new position and size of the ROI.
paddingTop	Number of pixels added above (or removed from, if negative) the bounding box.
paddingBottom	Number of pixels added below (or removed from, if negative) the bounding box.
paddingLeft	Number of pixels added to the left of (or removed from, if negative) the bounding box.
paddingRight	Number of pixels added to the right of (or removed from, if negative) the bounding box.

◆ SetPlacement() [11/11]

None eVision.EBaseROI.SetPlacement	(		self,
		int	originX,
		int	originY,
		int	width,
		int	height )

Sets the placement of an ROI, relative to its parent ROI/image.

Remarks:

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Parameters

originX	New x-coordinate of the top-left pixel of this ROI.
originY	New y-coordinate of the top-left pixel of this ROI.
width	New ROI width.
height	New ROI height.

◆ SetSize() [1/2]

None eVision.EBaseROI.SetSize	(		self,
		eVision.EBaseROI \| None	other )

Sets the width and height of an ROI/image.

Remarks:

eVision will allocate a new image buffer (deallocate the old image buffer) if the supplied width and height are different from the existing ones. If an external buffer has been specified by means of UseExternalBuffer, it will be kept only if the size does not change. Creating a new eVision image buffer and setting its size creates a 4-byte aligned buffer, by default. The size of an image is specified as a number of columns (width) and rows (height). The maximum image dimensions are 2^30 by 2^30. Furthermore, it must fit into the available memory, that depends upon the physical memory, the operating system and the memory already allocated by the process in other modules or libraries. The placement of an ROI is given by the x and y coordinates of its upper left pixel relative to its parent image, and also by its width and its height.

Parameters

other The other ROI/image whose dimensions have to be used for the current object.

◆ SetSize() [2/2]

None eVision.EBaseROI.SetSize	(		self,
		int	width,
		int	height )

Sets the width and height of an ROI/image.

Remarks:

eVision will allocate a new image buffer (deallocate the old image buffer) if the supplied width and height are different from the existing ones. If an external buffer has been specified by means of UseExternalBuffer, it will be kept only if the size does not change. Creating a new eVision image buffer and setting its size creates a 4-byte aligned buffer, by default. The size of an image is specified as a number of columns (width) and rows (height). The maximum image dimensions are 2^30 by 2^30. Furthermore, it must fit into the available memory, that depends upon the physical memory, the operating system and the memory already allocated by the process in other modules or libraries. The placement of an ROI is given by the x and y coordinates of its upper left pixel relative to its parent image, and also by its width and its height.

Parameters

width	The new requested ROI/image width.
height	The new requested ROI/image height.

◆ Title() [1/2]

str eVision.EBaseROI.Title ( self )

Gets or sets the Title attribute of the ROI/image.

This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ Title() [2/2]

eVision.EBaseROI.Title	(		self,
		str	value )

Gets or sets the Title attribute of the ROI/image.

This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ TotalHeight()

int eVision.EBaseROI.TotalHeight ( self )

Gets the height, in pixels, of the ROI topmost parent.

Remarks:

The total size of an ROI is the size of its topmost parent.

◆ TotalOrgX()

int eVision.EBaseROI.TotalOrgX ( self )

Gets the x-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.

Remarks:

The total origin coordinates of an ROI indicate the position of its upper left pixel relative to the topmost parent image.

The total origin coordinates (top-left pixel) of a topmost parent are always (0,0).

◆ TotalOrgY()

int eVision.EBaseROI.TotalOrgY ( self )

Gets the y-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.

Remarks:

The total origin coordinates of an ROI indicate the position of its upper left pixel relative to the topmost parent.

The total origin coordinates (top-left pixel) of a topmost parent are always (0,0).

◆ TotalWidth()

int eVision.EBaseROI.TotalWidth ( self )

Gets the width, in pixels, of the ROI topmost parent.

Remarks:

The total size of an ROI is the size of its topmost parent.

◆ Type()

eVision.EImageType eVision.EBaseROI.Type ( self )

Gets the ROI/image pixel type, as defined by the eVision.EImageType enumeration.

◆ UseExternalBuffer()

None eVision.EBaseROI.UseExternalBuffer	(		self,
		int	width,
		int	height,
		ctypes.c_void_p	buffer,
		int	rowPitch )

Sets the pointer to an externally allocated image buffer.

Remarks:

This call is only valid on an image. An ROI gets its buffer from its parent while an image normally allocates a pixel buffer automatically. The pointer to this buffer refers to the top left pixel of the image. The next pixels are stored contiguously, row by row, from top to bottom and from left to right.

Padding at the end of a row may be used, but it must lead to rows that are multiple of 4 bytes. This method overrides the internally allocated image buffer of the eVision.EBaseROI.

As long as the image accesses this buffer, it must not be deleted.

Parameters

width	The width of the supplied buffer, in pixels.
height	The height of the supplied buffer, in pixels.
buffer	The pointer (aligned on 4 bytes) to the buffer, which must be large enough to hold the image.
rowPitch	The total number of bytes contained in a row, padding included.

◆ Width() [1/2]

int eVision.EBaseROI.Width ( self )

If eVision.EBaseROI is a ROI, gets or sets the width of the ROI.

Otherwise, if eVision.EBaseROI is an image, gets or sets the width of the image (SetWidth has the same effect as eVision.EBaseROI.SetSize).

Remarks:

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ Width() [2/2]

eVision.EBaseROI.Width	(		self,
		int	value )

If eVision.EBaseROI is a ROI, gets or sets the width of the ROI.

Otherwise, if eVision.EBaseROI is an image, gets or sets the width of the image (SetWidth has the same effect as eVision.EBaseROI.SetSize).

Remarks:

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

Public Member Functions

Detailed Description

Member Function Documentation

◆ Attach() [1/14]

◆ Attach() [2/14]

◆ Attach() [3/14]

◆ Attach() [4/14]

◆ Attach() [5/14]

◆ Attach() [6/14]

◆ Attach() [7/14]

◆ Attach() [8/14]

◆ Attach() [9/14]

◆ Attach() [10/14]

◆ Attach() [11/14]

◆ Attach() [12/14]

◆ Attach() [13/14]

◆ Attach() [14/14]

◆ Author() [1/2]

◆ Author() [2/2]

◆ BaseImage()

◆ BaseTopParent()

◆ BitsPerPixel()

◆ ColorSystem() [1/2]

◆ ColorSystem() [2/2]

◆ ColPitch()

◆ Comment() [1/2]

◆ Comment() [2/2]

◆ CopyTo()

◆ CropToImage()

◆ Date() [1/2]

◆ Date() [2/2]

◆ Detach()

◆ Drag() [1/5]

◆ Drag() [2/5]

◆ Drag() [3/5]

◆ Drag() [4/5]

◆ Drag() [5/5]

◆ Draw() [1/15]

◆ Draw() [2/15]

◆ Draw() [3/15]

◆ Draw() [4/15]

◆ Draw() [5/15]

◆ Draw() [6/15]

◆ Draw() [7/15]

◆ Draw() [8/15]

◆ Draw() [9/15]

◆ Draw() [10/15]

◆ Draw() [11/15]

◆ Draw() [12/15]

◆ Draw() [13/15]

◆ Draw() [14/15]

◆ Draw() [15/15]

◆ DrawFrame() [1/10]

◆ DrawFrame() [2/10]

◆ DrawFrame() [3/10]

◆ DrawFrame() [4/10]

◆ DrawFrame() [5/10]

◆ DrawFrame() [6/10]

◆ DrawFrame() [7/10]

◆ DrawFrame() [8/10]

◆ DrawFrame() [9/10]

◆ DrawFrame() [10/10]

◆ FirstSubROI()

◆ GetImagePtr() [1/2]

◆ GetImagePtr() [2/2]

◆ GetNextROI()

◆ GetNextSiblingSubROI()

◆ GetSubBaseROIs() [1/2]

◆ GetSubBaseROIs() [2/2]

◆ HasSubROI()

◆ Height() [1/2]

◆ Height() [2/2]

◆ HitTest() [1/5]

◆ HitTest() [2/5]

◆ HitTest() [3/5]

◆ HitTest() [4/5]

◆ HitTest() [5/5]

◆ IsAnROI()

◆ IsAttached()

◆ IsPixelInside()