> For the complete documentation index, see [llms.txt](https://docs.viesus.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.viesus.com/features/features/portrait-auto-cropping.md).

# Portrait Auto Cropping

Automatically crops the image based on detected face position and configurable aspect ratio, headroom, and portrait mode.

{% hint style="info" %}
**Requires:** [Face Detection](/features/features/face-detection.md) for modes 1 and 2 — enabled automatically.
{% endhint %}

## Example

{% columns %}
{% column %}
**Before**

<figure><img src="https://919968377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FG3eQlcnlDKtn9yl3mxsx%2Fuploads%2Fgit-blob-2aac38d3a6989f640b75c2aeecf11934ec13a3c3%2Fplaceholder.svg?alt=media" alt="Before — Portrait Auto Cropping"><figcaption></figcaption></figure>
{% endcolumn %}

{% column %}
**After**

<figure><img src="https://919968377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FG3eQlcnlDKtn9yl3mxsx%2Fuploads%2Fgit-blob-2aac38d3a6989f640b75c2aeecf11934ec13a3c3%2Fplaceholder.svg?alt=media" alt="After — Portrait Auto Cropping"><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

## Parameters

<table><thead><tr><th width="163.2000732421875">Parameter</th><th width="100">Section</th><th width="95">Value</th><th width="95">Default</th><th>Description</th></tr></thead><tbody><tr><td><code>CropMode</code></td><td><code>AutoCrop</code></td><td>0 – 2</td><td>0</td><td>Mode selection (see below)</td></tr><tr><td><code>AspectWidth</code></td><td><code>AutoCrop</code></td><td>Float</td><td>1.0</td><td>Target aspect ratio width</td></tr><tr><td><code>AspectHeight</code></td><td><code>AutoCrop</code></td><td>Float</td><td>1.0</td><td>Target aspect ratio height</td></tr><tr><td><code>Headroom</code></td><td><code>AutoCrop</code></td><td>Float</td><td>0.106</td><td>General headroom</td></tr><tr><td><code>HeadroomLeft</code></td><td><code>AutoCrop</code></td><td>Float</td><td>0.106</td><td>Left-side headroom</td></tr><tr><td><code>PortraitMode</code></td><td><code>AutoCrop</code></td><td>0 – 2</td><td>2</td><td>Portrait cropping mode (largest face / all / auto)</td></tr><tr><td><code>CropModeHeadroom</code></td><td><code>AutoCrop</code></td><td>0, 1</td><td>0</td><td>Headroom alignment (centre / left)</td></tr></tbody></table>

## Modes

<table><thead><tr><th width="181.199951171875">Value</th><th>Description</th></tr></thead><tbody><tr><td><strong>0</strong> — Manual</td><td>Uses the configured aspect ratio and headroom values without face-based adjustment</td></tr><tr><td><strong>1</strong> — Automatic</td><td>Crops to the dominant detected face using the configured aspect ratio and headroom</td></tr><tr><td><strong>2</strong> — Group</td><td>Crops to include all detected faces (for group portraits)</td></tr></tbody></table>

For the full `AutoCrop` parameter set, see the [Parameter Reference → AutoCrop](/configuration/parameter-reference/background-and-cropping.md#portrait-auto-cropping-autocrop).

{% hint style="success" %}
**Recommended:** Use Mode 1 for single-subject portraits and Mode 2 for group shots. Set `AspectWidth`/`AspectHeight` to your output ratio; the default headroom (0.106) suits most headshots.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.viesus.com/features/features/portrait-auto-cropping.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.