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

#include <eVision/Easy/EROIBW8.h>

Inheritance diagram for eVision::EROIBW8:

Collaboration diagram for eVision::EROIBW8:

Public Member Functions
	EROIBW8 ()
	Constructs the EROIBW8 object.
	EROIBW8 (const eVision::EROIBW8 &other)
virtual	~EROIBW8 () throw ()
eVision::EROIBW8 &	operator= (const eVision::EROIBW8 &other)
	Assignment operator.
void	SetPixel (eVision::EBW8 value, int32_t x, int32_t y)
	Allows writing a single pixel value in the ROI or image.
void	SetUncheckedPixel (eVision::EBW8 value, int32_t x, int32_t y)
eVision::EROIBW8 *	GetFirstSubROI ()
	See GetFirstSubROI in the derived classes.
virtual void	Serialize (eVision::ESerializer *serializer)
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::EROIBW8 *	GetNextSiblingROI ()
	This method returns the ROI that is the next sibling of this ROI.
eVision::EROIBW8 *	GetParent ()
	Returns the hierarchical parent of this object.
const eVision::EROIBW8 *	GetParent () const
	Returns the hierarchical parent of this object.
eVision::EBW8	GetUncheckedPixel (int32_t x, int32_t y) const
eVision::EBW8	GetPixel (int32_t x, int32_t y) const
	Allows reading a single pixel value in the ROI or image.
eVision::EImageBW8 *	GetTopParent ()
	Returns the top parent of this object.
const eVision::EImageBW8 *	GetTopParent () const
	Returns the top parent of this object.
eVision::EImageBW8 *	GetImage ()
	Returns the image associated with this ROI, or NULL if there is no image associated.
const eVision::EImageBW8 *	GetImage () const
	Returns the image associated with this ROI, or NULL if there is no image associated.
	EROIBW8 (CppWrapperInternal::InternalConstructor)
Public Member Functions inherited from eVision::EBaseROI
virtual	~EBaseROI () throw ()
eVision::EBaseROI *	GetBaseTopParent ()
	Returns the image at the top of the hierarchy, or NULL if there is no image on top.
const eVision::EBaseROI *	GetBaseTopParent () const
	Returns the image at the top of the hierarchy, or NULL if there is no image on top.
eVision::EBaseROI *	GetBaseImage ()
	Returns the image associated with this ROI, or NULL if there is no image associated.
const eVision::EBaseROI *	GetBaseImage () const
	Returns the image associated with this ROI, or NULL if there is no image associated.
eVision::EBaseROI *	GetParent ()
	Returns the hierarchical parent of this object.
const eVision::EBaseROI *	GetParent () const
	Returns the hierarchical parent of this object.
bool	IsAttached () const
	Returns true if the ROI is attached to an image.
bool	IsAnROI () const
	Tests whether this object is an ROI or an image.
bool	HasSubROI (const eVision::EBaseROI *subROI) const
	Tests whether this object has a given attached ROI.
eVision::EBaseROI *	GetFirstSubROI ()
	See GetFirstSubROI in the derived classes.
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.
eVision::EBaseROI *	GetNextSiblingROI ()
	This method returns the ROI that is the next sibling of this ROI.
int32_t	GetRowPitch () const
	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).
int32_t	GetColPitch () const
	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.
uint32_t	GetBitsPerPixel () const
	Gets the number of storage bits per pixel.
void	SetImagePtr (int32_t width, int32_t height, void *imagePointer, int32_t bitsPerRow)
	Sets the pointer to an externally allocated image buffer.
void	SetImagePtr (int32_t width, int32_t height, void *imagePointer)
	Sets the pointer to an externally allocated image buffer.
void	UseExternalBuffer (int32_t width, int32_t height, void *buffer, int32_t rowPitch)
	Sets the pointer to an externally allocated image buffer.
void *	GetImagePtr (int32_t x, int32_t y)
	Returns a pointer to the pixel at given coordinates within the image/ROI.
const void *	GetImagePtr (int32_t x, int32_t y) const
	Returns a pointer to the pixel at given coordinates within the image/ROI.
