link_image_data

jdaviz.configs.imviz.helper.link_image_data(app, link_type='pixels', wcs_fallback_scheme='pixels', wcs_use_affine=True, error_on_fail=False, update_plugin=True)

(Re)link loaded data in Imviz with the desired link type. All existing links will be replaced.

Note

Any markers added in Imviz will need to be removed manually before changing linking type. You can add back the markers using add_markers() for the relevant viewer(s).

Parameters:

appApplication

Application associated with Imviz, e.g., imviz.app.

link_type{‘pixels’, ‘wcs’}

Choose to link by pixels or WCS.

wcs_fallback_scheme{None, ‘pixels’}

If WCS linking failed, choose to fall back to linking by pixels or not at all. This is only used when link_type='wcs'. Choosing None may result in some Imviz functionality not working properly.

wcs_use_affinebool

Use an affine transform to represent the offset between images if possible (requires that the approximation is accurate to within 1 pixel with the full WCS transformations). If approximation fails, it will automatically fall back to full WCS transformation. This is only used when link_type='wcs'. Affine approximation is much more performant at the cost of accuracy.

error_on_failbool

If True, any failure in linking will raise an exception. If False, warnings will be emitted as snackbar messages. When only warnings are emitted and no links are assigned, some Imviz functionality may not work properly.

update_pluginbool

Whether to update the state of the “Links Control” plugin, if available.

Raises:

ValueError

Invalid inputs or reference data.