ravepia.h

Go to the documentation of this file.

/* --------------------------------------------------------------------
Copyright (C) 2025 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 RAVE_PIA_H
#define RAVE_PIA_H
#include "rave_object.h"
#include "rave_field.h"
#include "polarscan.h"

typedef struct _RavePIA_t RavePIA_t;

extern RaveCoreObjectType RavePIA_TYPE;
 
const char* RavePIA_getHowTaskName();

void RavePIA_setZkPowerCoefficient(RavePIA_t* self, double c);

double RavePIA_getZkPowerCoefficient(RavePIA_t* self);

void RavePIA_setZkPowerExponent(RavePIA_t* self, double d);

double RavePIA_getZkPowerExponent(RavePIA_t* self);

void RavePIA_setPiaMax(RavePIA_t* self, double maxv);

double RavePIA_getPiaMax(RavePIA_t* self);
 

void RavePIA_setRangeResolution(RavePIA_t* self, double rr);

double RavePIA_getRangeResolution(RavePIA_t* self);
 

RaveField_t* RavePIA_calculatePIA(RavePIA_t* self, PolarScan_t* scan, const char* quantity, double* outDr);

PolarScanParam_t* RavePIA_createPIAParameter(RavePIA_t* self, PolarScan_t* scan, const char* quantity, RaveField_t** outPIA, double* outDr);

int RavePIA_process(RavePIA_t* self, PolarScan_t* scan, const char* quantity, int addparam, int reprocessquality, int apply);
 
#endif /* RAVE_GRA_H */