pyuvdata icon indicating copy to clipboard operation
pyuvdata copied to clipboard

Provide functionality to print a summary of UVData object's UVParameters

Open nithyanandan opened this issue 5 years ago • 1 comments

Although UVParameter attributes can be individually accessed, providing a functionality of a convenience function that prints the summary of the parameters, somewhat along the lines of a FITS header or something equivalent in one go for a quick view will be useful. This applies to metadata, usually small arrays and scalars that can be printed nicely.

See the CASA page here for examples -- https://casa.nrao.edu/casadocs-devel/stable/imaging/image-analysis/dealing-with-image-headers

Even though that page deals with FITS images as examples, an equivalent functionality can be provided for the UVData object.

nithyanandan avatar Sep 14 '20 07:09 nithyanandan

@nithyanandan thanks, this is a good suggestion. On our meeting today we talked about either adding this summary as a __repr__ on the object, or a stand-alone method. We'll follow up when we have a PR.

plaplant avatar Sep 16 '20 16:09 plaplant