Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Spatial Transforms » CropImage

CropImage


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates an image from a box-shaped fragment of the input image (with margins if requested).

Applications: Reduction of the amount of image data to be stored in memory.

Syntax

C++
C#
 
void fil::CropImage
(
	const fil::Image& inImage,
	const fil::Box& inSelection,
	const fil::Pixel& inBorderColor,
	fil::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage const Image& Input image
Input value inSelection const Box& Box defining a subimage to be cropped
Input value inBorderColor const Pixel& Color used for locations outside the selection
Output value outImage Image& Output image

Description

The operation extracts part of the inImage that corresponds to the inSelection box.

Hints

  • It is usually recommended to use Local Coordinate Systems rather than image cropping.

Examples

CropImage performed on the sample image.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

See Also