ROPO
Loading...
Searching...
No Matches
rave_fmi_volume.c File Reference
#include "rave_fmi_volume.h"
#include "rave_debug.h"
#include "rave_alloc.h"
Include dependency graph for rave_fmi_volume.c:

Go to the source code of this file.

Classes

struct  _RaveFmiVolume_t
 

Functions

int RaveFmiVolume_initialize (RaveFmiVolume_t *self, int sweepCount)
 
int RaveFmiVolume_getSweepCount (RaveFmiVolume_t *self)
 
FmiImageRaveFmiVolume_getImage (RaveFmiVolume_t *self)
 
FmiImageRaveFmiVolume_getSweep (RaveFmiVolume_t *self, int sweep)
 
PolarVolume_t * RaveFmiVolume_toRave (RaveFmiVolume_t *self, const char *quantity)
 
RaveFmiVolume_tRaveFmiVolume_new (int sweepCount)
 
RaveFmiVolume_tRaveFmiVolume_fromPolarVolume (PolarVolume_t *volume, const char *quantity)
 
RaveFmiVolume_tRaveFmiVolume_fromPolarScan (PolarScan_t *scan, const char *quantity)
 
RaveFmiVolume_tRaveFmiVolume_fromRaveField (RaveField_t *field)
 
RaveFmiVolume_tRaveFmiVolume_fromRave (RaveCoreObject *object, const char *quantity)
 

Variables

RaveCoreObjectType RaveFmiVolume_TYPE
 

Detailed Description

rave object wrapper for the fmi_image as a volume. This object DOES NOT support #RAVE_OBJECT_CLONE.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2011-08-31

Definition in file rave_fmi_volume.c.

Function Documentation

◆ RaveFmiVolume_fromPolarScan()

RaveFmiVolume_t * RaveFmiVolume_fromPolarScan ( PolarScan_t * scan,
const char * quantity )

Creates a fmi image from a polar scan

Parameters
[in]scan- the polar scan
[in]quantity- the quantity to use for building the fmi image (NULL == default parameter)
Returns
the object on success otherwise NULL

Definition at line 399 of file rave_fmi_volume.c.

◆ RaveFmiVolume_fromPolarVolume()

RaveFmiVolume_t * RaveFmiVolume_fromPolarVolume ( PolarVolume_t * volume,
const char * quantity )

Creates a fmi image from a polar volume

Parameters
[in]volume- the polar volume
[in]quantity- the quantity to use for building the fmi image (NULL == default parameter)
Returns
the object on success otherwise NULL

Definition at line 354 of file rave_fmi_volume.c.

◆ RaveFmiVolume_fromRave()

RaveFmiVolume_t * RaveFmiVolume_fromRave ( RaveCoreObject * object,
const char * quantity )

Creates a fmi image from a rave object. Currently supported object types are. PolarVolume_t, PolarScan_t and RaveField_t

Parameters
[in]object- the object to generate an fmi image from
[in]quantity- the specific quantity (NULL == default parameter if applicable)
Returns
the object on success otherwise NULL

Definition at line 449 of file rave_fmi_volume.c.

◆ RaveFmiVolume_fromRaveField()

RaveFmiVolume_t * RaveFmiVolume_fromRaveField ( RaveField_t * field)

Creates a fmi image from a rave field

Parameters
[in]field- the rave field
Returns
the object on success otherwise NULL

Definition at line 425 of file rave_fmi_volume.c.

◆ RaveFmiVolume_getImage()

FmiImage * RaveFmiVolume_getImage ( RaveFmiVolume_t * self)

Returns the internal FmiImage.

Parameters
[in]self- self
Returns
the internal fmi image (NOTE, THIS IS AN INTERNAL POINTER SO DO NOT RELEASE)

Definition at line 292 of file rave_fmi_volume.c.

◆ RaveFmiVolume_getSweep()

FmiImage * RaveFmiVolume_getSweep ( RaveFmiVolume_t * self,
int sweep )

Returns the internal sweep pointer.

Parameters
[in]self- self
[in]sweep- the sweep index
Returns
the sweep at specified index

Definition at line 298 of file rave_fmi_volume.c.

◆ RaveFmiVolume_getSweepCount()

int RaveFmiVolume_getSweepCount ( RaveFmiVolume_t * self)

Returns the number of sweeps this image is built from

Parameters
[in]self- self
Returns
number of sweeps

Definition at line 286 of file rave_fmi_volume.c.

◆ RaveFmiVolume_initialize()

int RaveFmiVolume_initialize ( RaveFmiVolume_t * self,
int sweepCount )

Initializes the rave image with the specific number of sweeps.

See also
RaveFmiVolume_new for short cut version
Parameters
[in]self- self
[in]sweepCount- number of sweeps this image should consist of > 0
Returns
1 on success otherwise 0

Definition at line 268 of file rave_fmi_volume.c.

◆ RaveFmiVolume_new()

RaveFmiVolume_t * RaveFmiVolume_new ( int sweepCount)

Creates a rave fmi image with specified number of sweeps

Parameters
[in]sweepCount- the number of sweeps > 0
Returns
the fmi image on success otherwise NULL

Definition at line 343 of file rave_fmi_volume.c.

◆ RaveFmiVolume_toRave()

PolarVolume_t * RaveFmiVolume_toRave ( RaveFmiVolume_t * self,
const char * quantity )

Creates a polar volume from a fmi image

Parameters
[in]self- self
[in]quantity- the quantity to be set for the parameters (may be NULL)
Returns
a polar volume on success otherwise NULL

Definition at line 307 of file rave_fmi_volume.c.

Variable Documentation

◆ RaveFmiVolume_TYPE

RaveCoreObjectType RaveFmiVolume_TYPE
Initial value:
= {
"RaveFmiVolume",
sizeof(RaveFmiVolume_t),
RaveFmiVolume_constructor,
RaveFmiVolume_destructor,
NULL
}
struct _RaveFmiVolume_t RaveFmiVolume_t

Type definition to use when creating a rave object.

Definition at line 465 of file rave_fmi_volume.c.