# Convolution Filter

## Description

Apply a Convolution filter to an Image with a Matrix

{% tabs %}
{% tab title="Preview" %}
![](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2F4fDfZNPh3EwLqo1S7R8d%2FBitmapPlus-Convolution.png?alt=media\&token=0b8934b2-9f10-4b98-b80d-e8ddf8e767ad)
{% endtab %}

{% tab title="Location" %}
**Name** | Threshold Filter

**Nickname** | Threshold

**Tab** | Bitmap

**Panel** | Filter

**Division** | 4
{% endtab %}

{% tab title="Inputs" %}
**I** | **Image** (*B+ Image, Bitmap*) | A Bitmap Plus Image or Bitmap

**M** | **Matrix** (*Matrix*) | A Matrix to apply

**D** | **Divisor** (*Integer*) | Optional Divisor Value
{% endtab %}

{% tab title="Ouputs" %}
**I** | **Image** (*B+ Image*) | A Bitmap Plus Image
{% endtab %}

{% tab title="Mode" %}
![](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2FeV1ulrSGqAXPXGlo6uDD%2Fimage.png?alt=media\&token=fb42f272-523b-4276-8531-df4f25a0a55c)

**Save Image** | Opens a file save dialog to save a raster file of the current image.

**Copy Image to Clipboard** | Copies the image to the clipboard (no alpha)
{% endtab %}
{% endtabs %}

## Usage

### Matrix Samples

![0,0,0,0,-1,0,0,0,0](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2F6jIjPiR1xH4dYgX5KwEu%2F0000-10000.png?alt=media\&token=18e0b8e5-bda8-421f-a751-a29b973fa94e) ![-1,0,-1,0,7,0,-1,0,-1](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2FaPUqnHTqZrTl7gEym3mN%2F-10-1070-10-1.png?alt=media\&token=5e3dc146-0188-4a43-b403-fa971b8ea98d) ![-2,-1,0,-1,1,1,0,1,2](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2FLIVWeKpl2fGd0SZgapVh%2F-2-10-111012.png?alt=media\&token=c609ca34-860e-420f-81c9-2c5f1046090b)

![-1,0,0,0,0,0,0,0,1](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2FxSu7hIvNG1ReLQEAmd2O%2F-100000001.png?alt=media\&token=d9a06dc4-55b3-4b9c-b265-be9f2463ca28) ![-1,-2,-1,0,0,0,1,2,1](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2F3Sgod7hbBDTp8bCkJr0d%2F-1-2-1000121.png?alt=media\&token=a601e179-848f-4f3e-839e-544e8bd8cfba) ![0,-1,0,-1,4,-1,0,-1,0](https://3118158252-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhT7C2oduVfvz0FwKt3nj%2Fuploads%2FDUk9N6qSZabcDYRJcLc7%2F0-10-14-10-10.png?alt=media\&token=9cef1c65-88b3-4044-bbc4-3292a61e34bf)


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://interopxyz.gitbook.io/bitmap-plus/components/filter/convolution-filter.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.