hpmcm.viz_utils module

hpmcm.viz_utils.showCluster(image, cluster, cell_data, mask=None)[source]

Draw a cluster

Return type:

Figure | SubFigure

Parameters:

  • image (ndarray) – Counts map used to make clusters

  • cluster (ClusterData) – Cluster being draw

  • cell_data (CellData) – Parent Cell for the cluster

  • mask (ndarray | None) – Mask showing which sources are in the cluster

Return type:

Figure showing the cluster in question

hpmcm.viz_utils.showObjects(image, cluster, cell_data)[source]

Draw a cluster, showing the objects

Return type:

Figure | SubFigure

Parameters:

  • image (ndarray) – Counts map used to make clusters

  • cluster (ClusterData) – Cluster being draw

  • cell_data (CellData) – Parent Cell for the cluster

  • mask – Mask showing which sources are in the cluster

Return type:

Figure showing the cluster in question

hpmcm.viz_utils.showObjectsV2(image, cluster, cell_data)[source]

Draw a cluster, showing the objects

Return type:

Figure | SubFigure

Parameters:

  • image (ndarray) – Counts map used to make clusters

  • cluster (ClusterData) – Cluster being draw

  • cell_data (CellData) – Parent Cell for the cluster

Return type:

Figure showing the cluster in question

hpmcm.viz_utils.showShearObj(matcher, i_k)[source]

Draw a single object

Return type:

Figure | SubFigure

Parameters:

  • matcher (Match) – Match object

  • i_k (tuple[int, int]) – Indices of the particular object

Return type:

Figure showing the object in question

hpmcm.viz_utils.showShearObjs(matcher, i_k)[source]

Draw the objects in a cluster

Return type:

Figure | SubFigure

Parameters:

  • matcher (Match) – Match object

  • i_k (tuple[int, int]) – Indices of the particular cluster

Return type:

Figure showing the cluster in question