CropImage


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++
Python
 
def CropImage(
	inImage: Image,
	inSelection: Box,
	outImage: Image,
	/,
	*,
	inBorderColor: Pixel = Pixel(0, 0, 0, 0)
)
-> None

Parameters

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

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.