void *	GetImagePtr ()
	Returns a pointer to the pixel at given coordinates within the image/ROI.
const void *	GetImagePtr () const
	Returns a pointer to the pixel at given coordinates within the image/ROI.
int32_t	GetOrgX () const
	Gets or sets the x-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
void	SetOrgX (int32_t x)
	Gets or sets the x-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
int32_t	GetOrgY () const
	Gets or sets the y-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
void	SetOrgY (int32_t y)
	Gets or sets the y-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
int32_t	GetWidth () const
	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).
void	SetWidth (int32_t w)
	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).
int32_t	GetHeight () const
	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).
void	SetHeight (int32_t h)
	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).
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.
bool	IsVoid () const
	Tests if the topmost parent image of this hierarchy has a zero size.
void	SetPlacement (int32_t originX, int32_t originY, int32_t width, int32_t height)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (const eVision::ERegion &region, int32_t paddingTop, int32_t paddingBottom, int32_t paddingLeft, int32_t paddingRight)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (const eVision::ERegion &region, int32_t paddingTop, int32_t paddingBottom, int32_t paddingLeft)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (const eVision::ERegion &region, int32_t paddingTop, int32_t paddingBottom)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (const eVision::ERegion &region, int32_t paddingTop)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (const eVision::ERegion &region)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (const eVision::ERegion &region, const eVision::EFrame &frame, int32_t paddingTop, int32_t paddingBottom, int32_t paddingLeft, int32_t paddingRight)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (const eVision::ERegion &region, const eVision::EFrame &frame, int32_t paddingTop, int32_t paddingBottom, int32_t paddingLeft)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (const eVision::ERegion &region, const eVision::EFrame &frame, int32_t paddingTop, int32_t paddingBottom)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (const eVision::ERegion &region, const eVision::EFrame &frame, int32_t paddingTop)
	Sets the placement of an ROI, relative to its parent ROI/image.
void	SetPlacement (const eVision::ERegion &region, const eVision::EFrame &frame)
	Sets the placement of an ROI, relative to its parent ROI/image.
std::vector< eVision::EBaseROI * >	GetSubBaseROIs (bool recursive)
	Returns all the children, and possibly recursively all their children, too.
std::vector< eVision::EBaseROI * >	GetSubBaseROIs ()
	Returns all the children, and possibly recursively all their children, too.
std::vector< const eVision::EBaseROI * >	GetSubBaseROIs (bool recursive) const
	Returns all the children, and possibly recursively all their children, too.
std::vector< const eVision::EBaseROI * >	GetSubBaseROIs () const
	Returns all the children, and possibly recursively all their children, too.
eVision::EDragHandle	HitTest (int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY)
	Detects if the cursor is placed over one of the dragging handles.
eVision::EDragHandle	HitTest (int32_t x, int32_t y, float zoomX, float zoomY, float panX)
	Detects if the cursor is placed over one of the dragging handles.
eVision::EDragHandle	HitTest (int32_t x, int32_t y, float zoomX, float zoomY)
	Detects if the cursor is placed over one of the dragging handles.
eVision::EDragHandle	HitTest (int32_t x, int32_t y, float zoomX)
	Detects if the cursor is placed over one of the dragging handles.
eVision::EDragHandle	HitTest (int32_t x, int32_t y)
	Detects if the cursor is placed over one of the dragging handles.
bool	IsPointInside (const eVision::EPoint &position) const
	Detects if the position is inside current ROI.
bool	IsPixelInside (int32_t x, int32_t y) const
	Detects if a pixel (given its x and y coordinates) is inside current ROI.
int32_t	GetTotalOrgX () const
	Gets the x-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.
int32_t	GetTotalOrgY () const
	Gets the y-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.
int32_t	GetTotalWidth () const
	Gets the width, in pixels, of the ROI topmost parent.
int32_t	GetTotalHeight () const
	Gets the height, in pixels, of the ROI topmost parent.
