vertical_profile.h File Reference

Defines the functions available when working with vertical profiles. More...

#include "rave_object.h"
#include "rave_types.h"
#include "rave_field.h"
#include "rave_attribute.h"

Go to the source code of this file.

Typedefs
typedef struct _VerticalProfile_t	VerticalProfile_t
	Defines a Vertical Profile.

Functions
int	VerticalProfile_setTime (VerticalProfile_t *self, const char *value)
	Sets the nominal time.
const char *	VerticalProfile_getTime (VerticalProfile_t *self)
	Returns the nominal time.
int	VerticalProfile_setDate (VerticalProfile_t *self, const char *value)
	Sets the nominal date.
const char *	VerticalProfile_getDate (VerticalProfile_t *self)
	Returns the nominal date.
int	VerticalProfile_setSource (VerticalProfile_t *self, const char *value)
	Sets the source.
const char *	VerticalProfile_getSource (VerticalProfile_t *self)
	Returns the source.
int	VerticalProfile_setProdname (VerticalProfile_t *self, const char *value)
	Sets the product name.
const char *	VerticalProfile_getProdname (VerticalProfile_t *self)
	Returns the product name.
void	VerticalProfile_setLongitude (VerticalProfile_t *self, double lon)
	Sets the longitude.
double	VerticalProfile_getLongitude (VerticalProfile_t *self)
	Returns the longitude.
void	VerticalProfile_setLatitude (VerticalProfile_t *self, double lat)
	Sets the latitude.
double	VerticalProfile_getLatitude (VerticalProfile_t *self)
	Returns the latitude.
void	VerticalProfile_setHeight (VerticalProfile_t *self, double h)
	Sets the height of the centre of the antenna.
double	VerticalProfile_getHeight (VerticalProfile_t *self)
	Returns the height of the centre of the antenna.
int	VerticalProfile_setLevels (VerticalProfile_t *self, long l)
	Sets the number of levels in the profile.
long	VerticalProfile_getLevels (VerticalProfile_t *self)
	Returns the number of levels in the profile.
int	VerticalProfile_setStartTime (VerticalProfile_t *self, const char *s)
	Sets the starttime of the lowest accepted scan.
const char *	VerticalProfile_getStartTime (VerticalProfile_t *self)
	Returns the starttime for the lowest accepted scan.
int	VerticalProfile_setEndTime (VerticalProfile_t *self, const char *s)
	Sets the endtime of the highest scan.
const char *	VerticalProfile_getEndTime (VerticalProfile_t *self)
	Returns the endtime for the highest scan.
int	VerticalProfile_setStartDate (VerticalProfile_t *self, const char *s)
	Sets the startdate for the VP.
const char *	VerticalProfile_getStartDate (VerticalProfile_t *self)
	Returns the startdate for the VP.
int	VerticalProfile_setEndDate (VerticalProfile_t *self, const char *s)
	Sets the enddate of the VP.
const char *	VerticalProfile_getEndDate (VerticalProfile_t *self)
	Returns the enddate for the VP.
int	VerticalProfile_setProduct (VerticalProfile_t *self, const char *s)
	Sets the product for the VP.
const char *	VerticalProfile_getProduct (VerticalProfile_t *self)
	Returns the product for the VP.
void	VerticalProfile_setInterval (VerticalProfile_t *self, double i)
	Sets the vertical distance (m) between height intervals, or 0.0 if variable.
double	VerticalProfile_getInterval (VerticalProfile_t *self)
	Returns the vertical distance (m) between height intervals, or 0.0 if variable.
void	VerticalProfile_setMinheight (VerticalProfile_t *self, double h)
	Sets the minimum height in meters above mean sea level.
double	VerticalProfile_getMinheight (VerticalProfile_t *self)
	Returns the minimum height in meters above mean sea level.
void	VerticalProfile_setMaxheight (VerticalProfile_t *self, double h)
	Sets the maximum height in meters above mean sea level.
