data_import

Author: boriskaus

docs/src/man/Tutorial_Jura.md

@@ -41,7 +41,7 @@ upperright = [8.948117154811715, 47.781282316442606, 0.0]
 We can now import the map with the `Screensho_To_GeoData` function:
 
 ```julia
-Geology  = screenshotToGeoData("SchoriM_Encl_01_Jura-map_A1.png", lowerleft, upperright, fieldname=:geology_colors) # name should have "colors" in it
+Geology  = screenshot_to_GeoData("SchoriM_Encl_01_Jura-map_A1.png", lowerleft, upperright, fieldname=:geology_colors) # name should have "colors" in it
 ```
 
 You can "drape" this image on the topographic map with
@@ -89,7 +89,7 @@ As example, we use the cross-section
 download_data("https://zenodo.org/records/10726801/files/Schori_2020_Ornans-Miserey-v2_whiteBG.png", "Schori_2020_Ornans-Miserey-v2_whiteBG.png")
 Corner_LowerLeft = (5.92507, 47.31300, -2.0)
 Corner_UpperRight = (6.25845, 46.99550, 2.0)
-CrossSection_1 = screenshotToGeoData("Schori_2020_Ornans-Miserey-v2_whiteBG.png", Corner_LowerLeft, Corner_UpperRight) # name should have "colors" in it
+CrossSection_1 = screenshot_to_GeoData("Schori_2020_Ornans-Miserey-v2_whiteBG.png", Corner_LowerLeft, Corner_UpperRight) # name should have "colors" in it
 ```
 
 Note that we slightly modified the image to save it with a white instead of a transparent background

docs/src/man/dataimport.md

@@ -3,9 +3,9 @@
 We have a number of ways to import data, besides using any of the additional packages in julia to read files.
 
 ```@docs
-GeophysicalModelGenerator.screenshotToGeoData
-GeophysicalModelGenerator.screenshotToCartData
-GeophysicalModelGenerator.screenshotToUTMData
+GeophysicalModelGenerator.screenshot_to_GeoData
+GeophysicalModelGenerator.screenshot_to_CartData
+GeophysicalModelGenerator.screenshot_to_UTMData
 GeophysicalModelGenerator.importTopo
 GeophysicalModelGenerator.importGeoTIFF
 ```

docs/src/man/tutorial_GMT_Topography_GeologicalMap.md

@@ -51,10 +51,10 @@ At this step, only the topographic data is imported. Now we have to import the t
 julia> Corner_LowerLeft  = (lon_min, lat_min , 0.0)
 julia> Corner_UpperRight = (lon_max, lat_max , 0.0)
 ```
-and import the png file with the GMG function `screenshotToGeoData`:  
+and import the png file with the GMG function `screenshot_to_GeoData`:  
 
 ```julia
-julia> DataPNG = screenshotToGeoData(filename_geo, Corner_LowerLeft, Corner_UpperRight)
+julia> DataPNG = screenshot_to_GeoData(filename_geo, Corner_LowerLeft, Corner_UpperRight)
 ```
 
 Next, we drape the screenshot on the topographic map with `drape_on_topo`:

docs/src/man/tutorial_Screenshot_To_Paraview.md

@@ -43,7 +43,7 @@ Once this is done, and we saved the picture under `Lippitsch_Fig13a.png`, you ca
 
 ```julia
 julia> using GeophysicalModelGenerator
-julia> data_profile1 = screenshotToGeoData("Lippitsch_Fig13a.png",Corner_LowerLeft, Corner_UpperRight)
+julia> data_profile1 = screenshot_to_GeoData("Lippitsch_Fig13a.png",Corner_LowerLeft, Corner_UpperRight)
 Extracting GeoData from: Lippitsch_Fig13a.png
            └ Corners:         lon       lat       depth
               └ lower left  = (4.65   , 45.73  ,  -400.0 )
@@ -80,7 +80,7 @@ Corner_LowerLeft    =   ( 3.5, 43.0 , -150.0)
 Corner_UpperRight   =   (15.5, 50.0 , -150.0)
 Corner_LowerRight   =   (15.5, 43.0 , -150.0)
 Corner_UpperLeft    =   (3.5 , 50.0 , -150.0)
-data_Fig13_map      =   screenshotToGeoData("Fig13_mapview.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
+data_Fig13_map      =   screenshot_to_GeoData("Fig13_mapview.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
 write_Paraview(data_Fig13_map, "Lippitsch_Fig13_mapview")
 ```
 

src/data_import.jl

@@ -6,7 +6,7 @@
 
 using LightXML
 
-export screenshotToGeoData, screenshotToCartData, screenshotToUTMData, getlonlatdepthmag_QuakeML
+export screenshot_to_GeoData, screenshot_to_CartData, screenshot_to_UTMData, getlonlatdepthmag_QuakeML
 
 # import CSV data using standard library functions
 # here we assume that the data is indeed comma separated and that comments are preceded with a "#"
@@ -160,7 +160,7 @@ end
 
 
 """
-    screenshotToGeoData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing, Cartesian=false, UTM=false, UTMzone, isnorth=true, fieldname::Symbol=:colors)
+    screenshot_to_GeoData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing, Cartesian=false, UTM=false, UTMzone, isnorth=true, fieldname::Symbol=:colors)
 
 Take a screenshot of Georeferenced image either a `lat/lon`, `x,y` (if `Cartesian=true`) or in UTM coordinates (if `UTM=true`) at a given depth or along profile and converts it to a `GeoData`, `CartData` or `UTMData` struct, which can be saved to Paraview
 
@@ -170,7 +170,7 @@ The lower right and upper left corners can be specified optionally (to take non-
 
 *Note*: if your data is in `UTM` coordinates you also need to provide the `UTMzone` and whether we are on the northern hemisphere or not (`isnorth`).
 """
-function screenshotToGeoData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing, Cartesian=false, UTM=false, UTMzone=nothing, isnorth::Bool=true, fieldname::Symbol=:colors)
+function screenshot_to_GeoData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing, Cartesian=false, UTM=false, UTMzone=nothing, isnorth::Bool=true, fieldname::Symbol=:colors)
 
     img         =   load(filename)      # load image
 
@@ -287,30 +287,30 @@ end
 
 
 """
-    Data = screenshotToCartData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing)
+    Data = screenshot_to_CartData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing)
 
-Does the same as `screenshotToGeoData`, but returns a `CartData` structure
+Does the same as `screenshot_to_GeoData`, but returns a `CartData` structure
 """
-function screenshotToCartData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing, fieldname::Symbol=:colors)
+function screenshot_to_CartData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing, fieldname::Symbol=:colors)
 
 
     # first create a GeoData struct
-    Data_Cart = screenshotToGeoData(filename, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=Corner_LowerRight, Corner_UpperLeft=Corner_UpperLeft, Cartesian=true, fieldname=fieldname)
+    Data_Cart = screenshot_to_GeoData(filename, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=Corner_LowerRight, Corner_UpperLeft=Corner_UpperLeft, Cartesian=true, fieldname=fieldname)
 
     return Data_Cart
 
 end
 
 """
-    Data = screenshotToUTMData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing, UTMzone::Int64=nothing, isnorth::Bool=true, fieldname=:colors)
+    Data = screenshot_to_UTMData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing, UTMzone::Int64=nothing, isnorth::Bool=true, fieldname=:colors)
 
-Does the same as `screenshotToGeoData`, but returns for UTM data
+Does the same as `screenshot_to_GeoData`, but returns for UTM data
 Note that you have to specify the `UTMzone` and `isnorth`
 """
-function screenshotToUTMData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing, UTMzone::Int64=nothing, isnorth::Bool=true, fieldname::Symbol=:colors)
+function screenshot_to_UTMData(filename::String, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=nothing, Corner_UpperLeft=nothing, UTMzone::Int64=nothing, isnorth::Bool=true, fieldname::Symbol=:colors)
 
       # first create a GeoData struct
-      Data_UTM = screenshotToGeoData(filename, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=Corner_LowerRight, Corner_UpperLeft=Corner_UpperLeft, Cartesian=false, UTM=true, UTMzone=UTMzone, isnorth=isnorth, fieldname=fieldname)
+      Data_UTM = screenshot_to_GeoData(filename, Corner_LowerLeft, Corner_UpperRight; Corner_LowerRight=Corner_LowerRight, Corner_UpperLeft=Corner_UpperLeft, Cartesian=false, UTM=true, UTMzone=UTMzone, isnorth=isnorth, fieldname=fieldname)
       return Data_UTM
 end
 

test/test_data_import.jl

@@ -32,25 +32,25 @@ using GeophysicalModelGenerator
 filename            =   "test.png";             # fake png
 Corner_LowerLeft    =   (18.0, 51.0, -590.0)
 Corner_UpperRight   =   (9.0, 42.0,    0.0)
-data_Image          =   screenshotToGeoData(filename,Corner_LowerLeft, Corner_UpperRight)
+data_Image          =   screenshot_to_GeoData(filename,Corner_LowerLeft, Corner_UpperRight)
 @test data_Image.lon[1000] ≈ 17.592964824120603
 @test data_Image.lat[1000] ≈ 50.59296482412061
 @test Value(data_Image.depth[1000])==-590km
 @test write_Paraview(data_Image, "Profile_1")==nothing
 
 # test if we use a different name for the color dataset
-data_Image_newfieldname  =   screenshotToGeoData(filename,Corner_LowerLeft, Corner_UpperRight, fieldname=:fake)
+data_Image_newfieldname  =   screenshot_to_GeoData(filename,Corner_LowerLeft, Corner_UpperRight, fieldname=:fake)
 @test  keys(data_Image_newfieldname.fields)[1] == :fake
 
 # Test in CartData
-data_Image          =   screenshotToGeoData(filename,Corner_LowerLeft, Corner_UpperRight, Cartesian=true)
+data_Image          =   screenshot_to_GeoData(filename,Corner_LowerLeft, Corner_UpperRight, Cartesian=true)
 @test Value(data_Image.x[22]) == 18.0km
 @test Value(data_Image.y[22]) == 51.0km
 @test Value(data_Image.z[22]) ≈ -125.15151515151516km
 
 
 # Test in UTM zone [note that depth should be in m]
-data_Image          =   screenshotToGeoData(filename,Corner_LowerLeft, Corner_UpperRight, UTM=true, UTMzone=33, isnorth=true)
+data_Image          =   screenshot_to_GeoData(filename,Corner_LowerLeft, Corner_UpperRight, UTM=true, UTMzone=33, isnorth=true)
 @test data_Image.EW.val[22] == 18.0
 @test data_Image.NS.val[22] == 51.0
 @test Value(data_Image.depth[22]) ≈ -125.15151515151516m
@@ -61,20 +61,20 @@ Corner_LowerLeft    =   (2.0,  40.0, -15.0)
 Corner_UpperRight   =   (22.0, 51.0, -15.0)
 Corner_LowerRight   =   (20.0, 40.0, -15.0)
 Corner_UpperLeft    =   (0.0,  51.0, -15.0)
-data_Image          =   screenshotToGeoData(filename,Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight, Corner_UpperLeft=Corner_UpperLeft)
+data_Image          =   screenshot_to_GeoData(filename,Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight, Corner_UpperLeft=Corner_UpperLeft)
 @test data_Image.lon[1000]  ≈  2.814070351758794
 @test data_Image.lat[1000]  ≈ 40.00000000000001
 @test Value(data_Image.depth[1000])==-15km
 @test write_Paraview(data_Image, "MapView_1") == nothing
 
 # MapView in CartData
-data_Image          =   screenshotToCartData(filename,Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight, Corner_UpperLeft=Corner_UpperLeft)
+data_Image          =   screenshot_to_CartData(filename,Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight, Corner_UpperLeft=Corner_UpperLeft)
 @test Value(data_Image.x[22]) ≈ 0.42424242424242425km
 @test Value(data_Image.y[22]) ≈ 48.666666666666664km
 @test Value(data_Image.z[22]) ≈ -15km
 
 # MapView in UTMData
