update docu to MTEX 6.0

mtex-toolbox · Oct 5, 2024 · 55b72f5 · 55b72f5
1 parent 6b44c75
commit 55b72f5
Show file tree

Hide file tree

Showing 255 changed files with 11,479 additions and 2,993 deletions.
diff --git a/images/BoundaryProperties.png b/images/BoundaryProperties.png
diff --git a/images/BoundaryProperties_01.png b/images/BoundaryProperties_01.png
diff --git a/images/BoundaryProperties_02.png b/images/BoundaryProperties_02.png
diff --git a/images/BoundaryProperties_03.png b/images/BoundaryProperties_03.png
diff --git a/images/BoundaryProperties_04.png b/images/BoundaryProperties_04.png
diff --git a/images/BoundaryProperties_05.png b/images/BoundaryProperties_05.png
diff --git a/images/BoundaryProperties_06.png b/images/BoundaryProperties_06.png
diff --git a/images/BoundarySelect.png b/images/BoundarySelect.png
diff --git a/images/BoundarySelect_01.png b/images/BoundarySelect_01.png
diff --git a/images/BoundarySelect_02.png b/images/BoundarySelect_02.png
diff --git a/images/BoundarySelect_03.png b/images/BoundarySelect_03.png
diff --git a/pages/documentation_matlab/AngleDistributionFunction.html b/pages/documentation_matlab/AngleDistributionFunction.html
@@ -6,10 +6,22 @@
 folder: documentation
 toc: false
 ---
-    <html><head>
-      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-   <!--
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Angle Distribution Function</title><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.source" content="script_AngleDistributionFunction.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Misorientations/AngleDistributionFunction.m">
-    edit page</a></font><div><h1>Angle Distribution Function</h1></div></body></html>
+    -->
+<title>Angle Distribution Function</title>
+<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/">
+<meta name="DC.source" content="script_AngleDistributionFunction.m">
+</head>
+<body>
+<font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Misorientations/AngleDistributionFunction.m">
+    edit page</a></font>
+<div>
+<h1>Angle Distribution Function</h1>
+</div>
+</body>
+</html>
diff --git a/pages/documentation_matlab/AnisotropicTheory.html b/pages/documentation_matlab/AnisotropicTheory.html
@@ -6,13 +6,24 @@
 folder: documentation
 toc: false
 ---
-    <html><head>
-      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-   <!--
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Anisotropic Elasticity</title><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.source" content="script_AnisotropicTheory.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Elasticity/AnisotropicTheory.m">
-    edit page</a></font><div><!--introduction--><!--/introduction--><p>The linear theory of elasticity in anisotropic materials is essentially based on the fourth order stiffness tensor <code class="language-plaintext highlighter-rouge">C</code>. Such a tensor is represented in MTEX by a variable of type <a href="stiffnessTensor.stiffnessTensor.html"><code class="language-plaintext highlighter-rouge">stiffnessTensor</code></a>. Such a variable can either by set up using a symmetric 6x6 matrix or by importing it from an external file. The following examples does so for the stiffness tensor for Olivine</p>
+    -->
+<title>Anisotropic Elasticity</title>
+<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/">
+<meta name="DC.source" content="script_AnisotropicTheory.m">
+</head>
+<body>
+<font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Elasticity/AnisotropicTheory.m">
+    edit page</a></font>
+<div>
+<!--introduction-->
+<!--/introduction-->
+<p>The linear theory of elasticity in anisotropic materials is essentially based on the fourth order stiffness tensor <code class="language-plaintext highlighter-rouge">C</code>. Such a tensor is represented in MTEX by a variable of type <a href="stiffnessTensor.stiffnessTensor.html"><code class="language-plaintext highlighter-rouge">stiffnessTensor</code></a>. Such a variable can either by set up using a symmetric 6x6 matrix or by importing it from an external file. The following examples does so for the stiffness tensor for Olivine</p>
 {% highlight matlab %}
 % file name
 fname = fullfile(mtexDataPath,'tensor','Olivine1997PC.GPa');
@@ -37,7 +48,8 @@
      0     0     0     0    77     0
      0     0     0     0     0  78.7
 {% endhighlight %}
-<h2 id="2">Hooke's Law</h2><p>The stiffness tensor tensor of a material is defined as the stress the material experiences for a given strain</p>
+<h2 id="2">Hooke's Law</h2>
+<p>The stiffness tensor tensor of a material is defined as the stress the material experiences for a given strain</p>
 {% highlight matlab %}
 eps = strainTensor(diag([1,1.1,0.9]),cs)
 {% endhighlight %}
@@ -91,7 +103,8 @@ <h2 id="2">Hooke's Law</h2><p>The stiffness tensor tensor of a material is defin
 U =
    1.1783e+03
 {% endhighlight %}
