ms.summary - Function

Summarize the measurement set

Synopsis
summary(header, verbose)

Arguments

header	out	Header information
		Allowed:	Record
		Default:	empty record
verbose	in	Produce verbose logging output
		Allowed:	Boolean
		Default:	F

Description
This function will print a summary of the measurement set to the system logger. The verbose argument provides some control on how much information is displayed.

This function can also return, in the header argument, a record containing the following fields.

nrow: Number of rows in the measurement set
name: Name of the measurement set

Example

      include 'ms.g'
      myms := ms('3C273XC1.ms')
      myms.summary(verbose=T)

This example will send a verbose summary of the measurement set to the logger.

Next: ms.listhistory - Function Up: ms - Tool Previous: ms.tofits - Function Contents Index

	Package	general
	Module	ms
	Tool	ms