Function test_compute_roi

pyxrf/core/tests/test_map_processing.py:1022–1072

Basic functionality of `_compute_roi` function

(dataset_params, add_pts_before, add_pts_after, use_snip)

@pytest.mark.parametrize("use_snip", [False, True])
# fmt: on
def test_compute_roi(dataset_params, add_pts_before, add_pts_after, use_snip):
    """Basic functionality of `_compute_roi` function"""

    ft = _FitXRFMapTesting(
        dataset_params=dataset_params,
        use_snip=use_snip,
        add_pts_before=add_pts_before,
        add_pts_after=add_pts_after,
    )

    n_pts = ft.n_spectrum_points
    energy_min, energy_max = 3.1, 12.2  # Energy range for the 'selected' data, keV
    energy_step = (energy_max - energy_min) / (n_pts - 1)

    # 'e_offset' - the offset for the 0th element of the array, not the selected range
    snip_param = {
        "e_offset": energy_min - energy_step * add_pts_before,
        "e_linear": energy_step,
        "e_quadratic": 0,
        "b_width": 2.0,
    }

    roi_dict = {
        "roi-1": (2.5, 3.5),  # Outside the range
        "roi-2": (3.5, 4.8),
        "roi-3": (5.2, 7.4),
        "roi-4": (6.0, 6.0),  # No data points
        "roi-5": (6.0, 5.5),  # No data points
        "roi-6": (10.1, 15.0),  # Outside the range
    }

    roi_bands = [_ for _ in roi_dict.values()]

    # We don't use autogenerated 'ft.snip_param', because we want to use specific
    #   values to make sure that computations are done correctly.

    data_out = _compute_roi(
        ft.data_input,
        data_sel_indices=ft.data_sel_indices,
        roi_bands=roi_bands,
        snip_param=snip_param,
        use_snip=use_snip,
    )

    roi_keys = list(roi_dict.keys())
    assert data_out.shape == (*ft.data_input.shape[0:2], len(roi_keys)), "Output data has unexpected shape"

    # Convert data from numpy array to dictionary
    data_out = {roi_keys[_]: data_out[:, :, _] for _ in range(len(roi_keys))}
    # Verify the dictionary
    ft.verify_roi_output(data_out=data_out, roi_dict=roi_dict, snip_param=snip_param)


@pytest.mark.usefixtures("_start_dask_client")