Inheritance diagram for __casac__.msmetadata.msmetadata:

Public Member Functions
def	__init__
def	antennaid
def	antennaname
def	chanavgspws
def	done
def	fdmspws
def	fieldsforintent
def	fieldsforname
def	fieldsforscan
def	fieldsforscans
def	fieldsforspw
def	fieldsfortimes
def	intents
def	intentsforscan
def	intentsforspw
def	nantennas
def	nameforfield
def	nfields
def	nspw
def	nstates
def	nscans
def	nvis
def	open
def	scannumbers
def	scansforfield
def	scansforintent
def	scansforspw
def	scansforstate
def	scansfortimes
def	spwsforfield
def	spwsforintent
def	spwsforscan
def	statesforscan
def	tdmspws
def	timesforfield
def	timesforscan
def	timesforscans
def	wvrspws
Public Attributes
	this
Static Private Attributes
dictionary	__swig_setmethods__
tuple	__setattr__
dictionary	__swig_getmethods__
tuple	__getattr__
	__repr__
	__swig_destroy__
	__del__

Detailed Description

Proxy of C++ casac::msmetadata class

Definition at line 70 of file msmetadata.py.

Constructor & Destructor Documentation

def __casac__.msmetadata.msmetadata.__init__ ( self )

__init__(self) -> msmetadata

Definition at line 77 of file msmetadata.py.

Member Function Documentation

def __casac__.msmetadata.msmetadata.antennaid	(	self,
		args,
		kwargs
	)

antennaid(self, name=string("")) -> int

Summary
Get the zero-based antenna ID for the specfied antenna name.

Input Parameters:
name             Zero-based antenna ID for which to get the antenna name. 

--------------------------------------------------------------------------------

Definition at line 84 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.antennaname	(	self,
		args,
		kwargs
	)

antennaname(self, antennaid=-1) -> string

Summary
Get the name of the antenna for the specfied zero-based antenna ID.

Input Parameters:
antennaid        Zero-based antenna ID for which to get the antenna name. -1 

--------------------------------------------------------------------------------

Definition at line 99 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.chanavgspws ( self )

chanavgspws(self) -> std::vector< int >

Summary
Get an array of spectral window IDs used for channel averages. These are windows that do have 1 channel.
--------------------------------------------------------------------------------

Definition at line 114 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.done ( self )

done(self) -> bool

Summary
Close this tool and reclaim system resources associated with it.
--------------------------------------------------------------------------------

Definition at line 125 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.fdmspws ( self )

fdmspws(self) -> std::vector< int >

Summary
Get an array of spectral window IDs used for FDM. These are windows that do not have 64, 128, or 256 channels.
--------------------------------------------------------------------------------

Definition at line 136 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.fieldsforintent	(	self,
		args,
		kwargs
	)

fieldsforintent(self, intent=string(""), asnames=False) -> variant *

Summary
Get an array of the unique fields for the specified intent.

Input Parameters:
intent           Intent (case sensitive) for which to return the fields. 
asnames          If true, return the field names. If false, return the zero-based field IDs. false 

--------------------------------------------------------------------------------

Definition at line 147 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.fieldsforname	(	self,
		args,
		kwargs
	)

fieldsforname(self, name=string("")) -> std::vector< int >

Summary
Get an array of the unique, zero-based field IDs for the specified field name.

Input Parameters:
name             Field name (case sensitive) for which to return the fields. 

--------------------------------------------------------------------------------

Definition at line 163 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.fieldsforscan	(	self,
		args,
		kwargs
	)

fieldsforscan(self, scan=-1, asnames=False) -> variant *

Summary
Get an array of the unique fields for the specified scan number.

Input Parameters:
scan             Scan number for which to return the fields. -1 
asnames          If true, return the field names. If false, return the zero-based field IDs. false 

--------------------------------------------------------------------------------

Definition at line 178 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.fieldsforscans	(	self,
		args,
		kwargs
	)

fieldsforscans(self, scans=std::vector< int >(), asnames=False) -> variant *

Summary
Get an array of the unique fields for the specified scan numbers.

