Updates & add earthregions

.github/workflows/deploy.yml

@@ -56,7 +56,7 @@ jobs:
  git config user.email "<>"
  - name: Checkout preview
  run: |
- git checkout -B gh-lixo
+ git checkout -B gh-lixa
  - name: Download artifact
  uses: actions/download-artifact@v3
  with:
@@ -70,4 +70,4 @@ jobs:
  rm -rf __tmp__site
  - name: Push
  run: |
- git add -A && git commit -am "update" && git push -u origin gh-lixo
+ git add -A && git commit -am "update" && git push -u origin gh-lixa

_assets/common_opts/opt_save_grd.md

@@ -1,4 +1,4 @@
 - **G** or **save** or **outgrid** or **outfile** : -- *save=file_name.grd*\
- Write one or more fields directly to grids on disk; no data is returned to the Julia REPL.
- If more than one fields are specified via **fields** then *file_name* must contain the format flag
+ Write one or more fields directly to grids on disk or return them to the Julia REPL as grid objects.
+ If more than one field is specified via **fields** then *file_name* must contain the format flag
  %s so that we can embed the field code in the file names.

documentation/all_docs_ref/all_refs.md

@@ -32,9 +32,9 @@
 
 | | | | | | | | | | |
 |:-----|:----|:----|:----|:----|:----|:----|:----|:----|:----|
-| \myreflink{arrows} | \myreflink{band} | \myreflink{bar} | \myreflink{bar3} | \myreflink{boxplot} | \myreflink{bubblechart} | \myreflink{contourf} | \myreflink{cornerplot} | \myreflink{decorated} | \myreflink{ecdfplot} |
-| \myreflink{feather} | \myreflink{fill_between} | \myreflink{hband} | \myreflink{lines} | \myreflink{marginalhist} | \myreflink{parallelplot} | \myreflink{plotlinefit} | \myreflink{qqplot} | \myreflink{quiver} | \myreflink{radar} |
-| \myreflink{scatter} | \myreflink{scatter3} | \myreflink{stairs} | \myreflink{stem} | \myreflink{vband} | \myreflink{violin} |  | | | |
+| \myreflink{arrows} | \myreflink{band} | \myreflink{bar} | \myreflink{bar3} | \myreflink{boxplot} | \myreflink{bubblechart} | \myreflink{contourf} | \myreflink{cornerplot} | \myreflink{decorated} | \myreflink{earthregions} |
+| \myreflink{ecdfplot} | \myreflink{feather} | \myreflink{fill_between} | \myreflink{hband} | \myreflink{lines} | \myreflink{marginalhist} | \myreflink{parallelplot} | \myreflink{plotlinefit} | \myreflink{qqplot} | \myreflink{quiver} |
+| \myreflink{radar} | \myreflink{scatter} | \myreflink{scatter3} | \myreflink{stairs} | \myreflink{stem} | \myreflink{vband} | \myreflink{violin} | | | |
 
 
 ## Supplemental Modules

documentation/general/types.md

@@ -10,6 +10,7 @@ type GMTgrid{T<:Real,N} <: AbstractArray{T,N} # The type holding a local he
  proj4::String # Projection string in PROJ4 syntax (Optional)
  wkt::String # Projection string in WKT syntax (Optional)
  epsg::Int # EPSG code
+ geog::Int # Is geographic coords? 0 -> No; 1 -> [-180 180]; 2 -> [0 360]
  range::Array{Float64,1} # 1x6[8] vector with [x_min, x_max, y_min, y_max, z_min, z_max [, v_min, v_max]]
  inc::Array{Float64,1} # 1x2[3] vector with [x_inc, y_inc [,v_inc]]
  registration::Int # Registration type: 0 -> Grid registration; 1 -> Pixel registration
@@ -42,6 +43,7 @@ type GMTimage{T<:Unsigned, N} <: AbstractArray{T,N} # The type holding a local
  proj4::String # Projection string in PROJ4 syntax (Optional)
  wkt::String # Projection string in WKT syntax (Optional)
  epsg::Int # EPSG code
+ geog::Int # Is geographic coords? 0 -> No; 1 -> [-180 180]; 2 -> [0 360]
  range::Array{Float64,1} # 1x6 vector with [x_min x_max y_min y_max z_min z_max]
  inc::Array{Float64,1} # 1x2 vector with [x_inc y_inc]
  registration::Int # Registration type: 0 -> Grid registration; 1 -> Pixel registration

documentation/modules/blockmode.md

@@ -32,7 +32,7 @@ Optional Arguments
 - **A** or **field** or **fields**: -- *field=mode|scale|highest|lowest|weights*\
  Output is a grid with one of the select fields. `field=mode` writes the modal data *z*. Other options are:
  *scale* (the L1 scale of the mode), *lowest* (lowest value), *highest* (highest value) and *weights* (the output weight;
- requires the **weights** option). The deafault is `field=mode`. Alternatively, one can use a condensed
+ requires the **weights** option). The default is `field=mode`. Alternatively, one can use a condensed
  form which uses the first character (except the mean) of the above options, separated by commas, to compute more than one grid.
  For example: `fields="z,h"` computes two grids; one with the modes and the other with the highest values in blocks.
 

