Skip to content

Add a detector-response tutorial (MTF and MCF) #10

Description

@TomaSusi

Gap: abtem/mtf.py (MTF) and abtem/mcf.py (DiagonalMCF) have zero documentation coverage — no tutorial, walkthrough mention, or example uses them.

Why it matters: Detector response directly affects quantitative comparison between simulated and experimental images; users comparing to real cameras need to know these exist and when to apply them.

Suggested content: A tutorial notebook (e.g. user_guide/tutorials/detector_response.ipynb) that:

  • explains what the modulation transfer function models and how to specify MTF(func=...) for a real camera;
  • shows DiagonalMCF (parameters like semiangle_cutoff, focal_spread, source_size) and how it differs from/complements the MTF;
  • applies both to a simple HRTEM or STEM simulation and compares against the ideal-detector result side by side.

From a docs coverage audit (July 2026) comparing the abTEM public API against documentation content.

🤖 Generated with Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions