Rename Within --> Crop (#1021)

* Rename Within --> Crop

* Update test/transforms.jl

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: juliohm

docs/src/transforms.md

@@ -176,15 +176,15 @@ viz(fig[1,2], disk)
 fig
 ```
 
-## Within
+## Crop
 
 ```@docs
-Within
+Crop
 ```
 
 ```@example transforms
 grid = CartesianGrid(10, 10)
-subgrid = grid |> Within(x=(1.5, 6.5), y=(3.5, 8.5))
+subgrid = grid |> Crop(x=(1.5, 6.5), y=(3.5, 8.5))
 
 fig = Mke.Figure(size = (800, 400))
 viz(fig[1,1], grid)

src/Meshes.jl

@@ -534,7 +534,7 @@ export
   Proj,
   LengthUnit,
   Shadow,
-  Within,
+  Crop,
   Repair,
   Bridge,
   LambdaMuSmoothing,

src/transforms.jl

@@ -96,7 +96,7 @@ include("transforms/stdcoords.jl")
 include("transforms/proj.jl")
 include("transforms/lengthunit.jl")
 include("transforms/shadow.jl")
-include("transforms/within.jl")
+include("transforms/crop.jl")
 include("transforms/repair.jl")
 include("transforms/bridge.jl")
 include("transforms/smoothing.jl")

src/transforms/within.jl renamed to src/transforms/crop.jl

@@ -3,7 +3,7 @@
 # ------------------------------------------------------------------
 
 """
-    Within(x=(xmin, xmax), y=(ymin, ymax), z=(zmin, zmax))
+    Crop(x=(xmin, xmax), y=(ymin, ymax), z=(zmin, zmax))
 
 Retain the domain geometries that intersect with `x` limits [`xmax`,`xmax`],
 `y` limits [`ymax`,`ymax`] and `z` limits [`zmin`,`zmax`] in length units
@@ -12,31 +12,31 @@ Retain the domain geometries that intersect with `x` limits [`xmax`,`xmax`],
 ## Examples
 
 ```julia
-Within(x=(2, 4))
-Within(x=(1u"km", 3u"km"))
-Within(y=(1.2, 1.8), z=(2.4, 3.0))
+Crop(x=(2, 4))
+Crop(x=(1u"km", 3u"km"))
+Crop(y=(1.2, 1.8), z=(2.4, 3.0))
 ```
 """
-struct Within{X,Y,Z} <: GeometricTransform
+struct Crop{X,Y,Z} <: GeometricTransform
   x::X
   y::Y
   z::Z
 end
 
-Within(; x=nothing, y=nothing, z=nothing) =
-  Within(isnothing(x) ? x : _aslen.(x), isnothing(y) ? y : _aslen.(y), isnothing(z) ? z : _aslen.(z))
+Crop(; x=nothing, y=nothing, z=nothing) =
+  Crop(isnothing(x) ? x : _aslen.(x), isnothing(y) ? y : _aslen.(y), isnothing(z) ? z : _aslen.(z))
 
-parameters(t::Within) = (; x=t.x, y=t.y, z=t.z)
+parameters(t::Crop) = (; x=t.x, y=t.y, z=t.z)
 
-function preprocess(t::Within, d::Domain)
+function preprocess(t::Crop, d::Domain)
   bbox = boundingbox(d)
   bbox₁ = _overlaps(1, t.x, bbox)
   bbox₂ = _overlaps(2, t.y, bbox₁)
   bbox₃ = _overlaps(3, t.z, bbox₂)
   indices(d, bbox₃)
 end
 
-function apply(t::Within, d::Domain)
+function apply(t::Crop, d::Domain)
   inds = preprocess(t, d)
   n = view(d, inds)
   n, nothing

test/transforms.jl

@@ -1638,21 +1638,20 @@
     @test r == SimpleMesh(f.(vertices(d)), topology(d))
   end
 
-  @testset "Within" begin
-    @test !isaffine(Within(x=(T(2), T(4))))
-    @test !TB.isrevertible(Within(x=(T(2), T(4))))
-    @test !TB.isinvertible(Within(x=(T(2), T(4))))
-    @test TB.parameters(Within(x=(T(2), T(4)))) == (x=(T(2) * u"m", T(4) * u"m"), y=nothing, z=nothing)
-    @test TB.parameters(Within(y=(T(2) * u"km", T(4) * u"km"))) ==
-          (x=nothing, y=(T(2) * u"km", T(4) * u"km"), z=nothing)
-    @test TB.parameters(Within(z=(2, 4))) == (x=nothing, y=nothing, z=(2.0u"m", 4.0u"m"))
-    @test_throws ArgumentError Within(x=(T(2) * u"°", T(4) * u"°"))
+  @testset "Crop" begin
+    @test !isaffine(Crop(x=(T(2), T(4))))
+    @test !TB.isrevertible(Crop(x=(T(2), T(4))))
+    @test !TB.isinvertible(Crop(x=(T(2), T(4))))
+    @test TB.parameters(Crop(x=(T(2), T(4)))) == (x=(T(2) * u"m", T(4) * u"m"), y=nothing, z=nothing)
+    @test TB.parameters(Crop(y=(T(2) * u"km", T(4) * u"km"))) == (x=nothing, y=(T(2) * u"km", T(4) * u"km"), z=nothing)
+    @test TB.parameters(Crop(z=(2, 4))) == (x=nothing, y=nothing, z=(2.0u"m", 4.0u"m"))
+    @test_throws ArgumentError Crop(x=(T(2) * u"°", T(4) * u"°"))
 
     # ---------
     # POINTSET
     # ---------
 
-    f = Within(x=(T(1.5), T(3.5)))
+    f = Crop(x=(T(1.5), T(3.5)))
     d = PointSet([cart(1, 0), cart(2, 1), cart(3, 1), cart(4, 0)])
     r, c = TB.apply(f, d)
     @test r == PointSet([cart(2, 1), cart(3, 1)])
@@ -1661,7 +1660,7 @@
     # GEOMETRYSET
     # ------------
 
-    f = Within(x=(T(1.5), T(3.5)))
+    f = Crop(x=(T(1.5), T(3.5)))
     t1 = Triangle(cart(0, 0), cart(1, 0), cart(0, 1))
     t2 = t1 |> Translate(T(2), T(2))
     t3 = t2 |> Translate(T(2), T(2))
@@ -1673,7 +1672,7 @@
     # CARTESIANGRID
     # --------------
 
-    f = Within(z=(T(1.5), T(4.5)))
+    f = Crop(z=(T(1.5), T(4.5)))
     d = cartgrid(10, 10, 10)
     r, c = TB.apply(f, d)
     @test r == CartesianGrid((10, 10, 4), cart(0, 0, 1), T.((1, 1, 1)))
@@ -1682,7 +1681,7 @@
     # RECTILINEARGRID
     # ----------------
 
-    f = Within(y=(T(3.5), T(6.5)))
+    f = Crop(y=(T(3.5), T(6.5)))
     d = convert(RectilinearGrid, cartgrid(10, 10))
     r, c = TB.apply(f, d)
     @test r == convert(RectilinearGrid, CartesianGrid((10, 4), cart(0, 3), T.((1, 1))))
@@ -1691,7 +1690,7 @@
     # STRUCTUREDGRID
     # ---------------
 
-    f = Within(x=(T(5.5), T(8.5)))
+    f = Crop(x=(T(5.5), T(8.5)))
     d = convert(StructuredGrid, cartgrid(10, 10))
     r, c = TB.apply(f, d)
     @test r == convert(StructuredGrid, CartesianGrid((4, 10), cart(5, 0), T.((1, 1))))
@@ -1700,7 +1699,7 @@
     # SIMPLEMESH
     # -----------
 
-    f = Within(x=(T(1.5), T(4.5)), y=(T(3.5), T(6.5)))
+    f = Crop(x=(T(1.5), T(4.5)), y=(T(3.5), T(6.5)))
     d = convert(SimpleMesh, cartgrid(10, 10))
     r, c = TB.apply(f, d)
     @test r == convert(SimpleMesh, CartesianGrid((4, 4), cart(1, 3), T.((1, 1))))