SkillAgentSearch skills...

ORTools

A function library for OR discovery, OR analysis and the plotting of publication-ready figures of martensitic transformations or OR-related phase transitions in MTEX.

Install / Use

/learn @ORTools4MTEX/ORTools

README

UPDATES

GitHub last commit (branch) GitHub repo size GitHub Discussions GitHub issues


<div align = left> <img src="./doc/images/ORTools.png" alt="ORTools" width="300"/>

buttonIcon1

buttonIcon2     buttonIcon3

buttonIcon4         buttonIcon5

buttonIcon6       buttonIcon7

<!---------------------------------[ Buttons ]---------------------------------> <!---------------------------------[ Links ]--------------------------------->

Introduction to ORTools

matlab compatible GitHub top language

Orientation relationship tools (ORTools) is a function library for OR discovery, advanced OR analysis and the plotting of visually stunning and informative publication-ready figures particular to microstructures undergone partial/full martensitic transformation or OR-related phase transition.

The ORTools function library is written in MATLAB and is used as an add-on to the basic phase transformation functionalities within the MATLAB-based crystallographic toolbox MTEX. Due to their specific nature, the scripts contained in the ORTools library have not been included in MTEX. You may want to watch this talk by Frank Niessen at the 2021 MTEX Workshop for an introduction to the phase transformation features in MTEX and ORTools.

The advanced OR discovery, analysis and plotting functionalities of the ORTools library are highlighted in a series of example scripts that showcase how the functions work and what their output comprises.

To help maintain the ORTools library, please report any bugs you encounter in the discussions board. If you would like to contribute additional functionalities or wish to suggest new features that help improve it, please submit an issue or open a discussion.

ORTools - Short video introduction

A short introduction to ORTools


Authors and contributors

GitHub contributors

ORTools has been created by Dr Azdiar Gazder and Dr Frank Niessen.


Collaborators

Static Badge

Dr Tuomo Nyyssönen - Lath martensite block width calculator


How to cite ORTools

DOI

If you have applied the OR discovery, OR and variant analyses, parent grain reconstruction, and correlated plotting features of MTEX and ORTools to your research, please cite this open-access paper as your reference:

F. Niessen, T. Nyyssönen, A.A. Gazder, R. Hielscher, Parent grain reconstruction from partially and fully transformed microstructures in MTEX, Journal of Applied Crystallography: 55(1), pp. 180-194, 2022. (https://doi.org/10.1107/S1600576721011560)


How to use ORTools

GitHub forks GitHub Repo stars GitHub watchers GitHub followers

  • The ORTools library only works after the prior installation of MATLAB and MTEX.
    • Follow the instructions for installing MATLAB. ORTools is tested for compatibility from MATLAB 2016b onwards.
    • With each release of ORTools, please check exactly which version of MTEX it is compatible with.
  • Click on the weblinks to download either one of the following two combinations:
  • For instructions on installing MTEX and ORTools within MATLAB, please refer to the video given below.
  • The peak fitting functionality within the function defineORs requires the prior installation of the MATLAB Signal Processing Toolbox.
  • Open MATLAB and run one of the example files. Please refer to the Example 1 instruction video to learn how to run the examples. Alternatively, if you do not wish to run the example files and want to use the function library instead, please ensure that the ORTools root directory and all of its sub-directories are added to the MATLAB path.
  • If you encounter any problems, please submit an issue or open a discussion.
  • If you would like to contribute additional functionalities or wish to suggest new features, please submit a contribution or request a feature in the discussion.

ORTools - How to install MTEX

How to install MTEX


ORTools example scripts

The world of martensitic transformation or phase transition analysis can be difficult to navigate. To help make the analysis accessible, transparent, and easy to comprehend, the ORTools library consists of plug-and-play functions. Example scripts are provided to help demonstrate these functions in action.

It is possible to run the example scripts from start to end, but we encourage you to run the example scripts in sections to understand the correlation between the scripts and the generated results. This will also help you follow the comments, which provide instructions on the various choices to make in the interactive parts of the program and/or help explain the obtained plots and results. In this way, you will learn the syntax applied throughout the scripts as well as the meaning behind the presented results.


Example 10: 03 JUL 2023

<details> <summary><b>Update to Example 1: Parent grain reconstruction using the variant graph approach in lath martensite and child grain id analysis</b></summary>

This script follows the same dataset as that used in the official MTEX example to demonstrate the reconstruction of parent gamma grains from child alpha grains in a lath martensite microstructure. The computeGrainPairs function provides a direct way of calculating the absolute or normalised frequency and boundary segment lengths of grain pairs. The grain pair ids can be defined by the user for variants, crystallographic packets, Bain groups, any other-id type or for groups of id or equivalent id pairs.

[ORTools - Example 10](http://www.youtube.com/wa

Related Skills

View on GitHub
GitHub Stars44
CategoryDevelopment
Updated1mo ago
Forks11

Languages

MATLAB

Security Score

95/100

Audited on Feb 5, 2026

No findings