void	Drag (eVision::EDragHandle dragHandle, int32_t x, int32_t 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, int32_t x, int32_t 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, int32_t x, int32_t 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, int32_t x, int32_t y, float zoomX)
	Moves the specified handle to a new position and updates all placement parameters of the ROI.
void	Drag (eVision::EDragHandle dragHandle, int32_t x, int32_t y)
	Moves the specified handle to a new position and updates all placement parameters of the ROI.
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, const eVision::ERegion &region, int32_t paddingTop, int32_t paddingBottom, int32_t paddingLeft, int32_t paddingRight)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision::EBaseROI *parent, const eVision::ERegion &region, int32_t paddingTop, int32_t paddingBottom, int32_t paddingLeft)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision::EBaseROI *parent, const eVision::ERegion &region, int32_t paddingTop, int32_t paddingBottom)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision::EBaseROI *parent, const eVision::ERegion &region, int32_t paddingTop)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision::EBaseROI *parent, const eVision::ERegion &region)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision::EBaseROI *parent, const eVision::ERegion &region, const eVision::EFrame &frame, int32_t paddingTop, int32_t paddingBottom, int32_t paddingLeft, int32_t paddingRight)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision::EBaseROI *parent, const eVision::ERegion &region, const eVision::EFrame &frame, int32_t paddingTop, int32_t paddingBottom, int32_t paddingLeft)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision::EBaseROI *parent, const eVision::ERegion &region, const eVision::EFrame &frame, int32_t paddingTop, int32_t paddingBottom)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision::EBaseROI *parent, const eVision::ERegion &region, const eVision::EFrame &frame, int32_t paddingTop)
	This method attaches the ROI to another ROI or image.
void	Attach (eVision::EBaseROI *parent, const eVision::ERegion &region, const eVision::EFrame &frame)
	This method attaches the ROI to another ROI or image.
void	CopyTo (eVision::EBaseROI &dest) const
	Copies all the data of the current EBaseROI object into another EBaseROI object and returns it.
void	CopyTo (eVision::EBaseROI *dest) const
	Copies all the data of the current EBaseROI object into another EBaseROI object and returns it.
uint32_t	GetPlanesPerPixel () const
	Gets the number of color components in each pixel of the ROI/image.
eVision::EColorSystem	GetColorSystem () const
	Gets or sets the color system used by this image, as defined by the EColorSystem enumeration.
void	SetColorSystem (eVision::EColorSystem colorSystem)
	Gets or sets the color system used by this image, as defined by the EColorSystem enumeration.
eVision::EImageType	GetType () const
	Gets the ROI/image pixel type, as defined by the EImageType enumeration.
void	SetSize (int32_t width, int32_t height)
	Sets the width and height of an ROI/image.
void	SetSize (const 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) const
	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) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision::EDrawAdapter *graphicContext, eVision::EFramePosition framePosition, bool handles, float zoomX, float zoomY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision::EDrawAdapter *graphicContext, eVision::EFramePosition framePosition, bool handles, float zoomX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision::EDrawAdapter *graphicContext, eVision::EFramePosition framePosition, bool handles) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision::EDrawAdapter *graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision::EDrawAdapter *graphicContext, bool handles, float zoomX, float zoomY, float panX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision::EDrawAdapter *graphicContext, bool handles, float zoomX, float zoomY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision::EDrawAdapter *graphicContext, bool handles, float zoomX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (eVision::EDrawAdapter *graphicContext, bool handles) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, bool handles, float zoomX, float zoomY, float panX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, bool handles, float zoomX, float zoomY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, bool handles, float zoomX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, bool handles) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, eVision::EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX, float panY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, eVision::EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, eVision::EFramePosition framePosition, bool handles, float zoomX, float zoomY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, eVision::EFramePosition framePosition, bool handles, float zoomX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, eVision::EFramePosition framePosition, bool handles) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, const eVision::ERGBColor &color, bool handles, float zoomX, float zoomY, float panX, float panY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, const eVision::ERGBColor &color, bool handles, float zoomX, float zoomY, float panX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, const eVision::ERGBColor &color, bool handles, float zoomX, float zoomY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, const eVision::ERGBColor &color, bool handles, float zoomX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrame (HDC graphicContext, const eVision::ERGBColor &color, bool handles) const
	Draws a rectangular frame around an image or ROI.
