pydarn.sdio.fitexfilter

Module: pydarn.sdio.fitexfilter

Filter fitexfiles natively in python

Warning

This is very SLOW. We are currently working on this. We recommend using the c version which is folded into pydarn.sdio.radDataRead.radDataOpen()

Functions:

• pydarn.sdio.fitexfilter.combBeams()
• pydarn.sdio.fitexfilter.fitFilter()
• pydarn.sdio.fitexfilter.doFilter()

Classes:

• pydarn.sdio.fitexfilter.Gate

class pydarn.sdio.fitexfilter.Gate(fit, i)

A class to represent a single range gate

Attrs:

• v (float): velocity
• w_l (float): spectral width
• p_l (float): power
• elv (float): elevation angle
• phi0 (float): phase difference between front and back array

written by AJ, 20130402

pydarn.sdio.fitexfilter.combBeams(scan)

This function combines all repeated beams within a scan into an averaged beam

Args:

• scan (sdio.scanData): the scan to be combined

Returns:

• outScan (sdio.scanData): the combined scan

Example:

combBeams(myScan)

written by AJ, 20130402

pydarn.sdio.fitexfilter.doFilter(scans, thresh=0.4)

This function applies a boxcar filter to consecutive scans

Warning

This is VERY slow. We are currently working on improving this.

Args:

• scans (list): a list of 3 consecutive scans in time.
• [thresh] (float): the filter threshold for turning on a R-B cell. default = 0.4

Returns:

• outScan** (pydarn.sdio.radDataTypes.scanData): the filtered scan

Example:

filtScan = pydarn.sdio.fitexfilter.doFilter(scanList,thresh=0.5)

written by AJ, 20130402

pydarn.sdio.fitexfilter.fitFilter(inFile, outFile, thresh=0.4, vb=False)

This function applies a boxcar filter to a fitacf file

Warning

This is VERY slow. We are currently working on improving this.

Args:

• infile (str): the name of the input fitacf-format file
• outfile (str): the name of the output file
• [thresh] (float): the filter threshold for turning on a R-B cell. default = 0.4
• [vb] (boolean): a flag indicating verbose output. default = False

Returns:

• Nothing.

Example:

pydarn.sdio.fitexfilter.fitFilter('input.fitacf','output.fitacf',thresh=0.5,vb=True)

written by AJ, 20130402

pydarn.sdio.fitexfilter

alias of pydarn.sdio.fitexfilter