pydarn.sdio.radDataRead¶
Module: pydarn.sdio.radDataRead¶
- Functions:
- pydarn.sdio.radDataRead.radDataOpen(sTime, rad, eTime=None, channel=None, bmnum=None, cp=None, fileType='fitex', filtered=False, src=None, fileName=None, custType='fitex', noCache=False)[source]¶
A function to establish a pipeline through which we can read radar data. first it tries the mongodb, then it tries to find local files, and lastly it sftp’s over to the VT data server.
- Args:
- sTime (datetime): the beginning time for which you want data
- rad (str): the 3-letter radar code for which you want data
- [eTime] (datetime): the last time that you want data for. if this is set to None, it will be set to 1 day after sTime. default = None
- [channel] (str): the 1-letter code for what channel you want data from, eg ‘a’,’b’,... if this is set to None, data from ALL channels will be read. default = None
- [bmnum] (int): the beam number which you want data for. If this is set to None, data from all beams will be read. default = None
- [cp] (int): the control program which you want data for. If this is set to None, data from all cp’s will be read. default = None
- [fileType] (str): The type of data you want to read. valid inputs are: ‘fitex’,’fitacf’,’lmfit’,’rawacf’,’iqdat’. if you choose a fit file format and the specified one isn’t found, we will search for one of the others. Beware: if you ask for rawacf/iq data, these files are large and the data transfer might take a long time. default = ‘fitex’
- [filtered] (boolean): a boolean specifying whether you want the fit data to be boxcar filtered. ONLY VALID FOR FIT. default = False
- [src] (str): the source of the data. valid inputs are ‘local’ ‘sftp’. if this is set to None, it will try all possibilites sequentially. default = None
- [fileName] (str): the name of a specific file which you want to open. default=None
- [custType] (str): if fileName is specified, the filetype of the file. default=’fitex’
- [noCache] (boolean): flag to indicate that you do not want to check first for cached files. default = False.
- Returns:
- myPtr (pydarn.sdio.radDataTypes.radDataPtr): a radDataPtr object which contains a link to the data to be read. this can then be passed to radDataReadRec in order to actually read the data.
- Example:
import datetime as dt myPtr = radDataOpen(dt.datetime(2011,1,1),'bks',eTime=dt.datetime(2011,1,1,2),channel='a', bmnum=7,cp=153,fileType='fitex',filtered=False, src=None):
Written by AJ 20130110
- pydarn.sdio.radDataRead.radDataReadAll(myPtr)[source]¶
A function to read a large amount (to the end of the request) of radar data into a list from a pydarn.sdio.radDataTypes.radDataPtr object
Note
to use this, you must first create a pydarn.sdio.radDataTypes.radDataPtr object with radDataOpen()
- Args:
- myPtr (pydarn.sdio.radDataTypes.radDataPtr): contains the pipeline to the data we are after
- Returns:
- myList (list): a list filled with pydarn.sdio.radDataTypes.scanData objects holding the data we are after. will return None if nothing is found
- Example:
import datetime as dt myPtr = radDataOpen(dt.datetime(2011,1,1),'bks',eTime=dt.datetime(2011,1,1,2),channel='a', bmnum=7,cp=153,fileType='fitex',filtered=False, src=None): myList = radDataReadAll(myPtr)
Written by AJ 20130606
- pydarn.sdio.radDataRead.radDataReadRec(myPtr)[source]¶
A function to read a single record of radar data from a pydarn.sdio.radDataTypes.radDataPtr object
Note
to use this, you must first create a pydarn.sdio.radDataTypes.radDataPtr object with radDataOpen()
- Args:
- myPtr (pydarn.sdio.radDataTypes.radDataPtr): contains the pipeline to the data we are after
- Returns:
- myBeam (pydarn.sdio.radDataTypes.beamData): an object filled with the data we are after. will return None when finished reading
- Example:
import datetime as dt myPtr = radDataOpen(dt.datetime(2011,1,1),'bks',eTime=dt.datetime(2011,1,1,2),channel='a', bmnum=7,cp=153,fileType='fitex',filtered=False, src=None): myBeam = radDataReadRec(myPtr)
Written by AJ 20130110
- pydarn.sdio.radDataRead.radDataReadScan(myPtr)[source]¶
A function to read a full scan of data from a pydarn.sdio.radDataTypes.radDataPtr object
Note
to use this, you must first create a pydarn.sdio.radDataTypes.radDataPtr object with radDataOpen()
Note
This will ignore any bmnum request. Also, if no channel was specified in radDataOpen, it will only read channel ‘a’
- Args:
- myPtr (pydarn.sdio.radDataTypes.radDataPtr): contains the pipeline to the data we are after
- Returns:
- myScan (pydarn.sdio.radDataTypes.scanData): an object filled with the data we are after. will return None when finished reading
- Example:
import datetime as dt myPtr = radDataOpen(dt.datetime(2011,1,1),'bks',eTime=dt.datetime(2011,1,1,2),channel='a', bmnum=7,cp=153,fileType='fitex',filtered=False, src=None): myBeam = radDataReadScan(myPtr)
Written by AJ 20130110
- pydarn.sdio.radDataRead¶
alias of pydarn.sdio.radDataRead