void	Draw (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY, float panX, float panY) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY, float panX) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter *graphicContext, float zoomX) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter *graphicContext) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter graphicContext, eVision::EC24Vector c24Vector, float zoomX, float zoomY, float panX, float panY) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter graphicContext, eVision::EC24Vector c24Vector, float zoomX, float zoomY, float panX) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter graphicContext, eVision::EC24Vector c24Vector, float zoomX, float zoomY) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter graphicContext, eVision::EC24Vector c24Vector, float zoomX) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter graphicContext, eVision::EC24Vector c24Vector) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter graphicContext, eVision::EBW8Vector bw8Vector, float zoomX, float zoomY, float panX, float panY) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter graphicContext, eVision::EBW8Vector bw8Vector, float zoomX, float zoomY, float panX) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter graphicContext, eVision::EBW8Vector bw8Vector, float zoomX, float zoomY) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter graphicContext, eVision::EBW8Vector bw8Vector, float zoomX) const
	Draws an ROI/image in a device context.
void	Draw (eVision::EDrawAdapter graphicContext, eVision::EBW8Vector bw8Vector) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, float zoomX, float zoomY, float panX, float panY) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, float zoomX, float zoomY, float panX) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, float zoomX, float zoomY) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, float zoomX) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, eVision::EC24Vector *c24Vector, float zoomX, float zoomY, float panX, float panY) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, eVision::EC24Vector *c24Vector, float zoomX, float zoomY, float panX) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, eVision::EC24Vector *c24Vector, float zoomX, float zoomY) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, eVision::EC24Vector *c24Vector, float zoomX) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, eVision::EC24Vector *c24Vector) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, eVision::EBW8Vector *bw8Vector, float zoomX, float zoomY, float panX, float panY) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, eVision::EBW8Vector *bw8Vector, float zoomX, float zoomY, float panX) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, eVision::EBW8Vector *bw8Vector, float zoomX, float zoomY) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, eVision::EBW8Vector *bw8Vector, float zoomX) const
	Draws an ROI/image in a device context.
void	Draw (HDC graphicContext, eVision::EBW8Vector *bw8Vector) const
	Draws an ROI/image in a device context.
