hops_control.pass_info.PassInfo Class Reference

Public Member Functions
def	__init__ (self, dict pass_dict)
str	__repr__ (self)
str	baseline (self)
bool	baseline_match (self, str b)
str	fgroup (self)
bool	fgroup_match (self, str fg)
str	polprod (self)
str	ref_station (self)
str	rem_station (self)
bool	scan_after (self, str scan)
bool	scan_before (self, str scan)
bool	scan_between (self, str lo, str hi)
str	scan_name (self)
str	source (self)
bool	source_match (self, str src)
bool	station (self, str s)

Static Public Attributes
string	WILDCARD = "?"

Detailed Description

Immutable description of the fringe pass (single-baseline, single-polproduct) being processed.

Constructed by ``MHO_PyControlEvaluator`` from the C++ parameter store and
passed as the first argument to the user's ``configure()`` function.

The *pass_dict* must contain these keys (all strings):

* ``baseline``   - full baseline string, e.g. ``"EG"`` or ``"Gs-Wf"``
* ``ref_mk4id``    - single-character Mk4 ref-station code, e.g. ``"E"``
* ``rem_mk4id``    - single-character Mk4 rem-station code, e.g. ``"G"``
* ``ref_code``   - canonical ref-station code (e.g. ``Gs``)
* ``rem_code``   - canonical rem-station code (e.g. ``Wf``)
* ``source``     - source name, e.g. ``"3C279"``
* ``fgroup``     - frequency-group character, e.g. ``"X"``
* ``scan_name``  - scan name / time string used for ordering comparisons
* ``polprod``    - polarization product, e.g. ``"RR"``

Constructor & Destructor Documentation

__init__()

def hops_control.pass_info.PassInfo.__init__	(		self,
		dict	pass_dict
	)

Member Function Documentation

__repr__()

str hops_control.pass_info.PassInfo.__repr__

(

self

)

baseline()

str hops_control.pass_info.PassInfo.baseline

(

self

)

Full baseline string (e.g. ``"EG"`` or ``"Gs-Wf"``).

baseline_match()

bool hops_control.pass_info.PassInfo.baseline_match	(		self,
		str	b
	)

Return True if *b* matches the current baseline.

*b* may be:

* A 2-character Mk4 baseline (e.g. ``"EG"``).
* A long-form baseline with ``-`` separator (e.g. ``"Gs-Wf"``).
* A wildcard pattern using ``"?"`` for either station.

fgroup()

str hops_control.pass_info.PassInfo.fgroup

(

self

)

Frequency-group character.

fgroup_match()

bool hops_control.pass_info.PassInfo.fgroup_match	(		self,
		str	fg
	)

Return True if *fg* equals the current frequency group (or is ``"?"``).

polprod()

str hops_control.pass_info.PassInfo.polprod

(

self

)

Polarization product (e.g. ``"RR"``).

ref_station()

str hops_control.pass_info.PassInfo.ref_station

(

self

)

Single-character Mk4 ID of the reference station.

rem_station()

str hops_control.pass_info.PassInfo.rem_station

(

self

)

Single-character Mk4 ID of the remote station.

scan_after()

bool hops_control.pass_info.PassInfo.scan_after	(		self,
		str	scan
	)

Return True if the current scan name is lexicographically *after* *scan*.

scan_before()

bool hops_control.pass_info.PassInfo.scan_before	(		self,
		str	scan
	)

Return True if the current scan name is lexicographically *before* *scan*.

scan_between()

bool hops_control.pass_info.PassInfo.scan_between	(		self,
		str	lo,
		str	hi
	)

Return True if the scan name falls in [*lo*, *hi*] (inclusive).

scan_name()

str hops_control.pass_info.PassInfo.scan_name

(

self

)

Scan name / time string.

source()

str hops_control.pass_info.PassInfo.source

(

self

)

Source name.

source_match()

bool hops_control.pass_info.PassInfo.source_match	(		self,
		str	src
	)

Return True if *src* equals the current source name (or is ``"?"``).

station()

bool hops_control.pass_info.PassInfo.station	(		self,
		str	s
	)

Return True if *s* matches the reference or remote station (or is the
wildcard ``"?"``).

Single-character *s* is matched against Mk4 station IDs.
Multi-character *s* is matched against canonical station names.

Member Data Documentation

WILDCARD

string hops_control.pass_info.PassInfo.WILDCARD = "?"

static

---

The documentation for this class was generated from the following file:

• pass_info.py