BDFHeader¶
-
class
BDFHeader[source]¶ Bases:
objectA class to hold the values from the primary header of a BDF.
This code is based on several c++ classes as well used to read BDFs.
Methods Summary
correlatorType()Return the CorrelatorType if the processorType is CORRELATOR, else None.
fromDOM(dataHeaderElem)set this from a minidom that is an sdmDataHeader element
getAPClist()Returns the apc list from the data struct.
getAxes(binaryType)Get the AxisNames enumeration list for the given binary type.
getAxesNames(binaryType)Return a list of axes names (strings) for the given binary type.
getBasebandsList()Returns the basebands list, a list of structs, from the data struct
getBinaryTypes()Return a list of the known types of binary data.
getByteOrder()gets byteOrder, a ByteOrder instance
getCorrelationMode()gets the correlationMode
getDataOID()get the dataOID
getDimensionality()gets the dimensionality
getExecBlockNum()gets the exectBlockNum
getExecBlockUID()get the execBlockUID
getNumAntenna()gets the numAntenna
getNumTime()gets the numTime
getProcessorType()gets the processorType
getScanNum()gets the scanNum
getSchemaVersion()gets schemaVersion
getSize(binaryType)Get the size of the named binary type.
getSpectralResolutionType()gets the spectralResolutionType
getStartTime()gets the startTime
getSubscanNum()gets the subscanNum
getTitle()get the title
hasBinary(binaryType)Does the given binaryType have a size > 0?
hasPackedData()Returns True if and only if all of the integrations are grouped in one subset.
isAutoDataNormalized()Returns True if this has autoData and the normalized value is True
isCorrelation()Return True if and only if the ProcessorTpe is CORELLATOR
isTP()Returns True if and only if the string “Total Power” appears in the title.
isWVR()Returns True if and only if the string “WVR” appears in the title.
projectPath()Return the project path using execBlockNum, scanNum, and subscanNum.
setAPClist(apcList)Sets the apc list in the data struct.
setByteOrder(byteOrder)Sets the byte order using byteOrder, which must be a string value that the ByteOrder class recognizes
setCorrelationMode(correlationMode)sets the correlationMode, correlationMode is any value that can be used for the CorrelationMode enumeration
setDataOID(dataOID)sets the dataOID, this can be any string
setDimensionality(dimensionality)set the dimensionality, always uses int(dimensionality) dimensionality must be >= 0, if > 0 then numTime must be zero when this is set
setExecBlockNum(execBlockNum)set the exec block num, always uses int(execBlockNum), can not be negative
setExecBlockUID(execBlockUID)sets the execBlockUID, this can be any string
setNumAntenna(numAntenna)set the numAntenna, always uses int(numAntenna), can not be negative
setNumTime(numTime)set the numTime, always uses int(numTime) numTime must be >= 0, if > 0 then dimensionality must be zero when this is set
setProcessorType(processorType)sets the processorType, processorType is any value that can be used for the ProcessorType enumeration
setScanNum(scanNum)set the scan num, always uses int(scanNum), can not be negative
setSchemaVersion(schemaVersion)sets schemaVersion, it always uses int(schemaVersion) so that the value returned by the getter should be an int schemaVersion here can be a string, for example
setSpectralResolutionType(spectralResolutionType)sets the spectralResolutionType, spectralResolutionType is any value that can be used for the SpectralResolutionType enumeration
setStartTime(startTime)set the startTime, always uses int(startTime), can not be negative
setSubscanNum(subscanNum)set the scan num, always uses int(scanNum), can not be negative
setTitle(title)sets the title, this can be any string
zeroLagsCorrelatorType()Returns the correlatorType for the zeroLags.
Methods Documentation
-
correlatorType()[source]¶ Return the CorrelatorType if the processorType is CORRELATOR, else None.
Note that what is actually returned is the correlatorType from the zeroLags section.
Returns a CorrelatorType enumeration or None if not CORRELATOR data or not set.
-
hasPackedData()[source]¶ Returns True if and only if all of the integrations are grouped in one subset.
This returns true if dimensionality returns 0.
-
isTP()[source]¶ Returns True if and only if the string “Total Power” appears in the title.
Note: as per the comments in SDMDataObject.cc this relies an un-said convension used to form the title. Apparently it’s difficult to be sure what data is Total Power only data.
-
isWVR()[source]¶ Returns True if and only if the string “WVR” appears in the title.
Note: as per the comments in SDMDataObject.cc this relies an un-said convension used to form the title. Apparently it’s difficult to be sure what data is WVR data.
-
setAPClist(apcList)[source]¶ Sets the apc list in the data struct. apcList must be a list of AtmPhaseCorrection instances
-
setByteOrder(byteOrder)[source]¶ Sets the byte order using byteOrder, which must be a string value that the ByteOrder class recognizes
-
setCorrelationMode(correlationMode)[source]¶ sets the correlationMode, correlationMode is any value that can be used for the CorrelationMode enumeration
-
setDimensionality(dimensionality)[source]¶ set the dimensionality, always uses int(dimensionality) dimensionality must be >= 0, if > 0 then numTime must be zero when this is set
-
setExecBlockNum(execBlockNum)[source]¶ set the exec block num, always uses int(execBlockNum), can not be negative
-
setNumAntenna(numAntenna)[source]¶ set the numAntenna, always uses int(numAntenna), can not be negative
-
setNumTime(numTime)[source]¶ set the numTime, always uses int(numTime) numTime must be >= 0, if > 0 then dimensionality must be zero when this is set
-
setProcessorType(processorType)[source]¶ sets the processorType, processorType is any value that can be used for the ProcessorType enumeration
-
setSchemaVersion(schemaVersion)[source]¶ sets schemaVersion, it always uses int(schemaVersion) so that the value returned by the getter should be an int schemaVersion here can be a string, for example
-