Package wsatools :: Module ProgrammeBuilder :: Class SynopticSetup

Class SynopticSetup

This determines the setup of the multi-epoch tables based on the details in Programme.

Instance Methods

__init__(self, progTable, dateRange=None, isDeep=None, extBandMergeCrit=None)
Processes the information in Programme to get the correct setup.

source code

namedtuple()

getBMTableAttr(self, bmTable)
Returns: Named tuple of the BestMatch table attributes

source code

str

getSynopticSourceTable(self)
Returns: SynopticSourceTable name

source code

str

getCorrelNeighTable(self)
Returns: Returns correlated neighbour table name if it exists

source code

str

getSynopticMergeLogTable(self)
Returns: SynopticMergeLogTable name

source code

list(str)

getSynopNeighTables(self)
Returns: List of all the Synoptic neighbour tables produced

source code

str

getVarNeighTable(self)
Returns: Name of the Neighbour table used by in the Variability table

source code

namedtuple(DateTime, DateTime)

getTimeRange(self, isCorrelated)
Returns: The time range for a given BestMatch table

source code

namedtuple(DateTime, DateTime)

getSynopticTableID(self, neighTable)
Returns: The time range for a given BestMatch table

source code

bool

isVarTableCorrel(self)
Returns: Is the variability table correlated

source code

bool

isNonCorrelBMTable(self)
Returns: Is there a SourceXDetectionBM table?

source code

bool

isCorrelBMTable(self)
Returns: Is there a SourceXDetectionBM table?

source code

parseSynString(self, synString)
Parses the synopticSetup string and processes each substring.

source code

process(self, subString)
Processes each substring.

source code

updateSynopticMatchRadius(self)
Calculates a matching radius for the synoptic neighbour table, in the range 1 to 10 arcsec, based on the density of sources in the source table and updates RequiredNeighbours in the current database.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

bandMergingCrit = None
Correlated band pass time scale.

bestMatchTables = None
List of best match tables for this programme.

corBMTable = None
Correlated best-match table name.

dateRangeOfTable = None
DateRange applied to a particular table.

isDeep = False
Set up survey as a deep survey?

mainDateRange = None
DateRange of synoptic data.

programme = None
Initialised Programme table for this archive.

synopticMergeLogTable = None
Synoptic merge-log table name.

synopticSourceTable = None
Synoptic source table name.

sysc = None
Initialised SystemConstants for this archive.

uncorBMTable = None
Uncorrelated best-match table name.

varBMTable = None
BestMatch table used for the Variability table.

isCorSingleEpoch = False
Use single epoch in SynopticSource table

specialFilter = None
Is there a special filter

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, progTable, dateRange=None, isDeep=None, extBandMergeCrit=None)
(Constructor)

source code

Processes the information in Programme to get the correct setup.

Parameters:

progTable (df.ProgrammeTable) - Programme table for current database with the current row set to that of the desired programme.
dateRange (DateRange) - Date range this synoptic data covers (default: all).
isDeep (bool) - If True, override Programme default to suggest this is a deep survey.
extBandMergeCrit (float) - Optionally override Programme default band merge criterion with this value.

Overrides: object.__init__