-<h2 id="6">Young's Modulus</h2><p>Young's modulus is also known as the tensile modulus and measures the stiffness of elastic materials. It is computed for a specific direction <code class="language-plaintext highlighter-rouge">d</code> by the command <a href="stiffnessTensor.YoungsModulus.html">YoungsModulus</a>.</p>
+<h2 id="6">Young's Modulus</h2>
+<p>Young's modulus is also known as the tensile modulus and measures the stiffness of elastic materials. It is computed for a specific direction <code class="language-plaintext highlighter-rouge">d</code> by the command <a href="stiffnessTensor.YoungsModulus.html">YoungsModulus</a>.</p>
 {% highlight matlab %}
 d = vector3d.X;
 E = C.YoungsModulus(d)
@@ -125,7 +138,9 @@ <h2 id="6">Young's Modulus</h2><p>Young's modulus is also known as the tensile m
 {% endhighlight %}
 <center>
 {% include inline_image.html file="AnisotropicTheory_01.png" %}
-</center><h2 id="8">Linear Compressibility</h2><p>The linear compressibility is the deformation of an arbitrarily shaped specimen caused by an increase in hydrostatic pressure and can be described by a second rank tensor. Similar to the Young's modulus it can be computed by the command <a href="stiffnessTensor.linearCompressibility.html">linearCompressibility</a> for specific directions <code class="language-plaintext highlighter-rouge">d</code> or as a spherical function</p>
+</center>
+<h2 id="8">Linear Compressibility</h2>
+<p>The linear compressibility is the deformation of an arbitrarily shaped specimen caused by an increase in hydrostatic pressure and can be described by a second rank tensor. Similar to the Young's modulus it can be computed by the command <a href="stiffnessTensor.linearCompressibility.html">linearCompressibility</a> for specific directions <code class="language-plaintext highlighter-rouge">d</code> or as a spherical function</p>
 {% highlight matlab %}
 % compute as a spherical function
 beta = linearCompressibility(C)
@@ -148,7 +163,9 @@ <h2 id="6">Young's Modulus</h2><p>Young's modulus is also known as the tensile m
 {% endhighlight %}
 <center>
 {% include inline_image.html file="AnisotropicTheory_02.png" %}
-</center><h2 id="9">Poisson Ratio</h2><p>The rate of compression / decompression in a direction <code class="language-plaintext highlighter-rouge">n</code> normal to the pulling direction <code class="language-plaintext highlighter-rouge">p</code> is called Poisson ratio.</p>
+</center>
+<h2 id="9">Poisson Ratio</h2>
+<p>The rate of compression / decompression in a direction <code class="language-plaintext highlighter-rouge">n</code> normal to the pulling direction <code class="language-plaintext highlighter-rouge">p</code> is called Poisson ratio.</p>
 {% highlight matlab %}
 % the pulling direction
 p = vector3d.Z;
@@ -183,7 +200,9 @@ <h2 id="6">Young's Modulus</h2><p>Young's modulus is also known as the tensile m
 {% endhighlight %}
 <center>
 {% include inline_image.html file="AnisotropicTheory_03.png" %}
-</center><h2 id="12">Shear Modulus</h2><p>The shear modulus is TODO</p>
+</center>
+<h2 id="12">Shear Modulus</h2>
+<p>The shear modulus is TODO</p>
 {% highlight matlab %}
 % shear plane
 n = Miller(0,0,1,cs);
@@ -230,4 +249,9 @@ <h2 id="6">Young's Modulus</h2><p>Young's modulus is also known as the tensile m
 {% endhighlight %}
 <center>
 {% include inline_image.html file="AnisotropicTheory_04.png" %}
-</center><h2 id="14">Wave Velocities</h2><p>Since elastic compression and decompression is mechanics of waves traveling through a medium anisotropic compressibility causes also anisotropic waves speeds. The analysis of this anisotropy is explained in the section <a href="WaveVelocities.html">wave velocities</a>.</p></div></body></html>
+</center>
+<h2 id="14">Wave Velocities</h2>
+<p>Since elastic compression and decompression is mechanics of waves traveling through a medium anisotropic compressibility causes also anisotropic waves speeds. The analysis of this anisotropy is explained in the section <a href="WaveVelocities.html">wave velocities</a>.</p>
+</div>
+</body>
+</html>
diff --git a/pages/documentation_matlab/Annotations.html b/pages/documentation_matlab/Annotations.html
@@ -6,13 +6,25 @@
 folder: documentation
 toc: false
 ---
