Skip to main content

alignment.plot_alignment_result

alignment.plot_alignment_result(
    result,
    brain_atlas,
    *,
    planned_xyz=None,
    histology_trace_xyz=None,
    features=DEFAULT_STRIPE_FEATURES,
    human_xyz=None,
    metrics=None,
    fig=None,
)

Draw an :class:~.result.AlignmentResult (see the module doc for the layout).

Args: result: The alignment result. brain_atlas: iblatlas.atlas.AllenAtlas. planned_xyz: [C, 3] planned channel positions (optional). histology_trace_xyz: The histology trace; defaults to the result’s trace for the histology methods. features: (name, label) pairs of the recorded vs predicted stripes. human_xyz: [C, 3] reference channel positions, drawn on the slices (offline evaluations only – a new recording has none). metrics: Scores to print in the title (offline evaluations only, e.g. from :func:~.metrics.alignment_metrics). fig: A matplotlib Figure to draw into (the GUI passes its canvas figure).

Returns: matplotlib.figure.Figure