CogRLEBuffer.Combine Method

CogRLEBuffer Combine Method

Cognex VisionPro 9.8

Combine with another CogRLEBuffer. The SubImage must be contained within the primary RLE image's bounds.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 75.1.0.0

Syntax

public CogRLEBuffer Combine(
	CogRLEBuffer subImage,
	byte[] map,
	byte transparencyValue
)

public CogRLEBuffer Combine(
	CogRLEBuffer subImage,
	byte[] map,
	byte transparencyValue
)

Public Function Combine ( 
	subImage As CogRLEBuffer,
	map As Byte(),
	transparencyValue As Byte
) As CogRLEBuffer

Public Function Combine ( 
	subImage As CogRLEBuffer,
	map As Byte(),
	transparencyValue As Byte
) As CogRLEBuffer

public:
CogRLEBuffer^ Combine(
	CogRLEBuffer^ subImage, 
	array<unsigned char>^ map, 
	unsigned char transparencyValue
)

public:
CogRLEBuffer^ Combine(
	CogRLEBuffer^ subImage, 
	array<unsigned char>^ map, 
	unsigned char transparencyValue
)

subImage: Type: Cognex.VisionPro CogRLEBuffer
The image to combine with this one. The contents of subImage are used to overwrite the corresponding part of this image.

map: Type: System Byte
A pixel map. If supplied, each pixel in subImage is replaced with the value at the corresponding offset in the map.

transparencyValue: Type: System Byte
If you specify a transparencyValue, then any pixels in subImage that have this value (after the mapping operation) are ignored during the combine operation (they are not used to replace existing pixels in this image).

Exceptions

Exception	Condition
ArgumentException	subImage is NULL.
ArgumentException	map's lower bound is < 0 or its upper bound is > 255, or its dimension is > 1.
CogRLEBufferNotInitializedException	The RLE buffer is not initialized.
CogRLEBufferCombineFailedException	The operation failed. Typically, this error means that the subImage exceeds the primary image's bounds.

Remarks

Combine with another CogRLEBuffer. The SubImage must be contained within the primary RLE image's bounds.