tools.maximum_info¶
-
maximum_info
(maxima, n, mapp, nmax=None)[source]¶ Show a plot with a maximum and some information about it.
Utility function to easily view the basic propierties of a specific maximum.
- Parameters
maxima (pd.DataFrame) – Pandas DataFrame with the information of the maxima. Has to contain at least the columns ‘Pixel number’ and ‘Intensity’. If it contains ‘pvalue’, it will use it. Otherwise, the p-value will be set to
np.nan
.n (int) – Row of the
maxima
with the information of the maximum to be shown.mapp (np.ndarray) – Healpix map to be shown in the image.
nmax (int or None, optional) – Total number of maxima detected in the map. If
None
is introduced, it uses the length of themaxima
table. Since this can affect the results (ifmaxima
does not contain all the maxima), the lines affected are colored grey and the function raises a warning.
- Returns
Figure containing the information about the maximum.
- Return type
matplotlib.figure.Figure