Back to FabImage Library website

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

GetImageRow


Header: FIL.h
Namespace: fil
Module: FoundationLite

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

Syntax

C++
C#
 
void fil::GetImageRow
(
	const fil::Image& inImage,
	ftl::Optional<int> inChannelIndex,
	const int inRowIndex,
	ftl::Array<float>& outValues,
	ftl::Array<fil::Pixel>& outPixels
)

Parameters

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

Errors

List of possible exceptions:

Error type Description
DomainError Channel index out of range in GetImageRow.
DomainError Row index out of range in GetImageRow.