polarscan.h

Go to the documentation of this file.

/* --------------------------------------------------------------------
Copyright (C) 2009 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/>.
------------------------------------------------------------------------*/
#ifndef POLARSCAN_H
#define POLARSCAN_H
#include "polarnav.h"
#include "projection.h"
#include "polarscanparam.h"
#include "rave_object.h"
#include "rave_types.h"
#include "rave_list.h"
#include "raveobject_list.h"
#include "rave_field.h"
#include "rave_legend.h"
 
typedef struct _PolarScan_t PolarScan_t;
 
typedef enum PolarScanSelectionMethod_t {
  PolarScanSelectionMethod_ROUND = 0,
  PolarScanSelectionMethod_FLOOR,
  PolarScanSelectionMethod_CEIL
} PolarScanSelectionMethod_t;
 
extern RaveCoreObjectType PolarScan_TYPE;
 
void PolarScan_setNavigator(PolarScan_t* scan, PolarNavigator_t* navigator);
 
PolarNavigator_t* PolarScan_getNavigator(PolarScan_t* scan);
 
void PolarScan_setProjection(PolarScan_t* scan, Projection_t* projection);
 
Projection_t* PolarScan_getProjection(PolarScan_t* scan);
 
int PolarScan_setTime(PolarScan_t* scan, const char* value);
 
const char* PolarScan_getTime(PolarScan_t* scan);
 
int PolarScan_setStartTime(PolarScan_t* scan, const char* value);
 
const char* PolarScan_getStartTime(PolarScan_t* scan);
 
int PolarScan_setEndTime(PolarScan_t* scan, const char* value);
 
const char* PolarScan_getEndTime(PolarScan_t* scan);
 
int PolarScan_setDate(PolarScan_t* scan, const char* value);
 
const char* PolarScan_getDate(PolarScan_t* scan);
 
int PolarScan_setStartDate(PolarScan_t* scan, const char* value);
 
const char* PolarScan_getStartDate(PolarScan_t* scan);
 
int PolarScan_setEndDate(PolarScan_t* scan, const char* value);
 
const char* PolarScan_getEndDate(PolarScan_t* scan);
 
int PolarScan_setSource(PolarScan_t* scan, const char* value);
 
const char* PolarScan_getSource(PolarScan_t* scan);
 
void PolarScan_setLongitude(PolarScan_t* scan, double lon);
 
double PolarScan_getLongitude(PolarScan_t* scan);
 
void PolarScan_setLatitude(PolarScan_t* scan, double lat);
 
double PolarScan_getLatitude(PolarScan_t* scan);
 
void PolarScan_setHeight(PolarScan_t* scan, double height);
 
double PolarScan_getHeight(PolarScan_t* scan);
 
double PolarScan_getDistance(PolarScan_t* scan, double lon, double lat);
 
double PolarScan_getMaxDistance(PolarScan_t* scan);
 
void PolarScan_setElangle(PolarScan_t* scan, double elangle);
 
double PolarScan_getElangle(PolarScan_t* scan);
 
long PolarScan_getNbins(PolarScan_t* scan);
 
void PolarScan_setRscale(PolarScan_t* scan, double rscale);
 
double PolarScan_getRscale(PolarScan_t* scan);
 
long PolarScan_getNrays(PolarScan_t* scan);
 
void PolarScan_setRstart(PolarScan_t* scan, double rstart);
 
double PolarScan_getRstart(PolarScan_t* scan);
 
RaveDataType PolarScan_getDataType(PolarScan_t* scan);
 
void PolarScan_setA1gate(PolarScan_t* scan, long a1gate);
 
long PolarScan_getA1gate(PolarScan_t* scan);
 
void PolarScan_setBeamwidth(PolarScan_t* scan, double beamwidth);
 
double PolarScan_getBeamwidth(PolarScan_t* scan);
 
void PolarScan_setBeamwH(PolarScan_t* scan, double beamwidth);
 
double PolarScan_getBeamwH(PolarScan_t* scan);
 
void PolarScan_setBeamwV(PolarScan_t* scan, double beamwidth);
 
double PolarScan_getBeamwV(PolarScan_t* scan);
 
int PolarScan_setDefaultParameter(PolarScan_t* scan, const char* quantity);
 
