reference
API Reference › Batch Image Crop
batch_crop.cropGeometry.cropScaledImage
Crop one calibrated image to a common physical output scale.
Syntax
result = batch_crop.cropGeometry.cropScaledImage(imageData, opts, plan)
result = batch_crop.cropGeometry.cropScaledImage(imageData, opts, plan, itemIndex)Description
Uses the selected item's native crop dimensions from scalePlan, delegates rotation and cropping to batch_crop.cropGeometry.cropImage, then resamples the crop to the plan's common output dimensions. Resampling uses bilinear interpolation independently for every channel and preserves image class. The function has no graphics or file side effects.
Inputs
imageData- Nonempty numeric or logical M-by-N or M-by-N-by-C image.
opts- Crop option structure accepted by cropImage. cropWidth and cropHeight are replaced by the native dimensions selected by plan.
plan- Scalar structure returned by
batch_crop.cropGeometry.scalePlan. itemIndex- Positive index selecting nativeCropWidth, nativeCropHeight, sourcePixelsPerUnit, resampleFactor, and warnings for imageData. Default: 1.
Options
angleDeg- Counterclockwise canvas rotation in degrees. Default: 0.
centerXY- Crop center [x y] in original-image pixel coordinates. Empty or invalid input selects the image center. Default: [].
paddingPercent- Padding around the source before rotation, as a percentage of each source dimension. Default: 0.
fillValue- Value used outside the rotated image. Empty selects the app's white value for imageData. Default: [].
Outputs
result- cropImage result updated for physical mode. result.image has plan.outputHeight rows and plan.outputWidth columns. cropWidth and cropHeight describe that output; nativeCropWidth and nativeCropHeight describe the pre-resampling crop. scaleUnit, sourcePixelsPerUnit, targetPixelsPerUnit, resampleFactor, and scaleWarning come from plan.
Failure Behavior
itemIndex must select an element from every per-image plan field, and plan output dimensions must be positive. Missing fields, out-of-range indices, invalid image/crop options, or unsupported interpolation classes propagate the originating cropGeometry or MATLAB error.
Example
imageData = reshape(uint8(1:100), 10, 10);
opts = struct("centerXY", [5 5]);
plan = struct("nativeCropWidth", 4, "nativeCropHeight", 4, ...
"outputWidth", 8, "outputHeight", 6, "unit", "um", ...
"sourcePixelsPerUnit", 2, "targetPixelsPerUnit", 4, ...
"resampleFactor", 2, "warnings", "");
result = batch_crop.cropGeometry.cropScaledImage(imageData, opts, plan);
assert(isequal(size(result.image), [6 8]))Related APIs
batch_crop.cropGeometry.cropImage— Rotate and crop an image at a fixed pixel size.batch_crop.cropGeometry.scalePlan— Plan equal-size physical crops across calibrated images.
Source
This page is generated from the MATLAB help text in apps/image_measurement/batch_crop/+batch_crop/+cropGeometry/cropScaledImage.m.