Crop Image

Category: Image

Status: Registered and callable in the CyberChef 11.3.0 compatibility inventory.

Input / output: ArrayBuffer → ArrayBuffer

Background: https://wikipedia.org/wiki/Cropping_(image)

What it does

Crops an image to the specified region, or automatically crops edges. Autocrop Automatically crops same-colour borders from the image. Autocrop tolerance A percentage value for the tolerance of colour difference between pixels. Only autocrop frames Only crop real frames (all sides must have the same border) Symmetric autocrop Force autocrop to be symmetric (top/bottom and left/right are cropped by the same amount) Autocrop keep border The number of pixels of border to leave around the image.

Note

Status here means the operation name is implemented and callable. It does not by itself promise byte-for-byte parity for every upstream option. See Compatibility and current status for the verified scope and known boundaries.

Arguments and options

Arguments are positional. Keep their order when using bake() or Pipeline.then().

Index	Name	UI type	PyChef default	Accepted values / format
`0`	X Position	`number`	`0`	A Python integer or floating-point value
`1`	Y Position	`number`	`0`	A Python integer or floating-point value
`2`	Width	`number`	`10`	A Python integer or floating-point value
`3`	Height	`number`	`10`	A Python integer or floating-point value
`4`	Autocrop	`boolean`	`False`	`True` or `False`
`5`	Autocrop tolerance (%)	`number`	`0.02`	A Python integer or floating-point value
`6`	Only autocrop frames	`boolean`	`True`	`True` or `False`
`7`	Symmetric autocrop	`boolean`	`False`	`True` or `False`
`8`	Autocrop keep border (px)	`number`	`0`	A Python integer or floating-point value

Recipe template

Important

This is a call template built from the documented defaults. Replace placeholder values such as empty keys, paths, patterns, or lookup data before running it.

from pychef import bake

input_value = b"example"
args = [0, 0, 10, 10, False, 0.02, True, False, 0]
result = bake(input_value, [{"op": 'Crop Image', "args": args}])
print(result)

Pipeline example

from pychef import Pipeline

args = [0, 0, 10, 10, False, 0.02, True, False, 0]
transform = Pipeline().then('Crop Image', *args)
result = transform(b"example")

Dedicated operation module

The registered entry point lives in pychef.operations.by_operation.crop_image. Direct calls receive the input value and a positional argument tuple:

from pychef.operations.by_operation.crop_image import run

result = run(b"example", tuple([0, 0, 10, 10, False, 0.02, True, False, 0]))

pychef.operations.by_operation.crop_image.run(value, args)

Run this operation using its shared internal implementation.

Parameters:

value (str | bytes)
args (Sequence[Any])

Return type:

str | bytes