plot_objects_sharing_sources#
- lsst.analysis.ap.plot_objects_sharing_sources(diaObjectId, sources1, sources2, objects1, objects2, butler, *, max_distance_arcsec=None, output_path=None, display_figure=True, column_labels=('run 1', 'run 2'), figsize_per_row=4.0, size=51, image_type='difference', image_datasets={'difference': 'difference_image', 'science': 'preliminary_visit_image', 'template': 'template_detector'}, marker_size=80, marker_symbol='o', palette=('lime', 'red', 'cyan', 'magenta', 'yellow', 'orange', 'deepskyblue', 'pink', 'white', 'violet', 'gold', 'lightgreen'), source_marker_size=80, current_source_marker_size=180, current_source_color='yellow')#
Two-column cutout figure comparing the run-1 and run-2 views of an association cluster.
Calls
find_objects_sharing_sourcesinternally to identify the cluster of diaSources and diaObjects reachable from the inputdiaObjectId, then renders one row per diaSource in the cluster. The same cutout image is loaded once per row and drawn into both columns: the left panel is overlaid with run-1 diaObject markers (fromobjects1) and the right panel with run-2 diaObject markers (fromobjects2). Each column’s diaObjects get their own palette mapping, so the same color in the left and right columns does not imply the same diaObject.Parameters#
- diaObjectId
int Starting diaObjectId for the cluster walk.
- sources1, sources2, objects1, objects2
pandas.DataFrame Forwarded to
find_objects_sharing_sources.- butler
lsst.daf.butler.Butler Butler used to fetch the cutout images. The same image backs both panels of a given row.
- max_distance_arcsec
float, optional Forwarded to
find_objects_sharing_sources.- output_path
str, optional Filename to write the combined figure to as a PNG. Parent directories are created if missing.
- display_figure
bool, optional If True, display the figure inline (notebook).
- column_labelspair of
str, optional Labels appended to each cutout’s title to identify the column.
- figsize_per_row
float, optional Height in inches allocated to each cutout row.
- All other kwargs:
Forwarded to the cutout renderer; same meaning as in
plot_cutouts_with_object_markers.
Returns#
- sources, related_objects1, related_objects2
pandas.DataFrame The catalogs returned by
find_objects_sharing_sources.
- diaObjectId