The EROIBW8 class is used to represent rectangular regions of interest inside BW8 gray-level images. See ROIs. More...

Inheritance diagram for eVision.EROIBW8:

[legend]

Collaboration diagram for eVision.EROIBW8:

[legend]

Public Member Functions
	EROIBW8 ()
	Constructs the EROIBW8 object.
	EROIBW8 (eVision.EROIBW8 other)
void	SetPixel (eVision.EBW8 value, int x, int y)
	Allows writing a single pixel value in the ROI or image.
void	SetUncheckedPixel (eVision.EBW8 value, int x, int y)
override void	Serialize (eVision.ESerializer serializer)
new eVision.EROIBW8	GetNextROI (eVision.EBaseROI startROI)
	Returns the next ROI in the list starting at startROI or null if there is no next ROI.
eVision.EBW8	GetUncheckedPixel (int x, int y)
eVision.EBW8	GetPixel (int x, int y)
	Allows reading a single pixel value in the ROI or image.
Public Member Functions inherited from eVision.EBaseROI
bool	IsAttached ()
	Returns true if the ROI is attached to an image.
bool	IsAnROI ()
	Tests whether this object is an ROI or an image.
bool	HasSubROI (eVision.EBaseROI subROI)
	Tests whether this object has a given attached ROI.
eVision.EBaseROI	GetNextSiblingSubROI (eVision.EBaseROI subROI)
	This method returns the ROI that is the next sibling of the supplied ROI in the list of sub-ROIs.
eVision.EBaseROI	GetNextROI (eVision.EBaseROI startROI)
	Returns the next ROI in the list starting at startROI or null if there is no next ROI.
void	SetImagePtr (int width, int height, IntPtr imagePointer, int bitsPerRow)
	Sets the pointer to an externally allocated image buffer.
void	SetImagePtr (int width, int height, IntPtr imagePointer)
	Sets the pointer to an externally allocated image buffer.
void	UseExternalBuffer (int width, int height, IntPtr buffer, int rowPitch)
	Sets the pointer to an externally allocated image buffer.
IntPtr	GetImagePtr (int x, int y)
	Returns a pointer to the pixel at given coordinates within the image/ROI.
IntPtr	GetImagePtr ()
	Returns a pointer to the pixel at given coordinates within the image/ROI.
void	CropToImage ()
	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.
void	SetPlacement (int originX, int originY, int width, int height)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft, int paddingRight)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (eVision.ERegion region, int paddingTop, int paddingBottom)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (eVision.ERegion region, int paddingTop)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (eVision.ERegion region)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (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.
void	SetPlacement (eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom, int paddingLeft)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (eVision.ERegion region, eVision.EFrame frame, int paddingTop)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (eVision.ERegion region, eVision.EFrame frame)
	Sets the placement of an ROI, relative to its parent ROI/image.
eVision.EBaseROI[]	GetSubBaseROIs (bool recursive)
	Returns all the children, and possibly recursively all their children, too.
eVision.EBaseROI[]	GetSubBaseROIs ()
	Returns all the children, and possibly recursively all their children, too.
eVision.EDragHandle	HitTest (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 (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 (int x, int y, float zoomX, float zoomY)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EDragHandle	HitTest (int x, int y, float zoomX)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EDragHandle	HitTest (int x, int y)
	Detects if the cursor is placed over one of the dragging handles.
bool	IsPointInside (eVision.EPoint position)
	Detects if the position is inside current ROI.
bool	IsPixelInside (int x, int y)
	Detects if a pixel (given its x and y coordinates) is inside current ROI.
void	Drag (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.
void	Drag (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.
void	Drag (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.
void	Drag (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.
void	Drag (eVision.EDragHandle dragHandle, int x, int y)
	Moves the specified handle to a new position and updates all placement parameters of the ROI.
void	Serialize (eVision.ESerializer serializer)
	Serializes the EBaseROI.
void	Detach ()
void	Attach (eVision.EBaseROI parent)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI parent, int orgX, int orgY, int width, int height)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI parent, int orgX, int orgY, int width)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI parent, int orgX, int orgY)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI parent, eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft, int paddingRight)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI parent, eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI parent, eVision.ERegion region, int paddingTop, int paddingBottom)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI parent, eVision.ERegion region, int paddingTop)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI parent, eVision.ERegion region)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI 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.
void	Attach (eVision.EBaseROI parent, eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom, int paddingLeft)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI parent, eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI parent, eVision.ERegion region, eVision.EFrame frame, int paddingTop)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision.EBaseROI parent, eVision.ERegion region, eVision.EFrame frame)
	This method attaches the ROI to another ROI or image.
void	CopyTo (eVision.EBaseROI dest)
	Copies all the data of the current EBaseROI object into another EBaseROI object and returns it.
void	SetSize (int width, int height)
	Sets the width and height of an ROI/image.
void	SetSize (eVision.EBaseROI other)
	Sets the width and height of an ROI/image.
