calibrain.metric_evaluation.get_subset_source_rr#

calibrain.metric_evaluation.get_subset_source_rr(lf_dict, *, to_mm=False)[source]#

Get subset-aligned source coordinates for EMD and other source-space metrics.

Parameters:
  • lf_dict (dict) –

    Output of extract_subset_leadfield(…), containing:
    • ”fwd”

    • ”subset_idx”

  • to_mm (bool) – If True, return coordinates in millimeters. Otherwise return coordinates in meters (MNE default).

Returns:

coords_subset – Source coordinates aligned exactly with lf_dict[“subset_idx”] and therefore with the source ordering used in L_flat and L_block.

Return type:

ndarray, shape (N, 3)

Notes

  • This helper uses the used-source ordering in the forward solution:

    [left hemisphere used sources, right hemisphere used sources]

  • This matches how subset_idx is constructed inside extract_subset_leadfield(…).

  • The same helper works for fixed, free_eeg, and free_meg, because subset_idx is source-level, not coefficient-level.