vbl_attributes.h File Reference

Find summary attributes of an array. More...

#include <vbl/vbl_array_1d.h>
#include <vbl/vbl_array_2d.h>
#include <vbl/vbl_array_3d.h>

Go to the source code of this file.

Functions
template<class T >
T	minval (vbl_array_1d< T > const &in)
	minimum element value. More...
template<class T >
T	maxval (vbl_array_1d< T > const &in)
	maximum element value. More...
template<class T >
void	bounds (vbl_array_1d< T > const &in, T &min, T &max)
	min max bounds. More...
template<class T >
T	mean (vbl_array_1d< T > const &in)
	mean of element values. More...
template<class T >
T	median (vbl_array_1d< T > const &in)
	median of element values. More...
template<class T >
T	minval (vbl_array_2d< T > const &in)
	minimum element value. More...
template<class T >
T	maxval (vbl_array_2d< T > const &in)
	maximum element value. More...
template<class T >
void	bounds (vbl_array_2d< T > const &in, T &min, T &max)
	min max bounds. More...
template<class T >
T	mean (vbl_array_2d< T > const &in)
	mean of element values. More...
template<class T >
T	median (vbl_array_2d< T > const &in)
	median of element values. More...
template<class T >
T	minval (vbl_array_3d< T > const &in)
	minimum element value. More...
template<class T >
T	maxval (vbl_array_3d< T > const &in)
	maximum element value. More...
template<class T >
void	bounds (vbl_array_3d< T > const &in, T &min, T &max)
	min max bounds. More...
template<class T >
T	mean (vbl_array_3d< T > const &in)
	mean of element values. More...
template<class T >
T	median (vbl_array_3d< T > const &in)
	median of element values. More...

Detailed Description

Find summary attributes of an array.

Author

J.L. Mundy October 5, 2010

  Modifications
   Oct 7, 2010 - Peter Vanroose - Added the median

Definition in file vbl_attributes.h.

Function Documentation

bounds() [1/3]

template<class T >

void bounds	(	vbl_array_1d< T > const &	in,
		T &	min,
		T &	max
	)

min max bounds.

Definition at line 45 of file vbl_attributes.hxx.

bounds() [2/3]

template<class T >

void bounds	(	vbl_array_2d< T > const &	in,
		T &	min,
		T &	max
	)

min max bounds.

Definition at line 102 of file vbl_attributes.hxx.

bounds() [3/3]

template<class T >

void bounds	(	vbl_array_3d< T > const &	in,
		T &	min,
		T &	max
	)

min max bounds.

Definition at line 159 of file vbl_attributes.hxx.

maxval() [1/3]

template<class T >

T maxval

(

vbl_array_1d< T > const &

in

)

maximum element value.

Definition at line 31 of file vbl_attributes.hxx.

maxval() [2/3]

template<class T >

T maxval

(

vbl_array_2d< T > const &

in

)

maximum element value.

Definition at line 88 of file vbl_attributes.hxx.

maxval() [3/3]

template<class T >

T maxval

(

vbl_array_3d< T > const &

in

)

maximum element value.

Definition at line 145 of file vbl_attributes.hxx.

mean() [1/3]

template<class T >

T mean

(

vbl_array_1d< T > const &

in

)

mean of element values.

Definition at line 59 of file vbl_attributes.hxx.

mean() [2/3]

template<class T >

T mean

(

vbl_array_2d< T > const &

in

)

mean of element values.

Definition at line 116 of file vbl_attributes.hxx.

mean() [3/3]

template<class T >

T mean

(

vbl_array_3d< T > const &

in

)

mean of element values.

Definition at line 173 of file vbl_attributes.hxx.

median() [1/3]

template<class T >

T median

(

vbl_array_1d< T > const &

in

)

median of element values.

Actually, the "left median" is returned: it's always a value from the array, which for even-sized arrays is a "left-biased" or better said, a "smaller-biased" middle entry from the array.

median of element values.

Definition at line 186 of file vbl_attributes.hxx.

median() [2/3]

template<class T >

T median

(

vbl_array_2d< T > const &

in

)

median of element values.

Actually, the "left median" is returned: it's always a value from the array, which for even-sized arrays is a "left-biased" or better said, a "smaller-biased" middle entry from the array.

median of element values.

Definition at line 196 of file vbl_attributes.hxx.

median() [3/3]

template<class T >

T median

(

vbl_array_3d< T > const &

in

)

median of element values.

Actually, the "left median" is returned: it's always a value from the array, which for even-sized arrays is a "left-biased" or better said, a "smaller-biased" middle entry from the array.

median of element values.

Definition at line 206 of file vbl_attributes.hxx.

minval() [1/3]

template<class T >

T minval

(

vbl_array_1d< T > const &

in

)

minimum element value.

Definition at line 17 of file vbl_attributes.hxx.

minval() [2/3]

template<class T >

T minval

(

vbl_array_2d< T > const &

in

)

minimum element value.

Definition at line 74 of file vbl_attributes.hxx.

minval() [3/3]

template<class T >

T minval

(

vbl_array_3d< T > const &

in

)

minimum element value.

Definition at line 131 of file vbl_attributes.hxx.