Navigation

pydarn.sdio.radDataTypes

Module: pydarn.sdio.radDataTypes

Classes:
class pydarn.sdio.radDataTypes.beamData(beamDict=None, myBeam=None, proctype=None)[source]

a class to contain the data from a radar beam sounding, extends class pydarn.sdio.radDataTypes.radBaseData

Attrs:
Example: 
myBeam = pydarn.sdio.radBeam()

Written by AJ 20121130

class pydarn.sdio.radDataTypes.fitData(fitDict=None, myFit=None)[source]

a class to contain the fitted params of a radar beam sounding, extends pydarn.sdio.radDataTypes.radBaseData

Attrs:
  • pwr0 (prm.nrang length list): lag 0 power
  • slist (npnts length list): list of range gates with backscatter
  • npnts (int): number of range gates with scatter
  • nlag (npnts length list): number of good lags
  • qflg (npnts length list): quality flag
  • gflg (npnts length list): ground scatter flag
  • p_l (npnts length list): lambda power
  • p_l_e (npnts length list): lambda power error
  • p_s (npnts length list): sigma power
  • p_s_e (npnts length list): sigma power error
  • v (npnts length list): velocity
  • v_e (npnts length list): velocity error
  • w_l (npnts length list): lambda spectral width
  • w_l_e (npnts length list): lambda width error
  • w_s (npnts length list): sigma spectral width
  • w_s_e (npnts length list): sigma width error
  • phi0 (npnts length list): phi 0
  • phi0_e (npnts length list): phi 0 error
  • elv (npnts length list): elevation angle
Example: 
myFit = pydarn.sdio.fitData()

Written by AJ 20121130

class pydarn.sdio.radDataTypes.iqData(iqDict=None, parent=None)[source]

a class to contain the iq data from a radar beam sounding, extends pydarn.sdio.radDataTypes.radBaseData

Warning

I’m not sure what all of the attributes mean. if somebody knows what these are, please help!

Attrs:
  • chnnum (int): number of channels?
  • smpnum (int): number of samples per pulse sequence
  • skpnum (int): number of samples to skip at the beginning of a pulse sequence?
  • seqnum (int): number of pulse sequences
  • tbadtr (? length list): time of bad tr samples?
  • tval (? length list): ?
  • atten (? length list): ?
  • noise (? length list): ?
  • offset (? length list): ?
  • size (? length list): ?
  • badtr (? length list): bad tr samples?
  • mainData (seqnum x smpnum x 2 length list): the actual iq samples (main array)
  • intData (seqnum x smpnum x 2 length list): the actual iq samples (interferometer)
Example: 
myIq = pydarn.sdio.iqData()

Written by AJ 20130116

class pydarn.sdio.radDataTypes.prmData(prmDict=None, myPrm=None)[source]

A class to represent radar operating parameters, extends pydarn.sdio.radDataTypes.radBaseData

Attrs:
  • nave (int): number of averages
  • lagfr (int): lag to first range in us
  • smsep (int): sample separation in us
  • bmazm (float): beam azimuth
  • scan (int): new scan flag
  • rxrise (int): receiver rise time
  • inttsc (int): integeration time (sec)
  • inttus (int): integration time (us)
  • mpinc (int): multi pulse increment (tau, basic lag time) in us
  • mppul (int): number of pulses
  • mplgs (int): number of lags
  • mplgexs (int): number of lags (tauscan)
  • nrang (int): number of range gates
  • frang (int): first range gate (km)
  • rsep (int): range gate separation in km
  • xcf (int): xcf flag
  • tfreq (int): transmit freq in kHz
  • ifmode (int): if mode flag
  • ptab (mppul length list): pulse table
  • ltab (mplgs x 2 length list): lag table
  • noisemean (float): mean noise level
  • noisesky (float): sky noise level
  • noisesearch (float): freq search noise level

Written by AJ 20121130

class pydarn.sdio.radDataTypes.radBaseData[source]

a base class for the radar data types. This allows for single definition of common routines

ATTRS:
  • Nothing.
METHODS:
  • updateValsFromDict(): converts a dict from a dmap file to radBaseData

Written by AJ 20130108

copyData(obj)[source]

This method is used to recursively copy all of the contents from ont object to self

Note

In general, users will not need to use this.

Args:
Returns:
  • Nothing.
Example:
myradBaseData.copyData(radBaseDataObj)

written by AJ, 20130402

updateValsFromDict(aDict)[source]

A function to to fill a radar params structure with the data in a dictionary that is returned from the reading of a dmap file

Note

In general, users will not need to us this.

Args:
  • aDict (dict): the dictionary containing the radar data
Returns
  • nothing.

Written by AJ 20121130

class pydarn.sdio.radDataTypes.radDataPtr(ptr=None, sTime=None, eTime=None, stid=None, channel=None, bmnum=None, cp=None)[source]

A class which contains a pipeline to a data source

Attrs:
  • ptr (file or mongodb query object): the data pointer (different depending on mongodo or dmap)
  • sTime (datetime): start time of the request
  • eTime (datetime): end time of the request
  • stid (int): station id of the request
  • channel (str): channel of the request
  • bmnum (int): beam number of the request
  • cp (int): control prog id of the request
  • fType (str): the file type, ‘fitacf’, ‘rawacf’, ‘iqdat’, ‘fitex’, ‘lmfit’
  • fBeam (pydarn.sdio.radDataTypes.beamData): the first beam of the next scan, useful for when reading into scan objects
Methods:
  • Nothing.

Written by AJ 20130108

class pydarn.sdio.radDataTypes.rawData(rawDict=None, parent=None)[source]

a class to contain the rawacf data from a radar beam sounding, extends pydarn.sdio.radDataTypes.radBaseData

Attrs:
  • acfd (nrang x mplgs x 2 length list): acf data
  • xcfd (nrang x mplgs x 2 length list): xcf data
Example: 
myRaw = pydarn.sdio.rawData()

Written by AJ 20130125

class pydarn.sdio.radDataTypes.scanData[source]

a class to contain a radar scan. Extends list. Just a list of pydarn.sdio.radDataTypes.beamData objects

Attrs:
Nothing.
Example: 
myBeam = pydarn.sdio.scanData()

Written by AJ 20121130

pydarn.sdio.radDataTypes

alias of pydarn.sdio.radDataTypes

Table Of Contents

Previous topic

pydarn.sdio.sdDataRead

Next topic

pydarn.sdio.sdDataTypes

This Page

Navigation

© Copyright 2013, VT SuperDARN Lab and Friends. Created using Sphinx 1.1.3.