double	VerticalProfile_getMaxheight (VerticalProfile_t *self)
	Returns the maximum height in meters above mean sea level.
int	VerticalProfile_addAttribute (VerticalProfile_t *self, RaveAttribute_t *attribute)
	Adds a rave attribute to the vertical profile.
int	VerticalProfile_addAttributeVersion (VerticalProfile_t *self, RaveAttribute_t *attribute, RaveIO_ODIM_Version version)
	Adds a rave attribute of specified version to the vertical profile.
RaveAttribute_t *	VerticalProfile_getAttribute (VerticalProfile_t *self, const char *name)
	Returns the rave attribute that is named accordingly.
RaveAttribute_t *	VerticalProfile_getAttributeVersion (VerticalProfile_t *self, const char *name, RaveIO_ODIM_Version version)
	Returns the rave attribute that is named accordingly of specified version.
int	VerticalProfile_hasAttribute (VerticalProfile_t *self, const char *name)
	Returns if the specified attribute exists or not.
RaveList_t *	VerticalProfile_getAttributeNames (VerticalProfile_t *self)
	Returns a list of attribute names.
RaveList_t *	VerticalProfile_getAttributeNamesVersion (VerticalProfile_t *self, RaveIO_ODIM_Version version)
	Returns a list of attribute names for specified version.
RaveObjectList_t *	VerticalProfile_getAttributeValues (VerticalProfile_t *self)
	Returns a list of attribute values belonging to this vertical profile.
RaveObjectList_t *	VerticalProfile_getAttributeValuesVersion (VerticalProfile_t *self, RaveIO_ODIM_Version version)
	Returns a list of attribute values for the specified version belonging to this vertical profile.
RaveField_t *	VerticalProfile_getFF (VerticalProfile_t *self)
	Returns the Mean horizontal wind velocity (m/s).
