You are here: Start » Function Reference » Image Basics » GetImageColumn

GetImageColumn

Extracts an array of pixel values from a single column of an image.

Header:	AVL.h

Syntax

void avl::GetImageColumn
(
	const avl::Image& inImage,
	atl::Optional<int> inChannelIndex,
	const int inColumnIndex,
	atl::Array<float>& outValues,
	atl::Array<avl::Pixel>& outPixels
)

void GetImageColumn
(
	Image inImage,
	int? inChannelIndex,
	int inColumnIndex,
	out float[] outValues,
	out Pixel[] outPixels
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inChannelIndex	Optional<int>	0 - 3	NIL	Selects a channel of the input image
inColumnIndex	const int	0 - 65535		Selects a column of the input image
outValues	Array<float>&			Output pixel values of the column
outPixels	Array<Pixel>&			Output pixels of the column

Errors

Error type	Description
DomainError	Channel index out of range in GetImageColumn.
DomainError	Column index out of range in GetImageColumn.