CogImageConvert.GetHSIImage Method

CogImageConvert GetHSIImage Method

Cognex VisionPro 9.10

Produce an HSI image from the supplied input image.

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

Syntax

public static ICogImage GetHSIImage(
	ICogImage inputImage,
	int x,
	int y,
	int width,
	int height
)

public static ICogImage GetHSIImage(
	ICogImage inputImage,
	int x,
	int y,
	int width,
	int height
)

Public Shared Function GetHSIImage ( 
	inputImage As ICogImage,
	x As Integer,
	y As Integer,
	width As Integer,
	height As Integer
) As ICogImage

Public Shared Function GetHSIImage ( 
	inputImage As ICogImage,
	x As Integer,
	y As Integer,
	width As Integer,
	height As Integer
) As ICogImage

public:
static ICogImage^ GetHSIImage(
	ICogImage^ inputImage, 
	int x, 
	int y, 
	int width, 
	int height
)

public:
static ICogImage^ GetHSIImage(
	ICogImage^ inputImage, 
	int x, 
	int y, 
	int width, 
	int height
)

Parameters

inputImage: Type: Cognex.VisionPro ICogImage
The image to convert.

x: Type: System Int32
The X-coordinate in pixels of the origin of the region to convert.

y: Type: System Int32
The Y-coordinate in pixels of the origin of the region to convert.

width: Type: System Int32
The width in pixels of the region to convert.

height: Type: System Int32
The height in pixels of the region to convert.

Return Value

Type: ICogImage

The converted image.

Exceptions

Exception	Condition
CogOperatorNoInputImageException	inputImage is null.
CogImageBadTypeException	inputImage does not refer to an image type that supports RGB representation such as CogImage24PlanarColor.
CogImageNoPixelsException	inputImage is not allocated.
CogImageClippedException	x is less than 0 or greater than or equal to the width of inputImage; y is less than 0 or greater than or equal to the height of inputImage; x plus width is greater than the width of inputImage; or y plus height is greater than the height of inputImage.

Remarks

Produce an HSI image from the supplied input image. The output image is of the same type (such as CogImage24PlanarColor) as the input image. If the supplied image is already an HSI image (ColorSpace is HSI) then no conversion is done.

If x, y, width, and height are all zero, then the entire image is converted. Otherwise, only the specified portion of the image is converted.