eVision.EImageC24 Class Reference

The eVision.EImageC24 class is used to represent rectangular regions of interest inside eVision.EC24 color images. More...

Inheritance diagram for eVision.EImageC24:

Collaboration diagram for eVision.EImageC24:

Public Member Functions
None	__init__ (self)
	Constructs a eVision.EImageC24 image.
None	__init__ (self, int width, int height)
	Constructs a eVision.EImageC24 image.
None	__init__ (self, int width, int height, eVision.EC24 constant)
	Constructs a eVision.EImageC24 image.
None	__init__ (self, eVision.EImageC24 other)
	Constructs a eVision.EImageC24 image.
None	Serialize (self, eVision.ESerializer|None serializer)
None	InitializeFromUnalignedBuffer (self, int width, int height, ctypes.c_void_p buffer, int pitch)
	Initialize image from an unaligned buffer.
None	InitializeFromUnalignedBuffer (self, int width, int height, ctypes.c_void_p buffer)
	Initialize image from an unaligned buffer.
Public Member Functions inherited from eVision.EROIC24
None	__init__ (self)
	Constructs the eVision.EROIC24 object.
None	__init__ (self, eVision.EROIC24 other)
None	SetPixel (self, eVision.EC24 value, int x, int y)
	Allows writing a single pixel value in the ROI or image.
None	SetUncheckedPixel (self, eVision.EC24 value, int x, int y)
eVision.EROIC24|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.
eVision.EC24	GetUncheckedPixel (self, int x, int y)
eVision.EC24	GetPixel (self, int x, int y)
	Allows reading a single pixel value in the ROI or image.
eVision.EROIC24|None	FirstSubROI (self)
	See GetFirstSubROI in the derived classes.
eVision.EROIC24|None	NextSiblingROI (self)
	This method returns the ROI that is the next sibling of this ROI.
eVision.EROIC24|None	Parent (self)
	Returns the hierarchical parent of this object.
eVision.EImageC24|None	TopParent (self)
	Returns the top parent of this object.
eVision.EImageC24|None	Image (self)
	Returns the image associated with this ROI, or NULL if there is no image associated.
eVision.EPixelViewC24	PixelView (self)
	Returns a pixel view of the ROI, allowing usage of the pixels defined in that ROI with the buffer protocol in Python.
Public Member Functions inherited from eVision.EBaseROI
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.
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	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.
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

The eVision.EImageC24 class is used to represent rectangular regions of interest inside eVision.EC24 color images.

See ROIs.

Remarks:

License(s): BasicTypes

Constructor & Destructor Documentation

__init__() [1/4]

None eVision.EImageC24.__init__

(

self

)

Constructs a eVision.EImageC24 image.

Remarks:

The constructor with no arguments creates a zero-sized image. You can modify the image size by calling eVision.EBaseROI.SetSize method.

The sizing constructor constructs an image of the given size. See eVision.EBaseROI.SetSize for informations about the sizing restrictions.

The copy constructor copies all the supplied image properties (content, attributes, sub-ROIs...) into the current object. Note that if you used eVision.EBaseROI.UseExternalBuffer to assign an external buffer to the image, that buffer will not be copied, the resulting image will just point to the same buffer as the original.

__init__() [2/4]

None eVision.EImageC24.__init__	(		self,
		int	width,
		int	height )

Constructs a eVision.EImageC24 image.

Remarks:

The constructor with no arguments creates a zero-sized image. You can modify the image size by calling eVision.EBaseROI.SetSize method.

The sizing constructor constructs an image of the given size. See eVision.EBaseROI.SetSize for informations about the sizing restrictions.

The copy constructor copies all the supplied image properties (content, attributes, sub-ROIs...) into the current object. Note that if you used eVision.EBaseROI.UseExternalBuffer to assign an external buffer to the image, that buffer will not be copied, the resulting image will just point to the same buffer as the original.

Parameters

width	The width, in pixels.
height	The height, in pixels.

__init__() [3/4]

None eVision.EImageC24.__init__	(		self,
		int	width,
		int	height,
		eVision.EC24	constant )

Constructs a eVision.EImageC24 image.

Remarks:

The constructor with no arguments creates a zero-sized image. You can modify the image size by calling eVision.EBaseROI.SetSize method.

The sizing constructor constructs an image of the given size. See eVision.EBaseROI.SetSize for informations about the sizing restrictions.

The copy constructor copies all the supplied image properties (content, attributes, sub-ROIs...) into the current object. Note that if you used eVision.EBaseROI.UseExternalBuffer to assign an external buffer to the image, that buffer will not be copied, the resulting image will just point to the same buffer as the original.

Parameters

width	The width, in pixels.
height	The height, in pixels.
constant	Color constant.

__init__() [4/4]

None eVision.EImageC24.__init__	(		self,
		eVision.EImageC24	other )

Constructs a eVision.EImageC24 image.

Remarks:

The constructor with no arguments creates a zero-sized image. You can modify the image size by calling eVision.EBaseROI.SetSize method.

The sizing constructor constructs an image of the given size. See eVision.EBaseROI.SetSize for informations about the sizing restrictions.

The copy constructor copies all the supplied image properties (content, attributes, sub-ROIs...) into the current object. Note that if you used eVision.EBaseROI.UseExternalBuffer to assign an external buffer to the image, that buffer will not be copied, the resulting image will just point to the same buffer as the original.

Parameters

other

Another eVision.EImageC24 object.

Member Function Documentation

InitializeFromUnalignedBuffer() [1/2]

None eVision.EImageC24.InitializeFromUnalignedBuffer	(		self,
		int	width,
		int	height,
		ctypes.c_void_p	buffer )

Initialize image from an unaligned buffer.

Remarks:

The image will be initialized to fit the width and height passed as arguments. The contents of the buffer will then be copied into the image. The buffer contents must be compatible with the pixel type of the image.

Parameters

width	Width of the image in the buffer.
height	Height of the image in the buffer.
buffer	Address of the buffer.

InitializeFromUnalignedBuffer() [2/2]

None eVision.EImageC24.InitializeFromUnalignedBuffer	(		self,
		int	width,
		int	height,
		ctypes.c_void_p	buffer,
		int	pitch )

Initialize image from an unaligned buffer.

Remarks:

The image will be initialized to fit the width and height passed as arguments. The contents of the buffer will then be copied into the image. The buffer contents must be compatible with the pixel type of the image.

Parameters

width	Width of the image in the buffer.
height	Height of the image in the buffer.
buffer	Address of the buffer.
pitch	Pitch of the buffer (in bytes). If omitted, the method assumes there is no padding (the pitch is assumed be equal (width * sizeOfAPixel))

Serialize()

None eVision.EImageC24.Serialize	(		self,
		eVision.ESerializer | None	serializer )

Deprecated

Use eVision.EBaseROI.Save or eVision.EBaseROI.Load instead.

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

Reimplemented from eVision.EROIC24.