ChileanVirtualObservatory / acalib

Advanced Computing for Astronomy Library
http://acalib.readthedocs.io/en/latest/
GNU General Public License v3.0
7 stars 13 forks source link

Enhance description of `acalib.core.transform.fits_props` #71

Closed autopawn closed 6 years ago

autopawn commented 7 years ago
"""
Extracts properties information of the astronomical data cube.
Parameters
----------
img : numpy.ndarray
    Astronomical data cube.

Returns
-------
result : dict
    Dictionary with properties of the image: *centroid*, *major*, *minor*, *ratio*, *angle*, *area*, *img*, *clr*, *label*, *orig*.
"""

Doens't seem to be enough for this function that does a lot of things. Maybe describe each value of the output dictionary?