DelayModelTable¶
-
class
DelayModelTable(container)[source]¶ Bases:
objectThe DelayModelTable class is an Alma table.
Contains the delay model components. For ALMA this includes all TMCDB delay model components.
Shown here are the fields found in each row.
The key fields are shown first and used (together) to index a unique row. Key fields are all required and indicated by “Key.” following the description.
Other fields are required unless “optional” is shown for that field.
The field description text here is as found in the model used to generate the code.
Types may be an enumeration or extended pyasdm type. Fields that are python lists are indicated that by “[]” in the type and having the word “Array” at the start of description followed by the expected number of elements in that list in parentheses. Lists (arrays) may be multi-dimensional (lists of lists) and are indicated by [][] … etc as needed to indicate the expected number of dimensions. Multi-dimenstional lists will show the expected number of elements for each dimension also in the parenthese after “Array”.
The use of “auto-incrementable” indicates that that field is auto-generated when the table is created and that field is set, as necessary, to create a unique key for the specific row being added, by incrementing that value from the previous highest value needed for the rest of the elements of the key on that row. Such a field can not be set independently, it is only set when the row is added to the table by that auto-increment mechanism.
-
timeInterval¶ time interval for which the row’s content is valid. key.
- Type
-
numPoly¶ the number of coefficients of the polynomials.
- Type
int
-
phaseDelay¶ Array(numPoly) the phase delay polynomial (rad).
- Type
float []
-
phaseDelayRate¶ Array(numPoly) Phase delay rate polynomial (rad/s).
- Type
float []
-
groupDelay¶ Array(numPoly) Group delay polynomial (s).
- Type
float []
-
groupDelayRate¶ Array(numPoly) Group delay rate polynomial (s/s)
- Type
float []
-
timeOrigin¶ value used as the origin for the evaluation of the polynomials. Optional.
- Type
-
atmosphericGroupDelay¶ Atmosphere group delay. Optional.
- Type
float
-
atmosphericGroupDelayRate¶ Atmosphere group delay rate. Optional.
- Type
float
-
geometricDelay¶ Geometric delay. Optional.
- Type
float
-
geometricDelayRate¶ Geometric delay. Optional.
- Type
float
-
numLO¶ the number of local oscillators. Optional.
- Type
int
-
dispersiveDelay¶ Dispersive delay. Optional.
- Type
float
-
dispersiveDelayRate¶ Dispersive delay rate. Optional.
- Type
float
-
atmosphericDryDelay¶ the dry atmospheric delay component. Optional.
- Type
float
-
atmosphericWetDelay¶ the wet atmospheric delay. Optional.
- Type
float
-
padDelay¶ Pad delay. Optional.
- Type
float
-
antennaDelay¶ Antenna delay. Optional.
- Type
float
-
numReceptor¶ Optional.
- Type
int
-
polarizationType¶ Array(numReceptor) describes the polarizations of the receptors (one value per receptor). Optional.
- Type
-
electronicDelay¶ Array(numReceptor) the electronic delay. Optional.
- Type
float []
-
electronicDelayRate¶ Array(numReceptor) the electronic delay rate. Optional.
- Type
float []
-
receiverDelay¶ Array(numReceptor) the receiver delay. Optional.
- Type
float []
-
IFDelay¶ Array(numReceptor) the intermediate frequency delay. Optional.
- Type
float []
-
LODelay¶ Array(numReceptor) the local oscillator delay. Optional.
- Type
float []
-
crossPolarizationDelay¶ the cross polarization delay. Optional.
- Type
float
Methods Summary
Key(antennaId, spectralWindowId)Returns a string built by concatenating the ascii representation of the parameters values suffixed with a “_” character.
MIMEXMLPart(byteOrder)Used in both the small XML file as well as the bin file when writing out as binary.
add(x)Add a row.
checkAndAdd(x)A method to append a row to its table, used by input conversion methods.
checkPresenceInMemory()Check if the table is present in memory.
fromXML(xmlstr)Populate this table from the content of a XML document that is required to conform to the XML schema defined for a DelayModel (DelayModelTable.xsd).
get()Get all rows.
getByContext(antennaId, spectralWindowId)Returns all the rows sorted by ascending startTime for a given context.
getContainer()Return the container to which this table belongs.
getEntity()Returns the table’s entity.
getKeyName()Return the list of field names that make up key key as a list of strings.
getLOOffsetEqTolerance()A getter for the tolerance on LOOffset Returns the tolerance as a Frequency
getLOOffsetRateEqTolerance()A getter for the tolerance on LOOffsetRate Returns the tolerance as a Frequency
getName()Return the name of this table.
getRowByKey(antennaId, spectralWindowId, …)Returns a DelayModelRow given a key.
getRows()get the rows, synonymous with the get method.
getVersion()insertByStartTime(x, rowlist)Insert a DelayModelRow in a list of DelayModelRow so that it’s ordered by ascending start time.
newRow(antennaId, spectralWindowId, …)Create a new DelayModelRow initialized to the specified values.
newRowCopy(row)Create a new row using a copy constructor mechanism.
newRowDefault()Create a new row with default values.
setEntity(e)Set the table’s entity The parameter, e, must be an Entity
setFromFile(directory)Reads and parses a file containing a representation of a DelayModelTable as those produced by the toFile method.
setFromMIME(byteStream)Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.
setFromMIMEFile(directory)Set this table from a MIME file.
setFromXMLFile(directory)This is the function used by setFromFile when the file is an XML file Not intended for external use.
setLOOffsetEqTolerance(tolerance)A setter for the tolerance on LOOffset
setLOOffsetRateEqTolerance(tolerance)A setter for the tolerance on LOOffsetRate
setNotPresentInMemory()Set the state to indicate it is not present in memory and needs to be loaded before being used.
setVersion(version)size()Return the number of rows in the table.
toFile(directory)Stores a representation (binary or XML) of this table into a file.
toMIME(mimeFilePath, mimeXMLpart, byteOrder)Write this out to mimeFilePath as a serialized MIME file with a leading XML part and a following binary part.
toXML()Translate this table to an XML representation conforming to the schema defined for DelayModel (DelayModelTable.xsd).
Methods Documentation
-
Key(antennaId, spectralWindowId)[source]¶ Returns a string built by concatenating the ascii representation of the parameters values suffixed with a “_” character.
-
MIMEXMLPart(byteOrder)[source]¶ Used in both the small XML file as well as the bin file when writing out as binary. The byte order is set by byteOrder.
-
add(x)[source]¶ Add a row. x the DelayModelRow to be added.
return a DelayModelRow. If the table contains a DelayModelRow whose attributes (key and mandatory values) are equal to this in x then this returns that previously added DelayModelRow, otherwise x is returned.
- raises DuplicateKey when the table contains a DelayModelRow with a key equal to the key in x but having
a value section different from the values in x.
note The row is inserted in the table in such a way that all the rows having the same value of ( antennaId, spectralWindowId ) are stored by ascending time.
-
checkAndAdd(x)[source]¶ A method to append a row to its table, used by input conversion methods. Not indended for external use.
If this table has an autoincrementable attribute then check if x verifies the rule of uniqueness and throw exception if not.
This method is appropriate for the case with a ArrayTimeInterval temporal key, no auto incrementable attribute, with other values in the key.
Append x to its table. x The row to be appended. returns x.
-
checkPresenceInMemory()[source]¶ Check if the table is present in memory. If not, load the table from the file using the directory of the container.
-
fromXML(xmlstr)[source]¶ Populate this table from the content of a XML document that is required to conform to the XML schema defined for a DelayModel (DelayModelTable.xsd).
-
getByContext(antennaId, spectralWindowId)[source]¶ Returns all the rows sorted by ascending startTime for a given context. The context is defined by a value of ( antennaId, spectralWindowId ).
return a list of DelayModelRow. A None value is returned if the table contains no DelayModelRow for the given ( antennaId, spectralWindowId ).
-
getLOOffsetEqTolerance()[source]¶ A getter for the tolerance on LOOffset Returns the tolerance as a Frequency
-
getLOOffsetRateEqTolerance()[source]¶ A getter for the tolerance on LOOffsetRate Returns the tolerance as a Frequency
-
getRowByKey(antennaId, spectralWindowId, timeInterval)[source]¶ Returns a DelayModelRow given a key. return the row having the key whose values are passed as parameters, or None if no row exists for that key.
-
insertByStartTime(x, rowlist)[source]¶ Insert a DelayModelRow in a list of DelayModelRow so that it’s ordered by ascending start time.
x The DelayModelRow to be inserted. rowlist The list where x is to be inserted.
The inserted row is returned. If x already exists in rowlist then it is not added and the row in rowlist is returned.
If a row matching the value of the start time of timeInterval is found in rowlist but the other required parameters do not have the same value then a DuplicateKey exception is raised.
-
newRow(antennaId, spectralWindowId, timeInterval, numPoly, phaseDelay, phaseDelayRate, groupDelay, groupDelayRate, fieldId)[source]¶ Create a new DelayModelRow initialized to the specified values.
The new row is not added to this table, but it does know about it. (the autoincrementable attribute, if any, is not in the parameter list)
-
newRowCopy(row)[source]¶ Create a new row using a copy constructor mechanism.
The method creates a new DelayModelRow which knows about this table. Each attribute of the created row is a (deep) copy of the corresponding attribute of row. The method does not add the created row to this, it simply parents it to this, a call to the add method has to be done in order to get the row added (very likely after having modified some of its attributes. If row is None then the method returns a new DelayModelRow with default values for its attributes.
-
newRowDefault()[source]¶ Create a new row with default values. The new row is not added to this table but it knows about it.
-
setFromFile(directory)[source]¶ Reads and parses a file containing a representation of a DelayModelTable as those produced by the toFile method. This table is populated with the result of the parsing. param directory The name of the directory containing the file te be read and parsed. raises ConversionException If any error occurs while reading the files in the directory or parsing them.
-
setFromMIME(byteStream)[source]¶ Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization. param byteStream the previously opened io.BufferedReader instance containing the data to be extracted.
It is the responsibility of this method to close byteStream.
-
setFromMIMEFile(directory)[source]¶ Set this table from a MIME file. Used internally by setFromFile. Not intended for external use.
-
setFromXMLFile(directory)[source]¶ This is the function used by setFromFile when the file is an XML file Not intended for external use.
-
setNotPresentInMemory()[source]¶ Set the state to indicate it is not present in memory and needs to be loaded before being used. This is used by the container class when loaded from a file and this table is present with non-zero rows. Tables are loaded on demand when the get function in the container for that table is used.
-
toFile(directory)[source]¶ Stores a representation (binary or XML) of this table into a file.
Depending on the boolean value of its _fileAsBin data member a binary serialization of this (_fileAsBin==True) will be saved in a file “DelayModel.bin” or an XML representation (_fileAsBin==False) will be saved in a file “DelayModel.xml”. The file is always written in a directory whose name is passed as a parameter. param directory The name of directory where the file containing the table’s representation will be saved. raises ConversionException for any errors while writing that file.
-
toMIME(mimeFilePath, mimeXMLpart, byteOrder)[source]¶ Write this out to mimeFilePath as a serialized MIME file with a leading XML part and a following binary part.
The mimeXMLpart is a string that should have already been written to the corresponding small XML file (and is returned by the MIMEXMLPart method here). The byteOrder is a ByteOrder instance that gives the byte order to use when writing the binary data. That instance should have also been used to generate mimeXMLpart.
-