-    <html><head>
-      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-   <!--
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Annotations</title><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.source" content="script_Annotations.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Plotting/Annotations.m">
-    edit page</a></font><div><!--introduction--><!--/introduction--><h2 id="1">Colorbars</h2><p>Unlike the common MATLAB command <code class="language-plaintext highlighter-rouge">colorbar</code> the MTEX command <a href="mtexColorbar.html">mtexColorbar</a> allows you to add a colorbar to all subplots in a figure.</p>
+    -->
+<title>Annotations</title>
+<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/">
+<meta name="DC.source" content="script_Annotations.m">
+</head>
+<body>
+<font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Plotting/Annotations.m">
+    edit page</a></font>
+<div>
+<!--introduction-->
+<!--/introduction-->
+<h2 id="1">Colorbars</h2>
+<p>Unlike the common MATLAB command <code class="language-plaintext highlighter-rouge">colorbar</code> the MTEX command <a href="mtexColorbar.html">mtexColorbar</a> allows you to add a colorbar to all subplots in a figure.</p>
 {% highlight matlab %}
 % this defines some model ODFs
 cs = crystalSymmetry('-3m');
@@ -28,7 +40,8 @@
 {% endhighlight %}
 <center>
 {% include inline_image.html file="Annotations_01.png" %}
-</center><p>Executing the command <a href="mtexColorbar.html">mtexColorbar</a> twice deletes the colorbar. You can also have a horizontal colorbar at the bottom of the figure by setting the option <code class="language-plaintext highlighter-rouge">location</code> to <code class="language-plaintext highlighter-rouge">southOutside</code>. Further, we can set a title to the colorbar to describe the unit.</p>
+</center>
+<p>Executing the command <a href="mtexColorbar.html">mtexColorbar</a> twice deletes the colorbar. You can also have a horizontal colorbar at the bottom of the figure by setting the option <code class="language-plaintext highlighter-rouge">location</code> to <code class="language-plaintext highlighter-rouge">southOutside</code>. Further, we can set a title to the colorbar to describe the unit.</p>
 {% highlight matlab %}
 % delete vertical colorbar
 mtexColorbar
@@ -38,21 +51,25 @@
 {% endhighlight %}
 <center>
 {% include inline_image.html file="Annotations_02.png" %}
-</center><p>If color range is set to equal in an MTEX figure only one colorbar is added (see. <a href="ColorMaps.html">Color Coding</a>).</p>
+</center>
+<p>If color range is set to equal in an MTEX figure only one colorbar is added (see. <a href="ColorMaps.html">Color Coding</a>).</p>
 {% highlight matlab %}
 mtexColorbar       % delete colorbar
 setColorRange('equal'); % set equal color range to all plots
 mtexColorbar       % create a new colorbar
 {% endhighlight %}
 <center>
 {% include inline_image.html file="Annotations_03.png" %}
-</center><h2 id="4">Annotating Directions, Orientations, Fibers</h2><p>Pole figures and inverse pole figures are much better readable if they include specimen or crystal directions. Using the MTEX command <a href="annotate.html">annotate</a> one can easily add <a href="vector3d.vector3d.html">specimen coordinate axes</a> to a pole figure plot.</p>
+</center>
+<h2 id="4">Annotating Directions, Orientations, Fibers</h2>
+<p>Pole figures and inverse pole figures are much better readable if they include specimen or crystal directions. Using the MTEX command <a href="annotate.html">annotate</a> one can easily add <a href="vector3d.vector3d.html">specimen coordinate axes</a> to a pole figure plot.</p>
 {% highlight matlab %}
 annotate(zvector,'label',{'Z'},'BackgroundColor','w')
 {% endhighlight %}
 <center>
 {% include inline_image.html file="Annotations_04.png" %}
-</center><p>The command <a href="annotate.html">annotate</a> allows also to mark <a href="Miller.Miller.html">crystal directions</a> in inverse pole figures.</p>
+</center>
+<p>The command <a href="annotate.html">annotate</a> allows also to mark <a href="Miller.Miller.html">crystal directions</a> in inverse pole figures.</p>
 {% highlight matlab %}
 plotIPDF(odf,[xvector,zvector],'antipodal','marginx',10)
 mtexColorMap white2black
@@ -62,7 +79,8 @@
 {% endhighlight %}
 <center>
 {% include inline_image.html file="Annotations_05.png" %}
-</center><p>One can also mark specific orientations in pole figures or in inverse pole figures.</p>
+</center>
+<p>One can also mark specific orientations in pole figures or in inverse pole figures.</p>
 {% highlight matlab %}
 plotIPDF(odf,[xvector,zvector],'antipodal')
 mtexColorMap white2black
@@ -78,7 +96,8 @@
 {% endhighlight %}
 <center>
 {% include inline_image.html file="Annotations_06.png" %}
