-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Splitting up functions between rectilinear and generalized grids
- Loading branch information
1 parent
57ebd56
commit 3e8f030
Showing
4 changed files
with
148 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| """ | ||
| extract( | ||
| odata :: AbstractArray{<:Real}, | ||
| ggrd :: RegionGrid | ||
| ) -> Array{<:Real} | ||
| Extracts data from odata, an Array of dimension N (where N ∈ 2,3,4) that contains data of a Parent `GeoRegion`, into another Array of dimension N, containing _**only**_ within a sub `GeoRegion` we are interested in. | ||
| !!! warning | ||
| Please ensure that the 1st dimension is longitude and 2nd dimension is latitude before proceeding. The order of the 3rd and 4th dimensions (when used), however, is not significant. | ||
| Arguments | ||
| ========= | ||
| - `odata` : An array of dimension N containing gridded data in the region we are interesting in extracting from | ||
| - `ggrd` : A `RegionGrid` containing detailed information on what to extract | ||
| """ | ||
| function extract( | ||
| odata :: AbstractArray{<:Real}, | ||
| ggrd :: GeneralizedGrid | ||
| ) | ||
|
|
||
| mask = ggrd.mask | ||
| ndata = zeros(size(mask)) | ||
| for ii in eachindex(mask) | ||
| ndata[ii] = odata[ii] * mask[ii] | ||
| end | ||
|
|
||
| return ndata | ||
|
|
||
| end | ||
|
|
||
| """ | ||
| extract!( | ||
| odata :: AbstractArray{<:Real}, | ||
| ndata :: AbstractArray{<:Real}, | ||
| ggrd :: RegionGrid | ||
| ) -> nothing | ||
| Extracts data from odata, an Array of dimension N (where N ∈ 2,3,4) that contains data of a Parent `GeoRegion`, into ndata, another Array of dimension N, containing _**only**_ within a sub `GeoRegion` we are interested in. | ||
| This allows for iterable in-place modification to save memory space and reduce allocations if the dimensions are fixed. | ||
| !!! warning | ||
| Please ensure that the 1st dimension is longitude and 2nd dimension is latitude before proceeding. The order of the 3rd and 4th dimensions (when used), however, is not significant. | ||
| Arguments | ||
| ========= | ||
| - `odata` : An array of dimension N containing gridded data in the region we are interesting in extracting from | ||
| - `ndata` : An array of dimension N meant as a placeholder for the extracted data to minimize allocations | ||
| - `ggrd` : A `RegionGrid` containing detailed information on what to extract | ||
| """ | ||
| function extract!( | ||
| ndata :: AbstractArray{<:Real}, | ||
| odata :: AbstractArray{<:Real}, | ||
| ggrd :: GeneralizedGrid | ||
| ) | ||
|
|
||
| mask = ggrd.mask | ||
| for ii in eachindex(mask) | ||
| ndata[ii] = odata[ii] * mask[ii] | ||
| end | ||
|
|
||
| return | ||
|
|
||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| """ | ||
| RegionGrid( | ||
| geo :: GeoRegion, | ||
| lon :: Array{<:Real,2}, | ||
| lat :: Array{<:Real,2} | ||
| ) -> RegionGrid | ||
| Creates a `RegionMask` type based on the following arguments. This method is more suitable for non-rectilinear grids of longitude and latitude points, such as in the output of WRF or CESM. | ||
| Arguments | ||
| ========= | ||
| - `geo` : A GeoRegion of interest | ||
| - `lon` : An array containing the longitude points | ||
| - `lat` : An array containing the latitude points | ||
| """ | ||
| function RegionGrid( | ||
| geo :: GeoRegion, | ||
| lon :: Array{<:Real,2}, | ||
| lat :: Array{<:Real,2} | ||
| ) | ||
|
|
||
| @info "$(modulelog()) - Creating a RegionMask for the $(geo.name) GeoRegion based on an array of longitude and latitude points" | ||
|
|
||
| if eltype(lon) <: AbstractFloat | ||
| FT = eltype(lon) | ||
| end | ||
|
|
||
| if size(lon) != size(lat) | ||
| error("$(modulelog()) - The size of the longitude and latitude arrays are not the same.") | ||
| end | ||
|
|
||
| mask = zeros(size(lon)) | ||
| wgts = zeros(size(lon)) | ||
|
|
||
| for ii in eachindex(lon) | ||
| ipnt = Point2(lon[ii],lat[ii]) | ||
| if in(ipnt,geo) | ||
| mask[ii] = 1 | ||
| wgts[ii] = cosd.(lat[ii]) | ||
| else; mask[ii] = NaN | ||
| wgts[ii] = 0 | ||
| end | ||
| end | ||
|
|
||
| return RegionMask{FT}(lon,lat,mask,wgts) | ||
|
|
||
| end | ||
|
|
||
| function VectorGrid( | ||
| geo :: GeoRegion, | ||
| lon :: Vector{<:Real}, | ||
| lat :: Vector{<:Real} | ||
| ) | ||
|
|
||
| @info "$(modulelog()) - Creating a RegionMask for the $(geo.name) GeoRegion based on an array of longitude and latitude points" | ||
|
|
||
| if eltype(lon) <: AbstractFloat | ||
| FT = eltype(lon) | ||
| end | ||
|
|
||
| if length(lon) != length(lat) | ||
| error("$(modulelog()) - The size of the longitude and latitude arrays are not the same.") | ||
| end | ||
|
|
||
| mask = zeros(length(lon)) | ||
|
|
||
| for ii in eachindex(lon) | ||
| ipnt = Point2(lon[ii],lat[ii]) | ||
| if in(ipnt,geo) | ||
| mask[ii] = 1 | ||
| else; mask[ii] = NaN | ||
| end | ||
| end | ||
| jj = .!isnan.(mask) | ||
|
|
||
| return VectorMask{FT}(lon,lat,mask,lon[jj],lat[jj]) | ||
|
|
||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters