utils.jl

Author: boriskaus

docs/src/man/Tutorial_AlpineData.md

@@ -363,10 +363,10 @@ nothing #hide
 At this stage we have the 3D velocity components on a grid. Yet, we don't have information yet about the elevation of the stations (as the provided data set did not give this).
 We could ignore that and set the elevation to zero, which would allow saving the data directly.
 Yet, a better way is to load the topographic map of the area and interpolate the elevation to the velocity grid.
-As we have already the loaded the topographic map in section 1 of this tutorial, we can simply reuse it. To interpolate, we will use the function `interpolateDataFields2D`
+As we have already the loaded the topographic map in section 1 of this tutorial, we can simply reuse it. To interpolate, we will use the function `interpolate_datafields_2D`
 
 ```julia
-topo_v, fields_v = interpolateDataFields2D(Topo, Lon, Lat)
+topo_v, fields_v = interpolate_datafields_2D(Topo, Lon, Lat)
 ```
 
 The variable we are interested in is the variable `topo_v`. `fields_v` contains the interpolation of all the fields in `Topo` to the new grid and we only keep it here for completeness.

docs/src/man/Tutorial_Basic.md

@@ -76,10 +76,10 @@ Note that I use the `Oleron` scientific colormap for the tomography which you ca
 
 ### 2. Extract subset of data
 As you can see the tomographic data covers a much larger area than the Alps itself, and in most of that area there is no data.
-It is thus advantageous to cut out a piece of the dataset that we are interested in which can be done with `extractSubvolume`:
+It is thus advantageous to cut out a piece of the dataset that we are interested in which can be done with `extract_subvolume`:
 
 ```julia
-Tomo_Alps = extractSubvolume(Tomo_Alps_full,Lon_level=(4,20),Lat_level=(36,50), Depth_level=(-600,-10))
+Tomo_Alps = extract_subvolume(Tomo_Alps_full,Lon_level=(4,20),Lat_level=(36,50), Depth_level=(-600,-10))
 
 write_Paraview(Tomo_Alps,"Tomo_Alps");
 ```
@@ -95,10 +95,10 @@ Which looks like:
 ### 3. Create cross sections
 Paraview has the option to `Slice` through the data but it is not very intuitive to do this in 3D. Another limitation of Paraview is that it does not have native support for spherical coordinates, and therefore the data is translated to cartesian (`x`,`y`,`z`) coordinates (with the center of the Earth at `(0,0,0)`).
 That makes this a bit cumbersome to make a cross-section at a particular location.
-If you are interested in this you can use the `crossSection` function:
+If you are interested in this you can use the `cross_section` function:
 
 ```julia
-data_200km = crossSection(Tomo_Alps, Depth_level=-200)
+data_200km = cross_section(Tomo_Alps, Depth_level=-200)
 ```
 
 ````
@@ -114,7 +114,7 @@ GeoData
 As you see, this is not exactly at 200 km depth, but at the closest `z`-level in the data sets. If you want to be exactly at 200 km, use the `Interpolate` option:
 
 ```julia
-data_200km_exact = crossSection(Tomo_Alps, Depth_level=-200, Interpolate=true)
+data_200km_exact = cross_section(Tomo_Alps, Depth_level=-200, Interpolate=true)
 ```
 
 ````
@@ -129,10 +129,10 @@ GeoData
 
 In general, you can get help info for all functions with `?`:
 ```julia
-help?> crossSection
-search: crossSection crossSectionVolume crossSectionPoints crossSectionSurface flattenCrossSection
+help?> cross_section
+search: cross_section cross_section_volume cross_section_points cross_section_surface flatten_cross_section
 
-  crossSection(DataSet::AbstractGeneralGrid; dims=(100,100), Interpolate=false, Depth_level=nothing, Lat_level=nothing, Lon_level=nothing, Start=nothing, End=nothing, Depth_extent=nothing, section_width=50km)
+  cross_section(DataSet::AbstractGeneralGrid; dims=(100,100), Interpolate=false, Depth_level=nothing, Lat_level=nothing, Lon_level=nothing, Start=nothing, End=nothing, Depth_extent=nothing, section_width=50km)
 
   Creates a cross-section through a GeoData object.
 
@@ -160,7 +160,7 @@ search: crossSection crossSectionVolume crossSectionPoints crossSectionSurface f
   julia> Data            =   Depth*2;                # some data
   julia> Vx,Vy,Vz        =   ustrip(Data*3),ustrip(Data*4),ustrip(Data*5);
   julia> Data_set3D      =   GeoData(Lon,Lat,Depth,(Depthdata=Data,LonData=Lon, Velocity=(Vx,Vy,Vz)));
-  julia> Data_cross      =   crossSection(Data_set3D, Depth_level=-100km)
+  julia> Data_cross      =   cross_section(Data_set3D, Depth_level=-100km)
   GeoData
     size  : (11, 11, 1)
     lon   ϵ [ 10.0 : 20.0]
@@ -172,7 +172,7 @@ search: crossSection crossSectionVolume crossSectionPoints crossSectionSurface f
 Let's use this to make a vertical cross-section as well:
 
 ```julia
-Cross_vert = crossSection(Tomo_Alps, Start=(5,47), End=(15,44))
+Cross_vert = cross_section(Tomo_Alps, Start=(5,47), End=(15,44))
 ```
 
 ````

docs/src/man/Tutorial_FaultDensity.md

@@ -82,12 +82,12 @@ Data_Faults         = GeoData(Lon3D,Lat3D,Faults,(Faults=Faults,))
 ```
 
 ## 2. Create Density Map
-Create a density map of the fault data. This is done with the `countMap` function. This function takes a specified field of a 2D `GeoData` struct and counts the entries in all control areas which are defined by steplon (number of control areas in lon direction) and steplat (number of control areas in lat direction). The field should only consist of 0.0 and 1.0 and the steplength. The final result is normalized by the highest count.
+Create a density map of the fault data. This is done with the `countmap` function. This function takes a specified field of a 2D `GeoData` struct and counts the entries in all control areas which are defined by steplon (number of control areas in lon direction) and steplat (number of control areas in lat direction). The field should only consist of 0.0 and 1.0 and the steplength. The final result is normalized by the highest count.
 
 ```julia
 steplon  = 188
 steplat  = 104
-cntmap   = countMap(Data_Faults,"Faults",steplon,steplat)
+cntmap   = countmap(Data_Faults,"Faults",steplon,steplat)
 ```
 
 Plot the density map with coastlines
@@ -103,7 +103,7 @@ Plot this using `Plots.jl`:
 
 ```julia
 heatmap(lon,lat,coastlinesEurope',colormap=cgrad(:gray1,rev=true),alpha=1.0);
-heatmap!(lon,lat,cntmap.fields.countMap[:,:,1]',colormap=cgrad(:batlowW,rev=true),alpha = 0.8,legend=true,title="Fault Density Map Europe",ylabel="Lat",xlabel="Lon")
+heatmap!(lon,lat,cntmap.fields.countmap[:,:,1]',colormap=cgrad(:batlowW,rev=true),alpha = 0.8,legend=true,title="Fault Density Map Europe",ylabel="Lat",xlabel="Lon")
 ```
 
 ![tutorial_Fault_Map](../assets/img/FaultDensity.png)

docs/src/man/Tutorial_Jura.md

@@ -186,7 +186,7 @@ below = belowSurface(CrossSection_1_cart, TopoGeology_cart)
 We can add that to the cross-section with:
 
 ```julia
-CrossSection_1_cart = addField(CrossSection_1_cart,"rocks",Int64.(below))
+CrossSection_1_cart = addfield(CrossSection_1_cart,"rocks",Int64.(below))
 ```
 
 Note that we transfer the boolean to an integer
@@ -204,13 +204,13 @@ The result looks like:
 
 ## 3. Geological block model
 Yet, if you want to perform a numerical simulation of the Jura, it is more convenient to rotate the maps such that we can perform a simulation perpendicular to the strike of the mountain belt.
-This can be done with `rotateTranslateScale`:
+This can be done with `rotate_translate_scale`:
 
 ```julia
 RotationAngle = -43
-TopoGeology_cart_rot    = rotateTranslateScale(TopoGeology_cart, Rotate=RotationAngle)
-Basement_cart_rot       = rotateTranslateScale(Basement_cart, Rotate=RotationAngle)
-CrossSection_1_cart_rot = rotateTranslateScale(CrossSection_1_cart, Rotate=RotationAngle)
+TopoGeology_cart_rot    = rotate_translate_scale(TopoGeology_cart, Rotate=RotationAngle)
+Basement_cart_rot       = rotate_translate_scale(Basement_cart, Rotate=RotationAngle)
+CrossSection_1_cart_rot = rotate_translate_scale(CrossSection_1_cart, Rotate=RotationAngle)
 ```
 
 Next, we can create a new computational grid that is more conveniently oriented:
@@ -226,8 +226,8 @@ ComputationalGrid  =  CartData(xyzGrid(x,y,z))
 Re-interpolate the rotated to the new grid:
 
 ```julia
-GeologyTopo_comp_surf = interpolateDataFields2D(TopoGeology_cart_rot, ComputationalSurf, Rotate=RotationAngle)
-Basement_comp_surf    = interpolateDataFields2D(Basement_cart_rot,    ComputationalSurf, Rotate=RotationAngle)
+GeologyTopo_comp_surf = interpolate_datafields_2D(TopoGeology_cart_rot, ComputationalSurf, Rotate=RotationAngle)
+Basement_comp_surf    = interpolate_datafields_2D(Basement_cart_rot,    ComputationalSurf, Rotate=RotationAngle)
 ```
 
 Next we can use the surfaces to create a 3D block model.
@@ -254,8 +254,8 @@ Phases[id] .= 2
 Add to the computational grid:
 
 ```julia
-ComputationalGrid = addField(ComputationalGrid,"Phases", Phases)
-ComputationalGrid = removeField(ComputationalGrid,"Z")
+ComputationalGrid = addfield(ComputationalGrid,"Phases", Phases)
+ComputationalGrid = removefield(ComputationalGrid,"Z")
 ```
 
 Save the surfaces, cross-section and the grid:

docs/src/man/Tutorial_LaPalma.md

@@ -140,7 +140,7 @@ Phases[ind] .= 3 #Magma
 Add rocktypes to the grid:
 
 ```julia
-Grid_3D = addField(Grid_3D,"Phases",Phases)
+Grid_3D = addfield(Grid_3D,"Phases",Phases)
 ```
 
 We can save this to paraview format

docs/src/man/Tutorial_NumericalModel_2D.md

@@ -59,7 +59,7 @@ addBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 0.0), phase = ConstantP
 Add them to the `CartData` dataset:
 
 ```julia
-Grid2D = addField(Grid2D,(;Phases, Temp))
+Grid2D = addfield(Grid2D,(;Phases, Temp))
 ```
 
 ````
@@ -107,7 +107,7 @@ addBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 0.0), phase = lith, Dip
 Which looks like:
 
 ```julia
-Grid2D = addField(Grid2D,(;Phases, Temp))
+Grid2D = addfield(Grid2D,(;Phases, Temp))
 write_Paraview(Grid2D,"Grid2D_SubductionMechanicalLayered");
 ```
 
@@ -131,7 +131,7 @@ addBox!(Phases, Temp, Grid2D; xlim=(0,300), zlim=(-80.0, 0.0), phase = lith, T =
 Which looks like:
 
 ```julia
-Grid2D = addField(Grid2D,(;Phases, Temp))
+Grid2D = addfield(Grid2D,(;Phases, Temp))
 write_Paraview(Grid2D,"Grid2D_SubductionHalfspaceCooling");
 ```
 
@@ -174,7 +174,7 @@ We can set the mantle lithosphere that is hotter > 1250 C to mantle:
 ind = findall(Temp .> 1250 .&& Phases .==2);
 Phases[ind] .= 0;
 
-Grid2D = addField(Grid2D,(;Phases, Temp))
+Grid2D = addfield(Grid2D,(;Phases, Temp))
 write_Paraview(Grid2D,"Grid2D_SubductionRidge");
 ```
 
@@ -213,7 +213,7 @@ Lithosphere-asthenosphere boundary:
 ind = findall(Temp .> 1250 .&& Phases .==2);
 Phases[ind] .= 0;
 
-Grid2D = addField(Grid2D,(;Phases, Temp))
+Grid2D = addfield(Grid2D,(;Phases, Temp))
 write_Paraview(Grid2D,"Grid2D_SubductionOverriding");
 ```
 
@@ -250,7 +250,7 @@ addSlab!(Phases, Temp, Grid2D, trench, phase = ConstantPhase(1));
 Add them to the `CartData` dataset:
 
 ```julia
-Grid2D = addField(Grid2D,(;Phases, Temp))
+Grid2D = addfield(Grid2D,(;Phases, Temp))
 write_Paraview(Grid2D,"Grid2D_SubductionCurvedMechanical");
 ```
 
@@ -330,7 +330,7 @@ Lithosphere-asthenosphere boundary:
 ind = findall(Temp .> 1250 .&& (Phases.==2 .|| Phases.==5));
 Phases[ind] .= 0;
 
-Grid2D = addField(Grid2D,(;Phases, Temp))
+Grid2D = addfield(Grid2D,(;Phases, Temp))
 write_Paraview(Grid2D,"Grid2D_SubductionCurvedOverriding");
 ```
 

docs/src/man/Tutorial_NumericalModel_3D.md

@@ -59,7 +59,7 @@ addBox!(Phases, Temp, Grid; xlim=(0,300), ylim=(-400, 400.0), zlim=(-80.0, 0.0),
 Add them to the `CartData` dataset:
 
 ```julia
-Grid = addField(Grid,(;Phases, Temp))
+Grid = addfield(Grid,(;Phases, Temp))
 ```
 
 ````
@@ -162,7 +162,7 @@ addStripes!(Phases, Grid; stripAxes = (1,1,0), phase = ConstantPhase(0), stripeP
 Finally, we can add all this to the `CartData` dataset:
 
 ```julia
-Grid = addField(Grid,(;Phases, Temp))
+Grid = addfield(Grid,(;Phases, Temp))
 write_Paraview(Grid,"Grid3D_Ridges");
 ```
 

docs/src/man/Tutorial_Votemaps.md

@@ -44,7 +44,7 @@ PSwave_Koulakov
   fields: (:dVp_percentage, :dVs_percentage)
 ```
 
-#### 2. Creating a voteMap
+#### 2. Creating a votemap
 The idea of `Votemaps` is rather simple:
 - assume that a certain perturbation describes a feature (say, P wave anomalies >3% are interpreted to be slabs in the model of Paffrath)
 - Everything that fulfills this criteria gets the number 1, everything else 0.
@@ -59,7 +59,7 @@ So how do we create Votemaps?
 Doing this is rather simple:
 
 ```julia
-Data_VoteMap = voteMap( [Pwave_Paffrath,       PSwave_Koulakov,    Pwave_Zhao],
+Data_VoteMap = votemap( [Pwave_Paffrath,       PSwave_Koulakov,    Pwave_Zhao],
                         ["dVp_Percentage>3.0","dVp_percentage>2.0","dVp_Percentage>2.0"], dims=(100,100,100))
 ```
 
@@ -72,7 +72,7 @@ GeoData
   lon   ϵ [ 4.0 : 18.0]
   lat   ϵ [ 38.0 : 49.01197604790419]
   depth ϵ [ -606.0385 km : -10.0 km]
-  fields: (:voteMap,)
+  fields: (:votemap,)
 ```
 
 And from this, we can generate profiles, visualize 3D features in Paraview etc. etc.
@@ -88,7 +88,7 @@ You can ofcourse argue that newer tomographic models include more data & should
 A simple way to take that into account is to list the model twice:
 
 ```julia
-Data_VoteMap = voteMap( [Pwave_Paffrath,       Pwave_Paffrath,       PSwave_Koulakov,    Pwave_Zhao],
+Data_VoteMap = votemap( [Pwave_Paffrath,       Pwave_Paffrath,       PSwave_Koulakov,    Pwave_Zhao],
                         ["dVp_Percentage>3.0","dVp_Percentage>3.0", "dVp_percentage>2.0","dVp_Percentage>2.0"],
                         dims=(100,100,100))
 ```

docs/src/man/profile_processing.md

@@ -9,7 +9,7 @@ The routines provided here have the following functionality:
 ```@docs
 load_GMG
 save_GMG
-crossSection
+cross_section
 ProfileData
 extractProfileData
 createProfileData

docs/src/man/tools.md

@@ -3,22 +3,22 @@
 We have a number of functions with which we can extract sub-data from a 2D or 3D `GeoData` structure.
 
 ```@docs
-crossSection
-extractSubvolume
-interpolateDataFields
-voteMap
-subtractHorizontalMean
+cross_section
+extract_subvolume
+interpolate_datafields
+votemap
+subtract_horizontalmean
 aboveSurface
 belowSurface
 interpolateDataOnSurface
-interpolateTopographyOnPlane
-parseColumns_CSV_File
-rotateTranslateScale!
+interpolate_topography_plane
+parse_columns_CSV
+rotate_translate_scale!
 pointData2NearestGrid
 convert2UTMzone
 convert2CartData
 projectCartData
 drape_on_topo
-lithostaticPressure!
-countMap
+lithostatic_pressure!
+countmap
 ```