Cover Image

Category: Image

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

Input / output: ArrayBuffer → ArrayBuffer

What it does

Scales the image to the given width and height, keeping the aspect ratio. The image may be clipped.

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`	Width	`number`	`100`	A Python integer or floating-point value
`1`	Height	`number`	`100`	A Python integer or floating-point value
`2`	Horizontal align	`option`	`'Center'`	`'Left'`, `'Center'`, `'Right'`
`3`	Vertical align	`option`	`'Middle'`	`'Top'`, `'Middle'`, `'Bottom'`
`4`	Resizing algorithm	`option`	`'Nearest Neighbour'`	`'Nearest Neighbour'`, `'Bilinear'`, `'Bicubic'`, `'Hermite'`, `'Bezier'`
`5`	Background	`value`	`True`	Any value supported by this argument type

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 = [100, 100, 'Center', 'Middle', 'Nearest Neighbour', True]
result = bake(input_value, [{"op": 'Cover Image', "args": args}])
print(result)

Pipeline example

from pychef import Pipeline

args = [100, 100, 'Center', 'Middle', 'Nearest Neighbour', True]
transform = Pipeline().then('Cover Image', *args)
result = transform(b"example")

Dedicated operation module

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

from pychef.operations.by_operation.cover_image import run

result = run(b"example", tuple([100, 100, 'Center', 'Middle', 'Nearest Neighbour', True]))

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

Run this operation using its shared internal implementation.

Parameters:

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

Return type:

str | bytes