codes:accessfunctions
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| codes:accessfunctions [2015/08/21 08:45] – bhcruz | codes:accessfunctions [Unknown date] (current) – removed - external edit (Unknown date) 127.0.0.1 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ACCESS FUNCTIONS ====== | ||
| - | **Definition of the access functions that are developed in [[http:// | ||
| - | There is [[codes: | ||
| - | **For security purposes user authentication has been added to this tools.** | ||
| - | Examples of connections in [[codes: | ||
| - | ---- | ||
| - | ===== FUNCTION TABLE ===== | ||
| - | |||
| - | ^ Function ^ Short Description ^ Long Description ^Link ^ | ||
| - | ^ getETC | ||
| - | ^ getDS | Returns the DS measures of a brewer for a date | ||
| - | ^ getDSinterval | ||
| - | ^ getZS | Returns the ZS measures of a brewer for a date | ||
| - | ^ getSL | Returns the SL measures of a brewer for a date | ||
| - | ^ getConfigbyDate | ||
| - | ^ getDSS | ||
| - | ^ getZSS | ||
| - | ^ getSLS | ||
| - | ^ getHG | Returns the mercury lamp tests of a brewer for a date | ||
| - | ^ getFileStatus | ||
| - | ^ getUmkehr | ||
| - | ^ getBfileAvailable | ||
| - | ^ getHGInterval | ||
| - | ^ getUV | Returns the UV measures for a specific scantype | ||
| - | ^ getUVAvailableScanTypes | ||
| - | ^ getUVR | ||
| - | ^ getAVG | ||
| - | |||
| - | ---- | ||
| - | ===== Descriptions ===== | ||
| - | ==== getETC ==== | ||
| - | * Function: getETC | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | * Outputs: A list of (brewerid, date(' | ||
| - | ==== getDS ==== | ||
| - | * Function: getDS | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | * Outputs: A list where the first element is the list of parameters and the rest of them are the DS measures with some extra fields as temperature or number of summary for a day. | ||
| - | ==== getDSinterval ==== | ||
| - | * Function: getDSinterval | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: start date(' | ||
| - | - enddate: end date(' | ||
| - | * Outputs: A list where the first element is the list of parameters and the rest of them are the DS measures with some extra fields as temperature or number of summary for the whole range of dates. | ||
| - | ==== getZS ==== | ||
| - | * Function: getZS | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | * Outputs: A dictionary with the ZS measures that for a brewer and a day. The key is the datetime(' | ||
| - | ==== getSL ==== | ||
| - | * Function: getSL | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | * Outputs: A dictionary with the SL measures that for a brewer and a day. The key is the datetime(' | ||
| - | ==== getConfigbyDate ==== | ||
| - | * Function: getConfigbyDate | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | * Outputs: A dictionary with the available Configuration for a brewer and a day formed by pairs of < | ||
| - | ==== getDSS ==== | ||
| - | * Function: getDSS | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | * Outputs: A list where the first element is the list of parameters and the rest of them are the DS summaries for a day. | ||
| - | ==== getZSS ==== | ||
| - | * Function: getZSS | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | * Outputs: A list where the first element is the list of parameters and the rest of them are the ZS summaries for a day. | ||
| - | ==== getSLS ==== | ||
| - | * Function: getSLS | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | * Outputs: A list where the first element is the list of parameters and the rest of them are the SL summaries for a day. | ||
| - | ==== getHG ==== | ||
| - | * Function: getHG | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | * Outputs: A list where the first element is the list of parameters and the rest of them are the mercury lamp test for a day. | ||
| - | ==== getFileStatus ==== | ||
| - | * Function: getFileStatus | ||
| - | * Inputs: | ||
| - | - file: Name of the file for status check | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | - enddate: end date(' | ||
| - | * Outputs: A list where the first element is a list with the fields and the rest are the status of a file with full information if file is provided or a short information with file name, process time and status for all the files between dates. | ||
| - | ==== getUmkehr ==== | ||
| - | * Function: getUmkehr | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | * Outputs: A list where the first element is the list of measure fields and the rest of them are the umkehr measures for a day from the B files. | ||
| - | ==== getBfileAvailable ==== | ||
| - | * Function: getBfileAvailable | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - year: date(' | ||
| - | * Outputs: A list whit the dates of the received B files in Eubrewnet. | ||
| - | ==== getHGInterval ==== | ||
| - | * Function: getHGInterval | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: start date(' | ||
| - | - date: end date(' | ||
| - | * Outputs: A list where first element is a list with the field names of the HG tests and the rest are the different measures between date and enddate. | ||
| - | ==== getUV ==== | ||
| - | * Function: getUV | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | - scantype: measures will be filtered by a specific scan type | ||
| - | * Outputs: A list where each element is a list. The different lists come in a row and can be grouped by fives. By this way, the information contained in the lists is related bellow: | ||
| - | - Header information (scan, brewerid, integration time, dead time, number of cycles, location, latitude, longitude, temperature, | ||
| - | - Minutes since 00:00 AM | ||
| - | - Wavelengths | ||
| - | - Micrometer steps | ||
| - | - Raw counts | ||
| - | ==== getUVAvailableScanTypes ==== | ||
| - | * Function: getUVAvailableScanTypes | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | * Output: A list with the different types of scans for the given brewer and date. | ||
| - | ==== getUVR ==== | ||
| - | * Function: getUVR | ||
| - | * Inputs: | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: date(' | ||
| - | * Output: A list with three lists, where the first list contains the brewerid and the date of the UVR file. The second and third lists contain pairs of wavelength and responsivity. | ||
| - | ==== getAVG ==== | ||
| - | * Function: getAVG | ||
| - | * Inputs: | ||
| - | - avg: Average name (apnavg, apoavg...) | ||
| - | - brewerid: Id of Brewer | ||
| - | - date: start date(' | ||
| - | - date: end date(' | ||
| - | * Outputs: A list where first element is a list with the field names of the AVG file and the rest are the different measures between date and enddate if both are defined, only from date if enddate is not defined. | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ===== EXAMPLES ===== | ||
| - | ==== MATLAB ==== | ||
| - | A [[http:// | ||
| - | <code matlab |t get_dss_auth.m> | ||
| - | extern> http:// | ||
| - | </ | ||
| - | |||
| - | ==== PYTHON ==== | ||
| - | A [[http:// | ||
| - | <code python |t connect_example.py> | ||
| - | extern> http:// | ||
| - | </ | ||
codes/accessfunctions.1440146726.txt.gz · Last modified: 2015/08/21 08:45 (external edit)