Auto-crop referenced images to the minimum set by the polygon boundingbox. (#1591)

* Docstrings

* Call the getsize instead of repeating it.

* Fix bug when determining if arg2_is_table is true

* Auto-crop referenced images to the minimum set by the polygon boundingbox.

Author: joa-quim

src/grdcut.jl

@@ -93,10 +93,11 @@ end
 """
 crop(arg::GItype; kw...)
 
-Crop a subregion of a grid (GMTgrid) or a image (GMTimage). The subregion is specified with the
-``limits`` or ``region`` keyword; the specified range must not exceed the range of the input.
-This function differs from ``grdcut`` in the sense that it doesn't call the GMT lib and works only on
-in-memory array (i.e., no disk files).
+Crop a subregion of a grid (GMTgrid) or a image (GMTimage).
+
+The subregion is specified with the ``limits`` or ``region`` keyword; the specified range must not
+exceed the range of the input.  This function differs from ``grdcut`` in the sense that it doesn't
+call the GMT lib and works only on in-memory array (i.e., no disk files).
 
 ### Returns
 A grid or an image, depending on the input type, plus two 1x2 matrices with the indices of the cropped zone.

src/grdimage.jl

@@ -187,8 +187,8 @@ function common_insert_R!(d::Dict, O::Bool, cmd0, I_G; is3D=false)
 	end
 	(opt_R != "") && (CTRL.pocket_R[1] = " -R" * opt_R)
 end
-function isimgsize(GI)
-	width, height = (GI.layout != "" && GI.layout[2] == 'C') ? (size(GI,2), size(GI,1)) : (length(GI.x), length(GI.y)) .- GI.registration
+function isimgsize(GI)::Bool
+	width, height = getsize(GI)
 	(GI.range[2] - GI.range[1]) == width && (GI.range[4] - GI.range[3]) == height
 end
 

src/grdtrack.jl

@@ -7,7 +7,7 @@ interpolated values added as (one or more) new columns.
 When using two numeric inputs and no G option, the order of the x,y and grid is not important.
 That is, both of this will work: ``D = grdtrack([0 0], Grid);``  or  ``D = grdtrack(Grid, [0 0]);`` 
 
-To see the documentation type: ``@? grdtrack``
+To see the documentation, type: ``@? grdtrack``
 """
 function grdtrack(cmd0::String="", arg1=nothing, arg2=nothing; kwargs...)
 
@@ -27,7 +27,7 @@ function grdtrack(cmd0::String="", arg1=nothing, arg2=nothing; kwargs...)
 	# Because we allow arg1 and arg2 to either exist or not and also contain data & grid in any order
 	if (arg1 !== nothing && arg2 !== nothing)
 		arg1_is_grid, arg1_is_fv = isa(arg1, GMTgrid), isa(arg1, GMTfv)
-		arg2_is_table = (isa(arg2, Array) || isa(arg2, GMTdataset) || isa(arg1, GMTfv))
+		arg2_is_table = (isa(arg2, Array) || isa(arg2, GMTdataset) || isa(arg2, GMTfv))
 		if (arg2_is_table && (arg1_is_grid || arg1_is_fv))			# Swap the arg1, arg2
 			arg1, arg2 = arg2, arg1
 		end
@@ -103,4 +103,4 @@ function parse_G_grdtrk(d::Dict, symbs::Vector{<:Symbol}, cmd::String, arg1, arg
 end
 
 # ---------------------------------------------------------------------------------------------------
-grdtrack(arg1, arg2=nothing; kw...) = grdtrack("", arg1, arg2; kw...)
+grdtrack(arg1, arg2=nothing; kw...) = isa(arg2, String) ? grdtrack(arg2, arg1; kw...) : grdtrack("", arg1, arg2; kw...)

src/solids.jl

@@ -725,12 +725,33 @@ viz(FV)
 """
 function flatfv(I::Union{GMTimage, AbstractString}; shape=:n, level=0.0)::GMTfv
 
+	function crop_if_possible(I::Union{GMTimage, AbstractString}, shape)
+		# If the image is referenced crop it to the 'shape's bounding box
+		if isa(I, AbstractString)
+			D = grdinfo(I, C=1)
+			isnoref = (D[2] - D[1] == D[9] && D[7] == 1) && (D[4] - D[3] == D[10] && D[8] == 1)
+		else
+			isnoref = isimgsize(I)		# A function from grdimage.jl
+		end
+		isnoref && return I				# A plain image with no coords
+	
+		x = extrema(view(shape, :, 1))	# xx minmax
+		y = extrema(view(shape, :, 2))
+		isa(I, AbstractString) && (x[1] < D[1] || x[2] > D[2] || y[1] < D[3] || y[2] > D[4]) &&
+			error("The 'shape' is outside the image.")
+		isa(I, GMTimage) && (x[1] < I.range[1] || x[2] > I.range[2] || y[1] < I.range[3] || y[2] > I.range[4]) &&
+			error("The 'shape' is outside the image.")
+	
+		return isa(I, AbstractString) ? gmtread(I, R=(x[1], x[2], y[1], y[2]), V=:q) : crop(I, R=(x[1], x[2], y[1], y[2]))
+	end
+
 	function forceRGB(I)::GMTimage{UInt8, 3}
 		I_ = isa(I, GMTimage) ? I : gmtread(I)::GMTimage
 		size(I_, 3) == 1 && (I_ = ind2rgb(I_))
 		return I_
 	end
 
+	I = crop_if_possible(I, shape)
 	_I = forceRGB(I)
 	n_cols::Int, n_rows::Int = getsize(_I)	# Works for both 'regular' and GDAL transposed images
 
@@ -784,6 +805,7 @@ function flatfv(I::Union{GMTimage, AbstractString}; shape=:n, level=0.0)::GMTfv
 	end
 
 	FV = surf2fv(X, Y, Z, type=:quad, mask=masca)
+	copyrefA2B!(_I, FV)
 	n_colors = doMask ? sum(masca) : (n_rows * n_cols)
 	cor = Vector{String}(undef, n_colors)