-data_Image          =   screenshotToUTMData(filename,Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight, Corner_UpperLeft=Corner_UpperLeft, UTMzone=33, isnorth=true)
+data_Image          =   screenshot_to_UTMData(filename,Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight, Corner_UpperLeft=Corner_UpperLeft, UTMzone=33, isnorth=true)
 @test data_Image.EW.val[22] ≈ 0.42424242424242425
 @test data_Image.NS.val[22] ≈ 48.666666666666664
 @test Value(data_Image.depth[22]) ≈ -15.0m

tutorials/Lippitsch_Screenshots.jl

@@ -12,53 +12,53 @@ using GeophysicalModelGenerator
 
 # Process cross-sections of Figure 13. Note that we estimated some of the lon/lat locations
 
-data_Fig13a         =   screenshotToGeoData("Lippitsch_Fig13a.png",( 4.65,45.73, -400.0), (17.23, 43.80, 0.0))
+data_Fig13a         =   screenshot_to_GeoData("Lippitsch_Fig13a.png",( 4.65,45.73, -400.0), (17.23, 43.80, 0.0))
 write_Paraview(data_Fig13a, "Lippitsch_Fig13a") 
 
-data_Fig13b         =   screenshotToGeoData("Lippitsch_Fig13b.png",( 5.51,51.53, -400.0), (12.04, 43.68 , 0.0))
+data_Fig13b         =   screenshot_to_GeoData("Lippitsch_Fig13b.png",( 5.51,51.53, -400.0), (12.04, 43.68 , 0.0))
 write_Paraview(data_Fig13b, "Lippitsch_Fig13b") 
 
-data_Fig13c         =   screenshotToGeoData("Lippitsch_Fig13c.png",(17.78,50.95, -400.0), (11.66, 43.68, 0.0))
+data_Fig13c         =   screenshot_to_GeoData("Lippitsch_Fig13c.png",(17.78,50.95, -400.0), (11.66, 43.68, 0.0))
 write_Paraview(data_Fig13c, "Lippitsch_Fig13c") 
 
 # Mapview images
 Corner_LowerLeft    =   ( 3.5, 43.0 , -150.0)
 Corner_UpperRight   =   (15.5, 50.0 , -150.0)
 Corner_LowerRight   =   (15.5, 43.0 , -150.0)
 Corner_UpperLeft    =   (3.5 , 50.0 , -150.0)