const char* PolarScan_getDefaultParameter(PolarScan_t* scan);
 
int PolarScan_addParameter(PolarScan_t* scan, PolarScanParam_t* parameter);
 
PolarScanParam_t* PolarScan_removeParameter(PolarScan_t* scan, const char* quantity);
 
int PolarScan_removeAllParameters(PolarScan_t* scan);
 
PolarScanParam_t* PolarScan_getParameter(PolarScan_t* scan, const char* quantity);
 
RaveObjectList_t* PolarScan_getParameters(PolarScan_t* scan);
 
int PolarScan_hasParameter(PolarScan_t* scan, const char* quantity);
 
RaveList_t* PolarScan_getParameterNames(PolarScan_t* scan);
 
int PolarScan_addQualityField(PolarScan_t* scan, RaveField_t* field);
 
int PolarScan_addOrReplaceQualityField(PolarScan_t* scan, RaveField_t* field);
 
RaveField_t* PolarScan_getQualityField(PolarScan_t* scan, int index);
 
int PolarScan_getNumberOfQualityFields(PolarScan_t* scan);
 
void PolarScan_removeQualityField(PolarScan_t* scan, int index);
 
RaveObjectList_t* PolarScan_getQualityFields(PolarScan_t* scan);
 
RaveField_t* PolarScan_getQualityFieldByHowTask(PolarScan_t* scan, const char* value);
 
RaveField_t* PolarScan_findQualityFieldByHowTask(PolarScan_t* scan, const char* value, const char* quantity);
 
RaveField_t* PolarScan_findAnyQualityFieldByHowTask(PolarScan_t* scan, const char* value);
 
int PolarScan_getRangeIndex(PolarScan_t* scan, double r, PolarScanSelectionMethod_t selectionMethod, int rangeMidpoint);
 
double PolarScan_getRange(PolarScan_t* scan, int ri, int rangeMidpoint);
 
void PolarScan_setUseAzimuthalNavInformation(PolarScan_t* self, int v);
 
int PolarScan_useAzimuthalNavInformation(PolarScan_t* self);
 
int PolarScan_getNorthmostIndex(PolarScan_t* self);
 
int PolarScan_getRotationRequiredToNorthmost(PolarScan_t* self);
 
int PolarScan_getAzimuthIndex(PolarScan_t* scan, double a, PolarScanSelectionMethod_t selectionMethod);
 
double PolarScan_getAzimuth(PolarScan_t* scan, int ai);
 
int PolarScan_setValue(PolarScan_t* scan, int bin, int ray, double v);
 
int PolarScan_setParameterValue(PolarScan_t* scan, const char* quantity, int bin, int ray, double v);
 
RaveValueType PolarScan_getValue(PolarScan_t* scan, int bin, int ray, double* v);
 
RaveValueType PolarScan_getParameterValue(PolarScan_t* scan, const char* quantity, int bin, int ray, double* v);
 
RaveValueType PolarScan_getConvertedValue(PolarScan_t* scan, int bin, int ray, double* v);
 
RaveValueType PolarScan_getConvertedParameterValue(PolarScan_t* scan, const char* quantity, int bin, int ray, double* v);
 
int PolarScan_getIndexFromAzimuthAndRange(
    PolarScan_t* scan,
    double a,
    double r,
    PolarScanSelectionMethod_t azimuthSelectionMethod,
    PolarScanSelectionMethod_t rangeSelectionMethod,
    int rangeMidpoint,
    int* ray,
    int* bin);
 
int PolarScan_getAzimuthAndRangeFromIndex(PolarScan_t* scan, int bin, int ray, double* a, double* r);
 
RaveValueType PolarScan_getValueAtAzimuthAndRange(PolarScan_t* scan, double a, double r, int convert, double* v);
 
RaveValueType PolarScan_getParameterValueAtAzimuthAndRange(PolarScan_t* scan, const char* quantity, double a, double r, double* v);
 
RaveValueType PolarScan_getConvertedParameterValueAtAzimuthAndRange(PolarScan_t* scan, const char* quantity, double a, double r, double* v);
 
void PolarScan_getLonLatNavigationInfo(PolarScan_t* scan, double lon, double lat, PolarNavigationInfo* info);
 
