# ee.Kernel.circle

Generates a circle-shaped boolean kernel.

<br />

| Usage | Returns |
|---|---|
| `ee.Kernel.circle(radius, *units*, *normalize*, *magnitude*)` | Kernel |

| Argument | Type | Details |
|---|---|---|
| `radius` | Float | The radius of the kernel to generate. |
| `units` | String, default: "pixels" | The system of measurement for the kernel ('pixels' or 'meters'). If the kernel is specified in meters, it will resize when the zoom-level is changed. |
| `normalize` | Boolean, default: true | Normalize the kernel values to sum to 1. |
| `magnitude` | Float, default: 1 | Scale each value by this amount. |

## Examples

### Code Editor (JavaScript)

```javascript
print('A circle kernel', ee.Kernel.circle({radius: 3}));

/**
 * Output weights matrix (up to 1/1000 precision for brevity)
 *
 * [0.000, 0.000, 0.000, 0.034, 0.000, 0.000, 0.000]
 * [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000]
 * [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000]
 * [0.034, 0.034, 0.034, 0.034, 0.034, 0.034, 0.034]
 * [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000]
 * [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000]
 * [0.000, 0.000, 0.000, 0.034, 0.000, 0.000, 0.000]
 */
```
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 circle kernel:', ee.Kernel.circle(**{'radius': 3}))

#  Output weights matrix (up to 1/1000 precision for brevity)

#  [0.000, 0.000, 0.000, 0.034, 0.000, 0.000, 0.000]
#  [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000]
#  [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000]
#  [0.034, 0.034, 0.034, 0.034, 0.034, 0.034, 0.034]
#  [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000]
#  [0.000, 0.034, 0.034, 0.034, 0.034, 0.034, 0.000]
#  [0.000, 0.000, 0.000, 0.034, 0.000, 0.000, 0.000]
```