PulsarRow

class PulsarRow(table, row=None)

Bases: object

The PulsarRow class is a row of a PulsarTable.

Generated from model’s revision -1, branch

Methods Summary

clearDispersionMeasure()	Mark dispersionMeasure, which is an optional field, as non-existent.
clearEndPhaseBin()	Mark endPhaseBin, which is an optional field, as non-existent.
clearNumPoly()	Mark numPoly, which is an optional field, as non-existent.
clearPhasePoly()	Mark phasePoly, which is an optional field, as non-existent.
clearRefFrequency()	Mark refFrequency, which is an optional field, as non-existent.
clearStartPhaseBin()	Mark startPhaseBin, which is an optional field, as non-existent.
clearTimeSpan()	Mark timeSpan, which is an optional field, as non-existent.
compareNoAutoInc(refTime, refPulseFreq, …)	Compare each attribute except the autoincrementable one of this PulsarRow with the corresponding parameters and return True if there is a match and False otherwise.
compareRequiredValue(refTime, refPulseFreq, …)
dispersionMeasureFromBin(row, eis)	Set the optional dispersionMeasure in row from the EndianInput (eis) instance.
endPhaseBinFromBin(row, eis)	Set the optional endPhaseBin in row from the EndianInput (eis) instance.
equalByRequiredValue(otherRow)	Return True if all required attributes of the value part are equal to their homologues in otherRow and False otherwise.
fromBin(eis, table, attributesSeq)	Given an EndianInput instance by the table (which must be a Pointing instance) and the list of attributes to be found in eis, in order, this constructs a row by pulling off values from that EndianInput in the expected order.
getDispersionMeasure()	Get dispersionMeasure, which is optional.
getEndPhaseBin()	Get endPhaseBin, which is optional.
getNumBin()	Get numBin.
getNumPoly()	Get numPoly, which is optional.
getPhasePoly()	Get phasePoly, which is optional.
getPulsarId()	Get pulsarId.
getRefFrequency()	Get refFrequency, which is optional.
getRefPhase()	Get refPhase.
getRefPulseFreq()	Get refPulseFreq.
getRefTime()	Get refTime.
getStartPhaseBin()	Get startPhaseBin, which is optional.
getTable()	Return the table to which this row belongs.
getTimeSpan()	Get timeSpan, which is optional.
initFromBinMethods()
isAdded()
isDispersionMeasureExists()	The attribute dispersionMeasure is optional.
isEndPhaseBinExists()	The attribute endPhaseBin is optional.
isNumPolyExists()	The attribute numPoly is optional.
isPhasePolyExists()	The attribute phasePoly is optional.
isRefFrequencyExists()	The attribute refFrequency is optional.
isStartPhaseBinExists()	The attribute startPhaseBin is optional.
isTimeSpanExists()	The attribute timeSpan is optional.
numBinFromBin(row, eis)	Set the numBin in row from the EndianInput (eis) instance.
numPolyFromBin(row, eis)	Set the optional numPoly in row from the EndianInput (eis) instance.
phasePolyFromBin(row, eis)	Set the optional phasePoly in row from the EndianInput (eis) instance.
pulsarIdFromBin(row, eis)	Set the pulsarId in row from the EndianInput (eis) instance.
refFrequencyFromBin(row, eis)	Set the optional refFrequency in row from the EndianInput (eis) instance.
refPhaseFromBin(row, eis)	Set the refPhase in row from the EndianInput (eis) instance.
refPulseFreqFromBin(row, eis)	Set the refPulseFreq in row from the EndianInput (eis) instance.
refTimeFromBin(row, eis)	Set the refTime in row from the EndianInput (eis) instance.
setDispersionMeasure(dispersionMeasure)	Set dispersionMeasure with the specified float value.
setEndPhaseBin(endPhaseBin)	Set endPhaseBin with the specified float [] value.
setFromXML(xmlrow)	Fill the values of this row from an XML string that was produced by the toXML() method.
setNumBin(numBin)	Set numBin with the specified int value.
setNumPoly(numPoly)	Set numPoly with the specified int value.
setPhasePoly(phasePoly)	Set phasePoly with the specified float [] value.
setPulsarId(pulsarId)	Set pulsarId with the specified Tag value.
setRefFrequency(refFrequency)	Set refFrequency with the specified Frequency value.
setRefPhase(refPhase)	Set refPhase with the specified float value.
setRefPulseFreq(refPulseFreq)	Set refPulseFreq with the specified Frequency value.
setRefTime(refTime)	Set refTime with the specified ArrayTime value.
setStartPhaseBin(startPhaseBin)	Set startPhaseBin with the specified float [] value.
setTimeSpan(timeSpan)	Set timeSpan with the specified Interval value.
startPhaseBinFromBin(row, eis)	Set the optional startPhaseBin in row from the EndianInput (eis) instance.
timeSpanFromBin(row, eis)	Set the optional timeSpan in row from the EndianInput (eis) instance.
toBin(eos)	Write this row out to the EndianOutput instance, eos.
toXML()	Return this row in the form of an XML string.

Methods Documentation

clearDispersionMeasure()

Mark dispersionMeasure, which is an optional field, as non-existent.

clearEndPhaseBin()

Mark endPhaseBin, which is an optional field, as non-existent.

clearNumPoly()

Mark numPoly, which is an optional field, as non-existent.

clearPhasePoly()

Mark phasePoly, which is an optional field, as non-existent.

clearRefFrequency()

Mark refFrequency, which is an optional field, as non-existent.

clearStartPhaseBin()

Mark startPhaseBin, which is an optional field, as non-existent.

clearTimeSpan()

Mark timeSpan, which is an optional field, as non-existent.

compareNoAutoInc(refTime, refPulseFreq, refPhase, numBin)

Compare each attribute except the autoincrementable one of this PulsarRow with the corresponding parameters and return True if there is a match and False otherwise.

compareRequiredValue(refTime, refPulseFreq, refPhase, numBin)

static dispersionMeasureFromBin(row, eis)

Set the optional dispersionMeasure in row from the EndianInput (eis) instance.

static endPhaseBinFromBin(row, eis)

Set the optional endPhaseBin in row from the EndianInput (eis) instance.

equalByRequiredValue(otherRow)

Return True if all required attributes of the value part are equal to their homologues in otherRow and False otherwise.

static fromBin(eis, table, attributesSeq)

Given an EndianInput instance by the table (which must be a Pointing instance) and the list of attributes to be found in eis, in order, this constructs a row by pulling off values from that EndianInput in the expected order.

The new row object is returned.

getDispersionMeasure()

Get dispersionMeasure, which is optional. return dispersionMeasure as float raises ValueError If dispersionMeasure does not exist.

getEndPhaseBin()

Get endPhaseBin, which is optional. return endPhaseBin as float [] raises ValueError If endPhaseBin does not exist.

getNumBin()

Get numBin. return numBin as int

getNumPoly()

Get numPoly, which is optional. return numPoly as int raises ValueError If numPoly does not exist.

getPhasePoly()

Get phasePoly, which is optional. return phasePoly as float [] raises ValueError If phasePoly does not exist.

getPulsarId()

Get pulsarId. return pulsarId as Tag

getRefFrequency()

Get refFrequency, which is optional. return refFrequency as Frequency raises ValueError If refFrequency does not exist.

getRefPhase()

Get refPhase. return refPhase as float

getRefPulseFreq()

Get refPulseFreq. return refPulseFreq as Frequency

getRefTime()

Get refTime. return refTime as ArrayTime

getStartPhaseBin()

Get startPhaseBin, which is optional. return startPhaseBin as float [] raises ValueError If startPhaseBin does not exist.

getTable()

Return the table to which this row belongs.

getTimeSpan()

Get timeSpan, which is optional. return timeSpan as Interval raises ValueError If timeSpan does not exist.

static initFromBinMethods()

isAdded()

isDispersionMeasureExists()

The attribute dispersionMeasure is optional. Return True if this attribute exists. return True if and only if the dispersionMeasure attribute exists.

isEndPhaseBinExists()

The attribute endPhaseBin is optional. Return True if this attribute exists. return True if and only if the endPhaseBin attribute exists.

