file_reader#

orix.io.plugins.ctf.file_reader(filename: str) → CrystalMap[source]#

Return a crystal map from a file in the Channel Text File (CTF) format.

The map in the input is assumed to be 2D.

Many vendors/programs can write a .ctf file. Files from the following vendors/programs are tested:

  • Oxford Instruments AZtec

  • Bruker Esprit

  • NanoMegas ASTAR Index

  • EMsoft (from program EMdpmerge)

  • MTEX

All points with a phase of 0 are classified as not indexed.

Parameters:
filename

Path to file.

Returns:
xmap

Crystal map.

Notes

Files written by MTEX do not contain information of the space group.

Files written by EMsoft have the column names for mean angular deviation (MAD), band contrast (BC), and band slope (BS) renamed to DP (dot product), OSM (orientation similarity metric), and IQ (image quality), respectively.

Description of error codes provided in CTF file: - 0: Success - 1: Low BC - 2: Low BS - 3: No solution - 4: High MAD - 5: Not yet analyzed (job cancelled before point) - 6: Unexpected error (exceptions etc.)