polarscanparam.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 POLARSCANPARAM_H
#define POLARSCANPARAM_H
#include "polarnav.h"
#include "projection.h"
#include "rave_object.h"
#include "rave_types.h"
#include "rave_attribute.h"
#include "rave_list.h"
#include "raveobject_list.h"
#include "rave_field.h"
#include "lazy_dataset.h"

typedef struct _PolarScanParam_t PolarScanParam_t;

extern RaveCoreObjectType PolarScanParam_TYPE;

int PolarScanParam_setQuantity(PolarScanParam_t* scanparam, const char* quantity);

const char* PolarScanParam_getQuantity(PolarScanParam_t* scanparam);

void PolarScanParam_setGain(PolarScanParam_t* scanparam, double gain);

double PolarScanParam_getGain(PolarScanParam_t* scanparam);

void PolarScanParam_setOffset(PolarScanParam_t* scanparam, double offset);

double PolarScanParam_getOffset(PolarScanParam_t* scanparam);

void PolarScanParam_setNodata(PolarScanParam_t* scanparam, double nodata);

double PolarScanParam_getNodata(PolarScanParam_t* scanparam);

void PolarScanParam_setUndetect(PolarScanParam_t* scanparam, double undetect);

double PolarScanParam_getUndetect(PolarScanParam_t* scanparam);

int PolarScanParam_setData(PolarScanParam_t* scanparam, long nbins, long nrays, void* data, RaveDataType type);

int PolarScanParam_setLazyDataset(PolarScanParam_t* scanparam, LazyDataset_t* lazyDataset);

int PolarScanParam_setData2D(PolarScanParam_t* scanparam, RaveData2D_t* data2d);

int PolarScanParam_createData(PolarScanParam_t* scanparam, long nbins, long nrays, RaveDataType type);

void* PolarScanParam_getData(PolarScanParam_t* scanparam);

RaveData2D_t* PolarScanParam_getData2D(PolarScanParam_t* scanparam);

long PolarScanParam_getNbins(PolarScanParam_t* scanparam);

long PolarScanParam_getNrays(PolarScanParam_t* scanparam);

RaveDataType PolarScanParam_getDataType(PolarScanParam_t* scan);

RaveValueType PolarScanParam_getValue(PolarScanParam_t* scanparam, int bin, int ray, double* v);

RaveValueType PolarScanParam_getConvertedValue(PolarScanParam_t* scanparam, int bin, int ray, double* v);

int PolarScanParam_setValue(PolarScanParam_t* scanparam, int bin, int ray, double v);

int PolarScanParam_addAttribute(PolarScanParam_t* scanparam,
  RaveAttribute_t* attribute);

int PolarScanParam_addAttributeVersion(PolarScanParam_t* scanparam, RaveAttribute_t* attribute, RaveIO_ODIM_Version version);

RaveAttribute_t* PolarScanParam_getAttribute(PolarScanParam_t* scanparam,  const char* name);

RaveAttribute_t* PolarScanParam_getAttributeVersion(PolarScanParam_t* scanparam,  const char* name, RaveIO_ODIM_Version version);

int PolarScanParam_hasAttribute(PolarScanParam_t* scanparam, const char* name);

RaveList_t* PolarScanParam_getAttributeNames(PolarScanParam_t* scanparam);

RaveList_t* PolarScanParam_getAttributeNamesVersion(PolarScanParam_t* scanparam, RaveIO_ODIM_Version version);

RaveObjectList_t* PolarScanParam_getAttributeValues(PolarScanParam_t* scanparam);

RaveObjectList_t* PolarScanParam_getAttributeValuesVersion(PolarScanParam_t* scanparam, RaveIO_ODIM_Version version);

int PolarScanParam_addQualityField(PolarScanParam_t* param, RaveField_t* field);

RaveField_t* PolarScanParam_getQualityField(PolarScanParam_t* param, int index);

int PolarScanParam_getNumberOfQualityFields(PolarScanParam_t* param);

void PolarScanParam_removeQualityField(PolarScanParam_t* param, int index);

RaveObjectList_t* PolarScanParam_getQualityFields(PolarScanParam_t* param);

RaveField_t* PolarScanParam_getQualityFieldByHowTask(PolarScanParam_t* param, const char* value);

RaveField_t* PolarScanParam_toField(PolarScanParam_t* param);

PolarScanParam_t* PolarScanParam_fromField(RaveField_t* field);

int PolarScanParam_convertDataDoubleToUchar(PolarScanParam_t* param);

int PolarScanParam_shiftData(PolarScanParam_t* param, int nrays);

void PolarScanParam_setLegend(PolarScanParam_t* self, RaveLegend_t* legend);

int PolarScanParam_hasLegend(PolarScanParam_t* self);

RaveLegend_t* PolarScanParam_getLegend(PolarScanParam_t* self);
 
#endif