beamblockagemap.h File Reference

Beam-blockage topography map reading functionallity. More...

#include <string.h>
#include "rave_object.h"
#include "rave_field.h"
#include "bbtopography.h"
#include "polarscan.h"

Go to the source code of this file.

Typedefs
typedef struct _BeamBlockageMap_t	BeamBlockageMap_t
	Defines a beam blockage object.

Functions
int	BeamBlockageMap_setTopo30Directory (BeamBlockageMap_t *self, const char *topodirectory)
	Sets the topo30 directory.
const char *	BeamBlockageMap_getTopo30Directory (BeamBlockageMap_t *self)
	Returns the topo30 directory.
BBTopography_t *	BeamBlockageMap_readTopography (BeamBlockageMap_t *self, double lat, double lon, double d)
	Find out which maps are needed to cover given area.
BBTopography_t *	BeamBlockageMap_getTopographyForScan (BeamBlockageMap_t *self, PolarScan_t *scan)
	Returns a topography that matches the scan sweep strategy.

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

Detailed Description

Beam-blockage topography map reading functionallity.

Author

Anders Henja (SMHI)

Date

2011-11-14

Typedef Documentation

BeamBlockageMap_t

typedef struct _BeamBlockageMap_t BeamBlockageMap_t

Defines a beam blockage object.

Function Documentation

BeamBlockageMap_getTopo30Directory()

const char * BeamBlockageMap_getTopo30Directory

(

BeamBlockageMap_t *

self

)

Returns the topo30 directory.

Parameters

[in]

self

- self

Returns

the topo30 directory

BeamBlockageMap_getTopographyForScan()

BBTopography_t * BeamBlockageMap_getTopographyForScan	(	BeamBlockageMap_t *	self,
		PolarScan_t *	scan )

Returns a topography that matches the scan sweep strategy.

I.e. the topography for each bin/ray index.

Parameters

[in]	self	- self
[in]	scan	- the polar scan

Returns

the topography with the corresponding dimensions. cols = bin and rows = rays

BeamBlockageMap_readTopography()

BBTopography_t * BeamBlockageMap_readTopography	(	BeamBlockageMap_t *	self,
		double	lat,
		double	lon,
		double	d )

Find out which maps are needed to cover given area.

Parameters

[in]	lat	- latitude of radar in radians
[in]	lon	- longitude of radar in radians
[in]	d	- maximum range of radar in meters

Returns

the topography field

Parameters

[in]	lat	- latitude of radar in degrees
[in]	lon	- longitude of radar in degrees
[in]	d	- maximum range of radar in meters

Returns

flag corresponding to map to be read

BeamBlockageMap_setTopo30Directory()

int BeamBlockageMap_setTopo30Directory	(	BeamBlockageMap_t *	self,
		const char *	topodirectory )

Sets the topo30 directory.

Parameters

[in]	self	- self
[in]	topodirectory	- the topo directory

Returns

1 on success otherwise 0

Variable Documentation

BeamBlockageMap_TYPE

RaveCoreObjectType BeamBlockageMap_TYPE

extern

Type definition to use when creating a rave object.