docu

mtex-toolbox · Dec 8, 2020 · 1f67eab · 1f67eab
1 parent 029438f
commit 1f67eab
Show file tree

Hide file tree

Showing 95 changed files with 265 additions and 231 deletions.
diff --git a/index.md b/index.md
@@ -13,7 +13,7 @@ scientists, geologists and mathematicians.
 
 ### News
 * MTEX Online Workshop 2021: ・ [Announcement](https://github.com/mtex-toolbox/mtex/discussions/519#discussioncomment-139964) ・ [Homepage](http://www-user.tu-chemnitz.de/~rahi/mtexWorkshop21) ・
-* MTEX 5.5.0 released: ・ [Download](https://github.com/mtex-toolbox/mtex/releases/download/mtex-5.5.0/mtex-5.5.0.zip) ・ [Release Notes](changelog.html) ・ [Installation](download) ・
+* MTEX 5.5.1 released: ・ [Download](https://github.com/mtex-toolbox/mtex/releases/download/mtex-5.5.1/mtex-5.5.1.zip) ・ [Release Notes](changelog.html) ・ [Installation](download) ・
 * MTEX GUI 2.4 by J. Hiscocks released: ・ [Download](https://www.researchgate.net/profile/Jessica_Hiscocks/publication/341722714_MTEX_GUI_3pt4-_An_updated_graphical_interface_for_MTEX/data/5ed1b00e299bf1c67d274ede/MTEX-GUI-3pt4.zip) ・ [Announcment](https://www.researchgate.net/publication/341722714_MTEX_GUI_3pt4-_An_updated_graphical_interface_for_MTEX) ・
 * New paper: [Gazing at crystal balls - electron backscatter diffraction indexing and cross correlation on the sphere](https://www-user.tu-chemnitz.de/~rahi/paper/gazingAtCrystalBalls.pdf)
 * New paper: [Denoising of Crystal Orientation Maps](https://www-user.tu-chemnitz.de/~rahi/paper/denoising.pdf)

diff --git a/pages/documentation_matlab/CrystalDirections.html b/pages/documentation_matlab/CrystalDirections.html
@@ -1,6 +1,6 @@
 ---
 title: Miller Indices
-last_updated: 20-Nov-2020
+last_updated: 08-Dec-2020
 sidebar: documentation_sidebar
 permalink: CrystalDirections.html
 folder: documentation
@@ -11,7 +11,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Miller Indices</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-11-20"><meta name="DC.source" content="script_CrystalDirections.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/CrystalGeometry/CrystalDirections.m">
+      --><title>Miller Indices</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-12-08"><meta name="DC.source" content="script_CrystalDirections.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/CrystalGeometry/CrystalDirections.m">
     edit page</a></font><div><!--introduction--><p>Miller indices are used to describe directions with respect to the crystal reference system.</p><!--/introduction--><h2 id="1">Crystal Lattice Directions</h2><p>Since lattice directions are always subject to a certain crystal reference frame, the starting point for any crystal direction is the definition of a variable of type <a href="crystalSymmetry.crystalSymmetry.html">crystalSymmetry</a>.</p>
 {% highlight matlab %}
 cs = crystalSymmetry('triclinic',[5.29,9.18,9.42],[90.4,98.9,90.1]*degree,...

diff --git a/pages/documentation_matlab/EBSDReferenceFrame.html b/pages/documentation_matlab/EBSDReferenceFrame.html
@@ -1,6 +1,6 @@
 ---
 title: Reference Frame Alignment
-last_updated: 20-Nov-2020
+last_updated: 08-Dec-2020
 sidebar: documentation_sidebar
 permalink: EBSDReferenceFrame.html
 folder: documentation
@@ -11,7 +11,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Reference Frame Alignment</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-11-20"><meta name="DC.source" content="script_EBSDReferenceFrame.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/EBSDAnalysis/EBSDReferenceFrame.m">
+      --><title>Reference Frame Alignment</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-12-08"><meta name="DC.source" content="script_EBSDReferenceFrame.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/EBSDAnalysis/EBSDReferenceFrame.m">
     edit page</a></font><div><!--introduction--><!--/introduction--><p>The most important difference between MTEX and many other EBSD software is that in MTEX the Euler angle reference is always the map reference frame. This mean the \(x\) and \(z\) axes of the map are exactly the rotation axes of the Euler angles.</p><p>In case the map coordinates and the Euler angles in your data are with respect to different reference frames it is highly recommendet to correct for this while importing the data into MTEX. This section explains in detail how to do this.</p><h2 id="2">On Sreen Orientation of the EBSD Map</h2><p>Many peoply are concerned when the images produced by MTEX are not aligned exactly as they are in their commercial software. It is indeed very important to understand exactly the alignment of you data. However, the important point is not whether a map is upside down on you screen or not. The important point is how your map alignes with the specimen, as we want to use the map to describe properties of the specimen.</p><p>There are basicaly two components in an EBSD data set that refers to the specimen reference frame: the spatial coordinates \(x\), \(y\) and the Euler angles \(\phi_1\), \(\Phi\), \(\phi_2\). To explain the difference have a look at the EDAX export dialog</p><p><center>
 {% include inline_image.html file="edax_coordinate_systems.png" %}
 </center></p><p>Here we have the axes \(x\) and \(y\) which describe how the map coordinates needs to be interpreted and the axes \(A_1\), \(A_2\), \(A_3\) which describe how the Euler angles, and in consequence, the pole figures needs to be interpreted. We see that in non of these settings the map reference system coincides with the Euler angle reference frame.</p><p>This situation is not specific to EDAX but occurs as well with EBSD data from Oxford or Bruker, all of them using different reference system alignments. For that reason MTEX stronly recommends to transform the data such that both map coordinates and Euler angles refer to the same coordinate system.</p><p>Doing this we have two choices:</p><div><ol><li>transfrom everything to the reference system \(x\), \(y\) using the option <code class="language-plaintext highlighter-rouge">'convertEuler2SpatialReferenceFrame'</code>. This will keep the map coordinates while changing the Euler angles</li><li>transfrom everything to the reference system \(A_1\), \(A_2\), \(A_3\) using the option <code class="language-plaintext highlighter-rouge">'convertSpatial2EulerReferenceFrame'</code>. This will keep the Euler angles while changing the map coordinates.</li></ol></div><p>In the case of EDAX data imported from an <code class="language-plaintext highlighter-rouge">*.ang</code> file we still need to specify the export option used by the EDAX software. This is done by the options <code class="language-plaintext highlighter-rouge">'setting 1'</code>, <code class="language-plaintext highlighter-rouge">'setting 2'</code>, <code class="language-plaintext highlighter-rouge">'setting 3'</code> or <code class="language-plaintext highlighter-rouge">'setting 4'</code>.</p><p>Since setting 2 is default for most EDAX exports a typical command for importing data from an ang file would look like this</p>

diff --git a/pages/documentation_matlab/GrainSmoothing.html b/pages/documentation_matlab/GrainSmoothing.html
@@ -1,6 +1,6 @@
 ---
 title: Grain Boundary Smoothing
-last_updated: 20-Nov-2020
+last_updated: 08-Dec-2020
 sidebar: documentation_sidebar
 permalink: GrainSmoothing.html
 folder: documentation
@@ -11,7 +11,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Grain Boundary Smoothing</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-11-20"><meta name="DC.source" content="script_GrainSmoothing.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/GrainBoundaries/GrainSmoothing.m">
+      --><title>Grain Boundary Smoothing</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-12-08"><meta name="DC.source" content="script_GrainSmoothing.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/GrainBoundaries/GrainSmoothing.m">
     edit page</a></font><div><!--introduction--><!--/introduction--><p>EBSD data is usually acquired on a regular grid. Hence, even over a finite number of grid points, all possible grain boundary directions can not be uniquely represented.  One way of overcoming this problem - and also allowing to compute grid-independent curvatures and grain boundary directions - is the interpolation of grain boundary coordinates using <a href="grain2d.smooth.html"><code class="language-plaintext highlighter-rouge">grains.smooth</code></a>.</p><p>Proper smoothing has an influence on measures such as total grain boundary length, grain boundary curvature, triple point angles or grain boundary directions among others.</p><p>While we used <a href="grain2d.smooth.html"><code class="language-plaintext highlighter-rouge">grains.smooth</code></a> before, here we will illustrate the different options.</p>
 {% highlight matlab %}
 mtexdata csl

diff --git a/pages/documentation_matlab/OrientationFibre.html b/pages/documentation_matlab/OrientationFibre.html
@@ -1,6 +1,6 @@
 ---
 title: Fibres of Orientations
-last_updated: 20-Nov-2020
+last_updated: 08-Dec-2020
 sidebar: documentation_sidebar
 permalink: OrientationFibre.html
 folder: documentation
@@ -11,7 +11,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Fibres of Orientations</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-11-20"><meta name="DC.source" content="script_OrientationFibre.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/CrystalOrientations/OrientationFibre.m">
+      --><title>Fibres of Orientations</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-12-08"><meta name="DC.source" content="script_OrientationFibre.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/CrystalOrientations/OrientationFibre.m">
     edit page</a></font><div><!--introduction--><!--/introduction--><p>A fibre in orientation space is essentially a line connecting two orientations and can be represented in MTEX by a single variable of type <a href="fibre.fibre.html">fibre</a>. To illustrate the definition of a fibre we first define <a href="orientation.cube.html"><code class="language-plaintext highlighter-rouge">cube</code></a> and <a href="orientation.goss.html"><code class="language-plaintext highlighter-rouge">goss</code></a> orientation</p>
 {% highlight matlab %}
 % define crystal and specimen symmetry

diff --git a/pages/documentation_matlab/PiezoElectricity.html b/pages/documentation_matlab/PiezoElectricity.html
@@ -1,6 +1,6 @@
 ---
 title: The Piezoelectricity Tensor
-last_updated: 20-Nov-2020
+last_updated: 08-Dec-2020
 sidebar: documentation_sidebar
 permalink: PiezoElectricity.html
 folder: documentation
@@ -11,7 +11,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>The Piezoelectricity Tensor</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-11-20"><meta name="DC.source" content="script_PiezoElectricity.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Tensors/PiezoElectricity.m">
+      --><title>The Piezoelectricity Tensor</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-12-08"><meta name="DC.source" content="script_PiezoElectricity.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/Tensors/PiezoElectricity.m">
     edit page</a></font><div><!--introduction--><!--/introduction--><p>In this chapter we discuss how to compute and visualize piezoellectirc properties. At first, let us import some piezoelectric contents for a quartz specimen.</p>
 {% highlight matlab %}
 CS = crystalSymmetry('32', [4.916 4.916 5.4054], 'X||a*', 'Z||c', 'mineral', 'Quartz');

diff --git a/pages/documentation_matlab/S2FunApproximationInterpolation.html b/pages/documentation_matlab/S2FunApproximationInterpolation.html
@@ -1,6 +1,6 @@
 ---
 title: Spherical Approximation and Interpolation
-last_updated: 20-Nov-2020
+last_updated: 08-Dec-2020
 sidebar: documentation_sidebar
 permalink: S2FunApproximationInterpolation.html
 folder: documentation
@@ -11,7 +11,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Spherical Approximation and Interpolation</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-11-20"><meta name="DC.source" content="script_S2FunApproximationInterpolation.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/SphericalFunctions/S2FunApproximationInterpolation.m">
+      --><title>Spherical Approximation and Interpolation</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-12-08"><meta name="DC.source" content="script_S2FunApproximationInterpolation.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/SphericalFunctions/S2FunApproximationInterpolation.m">
     edit page</a></font><div><!--introduction--><!--/introduction--><p>On this page, we want to cover the topic of function approximation from discrete values on the sphere. To simulate this, we have stored some nodes and corresponding function values which we can load. The csv-file contains the \(x\)-, \(y\)-, and \(z\)-component of the nodes and the function value in the fourth column. Lets import these data using the function <a href="vector3d.load.html"><code class="language-plaintext highlighter-rouge">load</code></a></p>
 {% highlight matlab %}
 fname = fullfile(mtexDataPath, 'vector3d', 'smiley.csv');

diff --git a/pages/documentation_matlab/SigmaSections.html b/pages/documentation_matlab/SigmaSections.html
@@ -1,6 +1,6 @@
 ---
 title: Sigma Sections
-last_updated: 20-Nov-2020
+last_updated: 08-Dec-2020
 sidebar: documentation_sidebar
 permalink: SigmaSections.html
 folder: documentation
@@ -11,7 +11,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Sigma Sections</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-11-20"><meta name="DC.source" content="script_SigmaSections.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/ODFAnalysis/SigmaSections.m">
+      --><title>Sigma Sections</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-12-08"><meta name="DC.source" content="script_SigmaSections.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/ODFAnalysis/SigmaSections.m">
     edit page</a></font><div><!--introduction--><!--/introduction--><p>Although \(\varphi_2\) sections are most common to represent orientation distribution functions they heavily suffer from geometrical distortions of the orientation space. Lets illustrate this at a simple example. The following \(\varphi_2\) sections represent a hexagonal ODF composod from several unimodal components</p>
 {% highlight matlab %}
 % the ODF is defined at the bottom of this script to be secret during the first read :)
@@ -39,9 +39,7 @@
 
 {% highlight plaintext %}
 ori1 = orientation  
-  size: 1 x 1
   crystal symmetry : Titanium (6/mmm, X||a*, Y||b, Z||c*)
-  specimen symmetry: 1
 
   Bunge Euler angles in degree
   phi1  Phi phi2 Inv.
@@ -54,9 +52,7 @@
 
 {% highlight plaintext %}
 ori2 = orientation  
-  size: 1 x 1
   crystal symmetry : Titanium (6/mmm, X||a*, Y||b, Z||c*)
-  specimen symmetry: 1
 
   Bunge Euler angles in degree
   phi1  Phi phi2 Inv.

diff --git a/pages/documentation_matlab/TiBetaReconstruction.html b/pages/documentation_matlab/TiBetaReconstruction.html
@@ -1,6 +1,6 @@
 ---
 title: Parent Beta Phase Reconstruction in Titanium Alloys
-last_updated: 20-Nov-2020
+last_updated: 08-Dec-2020
 sidebar: documentation_sidebar
 permalink: TiBetaReconstruction.html
 folder: documentation
@@ -11,7 +11,7 @@
    <!--
 This HTML was auto-generated from MATLAB code.
 To make changes, update the MATLAB code and republish this document.
-      --><title>Parent Beta Phase Reconstruction in Titanium Alloys</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-11-20"><meta name="DC.source" content="script_TiBetaReconstruction.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/PhaseTransistions/TiBetaReconstruction.m">
+      --><title>Parent Beta Phase Reconstruction in Titanium Alloys</title><meta name="generator" content="MATLAB 9.9"><link rel="schema.DC" href="http://purl.org/dc/elements/1.1/"><meta name="DC.date" content="2020-12-08"><meta name="DC.source" content="script_TiBetaReconstruction.m"></head><body><font size="2"><a href="https://github.com/mtex-toolbox/mtex/blob/develop/doc/PhaseTransistions/TiBetaReconstruction.m">
     edit page</a></font><div><!--introduction--><!--/introduction--><p>In this section we discuss parent grain reconstruction at the example of a titanium alloy. Lets start by importing a sample data set</p>
 {% highlight matlab %}
 mtexdata alphaBetaTitanium
@@ -51,10 +51,10 @@
 % reconstruct grains
 [grains,ebsd.grainId] = calcGrains(ebsd('indexed'),'threshold',1.5*degree,...
   'removeQuadruplePoints');
-grains = smooth(grains);
+grains = smooth(grains,1,'moveTriplePoints');
 
 % plot all alpha pixels
-region = [300 400 -500 -440];
+region = [299 401 -500 -440];
 plot(ebsd(alphaName),ebsd(alphaName).orientations,...
   'region',region,'micronbar','off','figSize','large');