Skip to main content

midas-plotting

Standard plots for MIDAS reconstructions.

from midas_plotting import read_mic, orientation_map, compare_maps

m = read_mic("sampleC_mr.2.mic")
print(m.summary())
orientation_map(m, space_group=225, cmin=0.3)
midas-plot sampleC.0.mic sampleC_sum3thr2.0.mic --kind orientation --cmin 0.3 \
    --titles "baseline|sum3+thr2" -o compare.png

Why

IPF colouring, .mic parsing and map plotting had been re-implemented in several one-off analysis scripts, each with its own conventions. Two things that kept going wrong and are now handled in one place:

  • Euler→RGB is not an orientation map. Two orientations a fraction of a degree apart can produce very different Euler triplets near gimbal lock, so a single grain renders as several colours. ipf_rgb colours by the crystal direction along a sample axis instead.
  • A permissive confidence cut fills the whole grid. The fit returns an orientation for every voxel it evaluates, so plotting at C ≥ 0.1 shows plausible microstructure whether or not material is there. orientation_map annotates the figure when asked to plot below TRUST_FLOOR (0.3).

Symmetry operators come from midas_stress; nothing is hand-listed here.

Implemented Laue families: cubic (SG 195–230) and hexagonal (168–194). Anything else raises rather than silently falling back to cubic.

Far-field (Grains.csv)

from midas_plotting import ff, read_grains

g = read_grains("Grains.csv")
print(len(g), g.space_group)        # symmetry is read from the file's header

ff.summary(g)                        # one-page overview
ff.grain_map(g, color="ipf")         # IPF-coloured grain centres
ff.ipf_legend(g.space_group)         # the colour key
ff.pole_figure(g, hkl=(1, 1, 1))
ff.strain_map(g, kind="vonmises")
midas-plot Grains.csv --kind summary -o overview.png
midas-plot Grains.csv --kind pole --hkl 1,1,1
midas-plot Grains.csv --kind strain --strain-kind hydrostatic

FF output is a grain list, not a voxel grid, so these are scatter and distribution plots. They are namespaced under ff rather than exported flat because both modalities have a grain_map and they mean different things: maps.grain_map labels a near-field voxel grid, ff.grain_map scatters far-field grain centres.

Things the module will not let you get wrong:

  • Symmetry comes from the file. Grains.csv states its space group in the preamble; the plots use it. Defaulting to cubic would colour a hexagonal sample with the wrong IPF triangle and produce a plausible, wrong figure.
  • Columns are read by name. Grains.csv has 53 columns (47 before 2026-08-21) and midas-fit-grain 0.5.6 shipped a cyclic rotation of three of them; a positional reader inherits that silently.
  • Euler angles are cross-checked against O11..O33. They describe the same orientation, so disagreement means the row is being sliced wrong — you get a warning instead of a wrong colour.
  • Strain is already microstrain. The eFab/eKen columns are not dimensionless; they are not rescaled.

Two caveats the plots cannot fix: FF grain positions are good to ~100 µm (not the six decimals the file prints), and GrainRadius is only correct with midas-process-grains >= 0.6.1.

Laue (solutions.txt, spots.txt)

from midas_plotting import laue, read_solutions, read_spots

sol = read_solutions("solutions.txt")     # one row per orientation PER FRAME
print(sol.summary())                      # ... 4,746 distinct orientations ...
sol = sol.gate(11)                        # the measured null for THAT scan

c = laue.cluster(sol, 1.0, space_group=194)
print(c)          # <GrainClusters 631 grains at 1.0deg (of 636 clusters,
                  #  5 spanning >half the map), n_eff 309.5>

reps = c.representatives(sol.orient_mat)  # one orientation per grain
laue.tilt_histogram(reps)                 # against the random reference
laue.texture_strength(reps)               # (peak, chance, peak/chance)
laue.summary(sol)
midas-plot solutions.txt --kind tilt --gate 11 --sg 194
midas-plot validated.npz --kind summary --sg 194 --tol 1.0

Laue output is neither a voxel grid nor a grain list: it is one row per orientation per frame, so a crystal seen at twenty positions appears twenty times. Nothing is a grain until it has been clustered, and every grain count here carries the tolerance that produced it.

Four things the module will not let you get wrong:

  • Half of a random population lies more than 60° from any fixed direction. That is solid angle, not texture. tilt_histogram draws random_tilt_fractions() beside the data by default, because "70% of grains lie near the surface plane" reads as a strong texture and is very nearly random — and 30% there is a depletion.
  • A raw pole density is not comparable between datasets. A small grain population peaks higher by chance alone, and its chance level rises to match. texture_strength returns the ratio to its own measured null, which is what makes 85 grains and 631 grains commensurable.
  • An orientation present at every raster position is not a grain. The beam moves a micron or two between frames. cluster flags anything spanning more than half the map; on one dataset a single such object held 59% of all measurements and dragged the effective sample size from 29 to 2.5. The Kish effective n sits next to every grain count for the same reason.
  • orientationRowNr is column 34 and misOrientationPostRefinement is 33. Reading 33 for 34 does not raise — it returns a near-zero float for every row, so distinct-orientation counts collapse to single digits and the scan looks like it found one crystal. Columns are read by name.

Geometry is explicit, never assumed: SURFACE_NORMAL_34IDE and the COS45 stage correction are module constants with 34-ID-E defaults, and every function takes normal=. The out-of-plane stage axis sits at 45°, so quoting its raw extent as a map size understates it by 1.41× — a 200 × 100 µm map reads as 200 × 71.

The acceptance gate has no default. It is the largest number of reflections a randomly oriented crystal achieves on those frames, it is a property of the scan, and midas-plot says so when you omit --gate rather than picking one.

Metadata

Release files for midas-plotting 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for midas-plotting 0.6.0
File Size Uploaded
midas_plotting-0.6.0.tar.gz 63.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for midas-plotting 0.6.0
File Interpreter ABI Platform
midas_plotting-0.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 113.5 kB

Release files / midas_plotting-0.6.0.tar.gz

Download URL midas_plotting-0.6.0.tar.gz
Size 63.1 kB
Tags Source
SHA-256 checksum
How to use checksums
4cd3f1b93ecd900d0c7ca0eab375d18b27b2f70be198b22f212619e979ae9727
BLAKE2b-256 checksum
How to use checksums
2c93090110392e643088868a6e2cb862a5bb1dae3a3308fbea57c18a30c2148c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

Release files / midas_plotting-0.6.0-py3-none-any.whl

Download URL midas_plotting-0.6.0-py3-none-any.whl
Size 50.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d5c0c8889ecd345688b5fc91ce819a6b62cd4678bf83ea682eb117fc0975216d
BLAKE2b-256 checksum
How to use checksums
cceb9bc07f3818c388c6d575f6d8f982843f5c045e6947cf3cbad67d018d207d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.6.0 This release

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page