diff --git a/docs/src/regiongrids/create.md b/docs/src/basics/create.md similarity index 98% rename from docs/src/regiongrids/create.md rename to docs/src/basics/create.md index 6e8cf6c..306c55a 100644 --- a/docs/src/regiongrids/create.md +++ b/docs/src/basics/create.md @@ -1,4 +1,6 @@ -# RegionGrid: Applying GeoRegions to Gridded Data +# Creating a RegionGrid + +Using RegionGrids.jl In this section, we go through the basic steps of creating a RegionGrid for `RectRegion`s and `PolyRegion`s. See if you can spot the differences between the RegionGrids generated by the two different types. diff --git a/docs/src/regiongrids/intro.md b/docs/src/regiongrids/intro.md deleted file mode 100644 index cbc3747..0000000 --- a/docs/src/regiongrids/intro.md +++ /dev/null @@ -1,14 +0,0 @@ -# What is a RegionGrid? - -But how do we go from defining a GeoRegion, to **extracting data** for that GeoRegion? The answer is with the information in the `RegionGrid` types, which maps gridded lon-lat data to a given GeoRegion as follows: -* Mapping gridded lon-lat data to a **`RectRegion`** gives a `RectGrid` structure -* Mapping gridded lon-lat data to a **`PolyRegion`** gives a `PolyGrid` structure -* Mapping non-rectilinear gridded lon-lat data to a **`RegionMask`** gives a `RegionMask` structure - -However, the basic uses of `RectGrid` and `PolyGrid` are the same, and as such their differences are largely transparent to the user, except for one field found in `PolyGrid`, the `mask`, which will be elaborated upon later. - -```@docs -RegionGrid -``` - -So basically a `RegionGrid` contains information on the indices of the gridded data that are part of the `GeoRegion`, thus helping us extract the relevant data for a given `GeoRegion`. \ No newline at end of file diff --git a/docs/src/using/extract.md b/docs/src/tutorials/extract.md similarity index 100% rename from docs/src/using/extract.md rename to docs/src/tutorials/extract.md diff --git a/src/RegionGrids.jl b/src/RegionGrids.jl index 58a9a1e..c4dfffd 100644 --- a/src/RegionGrids.jl +++ b/src/RegionGrids.jl @@ -15,7 +15,7 @@ using Reexport export RegionGrid, RectilinearGrid, RectGrid, PolyGrid, TiltGrid, - GeneralizedGrid, RegionMask, VectorMask, VectorGrid, + GeneralizedGrid, RegionMask, RegionTilt, VectorMask, VectorGrid, extract, extract! @@ -33,7 +33,6 @@ abstract type RegionGrid end A `RectilinearGrid` is a `RegionGrid` that is created based on rectilinear longitude/latitude grids. It has its own subtypes: `RectGrid`, `TiltGrid` and `PolyGrid`. All `RectilinearGrid` types contain the following fields: -* `grid` - A vector of `Int`s, defining the gridpoint indices of the [N,S,E,W] points respectively * `lon` - A vector of `Float`s, defining the latitude vector describing the region * `lat` - A vector of `Float`s, defining the latitude vector describing the region * `ilon` - A vector of `Int`s, defining indices of the parent longitude vector describing the region