documentation/modules/coast.md

@@ -44,6 +44,10 @@ painted and no land fill is set then the land-areas will be transparent. A map p
 - **E** or **DCW** : -- *DCW=code1,code2,...* **|** *DCW=(country=code, continent=code, pen=pen, fill=fill)*\
  Select painting country polygons from the Digital Chart of the World. This is another dataset independent of GSHHG and hence the **area** and **resolution** options do not apply. **DCW="+l"** just list the countries and their codes [plotting takes place] and **DCW="+L"** shows states/territories for Argentina, Australia, Brazil, Canada, and the US. *country* or **name=code(s)**, where **code(s)** is a one or more comma-separated countries using the 2-character ISO 3166-1 alpha-2 convention. To select a state of a country (if available), append .state, e.g, US.TX for Texas. To specify a whole continent, use **continent=code**, with continent codes AF (Africa),AN (Antarctica), AS (Asia), EU (Europe), OC (Oceania), NA (North America), or SA (South America). Use **pen=pen** (see \myreflink{Pen attributes}) to draw polygon outlines and **fill=fill** (see \myreflink{Fill color/pattern}) to fill them [default is no fill]. At least one of these must be specified unless **dump** is in effect, in which case only one **DCW** option can be given. It is also possible to specify the parameters using simple Tuples. For example: **DCW=("PT", (0.5,"red","--"), "blue")** plots the polygon *PT* with a 0.5p red dashed line and filled with blue and **DCW=:PT** uses a default pen of 0.5. **DCW=(:PT, :blue)** fills with blue. You may repeat **DCW** to give different groups of items their own *pen/fill* settings. However, since we cannot repeat a keyword, the solution to setting different groupes is to use a tuple of tuples. An example would be *DCW=((country=:PT, pen=(2,:red), fill=:blue), (country=:ES, pen=(2,:blue)) )*. If neither **proj** nor **dump** are set then we just print the **region**.
 
+- **getR** or **getregion** or **get_region** : -- *getR=code1,code2,...*\
+ Return the region corresponding to the code/list-of-codes passed in as argument. The code(s) are the same
+ as in the **DCW** option above.
+
 \textinput{common_opts/opt_box}
 
 - **G** or **land** : -- *land=fill*\

documentation/modules/grd2xyz.md

@@ -41,7 +41,7 @@ Optional Arguments
 
 \textinput{common_opts/opt_R}
 
-**T** or **stl** or **STL** : -- *STL=true* **|** *STL=[:b][base]*\
+- **T** or **stl** or **STL** : -- *STL=true* **|** *STL=[:b][base]*\
  Write STL triangulation for 3-D printing to standard output. By default we write an STL ASCII file.
  Append **b** to instead write the STL binary (little-endian) format. For more information on STL, see the
  [STL overview on Wikipedia](https://en.wikipedia.org/wiki/STL_(file_format)). **Note**: All coordinates are

documentation/modules/surface.md

@@ -109,7 +109,7 @@ Optional Arguments
  iteration; it is not worth the time unless the grid lattice is prime and cannot have
  regional stages. [Default = 0.0 and no search is made.]
 
-- **T** or **tension** :-- *tension=factor* **|** *search_radius="i|b_factor"*\
+- **T** or **tension** : -- *tension=factor* **|** *search_radius="i|b_factor"*\
  Tension factor[s]. These must be between 0 and 1. Tension may be used in the interior solution
  (above equation, where it suppresses spurious oscillations) and in the boundary conditions
  (where it tends to flatten the solution approaching the edges). Using zero for both values
@@ -131,6 +131,12 @@ Optional Arguments
  it is a good idea to monitor each iteration with the **verbose=:i** option. [Default = 1.4
  converges quickly and is almost always stable.]
 
+- **preproc** : -- *preproc=true* **|** *preproc="blockmedian|blockmode"*\
+
+ This option means that the data is previously passed through one of `block*` modules to decimate the data
+ in each cell as strongly advised. `preproc=true` will use ``blockmean``. To use any of the other two,
+ pass its name as value. *e.g.* `preproc="blockmedian"`.
+
 \textinput{common_opts/opt_a}
 
 \textinput{common_opts/opt_bi}

documentation/utilfuns.txt

@@ -15,6 +15,7 @@ geodetic2enu
 getbyattrib
 gmtread
 graticules
+gridit
 gunique
 hlines
 imagesc

examples/misc/mix_paper_geog.md

@@ -4,7 +4,7 @@ When we want to make annotations or draw additional symbols outside of a map in
 coordinates, we have a problem. Because the geographical coordinates are active one cannot
 plot outside of Earth. The solution is to define a larger cartesian frame and do the
 annotations using this new reference. To make this process simpler we use the option **paper**
-option that is available in the ``plot`` and ``text`` modules. This option sets and unsets
+option that is available in the ``plot``, ``text`` and ``colorbar`` modules. This option sets and unsets
 the temporary cartesian frame under the hood and we only have to care to use cm (or inch) as
 units.