int	VerticalProfile_setFF (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Mean horizontal wind velocity (m/s) This function will modify ff and add the attribute what/quantity = ff.
RaveField_t *	VerticalProfile_getFFDev (VerticalProfile_t *self)
	Returns the Standard deviation of the horizontal wind velocity.
int	VerticalProfile_setFFDev (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Standard deviation of the horizontal wind velocity This function will modify ff and add the attribute what/quantity = ff_dev.
RaveField_t *	VerticalProfile_getW (VerticalProfile_t *self)
	Returns the Mean vertical wind velocity (positive upwards)
int	VerticalProfile_setW (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Mean vertical wind velocity (positive upwards) This function will modify ff and add the attribute what/quantity = w.
RaveField_t *	VerticalProfile_getWDev (VerticalProfile_t *self)
	Returns the Standard deviation of the vertical wind velocity.
int	VerticalProfile_setWDev (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Standard deviation of the vertical wind velocity This function will modify ff and add the attribute what/quantity = w_dev.
RaveField_t *	VerticalProfile_getDD (VerticalProfile_t *self)
	Returns the Mean horizontal wind direction.
int	VerticalProfile_setDD (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Mean horizontal wind direction This function will modify ff and add the attribute what/quantity = dd.
RaveField_t *	VerticalProfile_getDDDev (VerticalProfile_t *self)
	Returns the Standard deviation of the horizontal wind direction.
int	VerticalProfile_setDDDev (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Standard deviation of the horizontal wind direction This function will modify ff and add the attribute what/quantity = dd_dev.
RaveField_t *	VerticalProfile_getDiv (VerticalProfile_t *self)
	Returns the Divergence.
int	VerticalProfile_setDiv (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Divergence This function will modify ff and add the attribute what/quantity = div.
RaveField_t *	VerticalProfile_getDivDev (VerticalProfile_t *self)
	Returns the Standard deviation of the divergence.
int	VerticalProfile_setDivDev (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Standard deviation of the divergence This function will modify ff and add the attribute what/quantity = div_dev.
RaveField_t *	VerticalProfile_getDef (VerticalProfile_t *self)
	Returns the Deformation.
int	VerticalProfile_setDef (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Deformation This function will modify ff and add the attribute what/quantity = def.
RaveField_t *	VerticalProfile_getDefDev (VerticalProfile_t *self)
	Returns the Standard deviation of the deformation.
int	VerticalProfile_setDefDev (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Standard deviation of the deformation This function will modify ff and add the attribute what/quantity = def_dev.
RaveField_t *	VerticalProfile_getAD (VerticalProfile_t *self)
	Returns the Axis of dilation (0-360)
int	VerticalProfile_setAD (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Axis of dilation (0-360) This function will modify ff and add the attribute what/quantity = ad.
RaveField_t *	VerticalProfile_getADDev (VerticalProfile_t *self)
	Returns the Standard deviation of the axis of dilation.
int	VerticalProfile_setADDev (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Standard deviation of the axis of dilation This function will modify ff and add the attribute what/quantity = ad_dev.
RaveField_t *	VerticalProfile_getDBZ (VerticalProfile_t *self)
	Returns the Mean radar reflectivity factor.
int	VerticalProfile_setDBZ (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Mean radar reflectivity factor This function will modify ff and add the attribute what/quantity = dbz.
RaveField_t *	VerticalProfile_getDBZDev (VerticalProfile_t *self)
	Returns the Standard deviation of the radar reflectivity factor.
int	VerticalProfile_setDBZDev (VerticalProfile_t *self, RaveField_t *ff)
	Sets the Standard deviation of the radar reflectivity factor This function will modify ff and add the attribute what/quantity = dbz_dev.
RaveField_t *	VerticalProfile_getNV (VerticalProfile_t *self)
	Returns the number of sample points for mean horizontal wind velocity.
int	VerticalProfile_setNV (VerticalProfile_t *self, RaveField_t *ff)
	Sets the number of sampled points for horizontal wind This function will add the attribute what/quantity = n.
RaveField_t *	VerticalProfile_getNZ (VerticalProfile_t *self)
	Returns the number of sample points for reflectivity.
int	VerticalProfile_setNZ (VerticalProfile_t *self, RaveField_t *ff)
	Sets the number of sampled points for reflectivity This function will modify add the attribute what/quantity = nz.
RaveField_t *	VerticalProfile_getHGHT (VerticalProfile_t *self)
	Returns the different height levels.
int	VerticalProfile_setHGHT (VerticalProfile_t *self, RaveField_t *ff)
	Sets the different height levels.
RaveField_t *	VerticalProfile_getUWND (VerticalProfile_t *self)
	Returns the vind field UWND i.e.
int	VerticalProfile_setUWND (VerticalProfile_t *self, RaveField_t *ff)
	Sets the vind field UWND i.e.
RaveField_t *	VerticalProfile_getVWND (VerticalProfile_t *self)
	Returns the vind field VWND i.e.
int	VerticalProfile_setVWND (VerticalProfile_t *self, RaveField_t *ff)
	Sets the vind field VWND i.e.
RaveObjectList_t *	VerticalProfile_getFields (VerticalProfile_t *self)
	Returns a list of all existing fields in the vertical profile.
int	VerticalProfile_addField (VerticalProfile_t *self, RaveField_t *field)
	Adds a field to the vertical profile.
RaveField_t *	VerticalProfile_getField (VerticalProfile_t *self, const char *quantity)
	Another variant of getting the field, but use the quantity instead.

Variables
RaveCoreObjectType	VerticalProfile_TYPE
	Type definition to use when creating a rave object.

Detailed Description

Defines the functions available when working with vertical profiles.

This object supports RAVE_OBJECT_CLONE.

Author

Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2012-08-24

Author

Ulf E. Nordh (Swedish Meteorological and Hydrological Institute, SMHI)

Date

2017-02-23 Added functionality to yield an extended set of fields for vertical profiles e.g. HGHT, n (sample size), UWND and VWND

Typedef Documentation

VerticalProfile_t

typedef struct _VerticalProfile_t VerticalProfile_t

Defines a Vertical Profile.

Function Documentation

VerticalProfile_addAttribute()

int VerticalProfile_addAttribute	(	VerticalProfile_t *	self,
		RaveAttribute_t *	attribute )

Adds a rave attribute to the vertical profile.

Parameters

[in]	self	- self
[in]	attribute	- the attribute

Returns

1 on success otherwise 0

VerticalProfile_addAttributeVersion()

int VerticalProfile_addAttributeVersion	(	VerticalProfile_t *	self,
		RaveAttribute_t *	attribute,
		RaveIO_ODIM_Version	version )

Adds a rave attribute of specified version to the vertical profile.

NOTE! This method is usually only used internally.

Parameters

[in]	self	- self
[in]	attribute	- the attribute
[in]	version	- the attribute version

Returns

1 on success otherwise 0

VerticalProfile_addField()

int VerticalProfile_addField	(	VerticalProfile_t *	self,
		RaveField_t *	field )

Adds a field to the vertical profile.

The field must have what/quantity set in order to identify the type. This basically means that if addField is called with a field having what/quantity = ff, it would be the same as calling VerticalProfile_setFF. Allowed quantities are: ff, ff_dev, w, w_dev, dd, dd_dev div, div_dev, def, def_dev. ad, ad_dev, dbz, dbz_dev, n, HGHT, UWND and VWND

Parameters

[in]	self	- self
[in]	field	- the field

Returns

1 on success or 0 on failure, either inconsistency or missing/bad what/quantity.

VerticalProfile_getAD()

RaveField_t * VerticalProfile_getAD

(

VerticalProfile_t *

self

)

Returns the Axis of dilation (0-360)

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getADDev()

RaveField_t * VerticalProfile_getADDev

(

VerticalProfile_t *

self

)

Returns the Standard deviation of the axis of dilation.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getAttribute()

RaveAttribute_t * VerticalProfile_getAttribute	(	VerticalProfile_t *	self,
		const char *	name )

Returns the rave attribute that is named accordingly.

Parameters

[in]	self	- self
[in]	name	- the name of the attribute

Returns

the attribute if found otherwise NULL

VerticalProfile_getAttributeNames()

RaveList_t * VerticalProfile_getAttributeNames

(

VerticalProfile_t *

self

)

Returns a list of attribute names.

Release with @ref RaveList_freeAndDestroy.

Parameters

[in]

self

- self

Returns

a list of attribute names

VerticalProfile_getAttributeNamesVersion()

RaveList_t * VerticalProfile_getAttributeNamesVersion	(	VerticalProfile_t *	self,
		RaveIO_ODIM_Version	version )

Returns a list of attribute names for specified version.

Release with @ref RaveList_freeAndDestroy. NOTE! This method is usually only used internally.

Parameters

[in]	self	- self
[in]	version	- the attribute version

Returns

a list of attribute names

VerticalProfile_getAttributeValues()

RaveObjectList_t * VerticalProfile_getAttributeValues

(

VerticalProfile_t *

self

)

Returns a list of attribute values belonging to this vertical profile.

Parameters

[in]

self

- self

Returns

a list of RaveAttributes.

VerticalProfile_getAttributeValuesVersion()

RaveObjectList_t * VerticalProfile_getAttributeValuesVersion	(	VerticalProfile_t *	self,
		RaveIO_ODIM_Version	version )

Returns a list of attribute values for the specified version belonging to this vertical profile.

NOTE! This method is usually only used internally.

Parameters

[in]	self	- self
[in]	version	- the attribute version

Returns

a list of RaveAttributes.

VerticalProfile_getAttributeVersion()

RaveAttribute_t * VerticalProfile_getAttributeVersion	(	VerticalProfile_t *	self,
		const char *	name,
		RaveIO_ODIM_Version	version )

Returns the rave attribute that is named accordingly of specified version.

NOTE! This method is usually only used internally.

Parameters

[in]	self	- self
[in]	name	- the name of the attribute
[in]	version	- the attribute version

Returns

the attribute if found otherwise NULL

VerticalProfile_getDate()

const char * VerticalProfile_getDate

(

VerticalProfile_t *

self

)

Returns the nominal date.

Parameters

[in]

scan

- self

Returns

the nominal time (or NULL if there is none)

VerticalProfile_getDBZ()

RaveField_t * VerticalProfile_getDBZ

(

VerticalProfile_t *

self

)

Returns the Mean radar reflectivity factor.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getDBZDev()

RaveField_t * VerticalProfile_getDBZDev

(

VerticalProfile_t *

self

)

Returns the Standard deviation of the radar reflectivity factor.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getDD()

RaveField_t * VerticalProfile_getDD

(

VerticalProfile_t *

self

)

Returns the Mean horizontal wind direction.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getDDDev()

RaveField_t * VerticalProfile_getDDDev

(

VerticalProfile_t *

self

)

Returns the Standard deviation of the horizontal wind direction.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getDef()

RaveField_t * VerticalProfile_getDef

(

VerticalProfile_t *

self

)

Returns the Deformation.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getDefDev()

RaveField_t * VerticalProfile_getDefDev

(

VerticalProfile_t *

self

)

Returns the Standard deviation of the deformation.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getDiv()

RaveField_t * VerticalProfile_getDiv

(

VerticalProfile_t *

self

)

Returns the Divergence.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getDivDev()

RaveField_t * VerticalProfile_getDivDev

(

VerticalProfile_t *

self

)

Returns the Standard deviation of the divergence.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getEndDate()

const char * VerticalProfile_getEndDate

(

VerticalProfile_t *

self

)

Returns the enddate for the VP.

Parameters

[in]

self

- self

Returns

the enddate

VerticalProfile_getEndTime()

const char * VerticalProfile_getEndTime

(

VerticalProfile_t *

self

)

Returns the endtime for the highest scan.

Parameters

[in]

self

- self

Returns

the endtime

VerticalProfile_getFF()

RaveField_t * VerticalProfile_getFF

(

VerticalProfile_t *

self

)

Returns the Mean horizontal wind velocity (m/s).

Parameters

[in]

self

- self

Returns

the mean horizontal wind velocity

VerticalProfile_getFFDev()

RaveField_t * VerticalProfile_getFFDev

(

VerticalProfile_t *

self

)

Returns the Standard deviation of the horizontal wind velocity.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getField()

RaveField_t * VerticalProfile_getField	(	VerticalProfile_t *	self,
		const char *	quantity )

Another variant of getting the field, but use the quantity instead.

Parameters

[in]	self	- self
[in]	quantity	- the quantity

Returns

the field or NULL if not found or error

VerticalProfile_getFields()

RaveObjectList_t * VerticalProfile_getFields

(

VerticalProfile_t *

self

)

Returns a list of all existing fields in the vertical profile.

Each field will contain a what/quantity attribute for identification purposes.

Parameters

[in]

self

- self

Returns

a list of all existing (set) fields

VerticalProfile_getHeight()

double VerticalProfile_getHeight

(

VerticalProfile_t *

self

)

Returns the height of the centre of the antenna.

Parameters

[in]

self

- self

Returns

the height

VerticalProfile_getHGHT()

RaveField_t * VerticalProfile_getHGHT

(

VerticalProfile_t *

self

)

Returns the different height levels.

Each level is the center of the height bin

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getInterval()

double VerticalProfile_getInterval

(

VerticalProfile_t *

self

)

Returns the vertical distance (m) between height intervals, or 0.0 if variable.

Parameters

[in]

self

- self

Returns

the interval

VerticalProfile_getLatitude()

double VerticalProfile_getLatitude

(

VerticalProfile_t *

self

)

Returns the latitude.

Parameters

[in]

self

- self

Returns

the latitude in radians

VerticalProfile_getLevels()

long VerticalProfile_getLevels

(

VerticalProfile_t *

self

)

Returns the number of levels in the profile.

Parameters

[in]

self

- self

Returns

the number of levels

VerticalProfile_getLongitude()

double VerticalProfile_getLongitude

(

VerticalProfile_t *

self

)

Returns the longitude.

Parameters

[in]

self

- self

Returns

the longitude in radians

VerticalProfile_getMaxheight()

double VerticalProfile_getMaxheight

(

VerticalProfile_t *

self

)

Returns the maximum height in meters above mean sea level.

Parameters

[in]

self

- self

Returns

the interval

VerticalProfile_getMinheight()

double VerticalProfile_getMinheight

(

VerticalProfile_t *

self

)

Returns the minimum height in meters above mean sea level.

Parameters

[in]

self

- self

Returns

the interval

VerticalProfile_getNV()

RaveField_t * VerticalProfile_getNV

(

VerticalProfile_t *

self

)

Returns the number of sample points for mean horizontal wind velocity.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getNZ()

RaveField_t * VerticalProfile_getNZ

(

VerticalProfile_t *

self

)

Returns the number of sample points for reflectivity.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getProdname()

const char * VerticalProfile_getProdname

(

VerticalProfile_t *

self

)

Returns the product name.

Parameters

[in]

self

- self

Returns

the product name or NULL if there is none

VerticalProfile_getProduct()

const char * VerticalProfile_getProduct

(

VerticalProfile_t *

self

)

Returns the product for the VP.

Parameters

[in]

self

- self

Returns

the starttime

VerticalProfile_getSource()

const char * VerticalProfile_getSource

(

VerticalProfile_t *

self

)

Returns the source.

Parameters

[in]

self

- self

Returns

the source or NULL if there is none

VerticalProfile_getStartDate()

const char * VerticalProfile_getStartDate

(

VerticalProfile_t *

self

)

Returns the startdate for the VP.

Parameters

[in]

self

- self

Returns

the startdate

VerticalProfile_getStartTime()

const char * VerticalProfile_getStartTime

(

VerticalProfile_t *

self

)

Returns the starttime for the lowest accepted scan.

Parameters

[in]

self

- self

Returns

the starttime

VerticalProfile_getTime()

const char * VerticalProfile_getTime

(

VerticalProfile_t *

self

)

Returns the nominal time.

Parameters

[in]

self

- self

Returns

the nominal time (or NULL if there is none)

VerticalProfile_getUWND()

RaveField_t * VerticalProfile_getUWND

(

VerticalProfile_t *

self

)

Returns the vind field UWND i.e.

the wind component in the x-direction. This field is calculated using the fields ff and dd

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getVWND()

RaveField_t * VerticalProfile_getVWND

(

VerticalProfile_t *

self

)

Returns the vind field VWND i.e.

the wind component in the y-direction. This field is calculated using the fields ff and dd

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getW()

RaveField_t * VerticalProfile_getW

(

VerticalProfile_t *

self

)

Returns the Mean vertical wind velocity (positive upwards)

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_getWDev()

RaveField_t * VerticalProfile_getWDev

(

VerticalProfile_t *

self

)

Returns the Standard deviation of the vertical wind velocity.

Parameters

[in]

self

- self

Returns

the field

VerticalProfile_hasAttribute()

int VerticalProfile_hasAttribute	(	VerticalProfile_t *	self,
		const char *	name )

Returns if the specified attribute exists or not.

Parameters

[in]	self	- self
[in]	name	- the name of the attribute

Returns

1 if the attribute exists otherwise 0

VerticalProfile_setAD()

int VerticalProfile_setAD	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Axis of dilation (0-360) This function will modify ff and add the attribute what/quantity = ad.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setADDev()

int VerticalProfile_setADDev	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Standard deviation of the axis of dilation This function will modify ff and add the attribute what/quantity = ad_dev.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setDate()

int VerticalProfile_setDate	(	VerticalProfile_t *	self,
		const char *	value )

Sets the nominal date.

Parameters

[in]	self	- self
[in]	value	- the date in the format YYYYMMDD

Returns

1 on success, otherwise 0

VerticalProfile_setDBZ()

int VerticalProfile_setDBZ	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Mean radar reflectivity factor This function will modify ff and add the attribute what/quantity = dbz.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setDBZDev()

int VerticalProfile_setDBZDev	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Standard deviation of the radar reflectivity factor This function will modify ff and add the attribute what/quantity = dbz_dev.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setDD()

int VerticalProfile_setDD	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Mean horizontal wind direction This function will modify ff and add the attribute what/quantity = dd.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setDDDev()

int VerticalProfile_setDDDev	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Standard deviation of the horizontal wind direction This function will modify ff and add the attribute what/quantity = dd_dev.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setDef()

int VerticalProfile_setDef	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Deformation This function will modify ff and add the attribute what/quantity = def.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setDefDev()

int VerticalProfile_setDefDev	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Standard deviation of the deformation This function will modify ff and add the attribute what/quantity = def_dev.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setDiv()

int VerticalProfile_setDiv	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Divergence This function will modify ff and add the attribute what/quantity = div.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setDivDev()

int VerticalProfile_setDivDev	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Standard deviation of the divergence This function will modify ff and add the attribute what/quantity = div_dev.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setEndDate()

int VerticalProfile_setEndDate	(	VerticalProfile_t *	self,
		const char *	s )

Sets the enddate of the VP.

Parameters

[in]	self	- self
[in]	enddate	- the enddate

Returns

1 on success or 0 on failure

VerticalProfile_setEndTime()

int VerticalProfile_setEndTime	(	VerticalProfile_t *	self,
		const char *	s )

Sets the endtime of the highest scan.

Parameters

[in]	self	- self
[in]	endtime	- the endtime

Returns

1 on success or 0 on failure

VerticalProfile_setFF()

int VerticalProfile_setFF	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Mean horizontal wind velocity (m/s) This function will modify ff and add the attribute what/quantity = ff.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setFFDev()

int VerticalProfile_setFFDev	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Standard deviation of the horizontal wind velocity This function will modify ff and add the attribute what/quantity = ff_dev.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setHeight()

void VerticalProfile_setHeight	(	VerticalProfile_t *	self,
		double	h )

Sets the height of the centre of the antenna.

Parameters

[in]	self	- self
[in]	height	- the height (in meters)

VerticalProfile_setHGHT()

int VerticalProfile_setHGHT	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the different height levels.

Each level is the center of the height bin This function will modify ff and add the attribute what/quantity = HGHT.

Parameters

[in]	self	- self
[in]	HGHT	- HGHT (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setInterval()

void VerticalProfile_setInterval	(	VerticalProfile_t *	self,
		double	i )

Sets the vertical distance (m) between height intervals, or 0.0 if variable.

Parameters

[in]	self	- self
[in]	i	- the interval (in meters)

VerticalProfile_setLatitude()

void VerticalProfile_setLatitude	(	VerticalProfile_t *	self,
		double	lat )

Sets the latitude.

Parameters

[in]	self	- self
[in]	lat	- the latitude (in radians)

VerticalProfile_setLevels()

int VerticalProfile_setLevels	(	VerticalProfile_t *	self,
		long	l )

Sets the number of levels in the profile.

Parameters

[in]	self	- self
[in]	levels	- the number of levels

Returns

1 on success or 0 on failure

VerticalProfile_setLongitude()

void VerticalProfile_setLongitude	(	VerticalProfile_t *	self,
		double	lon )

Sets the longitude.

Parameters

[in]	self	- self
[in]	lon	- the longitude (in radians)

VerticalProfile_setMaxheight()

void VerticalProfile_setMaxheight	(	VerticalProfile_t *	self,
		double	h )

Sets the maximum height in meters above mean sea level.

Parameters

[in]	self	- self
[in]	h	- the height (in meters)

VerticalProfile_setMinheight()

void VerticalProfile_setMinheight	(	VerticalProfile_t *	self,
		double	h )

Sets the minimum height in meters above mean sea level.

Parameters

[in]	self	- self
[in]	h	- the height (in meters)

VerticalProfile_setNV()

int VerticalProfile_setNV	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the number of sampled points for horizontal wind This function will add the attribute what/quantity = n.

Parameters

[in]	self	- self
[in]	n	- n (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setNZ()

int VerticalProfile_setNZ	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the number of sampled points for reflectivity This function will modify add the attribute what/quantity = nz.

Parameters

[in]	self	- self
[in]	nz	- nz (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setProdname()

int VerticalProfile_setProdname	(	VerticalProfile_t *	self,
		const char *	value )

Sets the product name.

Parameters

[in]	self	- self
[in]	value	- the product name

Returns

1 on success, otherwise 0

VerticalProfile_setProduct()

int VerticalProfile_setProduct	(	VerticalProfile_t *	self,
		const char *	s )

Sets the product for the VP.

Parameters

[in]	self	- self
[in]	product	- the product

Returns

1 on success or 0 on failure

VerticalProfile_setSource()

int VerticalProfile_setSource	(	VerticalProfile_t *	self,
		const char *	value )

Sets the source.

Parameters

[in]	self	- self
[in]	value	- the source

Returns

1 on success, otherwise 0

VerticalProfile_setStartDate()

int VerticalProfile_setStartDate	(	VerticalProfile_t *	self,
		const char *	s )

Sets the startdate for the VP.

Parameters

[in]	self	- self
[in]	startdate	- the startdate

Returns

1 on success or 0 on failure

VerticalProfile_setStartTime()

int VerticalProfile_setStartTime	(	VerticalProfile_t *	self,
		const char *	s )

Sets the starttime of the lowest accepted scan.

Parameters

[in]	self	- self
[in]	starttime	- the starttime

Returns

1 on success or 0 on failure

VerticalProfile_setTime()

int VerticalProfile_setTime	(	VerticalProfile_t *	self,
		const char *	value )

Sets the nominal time.

Parameters

[in]	self	- self
[in]	value	- the time in the format HHmmss

Returns

1 on success, otherwise 0

VerticalProfile_setUWND()

int VerticalProfile_setUWND	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the vind field UWND i.e.

the wind component in the x-direction. This field is calculated using the fields ff and dd This function will modify ff and add the attribute what/quantity = UWND.

Parameters

[in]	self	- self
[in]	UWND	- UWND (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setVWND()

int VerticalProfile_setVWND	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the vind field VWND i.e.

the wind component in the y-direction. This field is calculated using the fields ff and dd This function will modify ff and add the attribute what/quantity = VWND.

Parameters

[in]	self	- self
[in]	VWND	- VWND (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setW()

int VerticalProfile_setW	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Mean vertical wind velocity (positive upwards) This function will modify ff and add the attribute what/quantity = w.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

VerticalProfile_setWDev()

int VerticalProfile_setWDev	(	VerticalProfile_t *	self,
		RaveField_t *	ff )

Sets the Standard deviation of the vertical wind velocity This function will modify ff and add the attribute what/quantity = w_dev.

Parameters

[in]	self	- self
[in]	ff	- ff (must be a 1 dimensional field with same dim as the other members).

Returns

1 on success otherwise 0

Variable Documentation

VerticalProfile_TYPE

RaveCoreObjectType VerticalProfile_TYPE

extern

Type definition to use when creating a rave object.