pydarn.sdio.sdDataTypes

Module: pydarn.sdio.sdDataTypes

Classes:

• pydarn.sdio.sdDataTypes.sdDataPtr
• pydarn.sdio.sdDataTypes.sdBaseData
• pydarn.sdio.sdDataTypes.gridData
• pydarn.sdio.sdDataTypes.mapData

class pydarn.sdio.sdDataTypes.gridData(dataDict=None)

a class to contain a record of gridded data, extends pydarn.sdio.sdDataTypes.sdBaseData

Attrs:

• sTime (datetime): start time of the record
• eTime (datetime): end time of the record
• stid (list): a list of the station IDs in the record, by radar
• nvec (list): a list of the number of vectors in the record, by radar
• freq (list): a list of the transmit frequencies, in kHz, by radar
• programid (list): a list of the program IDs, by radar
• noisemean (list): a list of the mean noise level, by radar
• noisesd (list): a list of the standard deviation of noise level, by radar
• gsct (list): a list of flags indicating whether ground scatter was excluded from the gridding, by radar
• vmin (list): a list of minimum allowed Doppler velocity, by radar
• vmax (list): a list of the maximum allowed Doppler velocity, by radar
• pmin (list): a list of the minimum allowed power level, by radar
• pmax (list): a list of the maximum allowed power level, by radar
• wmin (list): a list of the minimum allowed spectral width, by radar
• wmax (list): a list of the maximum allowed spectral width, by radar
• vemin (list): a list of the minimum allowed velocity error, by radar
• vemax (list): a list of the maximum allowed velocity error, by radar
• vector (pydarn.sdio.sdDataTypes.sdVector): an object containing all of the vector.* elements from the file

Example:

myGrid = pydarn.sdio.gridData()

Written by AJ 20130607

class pydarn.sdio.sdDataTypes.mapData(dataDict=None)

a class to contain a record of map potential data, extends pydarn.sdio.sdDataTypes.sdBaseData

Note

I don’t know what alot of these attributes mean. If you do, please add them in.

Attrs:

• sTime (datetime): start time of the record
• eTime (datetime): end time of the record
• dopinglevel (int): density of points where statistical model is sampled
• modelwt (int):
• errorwt (int):
• IMFflag (int):
• IMFdelay (int):
• IMFBx (float): the Bx component of the IMF
• IMFBy (float): the By component of the IMF
• IMFBz (float): the Bz component of the IMF
• modelangle (string):
• modellevel (string):
• hemi (int): the hemisphere, 1=north, 2=south?
• fitorder (int): the order of the spherical harmonic fit
• latmin (float): the minimum latitude in the spherical harmonic fit
• chisqr (double):
• chisqrdat (double):
• rmserr (double): an object containing all of the vector.* elements from the file
• lonshft (double):
• latshft (double):
• mltstart (double):
• mltend (double):
• mltav (double):
• potdrop (double): the cross polar cap potential, in volts
• potdroperr (int): the error in the cross polar cap potential
• potmax (double):
• potmaxerr (double):
• potmin (double):
• potminerr (double):
• grid (pydarn.sdio.sdDataTypes.gridData): an object to hold all of the grid data in the record
• N (list):
• Np1 (list):
• Np2 (list):
• Np3 (list):
• model (pydarn.sdio.sdDataTypes.sdModel): an object to hold the model.* data in the record

Example:

myMap = pydarn.sdio.mapData()

Written by AJ 20130607

class pydarn.sdio.sdDataTypes.sdBaseData

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

ATTRS:

• Nothing.

METHODS:

• updateValsFromDict(): converts a dict from a dmap file to baseData

Written by AJ 20130607

updateValsFromDict(aDict)

A function to to fill an sdBaseData object with the data in a dictionary that is returned from the reading of a dmap file

Note

In general, users will not need to use this.

Args:

• aDict (dict): the dictionary containing the radar data

Returns

• Nothing.

Written by AJ 20121130

class pydarn.sdio.sdDataTypes.sdDataPtr(ptr=None, sTime=None, eTime=None, hemi=None, fType=None)

A class which contains a pipeline to a data source

Attrs:

• ptr (file or mongodb query object): the file pointer
• sTime (datetime): start time of the request
• eTime (datetime): end time of the request
• hemi (str): station id of the request
• fType (str): the file type, ‘grid’, ‘map’

Methods:

• Nothing.

Written by AJ 20130607

class pydarn.sdio.sdDataTypes.sdModel(dataDict=None)

a class to contain model records of map poential data, extends pydarn.sdio.sdDataTypes.sdBaseData

Note

I don’t know what alot of these attributes mean. If you do, please add them in.

Attrs:

• mlat (list):
• kvect (list):
• velmedian (list):
• boundarymlat (int):
• boundarymlon (int):

Example:

myMod = pydarn.sdio.sdModel()

Written by AJ 20130607

class pydarn.sdio.sdDataTypes.sdVector(dataDict=None)

a class to contain vector records of gridded data, extends pydarn.sdio.sdDataTypes.sdBaseData

Attrs:

• mlat (list): the magnetic longitude of the grid cells
• mlon (list): the magnetic longitude of the grid cells
• kvect (list): the kvectors of the vectors in the grid cells
• stid (int): the station ID of the radar which made the measurement of the vector in the grid cell
• channel (int): the channel of the radar which made the measurement of the vector in the grid cell
• index (int):
• velmedian (int): the median velocity of the vector
• velsd (float): the standard deviation of the velocity of the vector
• pwrmedian (float): the median power of the vector
• pwrsd (float): the standard devation of the power of the vector
• wdtmedian (string): the median spectral width of the vector
• wdtsd (string): the standard devation on the spectral width of the vector

Example:

myVec = pydarn.sdio.sdVector()

Written by AJ 20130607

pydarn.sdio.sdDataTypes

alias of pydarn.sdio.sdDataTypes