isNumPolyExists()

The attribute numPoly is optional. Return True if this attribute exists. return True if and only if the numPoly attribute exists.

isPhasePolyExists()

The attribute phasePoly is optional. Return True if this attribute exists. return True if and only if the phasePoly attribute exists.

isRefFrequencyExists()

The attribute refFrequency is optional. Return True if this attribute exists. return True if and only if the refFrequency attribute exists.

isStartPhaseBinExists()

The attribute startPhaseBin is optional. Return True if this attribute exists. return True if and only if the startPhaseBin attribute exists.

isTimeSpanExists()

The attribute timeSpan is optional. Return True if this attribute exists. return True if and only if the timeSpan attribute exists.

static numBinFromBin(row, eis)

Set the numBin in row from the EndianInput (eis) instance.

static numPolyFromBin(row, eis)

Set the optional numPoly in row from the EndianInput (eis) instance.

static phasePolyFromBin(row, eis)

Set the optional phasePoly in row from the EndianInput (eis) instance.

static pulsarIdFromBin(row, eis)

Set the pulsarId in row from the EndianInput (eis) instance.

static refFrequencyFromBin(row, eis)

Set the optional refFrequency in row from the EndianInput (eis) instance.

static refPhaseFromBin(row, eis)

Set the refPhase in row from the EndianInput (eis) instance.

static refPulseFreqFromBin(row, eis)

Set the refPulseFreq in row from the EndianInput (eis) instance.

static refTimeFromBin(row, eis)

Set the refTime in row from the EndianInput (eis) instance.

setDispersionMeasure(dispersionMeasure)

Set dispersionMeasure with the specified float value. dispersionMeasure The float value to which dispersionMeasure is to be set.

setEndPhaseBin(endPhaseBin)

Set endPhaseBin with the specified float [] value. endPhaseBin The float [] value to which endPhaseBin is to be set.

setFromXML(xmlrow)

Fill the values of this row from an XML string that was produced by the toXML() method. If xmlrow is a minidom.Element with a nodeName of row then it will be used as is. Anything else that is not a string is an error.

setNumBin(numBin)

Set numBin with the specified int value. numBin The int value to which numBin is to be set.

setNumPoly(numPoly)

Set numPoly with the specified int value. numPoly The int value to which numPoly is to be set.

setPhasePoly(phasePoly)

Set phasePoly with the specified float [] value. phasePoly The float [] value to which phasePoly is to be set.

setPulsarId(pulsarId)

Set pulsarId with the specified Tag value. pulsarId The Tag value to which pulsarId is to be set. The value of pulsarId can be anything allowed by the Tag constructor.

Raises a ValueError If an attempt is made to change a part of the key after is has been added to the table.

setRefFrequency(refFrequency)

Set refFrequency with the specified Frequency value. refFrequency The Frequency value to which refFrequency is to be set. The value of refFrequency can be anything allowed by the Frequency constructor.

setRefPhase(refPhase)

Set refPhase with the specified float value. refPhase The float value to which refPhase is to be set.

setRefPulseFreq(refPulseFreq)

Set refPulseFreq with the specified Frequency value. refPulseFreq The Frequency value to which refPulseFreq is to be set. The value of refPulseFreq can be anything allowed by the Frequency constructor.

setRefTime(refTime)

Set refTime with the specified ArrayTime value. refTime The ArrayTime value to which refTime is to be set. The value of refTime can be anything allowed by the ArrayTime constructor.

setStartPhaseBin(startPhaseBin)

Set startPhaseBin with the specified float [] value. startPhaseBin The float [] value to which startPhaseBin is to be set.

setTimeSpan(timeSpan)

Set timeSpan with the specified Interval value. timeSpan The Interval value to which timeSpan is to be set. The value of timeSpan can be anything allowed by the Interval constructor.

static startPhaseBinFromBin(row, eis)

Set the optional startPhaseBin in row from the EndianInput (eis) instance.

static timeSpanFromBin(row, eis)

Set the optional timeSpan in row from the EndianInput (eis) instance.

toBin(eos)

Write this row out to the EndianOutput instance, eos.

toXML()

Return this row in the form of an XML string.