You are here: Start » FIL.NET » Function Reference » Image » Image Spatial Transforms » FIL.CropImageToRectangle

FIL.CropImageToRectangle

Creates an image from a rectangular fragment of another image (with black margins if requested).

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void CropImageToRectangle
(
	FilNet.Image inImage,
	FilNet.Rectangle2D inRectangle,
	FilNet.CoordinateSystem2D? inRectangleAlignment,
	FilNet.CropScaleMode inScaleMode,
	FilNet.InterpolationMethod inInterpolationMethod,
	float inMargin,
	FilNet.Pixel inBorderColor,
	FilNet.Image outImage,
	NullableValue<FilNet.Rectangle2D> outAlignedRectangle,
	NullableValue<FilNet.CoordinateSystem2D> outOutputAlignment
)

Parameters

Name Type Range Default Description
inImageFilNet.ImageInput image.
inRectangleFilNet.Rectangle2DRectangle defining a rotated subimage.
inRectangleAlignmentFilNet.CoordinateSystem2D?Adjusts the rectangle to the position of the inspected object. Default value: ftl::NIL.
inScaleModeFilNet.CropScaleModeInputScaleInputScale keeps the input scale unchanged, AlignedScale rescales according to the input alignment scale. Default value: InputScale.
inInterpolationMethodFilNet.InterpolationMethodBilinearDefault value: Bilinear.
inMarginfloat<0.0f, INF>Width of an additional margin for the output image.
inBorderColorFilNet.PixelColor used for locations outside the rectangle.
outImageFilNet.ImageOutput image.
outAlignedRectangleFilNet.NullableValue<FilNet.Rectangle2D>Input rectangle after transformation (in the image coordinates). Can be null to skip this parameter calculation.
outOutputAlignmentFilNet.NullableValue<FilNet.CoordinateSystem2D>Alignment of the output image. Can be null to skip this parameter calculation.

Examples

CropImageToRectangle used to extract an image of an object.

Function Overrides

See also