Skip to content

Commit

Permalink
Update zonal.jl
Browse files Browse the repository at this point in the history
  • Loading branch information
asinghvi17 authored Oct 23, 2024
1 parent 1f00143 commit bca00e7
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/methods/zonal.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@
Calculate zonal statistics for the the zone of a `Raster` or `RasterStack`
covered by the `of` object/s.
Since `f` is the first argument, you can use Julia's `do`-block syntax with `zonal`,
like so:
```julia
zonal(raster; of = geom) do r # r is an iterator if skipmissing=true, or a raster if skipmissing=false
return r # or do some operation
end
```
# Arguments
- `f`: any function that reduces an iterable to a single value, such as `sum` or `Statistics.mean`
- `f`: any function that reduces an iterable to a single value, such as `sum` or `Statistics.mean` - but it can even be `identity`.
- `x`: A `Raster` or `RasterStack`
- `of`: A `DimTuple`, `Extent`, $OBJ_ARGUMENT
Expand Down

0 comments on commit bca00e7

Please sign in to comment.