Lib.odc_polarQC Namespace Reference

Functions
	QC (pload)
	Run Quality Controls.
	MakeCheckOfstr (ifstr)
	Create an output file string and check for the presence of an output file.
	generate (ifstr)
	Generator, includes gathering of timing information for benchmarking.
	multi_generate (fstrs, procs=None)
	Distributes 'generate' among the available CPU cores on this machine.

Variables
str	opath = '/dev/shm/odc'
	algorithm_ids = None
bool	delete = False
bool	check = True

Detailed Description

Copyright (C) 2012- Swedish Meteorological and Hydrological Institute (SMHI)

This file is part of RAVE.

RAVE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

RAVE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with RAVE.  If not, see <http://www.gnu.org/licenses/>.

Function Documentation

generate()

Lib.odc_polarQC.generate

(

ifstr

)

Generator, includes gathering of timing information for benchmarking.

Parameters

ifstr

string of the input file

Returns

tuple of strings, containing input file and return status, either "OK", "EXISTS", or a Traceback message. In the case of "OK", benchmarking statistics are also included in a tuple

MakeCheckOfstr()

Lib.odc_polarQC.MakeCheckOfstr

(

ifstr

)

Create an output file string and check for the presence of an output file.

Parameters

ifstr

string input file string

Returns

tuple containing output file string and a True/False on its presence. Will return False if the input file has been copied to the output directory.

multi_generate()

Lib.odc_polarQC.multi_generate	(		fstrs,
			procs = None )

Distributes 'generate' among the available CPU cores on this machine.

Parameters

fstrs	list of input file name strings
procs	int number of concurrent processes, defaults to the max allowed

Returns

list of returned tuples from generate

QC()

Lib.odc_polarQC.QC

(

pload

)

Run Quality Controls.

Parameters

pload	input polar data, either a SCAN or a PVOL object
new	version of pload, updated with quality field(s) generated by the chosen QC algorithms