Input Parameters:
scans            Scan numbers for which to return the fields. 
asnames          If true, return the field names. If false, return the zero-based field IDs. false 

--------------------------------------------------------------------------------

Definition at line 194 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.fieldsforspw	(	self,
		args,
		kwargs
	)

fieldsforspw(self, spw=-1, asnames=False) -> variant *

Summary
Get an array of the unique fields for the specified spectral window.

Input Parameters:
spw              Zero-based spectral window ID for which to return the fields. -1 
asnames          If true, return the field names. If false, return the zero-based field IDs. false 

--------------------------------------------------------------------------------

Definition at line 210 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.fieldsfortimes	(	self,
		args,
		kwargs
	)

fieldsfortimes(self, time=-1, tol=0) -> std::vector< int >

Summary
Get an array of the unique, zero-based, field IDs for the specified time range (time-tol to time+tol).

Input Parameters:
time             Time at center of time range. -1 
tol              Time on either side of center for specifying range. 0 

--------------------------------------------------------------------------------

Definition at line 226 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.intents ( self )

intents(self) -> std::vector< std::string >

Summary
Get an array of the unique intents associated with the MS.
--------------------------------------------------------------------------------

Definition at line 242 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.intentsforscan	(	self,
		args,
		kwargs
	)

intentsforscan(self, scan=-1) -> std::vector< std::string >

Summary
Get an array of the unique intents for the specified scan.

Input Parameters:
scan             Scan number for which to return the intents. -1 

--------------------------------------------------------------------------------

Definition at line 253 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.intentsforspw	(	self,
		args,
		kwargs
	)

intentsforspw(self, spw=-1) -> std::vector< std::string >

Summary
Get an array of the unique intents for the specified spectral window ID.

Input Parameters:
spw              Spectral window ID (>=0) for which to return the intents. -1 

--------------------------------------------------------------------------------

Definition at line 268 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.nameforfield	(	self,
		args,
		kwargs
	)

nameforfield(self, field=-1) -> string

Summary
Get the name of the specified field.

Input Parameters:
field            Zero-based field ID for which to get the name. -1 

--------------------------------------------------------------------------------

Definition at line 294 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.nantennas ( self )

nantennas(self) -> int

Summary
Get the number of antennas associated with the MS.
--------------------------------------------------------------------------------

Definition at line 283 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.nfields ( self )

nfields(self) -> int

Summary
Get the number of fields associated with the MS.
--------------------------------------------------------------------------------

Definition at line 309 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.nscans ( self )

nscans(self) -> int

Summary
Get the number of scans associated with the MS.
--------------------------------------------------------------------------------

Definition at line 342 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.nspw ( self )

nspw(self) -> int

Summary
Get the number of spectral windows associated with the MS.
--------------------------------------------------------------------------------

Definition at line 320 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.nstates ( self )

nstates(self) -> int

Summary
Get the number of states (from the STATE table) associated with the MS.
--------------------------------------------------------------------------------

Definition at line 331 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.nvis ( self )

nvis(self) -> int

Summary
Get the number of visibilities (from the main table) associated with the MS.
--------------------------------------------------------------------------------

Definition at line 353 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.open	(	self,
		args,
		kwargs
	)

open(self, msfile=string("")) -> bool

Summary
Attach the MS metadata tool to the specified MS

Input Parameters:
msfile           Name of the existing measurement set 

--------------------------------------------------------------------------------

Definition at line 364 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.scannumbers ( self )

scannumbers(self) -> std::vector< int >

Summary
Get an array of the unique scan numbers associated with the MS.
--------------------------------------------------------------------------------

Definition at line 379 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.scansforfield	(	self,
		args,
		kwargs
	)

scansforfield(self, intent=initialize_variant("")) -> std::vector< int >

Summary
Get an array of the unique scan numbers associated with the specified field.

Input Parameters:
intent           Field ID or field name (case sensitive) for which to return the scan numbers. 

--------------------------------------------------------------------------------

Definition at line 390 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.scansforintent	(	self,
		args,
		kwargs
	)

scansforintent(self, intent=string("-1")) -> std::vector< int >

Summary
Get an array of the unique scan numbers associated with the specified intent.