void	DrawFrame (eVision.EDrawAdapter graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision.EDrawAdapter graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision.EDrawAdapter graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision.EDrawAdapter graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision.EDrawAdapter graphicContext, eVision.EFramePosition framePosition, bool handles)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision.EDrawAdapter graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision.EDrawAdapter graphicContext, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision.EDrawAdapter graphicContext, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision.EDrawAdapter graphicContext, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision.EDrawAdapter graphicContext, bool handles)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, bool handles)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, eVision.ERGBColor color, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (IntPtr graphicContext, eVision.ERGBColor color, bool handles)
	Draws a rectangular frame around an image or ROI.
void	Draw (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, float zoomX)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EC24Vector c24Vector, float zoomX)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EC24Vector c24Vector)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EBW8Vector bw8Vector, float zoomX)
	Draws an ROI/image in a device context.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EBW8Vector bw8Vector)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, float zoomX)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, eVision.EC24Vector c24Vector, float zoomX)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, eVision.EC24Vector c24Vector)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, eVision.EBW8Vector bw8Vector, float zoomX)
	Draws an ROI/image in a device context.
void	Draw (IntPtr graphicContext, eVision.EBW8Vector bw8Vector)
	Draws an ROI/image in a device context.
void	DrawFrameWithCurrentPen (IntPtr graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (IntPtr graphicContext, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (IntPtr graphicContext, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (IntPtr graphicContext, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (IntPtr graphicContext, bool handles)
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles)
	Draws a rectangular frame around an image or ROI.
void	Load (string path)
	Restores an image stored in the given file.
void	Load (eVision.ESerializer serializer)
	Restores an image stored in the given file.
void	Save (string path, eVision.EImageFileType type)
	Saves the EBaseROI object to the given file.
void	Save (string path)
	Saves the EBaseROI object to the given file.
void	Save (eVision.ESerializer serializer)
	Saves the EBaseROI object to the given file.
void	SavePng (string path, int compression)
	Saves the EBaseROI object to the given file, in PNG format.
void	SavePng (string path)
	Saves the EBaseROI object to the given file, in PNG format.
void	SaveJpeg (string path, int quality)
	Saves the EBaseROI object to the given file, in JPEG format.
void	SaveJpeg (string path)
	Saves the EBaseROI object to the given file, in JPEG format.
void	SaveJpeg2K (string path, int quality)
	Saves the EBaseROI object to the given file, in JPEG 2000 format.
void	SaveJpeg2K (string path)
	Saves the EBaseROI object to the given file, in JPEG 2000 format.
void	DrawFrame (System.Drawing.Graphics graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, bool handles)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, eVision.EFramePosition framePosition, bool handles)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY, float panX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, bool handles, float zoomX)
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, bool handles)
	Draws a rectangular frame around an image or ROI.
void	Draw (System.Drawing.Graphics graphicContext, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, float zoomX)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EC24Vector c24Vector, float zoomX)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EC24Vector c24Vector)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX, float panY)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EBW8Vector bw8Vector, float zoomX)
	Draws an ROI/image in a device context.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EBW8Vector bw8Vector)
	Draws an ROI/image in a device context.

Properties
new eVision.EROIBW8	FirstSubROI `[get]`
	See GetFirstSubROI in the derived classes.
new eVision.EROIBW8	NextSiblingROI `[get]`
	This method returns the ROI that is the next sibling of this ROI.
new eVision.EROIBW8	Parent `[get]`
	Returns the hierarchical parent of this object.
eVision.EImageBW8	TopParent `[get]`
	Returns the top parent of this object.
eVision.EImageBW8	Image `[get]`
	Returns the image associated with this ROI, or NULL if there is no image associated.
Properties inherited from eVision.EBaseROI
eVision.EBaseROI	BaseTopParent `[get]`
	Returns the image at the top of the hierarchy, or NULL if there is no image on top.
eVision.EBaseROI	BaseImage `[get]`
	Returns the image associated with this ROI, or NULL if there is no image associated.
eVision.EBaseROI	Parent `[get]`
	Returns the hierarchical parent of this object.
eVision.EBaseROI	FirstSubROI `[get]`
	See GetFirstSubROI in the derived classes.
eVision.EBaseROI	NextSiblingROI `[get]`
	This method returns the ROI that is the next sibling of this ROI.
int	RowPitch `[get]`
	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).
int	ColPitch `[get]`
	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.
uint	BitsPerPixel `[get]`
	Gets the number of storage bits per pixel.
int	OrgX `[get, set]`
	Gets or sets the x-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
int	OrgY `[get, set]`
	Gets or sets the y-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
int	Width `[get, set]`
	If EBaseROI is a ROI, gets or sets the width of the ROI. Otherwise, if EBaseROI is an image, gets or sets the width of the image (SetWidth has the same effect as EBaseROI.SetSize).