-data_Fig13_map      =   screenshotToGeoData("Fig13_mapview.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
+data_Fig13_map      =   screenshot_to_GeoData("Fig13_mapview.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
 write_Paraview(data_Fig13_map, "Lippitsch_Fig13_mapview") 
 
 Depth                   =   -90.0;
 Corner_LowerLeft        =   (Corner_LowerLeft[1],   Corner_LowerLeft[2],    Depth)
 Corner_UpperRight       =   (Corner_UpperRight[1],  Corner_UpperRight[2],   Depth)
 Corner_LowerRight       =   (Corner_LowerRight[1],  Corner_LowerRight[2],   Depth)
 Corner_UpperLeft        =   (Corner_UpperLeft[1],   Corner_UpperLeft[2],    Depth)
-data_Fig12_90km    =   screenshotToGeoData("Fig12_90km.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
+data_Fig12_90km    =   screenshot_to_GeoData("Fig12_90km.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
 write_Paraview(data_Fig12_90km, "Lippitsch_Fig12_90km") 
 
 Depth                   = -180.0;
 Corner_LowerLeft        =   (Corner_LowerLeft[1],   Corner_LowerLeft[2],    Depth)
 Corner_UpperRight       =   (Corner_UpperRight[1],  Corner_UpperRight[2],   Depth)
 Corner_LowerRight       =   (Corner_LowerRight[1],  Corner_LowerRight[2],   Depth)
 Corner_UpperLeft        =   (Corner_UpperLeft[1],   Corner_UpperLeft[2],    Depth)
-data_Fig12_180km   =   screenshotToGeoData("Fig12_180km.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
+data_Fig12_180km   =   screenshot_to_GeoData("Fig12_180km.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
 write_Paraview(data_Fig12_180km, "Lippitsch_Fig12_180km") 
 
 Depth                   = -300.0;
 Corner_LowerLeft        =   (Corner_LowerLeft[1],   Corner_LowerLeft[2],    Depth)
 Corner_UpperRight       =   (Corner_UpperRight[1],  Corner_UpperRight[2],   Depth)
 Corner_LowerRight       =   (Corner_LowerRight[1],  Corner_LowerRight[2],   Depth)
 Corner_UpperLeft        =   (Corner_UpperLeft[1],   Corner_UpperLeft[2],    Depth)
-data_Fig12_300km   =   screenshotToGeoData("Fig12_300km.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
+data_Fig12_300km   =   screenshot_to_GeoData("Fig12_300km.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
 write_Paraview(data_Fig12_300km, "Lippitsch_Fig12_300km") 
 
 Depth                   = -400.0;
 Corner_LowerLeft        =   (Corner_LowerLeft[1],   Corner_LowerLeft[2],    Depth)
 Corner_UpperRight       =   (Corner_UpperRight[1],  Corner_UpperRight[2],   Depth)
 Corner_LowerRight       =   (Corner_LowerRight[1],  Corner_LowerRight[2],   Depth)
 Corner_UpperLeft        =   (Corner_UpperLeft[1],   Corner_UpperLeft[2],    Depth)
-data_Fig12_400km   =   screenshotToGeoData("Fig12_400km.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
+data_Fig12_400km   =   screenshot_to_GeoData("Fig12_400km.png",Corner_LowerLeft, Corner_UpperRight, Corner_LowerRight=Corner_LowerRight,Corner_UpperLeft=Corner_UpperLeft)
 write_Paraview(data_Fig12_400km, "Lippitsch_Fig12_400km") 
 
 

tutorials/Tutorial_Jura.jl

@@ -24,7 +24,7 @@ lowerleft  = [4.54602510460251, 45.27456049638056, 0.0]
 upperright = [8.948117154811715, 47.781282316442606, 0.0]
 
 # We can now import the map with the `Screensho_To_GeoData` function:
-Geology  = screenshotToGeoData("SchoriM_Encl_01_Jura-map_A1.png", lowerleft, upperright, fieldname=:geology_colors) # name should have "colors" in it
+Geology  = screenshot_to_GeoData("SchoriM_Encl_01_Jura-map_A1.png", lowerleft, upperright, fieldname=:geology_colors) # name should have "colors" in it
 
 # You can "drape" this image on the topographic map with
 TopoGeology = drape_on_topo(Topo, Geology)
@@ -58,7 +58,7 @@ Basement = importGeoTIFF("BMes_Spline_longlat.tif", fieldname=:Basement, removeN
 download_data("https://zenodo.org/records/10726801/files/Schori_2020_Ornans-Miserey-v2_whiteBG.png", "Schori_2020_Ornans-Miserey-v2_whiteBG.png")
 Corner_LowerLeft = (5.92507, 47.31300, -2.0)
 Corner_UpperRight = (6.25845, 46.99550, 2.0)
-CrossSection_1 = screenshotToGeoData("Schori_2020_Ornans-Miserey-v2_whiteBG.png", Corner_LowerLeft, Corner_UpperRight) # name should have "colors" in it
+CrossSection_1 = screenshot_to_GeoData("Schori_2020_Ornans-Miserey-v2_whiteBG.png", Corner_LowerLeft, Corner_UpperRight) # name should have "colors" in it
 
 # Note that we slightly modified the image to save it with a white instead of a transparent background
 

tutorials/Tutorial_TopoGeological_PNG.jl

@@ -36,7 +36,7 @@ Corner_UpperRight   =   (17.0, 48.5 , 0.0)
 Corner_LowerLeft    =   ( lon_min, lat_min , 0.0)
 Corner_UpperRight   =   (lon_max, lat_max , 0.0)
 
-DataPNG = screenshotToGeoData(filename_geo, Corner_LowerLeft, Corner_UpperRight)
+DataPNG = screenshot_to_GeoData(filename_geo, Corner_LowerLeft, Corner_UpperRight)
 
 # 4. interpolate geological map data colors onto topo grid using nearest neighbor interpolation