Input Parameters:
intent           Intent (case-sensitive) for which to return the scan numbers. -1 

--------------------------------------------------------------------------------

Definition at line 405 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.scansforspw	(	self,
		args,
		kwargs
	)

scansforspw(self, spw=-1) -> std::vector< int >

Summary
Get an array of the unique scan numbers associated with the specified zero-based spectral window ID.

Input Parameters:
spw              Zero-based spectral window ID for which to return the scan numbers. -1 

--------------------------------------------------------------------------------

Definition at line 420 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.scansforstate	(	self,
		args,
		kwargs
	)

scansforstate(self, state=-1) -> std::vector< int >

Summary
Get an array of the unique scan numbers for the specified state.

Input Parameters:
state            ID of state for which to return the scan numbers. -1 

--------------------------------------------------------------------------------

Definition at line 435 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.scansfortimes	(	self,
		args,
		kwargs
	)

scansfortimes(self, time=-1, tol=0) -> std::vector< int >

Summary
Get an array of the unique scan numbers for the specified time range (time-tol to time+tol).

Input Parameters:
time             Time at center of time range. -1 
tol              Time on either side of center for specifying range. 0 

--------------------------------------------------------------------------------

Definition at line 450 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.spwsforfield	(	self,
		args,
		kwargs
	)

spwsforfield(self, field=initialize_variant("")) -> std::vector< int >

Summary
Get an array of the unique spectral window IDs for the specified field.

Input Parameters:
field            Field (case sensitive string or zero-based integer ID) for which to return the spectral window IDs. 

--------------------------------------------------------------------------------

Definition at line 466 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.spwsforintent	(	self,
		args,
		kwargs
	)

spwsforintent(self, intent=string("")) -> std::vector< int >

Summary
Get an array of the unique spectral window IDs for the specified intent.

Input Parameters:
intent           Intent (case sensitive) for which to return the spectral window IDs. 

--------------------------------------------------------------------------------

Definition at line 481 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.spwsforscan	(	self,
		args,
		kwargs
	)

spwsforscan(self, scan=-1) -> std::vector< int >

Summary
Get an array of the unique spectral window IDs for the specified scan number.

Input Parameters:
scan             Scan number for which to return the spectral window IDs. -1 

--------------------------------------------------------------------------------

Definition at line 496 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.statesforscan	(	self,
		args,
		kwargs
	)

statesforscan(self, scan=-1) -> std::vector< int >

Summary
Get an array of the unique state IDs for the specified scan number.

Input Parameters:
scan             Scan number for which to return the state IDs. -1 

--------------------------------------------------------------------------------

Definition at line 511 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.tdmspws ( self )

tdmspws(self) -> std::vector< int >

Summary
Get an array of spectral window IDs used for TDM. These are windows that have 64, 128, or 256 channels.
--------------------------------------------------------------------------------

Definition at line 526 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.timesforfield	(	self,
		args,
		kwargs
	)

timesforfield(self, field=-1) -> std::vector< double >

Summary
Get an array of the unique times for the specified field.

Input Parameters:
field            Zero-based field ID for which to return the times. -1 

--------------------------------------------------------------------------------

Definition at line 537 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.timesforscan	(	self,
		args,
		kwargs
	)

timesforscan(self, scan=-1) -> std::vector< double >

Summary
Get an array of the unique times for the specified scan number.

Input Parameters:
scan             Scan number for which to return the times. -1 

--------------------------------------------------------------------------------

Definition at line 552 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.timesforscans	(	self,
		args,
		kwargs
	)

timesforscans(self, scans=initialize_vector(1, (int)-1)) -> std::vector< double >

Summary
Get an array of the unique times for the specified scan numbers.

Input Parameters:
scans            Scan numbers for which to return the times. -1 

--------------------------------------------------------------------------------

Definition at line 567 of file msmetadata.py.

def __casac__.msmetadata.msmetadata.wvrspws ( self )

wvrspws(self) -> std::vector< int >

Summary
Get an array of spectral window IDs used for WVR. These are windows that have 4 channels.
--------------------------------------------------------------------------------

Definition at line 582 of file msmetadata.py.