int	Height `[get, set]`
	If EBaseROI is a ROI, gets or sets the height of the ROI. Otherwise, if EBaseROI is an image, gets or sets the height of the image (SetHeight has the same effect as EBaseROI.SetSize).
bool	IsVoid `[get]`
	Tests if the topmost parent image of this hierarchy has a zero size.
int	TotalOrgX `[get]`
	Gets the x-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.
int	TotalOrgY `[get]`
	Gets the y-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.
int	TotalWidth `[get]`
	Gets the width, in pixels, of the ROI topmost parent.
int	TotalHeight `[get]`
	Gets the height, in pixels, of the ROI topmost parent.
uint	PlanesPerPixel `[get]`
	Gets the number of color components in each pixel of the ROI/image.
eVision.EColorSystem	ColorSystem `[get, set]`
	Gets or sets the color system used by this image, as defined by the EColorSystem enumeration.
eVision.EImageType	Type `[get]`
	Gets the ROI/image pixel type, as defined by the EImageType enumeration.
string	Author `[get, set]`
	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.
string	Comment `[get, set]`
	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.
string	Date `[get, set]`
	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.
string	Title `[get, set]`
	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.

Detailed Description

The EROIBW8 class is used to represent rectangular regions of interest inside BW8 gray-level images. See ROIs.

License(s): BasicTypes

Constructor & Destructor Documentation

◆ EROIBW8() [1/2]

eVision.EROIBW8.EROIBW8 ( )

Constructs the EROIBW8 object.

◆ EROIBW8() [2/2]

eVision.EROIBW8.EROIBW8 ( eVision.EROIBW8 other )

Parameters

other The other EROIBW8 that we will copy into this one.

Member Function Documentation

◆ GetNextROI()

new eVision.EROIBW8 eVision.EROIBW8.GetNextROI ( eVision.EBaseROI startROI )

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

Parameters

startROI the first ROI in the list.

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.

◆ GetPixel()

eVision.EBW8 eVision.EROIBW8.GetPixel	(	int	x,
		int	y )

Allows reading a single pixel value in the ROI or image.

Parameters

x	Offset of the pixel on the x axis.
y	Offset of the pixel on the y axis.

Although coordinates outside the ROI can be supplied, this function will raise an error condition if the coordinates are outside the top parent image.

It should be noted that calling this function several thousand times can be slow. The recommended way to access pixel content in an image or ROI is to use the EBaseROI.GetImagePtr and EBaseROI.UseExternalBuffer functions. For BW8 images/ROIs, using the C++ API only, it is possible to access pixels data faster through an intermediate object: EBW8PixelAccessor.

◆ GetUncheckedPixel()

eVision.EBW8 eVision.EROIBW8.GetUncheckedPixel	(	int	x,
		int	y )

◆ Serialize()

override void eVision.EROIBW8.Serialize ( eVision.ESerializer serializer )

Deprecated

Use EBaseROI.Save or EBaseROI.Load instead.

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

◆ SetPixel()

void eVision.EROIBW8.SetPixel	(	eVision.EBW8	value,
		int	x,
		int	y )

Allows writing a single pixel value in the ROI or image.

Parameters

value	value to set the pixel to.
x	Offset of the pixel on the x axis.
y	Offset of the pixel on the y axis.

Although coordinates outside of the ROI can be supplied, this function will raise an error condition if the coordinates are outside of the top parent image.

It should be noted that calling this function several thousand times can be slow. The recommended way to access pixel content in an image or ROI is to use the EBaseROI.GetImagePtr and EBaseROI.UseExternalBuffer functions. For BW8 images/ROIs, using the C++ API only, it is possible to access pixels data faster through an intermediate object: EBW8PixelAccessor.

◆ SetUncheckedPixel()

void eVision.EROIBW8.SetUncheckedPixel	(	eVision.EBW8	value,
		int	x,
		int	y )

Property Documentation

◆ FirstSubROI

new eVision.EROIBW8 eVision.EROIBW8.FirstSubROI

get

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 ROI and Image classes.

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

◆ Image

eVision.EImageBW8 eVision.EROIBW8.Image

get

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

◆ NextSiblingROI

new eVision.EROIBW8 eVision.EROIBW8.NextSiblingROI

get

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 ROI and Image classes.

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

◆ Parent

new eVision.EROIBW8 eVision.EROIBW8.Parent

get

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.

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

◆ TopParent

eVision.EImageBW8 eVision.EROIBW8.TopParent

get

Returns the top parent of this object.

Deprecated

Use EROIBW8.Image instead.

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ EROIBW8() [1/2]

◆ EROIBW8() [2/2]

Member Function Documentation

◆ GetNextROI()

◆ GetPixel()

◆ GetUncheckedPixel()

◆ Serialize()

◆ SetPixel()

◆ SetUncheckedPixel()

Property Documentation

◆ FirstSubROI

◆ Image

◆ NextSiblingROI

◆ Parent

◆ TopParent