void	DrawFrameWithCurrentPen (HDC graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (HDC graphicContext, bool handles, float zoomX, float zoomY, float panX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (HDC graphicContext, bool handles, float zoomX, float zoomY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (HDC graphicContext, bool handles, float zoomX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (HDC graphicContext, bool handles) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (HDC graphicContext, eVision::EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX, float panY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (HDC graphicContext, eVision::EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (HDC graphicContext, eVision::EFramePosition framePosition, bool handles, float zoomX, float zoomY) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (HDC graphicContext, eVision::EFramePosition framePosition, bool handles, float zoomX) const
	Draws a rectangular frame around an image or ROI.
void	DrawFrameWithCurrentPen (HDC graphicContext, eVision::EFramePosition framePosition, bool handles) const
	Draws a rectangular frame around an image or ROI.
void	Load (const std::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 (const std::string &path, eVision::EImageFileType type) const
	Saves the EBaseROI object to the given file.
void	Save (const std::string &path) const
	Saves the EBaseROI object to the given file.
void	Save (eVision::ESerializer *serializer) const
	Saves the EBaseROI object to the given file.
void	SavePng (const std::string &path, int compression) const
	Saves the EBaseROI object to the given file, in PNG format.
void	SavePng (const std::string &path) const
	Saves the EBaseROI object to the given file, in PNG format.
void	SaveJpeg (const std::string &path, int quality) const
	Saves the EBaseROI object to the given file, in JPEG format.
void	SaveJpeg (const std::string &path) const
	Saves the EBaseROI object to the given file, in JPEG format.
void	SaveJpeg2K (const std::string &path, int quality) const
	Saves the EBaseROI object to the given file, in JPEG 2000 format.
void	SaveJpeg2K (const std::string &path) const
	Saves the EBaseROI object to the given file, in JPEG 2000 format.
std::string	GetAuthor () const
	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.
void	SetAuthor (const std::string &author)
	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.
std::string	GetComment () const
	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.
void	SetComment (const std::string &comment)
	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.
std::string	GetDate () const
	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.
void	SetDate (const std::string &date)
	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.
std::string	GetTitle () const
	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.
void	SetTitle (const std::string &title)
	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.
	EBaseROI (CppWrapperInternal::InternalConstructor)

Additional Inherited Members
Public Attributes inherited from eVision::EBaseROI
CppWrapperInternal::WrappedClass	wrappedClass_

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/3]

eVision::EROIBW8::EROIBW8 ( )

Constructs the EROIBW8 object.

◆ EROIBW8() [2/3]

eVision::EROIBW8::EROIBW8 ( const eVision::EROIBW8 & other )

Parameters

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

◆ ~EROIBW8()

eVision::EROIBW8::~EROIBW8	(		)
throw	(	)

virtual

◆ EROIBW8() [3/3]

eVision::EROIBW8::EROIBW8 ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ GetFirstSubROI()

eVision::EROIBW8 * eVision::EROIBW8::GetFirstSubROI ( )

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.

◆ GetImage() [1/2]

eVision::EImageBW8 * eVision::EROIBW8::GetImage ( )

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

◆ GetImage() [2/2]

const eVision::EImageBW8 * eVision::EROIBW8::GetImage ( ) const

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

◆ GetNextROI()

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.

◆ GetNextSiblingROI()

eVision::EROIBW8 * eVision::EROIBW8::GetNextSiblingROI ( )

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.

◆ GetParent() [1/2]

eVision::EROIBW8 * eVision::EROIBW8::GetParent ( )

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.

◆ GetParent() [2/2]

const eVision::EROIBW8 * eVision::EROIBW8::GetParent ( ) const

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.

◆ GetPixel()

eVision::EBW8 eVision::EROIBW8::GetPixel	(	int32_t	x,
		int32_t	y ) const

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.

◆ GetTopParent() [1/2]

eVision::EImageBW8 * eVision::EROIBW8::GetTopParent ( )

Returns the top parent of this object.

Deprecated

Use EROIBW8::GetImage instead.

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

◆ GetTopParent() [2/2]

const eVision::EImageBW8 * eVision::EROIBW8::GetTopParent ( ) const

Returns the top parent of this object.

Deprecated

Use EROIBW8::GetImage instead.

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

◆ GetUncheckedPixel()

eVision::EBW8 eVision::EROIBW8::GetUncheckedPixel	(	int32_t	x,
		int32_t	y ) const

◆ operator=()

eVision::EROIBW8 & eVision::EROIBW8::operator= ( const eVision::EROIBW8 & other )

Assignment operator.

Parameters

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

◆ Serialize()

void eVision::EROIBW8::Serialize ( eVision::ESerializer * serializer )

virtual

Deprecated

Use EBaseROI::Save or EBaseROI::Load instead.

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

Implements eVision::EBaseROI.

Reimplemented in eVision::EImageBW8.

◆ SetPixel()

void eVision::EROIBW8::SetPixel	(	eVision::EBW8	value,
		int32_t	x,
		int32_t	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,
		int32_t	x,
		int32_t	y )

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EROIBW8() [1/3]

◆ EROIBW8() [2/3]

◆ ~EROIBW8()

◆ EROIBW8() [3/3]

Member Function Documentation

◆ GetFirstSubROI()

◆ GetImage() [1/2]

◆ GetImage() [2/2]

◆ GetNextROI()

◆ GetNextSiblingROI()

◆ GetParent() [1/2]

◆ GetParent() [2/2]

◆ GetPixel()

◆ GetTopParent() [1/2]

◆ GetTopParent() [2/2]

◆ GetUncheckedPixel()

◆ operator=()

◆ Serialize()

◆ SetPixel()

◆ SetUncheckedPixel()