radolan_utils.h

/* The MIT License (MIT)
 *
 * (c) Jürgen Simon 2014 (juergen.simon@uni-bonn.de)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef RADOLAN_UTILS_H
#define RADOLAN_UTILS_H

#include <radolan/types.h>

#ifdef __cplusplus

#include <ctime>

extern "C" {
namespace Radolan {
#else
#include <time.h>
#endif

    void RDPrintPolarStereographic(RDScan *, int, int);

    void RDPrintHeaderInformation(RDScan *scan);

    void RDPrintScan(RDScan *scan, int latCount, int lonCount);

    const char *RDScanTypeToString(RDScanType type);

    RDScanType RDScanTypeFromString(const char *str);

    RDDataType RDMinValue(RDScanType t);

    RDDataType RDMaxValue(RDScanType t);

    RDDataType RDMissingValue(RDScanType t);

    RDDataType RDClutterValue(RDScanType t);

    const char *RDUnits(RDScanType type);

    RDByteType RDRVP6ToByteValue(float rvp6);

    float RDByteToRVP6Value(const RDByteType byte_value);

    int RDIsCleanMeasurement(RDScanType t, RDDataType value);

    int RDIsCleanMeasurementAndNotMin(RDScanType t, RDDataType value);

    size_t RDBytesPerPixel(RDScanType type);

    float RDRainrateFromDezibels(RDDataType dezibels);

    void RDGridSize(RDScanType t, size_t *width, size_t *height);

    void RDScanTime(RDScan *scan, struct tm *);

    time_t RDScanTimeInSecondsSinceEpoch(RDScan *scan);

    float RDMMPerHour(RDScanType t, RDDataType value);

    char *RDGuessFilename(RDScanType type, time_t timestamp);


#ifdef __cplusplus
}
}
#endif

#endif /* Header Guard */