# ee.Kernel.kirsch

Generates a 3x3 Kirsch's Compass edge-detection kernel.

<br />

| Usage | Returns |
|---|---|
| `ee.Kernel.kirsch(*magnitude*, *normalize*)` | Kernel |

| Argument | Type | Details |
|---|---|---|
| `magnitude` | Float, default: 1 | Scale each value by this amount. |
| `normalize` | Boolean, default: false | Normalize the kernel values to sum to 1. |

## Examples

### Code Editor (JavaScript)

```javascript
print('A Kirsch compass kernel', ee.Kernel.kirsch());

/**
 * Output weights matrix
 *
 * [5, -3, -3]
 * [5,  0, -3]
 * [5, -3, -3]
 */
```
Python setup

See the [Python Environment](https://developers.google.com/earth-engine/guides/python_install) page for information on the Python API and using
`geemap` for interactive development.

```python
import ee
import geemap.core as geemap
```

### Colab (Python)

```python
display('A Kirsch compass kernel:', ee.Kernel.kirsch())

#  Output weights matrix

#  [5, -3, -3]
#  [5,  0, -3]
#  [5, -3, -3]
```