-</center><p>as well as in ODF plots</p>
+</center>
+<p>as well as in ODF plots</p>
 {% highlight matlab %}
 plot(odf,'sigma')
 mtexColorMap white2black
@@ -90,7 +109,8 @@
 {% endhighlight %}
 <center>
 {% include inline_image.html file="Annotations_07.png" %}
-</center><p>or orientation scatter plots</p>
+</center>
+<p>or orientation scatter plots</p>
 {% highlight matlab %}
 ori = odf.discreteSample(200);
 scatter(ori);
@@ -101,7 +121,9 @@
 {% endhighlight %}
 <center>
 {% include inline_image.html file="Annotations_08.png" %}
-</center><h2 id="9">Legends</h2><p>If you have multiple data in one plot then it makes sense to add a legend saying which color / symbol correspond to which data set. The key is to use the option <b>DisplayName</b> available for all plotting commands to include the resulting graphical object into the legend and give it a name.</p>
+</center>
+<h2 id="9">Legends</h2>
+<p>If you have multiple data in one plot then it makes sense to add a legend saying which color / symbol correspond to which data set. The key is to use the option <b>DisplayName</b> available for all plotting commands to include the resulting graphical object into the legend and give it a name.</p>
 {% highlight matlab %}
 plotPDF(odf,Miller({1,0,0},{1,1,1},cs))
 plot(ori,'MarkerFaceColor','k','MarkerEdgeColor','black','add2all',...
@@ -114,7 +136,8 @@
 {% endhighlight %}
 <center>
 {% include inline_image.html file="Annotations_09.png" %}
-</center><p>The following example compares the Fourier coefficients of the fibre ODF with the Fourier coefficients of an unimodal ODF.</p>
+</center>
+<p>The following example compares the Fourier coefficients of the fibre ODF with the Fourier coefficients of an unimodal ODF.</p>
 {% highlight matlab %}
 close all
 plotSpektra(FourierODF(odf,32),'DisplayName','Unimodal ODF')
@@ -126,11 +149,16 @@
 {% endhighlight %}
 <center>
 {% include inline_image.html file="Annotations_10.png" %}
-</center><p>Adding a Spherical Grid</p><p>Sometimes it is useful to have a spherical grid in your plot to make the projection easier to understand or if you need to know some angular relationships. For this reason, there is the option <b>grid</b>, which enables the grid and the option <b>grid_res</b>, which allows to specify the spacing of the grid lines.</p>
+</center>
+<p>Adding a Spherical Grid</p>
+<p>Sometimes it is useful to have a spherical grid in your plot to make the projection easier to understand or if you need to know some angular relationships. For this reason, there is the option <b>grid</b>, which enables the grid and the option <b>grid_res</b>, which allows to specify the spacing of the grid lines.</p>
 {% highlight matlab %}
 plotPDF(odf,[Miller(1,0,0,cs),Miller(0,0,1,cs)],'grid','grid_res',15*degree,'antipodal');
 mtexColorMap white2black
 {% endhighlight %}
 <center>
 {% include inline_image.html file="Annotations_11.png" %}
-</center></div></body></html>
+</center>
+</div>
+</body>
+</html>
diff --git a/pages/documentation_matlab/AxesAlignment.html b/pages/documentation_matlab/AxesAlignment.html
@@ -6,10 +6,24 @@
 folder: documentation
 toc: false
 ---
-    <html><head>
-      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-   <!--
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Axes Alignment</title><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.source" content="script_AxesAlignment.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Plotting/AxesAlignment.m">
-    edit page</a></font><div><!--introduction--><!--/introduction--><p>TODO</p></div></body></html>
+    -->
+<title>Axes Alignment</title>
+<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/">
+<meta name="DC.source" content="script_AxesAlignment.m">
+</head>
+<body>
+<font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Plotting/AxesAlignment.m">
+    edit page</a></font>
+<div>
+<!--introduction-->
+<!--/introduction-->
+<p>TODO</p>
+</div>
+</body>
+</html>
diff --git a/pages/documentation_matlab/AxisDistributionFunction.html b/pages/documentation_matlab/AxisDistributionFunction.html
@@ -6,10 +6,22 @@
 folder: documentation
 toc: false
 ---
-    <html><head>
-      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-   <!--
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Axis Distribution Function</title><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.source" content="script_AxisDistributionFunction.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Misorientations/AxisDistributionFunction.m">
-    edit page</a></font><div><h1>Axis Distribution Function</h1></div></body></html>
+    -->
+<title>Axis Distribution Function</title>
+<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/">
+<meta name="DC.source" content="script_AxisDistributionFunction.m">
+</head>
+<body>
+<font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Misorientations/AxisDistributionFunction.m">
+    edit page</a></font>
+<div>
+<h1>Axis Distribution Function</h1>
+</div>
+</body>
+</html>