int PolarScan_fillNavigationIndexFromAzimuthAndRange(
  PolarScan_t* scan,
  PolarScanSelectionMethod_t azimuthSelectionMethod,
  PolarScanSelectionMethod_t rangeSelectionMethod,
  int rangeMidpoint,
  PolarNavigationInfo* info);
 
RaveValueType PolarScan_getNearest(PolarScan_t* scan, double lon, double lat, int convert, double* v);
 
RaveValueType PolarScan_getNearestParameterValue(PolarScan_t* scan, const char* quantity, double lon, double lat, double* v);
 
int PolarScan_addSurroundingNavigationInfosForTarget(
    PolarScan_t* scan,
    PolarNavigationInfo* targetNavInfo,
    int surroundingRangeBins,
    int surroundingRays,
    int noofNavinfos,
    PolarNavigationInfo navinfos[]);
 
int PolarScan_getSurroundingNavigationInfos(
    PolarScan_t* scan,
    double lon,
    double lat,
    int surroundingRangeBins,
    int surroundingRays,
    PolarNavigationInfo navinfos[]);
 
int PolarScan_getNearestNavigationInfo(PolarScan_t* scan, double lon, double lat, PolarNavigationInfo* navinfo);
 
RaveValueType PolarScan_getNearestConvertedParameterValue(PolarScan_t* scan, const char* quantity, double lon, double lat, double* v, PolarNavigationInfo* navinfo);
 
int PolarScan_getNearestIndex(PolarScan_t* scan, double lon, double lat, int* bin, int* ray);
 
int PolarScan_getLonLatFromIndex(PolarScan_t* scan, int bin, int ray, double* lon, double* lat);
 
int PolarScan_getQualityValueAt(PolarScan_t* scan, const char* quantity, int ri, int ai, const char* name, int convert, double* v);
 
int PolarScan_isTransformable(PolarScan_t* scan);
 
int PolarScan_addAttribute(PolarScan_t* scan, RaveAttribute_t* attribute);
 
int PolarScan_addAttributeVersion(PolarScan_t* scan, RaveAttribute_t* attribute, RaveIO_ODIM_Version version);
 
void PolarScan_removeAttribute(PolarScan_t* scan, const char* attrname);
 
RaveAttribute_t* PolarScan_getAttribute(PolarScan_t* scan, const char* name);
 
RaveAttribute_t* PolarScan_getAttributeVersion(PolarScan_t* scan, const char* name, RaveIO_ODIM_Version version);
 
int PolarScan_hasAttribute(PolarScan_t* scan, const char* name);
 
RaveList_t* PolarScan_getAttributeNames(PolarScan_t* scan);
 
RaveList_t* PolarScan_getAttributeNamesVersion(PolarScan_t* scan, RaveIO_ODIM_Version version);
 
RaveObjectList_t* PolarScan_getAttributeValues(PolarScan_t* scan);
 
RaveObjectList_t* PolarScan_getAttributeValuesVersion(PolarScan_t* scan, RaveIO_ODIM_Version version);
 
 
int PolarScan_shiftAttribute(PolarScan_t* scan, const char* name, int nx);
 
int PolarScan_isValid(PolarScan_t* scan, Rave_ObjectType otype);
 
PolarScan_t* PolarScan_createFromScanAndField(PolarScan_t* self, RaveField_t* field);
 
RaveField_t* PolarScan_getDistanceField(PolarScan_t* self);
 
RaveField_t* PolarScan_getHeightField(PolarScan_t* self);
 
int PolarScan_shiftData(PolarScan_t* self, int nrays);
 
int PolarScan_shiftDataAndAttributes(PolarScan_t* self, int nrays);
 
int PolarScan_removeParametersExcept(PolarScan_t* scan, RaveList_t* parameters);
 
void PolarScanInternal_setPolarVolumeBeamwH(PolarScan_t* scan, double bw);
 
void PolarScanInternal_setPolarVolumeBeamwV(PolarScan_t* scan, double bw);
 
int PolarScanInternal_isPolarVolumeBeamwH(PolarScan_t* scan);
 
int PolarScanInternal_isPolarVolumeBeamwV(PolarScan_t* scan);
 
#endif