ODIM bird profile format specification

Specification of bird profile output in ODIM HDF5 format.

The vol2bird output format follows the ODIM_H5 version 2.3 format specification.

/Conventions				"ODIM_H5/V2_2"		[String]	#Conventions
/what										#Group
/what/object				"VP"			[String]	#Vertical profile
/what/version				"H5rad 2.2"		[String]	#Version
/what/date 				"YYYYMMDD"		[String]	#Nominal Date (copy from volume file)
/what/time				"HHmmss"		[String]	#Nominal Time (copy from volume file)
/what/source				"WMO:xxxxx"		[String]	#Radar (copy from volume file)
/where										#Group
/where/lon				5.176			[Double]	#Longitude
/where/lat				52.101			[Double]	#Latitude
/where/height				44.0			[Double]	#Height of the radar antenna [m] a.s.l.
/where/levels				20			[Long]		#Number of levels in the profile
/where/interval				200.0			[Double]	#Height interval [m]
/where/minheight			0.0			[Double]	#Minimum height in the profile [m] a.s.l.
/where/maxheight			4000.0			[Double]	#Maximum height in the profile [m] a.s.l.
/how										#Group => copy all attributes from volume file
/how/beamwidth				1.0			[Double]	#radar beam width [deg]
/how/clutterMap				"clutter.h5"		[String]	#Filename of cluttermap [string]
/how/dealiased				0			[Long]		#Whether dealiased radial velocities were used [0 no, 1 yes]
/how/enddate	 			"YYYYMMDD"		[String]	#Date (nominal date from last scan)
/how/endtime				"HHmmss"		[String]	#Time (nominal time from last scan)
/how/sd_vvp_thresh 			2.0			[Double]	#VVP radial velocity standard deviation [m/s]
/how/minrange				5.0			[Double]	#Minimum range [km] used for profile
/how/maxrange				25.0			[Double]	#Maximum range [km] used for profile
/how/minazim				0.0			[Double]	#Minimum azimuth used for profile
/how/maxazim				360.0			[Double]	#Maximum azimuth used for profile
/how/rcs_bird				10.0			[Double]	#Assumed bird radar cross-section [cm2]
/how/task				"vol2bird"		[String]	#Name of the program that generated this file
/how/startdate 				"YYYYMMDD"		[String]	#Date (nominal date from first scan)
/how/starttime				"HHmmss"		[String]	#Time (nominal time from first scan)
/how/task_args				"{see below}"		[String]	#Arguments of the program that generated this file
/how/task_version			0.2.2			[String]	#version of the program that generated this file
/how/wavelength				5.3			[Double]	#radar wavelength [cm]
/how/comment				"Birds only"		[String]	#Indicator of how these profiles were generated

/dataset1									#Group
/dataset1/data1									#Group
/dataset1/data1/what								#Group
/dataset1/data1/what/quantity		"HGHT"			[String]	#Height [m] a.s.l
/dataset1/data1/what/gain		1.0			[Double]	#Gain
/dataset1/data1/what/offset		0.0			[Double]	#Offset
/dataset1/data1/what/nodata		-1000			[Double]	#Nodata indicator
/dataset1/data1/what/undetect		-999			[Double]	#Undetect indicator
/dataset1/data1/data			1x20 array		[Dataset]	#Dataset containing profile heights (coded as HGHT = offset + gain * value)

... --> only changing those variables that are different w.r.t. /dataset1/data1

/dataset1/data2/what/quantity		"width"*		[String]	#Layer width [m]
/dataset1/data2/data			1x20 array		[Dataset]	#Dataset containing width of each layer
...
/dataset1/data3/what/quantity		"ff"			[String]	#Bird flight ground speed [m/s]
/dataset1/data3/data			1x20 array		[Dataset]	#Dataset containing bird flight ground speeds
...
/dataset1/data4/what/quantity		"dd"			[String]	#Bird flight direction [deg]
/dataset1/data4/data			1x20 array		[Dataset]	#Dataset containing bird directions
...
/dataset1/data5/what/quantity		"w"			[Double]	#vertical bird speed [m/s]
/dataset1/data5/data			1x20 array		[Dataset]	#Dataset containing bird's vertical (positive upwards) speed (unreliable!)
...
/dataset1/data6/what/quantity		"gap"*			[String]	# logical indicator of azimuthal gap without data detected
/dataset1/data6/data			1x20 array		[Dataset]	# Dataset containing gap indicators, 1 when gap present, otherwise 0.
...
/dataset1/data6/what/quantity		"dbz"*			[String]	#Bird reflectivity factor [dBZ]
/dataset1/data6/data			1x20 array		[Dataset]	#Dataset containing bird reflectivities
...
/dataset1/data7/what/quantity		"eta"*			[String]	#Bird reflectivity [cm2/km3]
/dataset1/data7/data			1x20 array		[Dataset]	#Dataset containing bird reflectivities
...
/dataset1/data8/what/quantity		"dens"*			[String]	#Bird density [1/km3]
/dataset1/data8/data			1x20 array		[Dataset]	#Dataset containing bird densities
...
/dataset1/data10/what/quantity		"n"			[String]	#Number of samples used for bird velocity profile
/dataset1/data10/data			1x20 array		[Dataset]	#Dataset containing number of samples for vvp
...
/dataset1/data11/what/quantity		"n_dbz"*		[String]	#Number of samples used for dBZ profile
/dataset1/data11/data			1x20 array		[Dataset]	#Dataset containing number of samples for dBZ
...
/dataset1/data12/what/quantity		"sd_vvp"*		[String]	#Standard deviation of VVP fit [m/s]
/dataset1/data12/data			1x20 array		[Dataset]	#Dataset containing VVP standard deviations
...
/dataset1/data13/what/quantity		"DBZH"			[String]	#Reflectivity profile [dBZ]
/dataset1/data13/data			1x20 array		[Dataset]	#Dataset containing reflecticity profile
This quantity may vary between "DBZH", "DBZV","TH","TV", corresponding with DBZTYPE setting
...
/dataset1/data14/what/quantity		"n_all"*		[String]	#Number of samples used for total velocity profile
/dataset1/data14/data			1x20 array		[Dataset]	#Dataset containing number of samples for vvp
...
/dataset1/data15/what/quantity		"n_dbz_all"*		[String]	#Number of samples used for total dBZ profile
/dataset1/data15/data			1x20 array		[Dataset]	#Dataset containing number of samples for dBZ
...

task_args string: "variable1=value,variable2=value,...,variableN=value" for example: "AREACELL=4,CHISQMIN=1E-5,CLUTPERCELL=0.5"

* indicates this an added quantity not specified in ODIM HDF5