/disk01/web/ocssw/build/src/l2gen/qaa.h File Reference

(r8099/r7411)

Go to the source code of this file.

Enumerations
enum	{ QAA_S_PARAM = 1, QAA_CHL_PARAM = 2, QAA_COEFS_PARAM = 3, QAA_APH_CHECK = 8 }
Functions
int	qaa_is_initialized (void)
	determine if qaa algorithm properly initialized
int	qaa_init (int i410, int i440, int i490, int i555, int i640)
	initalize Quasi-Analytical Algorithm v4
int	qaa_set_param (int param,...)
	set a parameter for Quasi-Analytical Algorithm
int	qaa_v6 (int nbands, double *wavel, double *Rrs, double *aw, double *bbw, double *rrs, double *u, double *a, double *bb, unsigned char *flags)
	Quasi-Analytical Algorithm v6.
int	qaa_decomp (int nbands, double *wavel, double *rrs, double *a, double *aw, double *adg, double *aph, unsigned char *flags)
	Quasi-Analytical Algorithm - decomposition of total absorption.
int	qaaf_v6 (int nbands, float *wavel, float *Rrs, float *aw, float *bbw, float *rrs, float *u, float *a, float *bb, unsigned char *flags)
	Quasi-Analytical Algorithm v4.
int	qaaf_decomp (int nbands, float *wavel, float *rrs, float *a, float *aw, float *adg, float *aph, unsigned char *flags)
	Quasi-Analytical Algorithm - decomposition of total absorption.

---

Enumeration Type Documentation

anonymous enum

Enumerator:

QAA_S_PARAM
QAA_CHL_PARAM
QAA_COEFS_PARAM
QAA_APH_CHECK

Definition at line 11 of file qaa.h.

---

Function Documentation

int qaa_decomp	(	int	nbands,
		double *	wavel,
		double *	rrs,
		double *	a,
		double *	aw,
		double *	adg,
		double *	aph,
		unsigned char *	flags
	)

Quasi-Analytical Algorithm - decomposition of total absorption.

Parameters:

[in]	nbands	number of bands in spectrum
[in]	wavel	wavelength of spectrum (nbands)
[in]	rrs	below-water remote sensing reflectance (nbands)
[in]	a	total absorption (nbands)
[in]	aw	pure-water absorption (nbands)
[out]	adg	gelbstuff absorption (nbands)
[out]	aph	phytoplankton absorption (nbands)
[out]	flags	quality flags (will be modified) or NULL

This implements Table 3 of the Quasi-Analytical Algorithm. It decomposes the total absorption into phytoplankton absorption and gelbstuff absorption.

This implementation adds a consistency check based on the phytoplankton absorption at 443nm to improve the decomposition of total absorption.

Definition at line 388 of file qaa.c.

int qaa_init	(	int	i410,
		int	i440,
		int	i490,
		int	i555,
		int	i670
	)

initalize Quasi-Analytical Algorithm v4

Parameters:

[in]	i410	0-relative index in spectrum of 410 nm
[in]	i440	0-relative index in spectrum of 440 nm
[in]	i490	0-relative index in spectrum of 490 nm
[in]	i555	0-relative index in spectrum of 555 nm
[in]	i670	0-relative index in spectrum of 670 nm

This routine should be called to initialize various parameters that may be adjusted in the QAA algorithm or that must be known apriori. For example, the user must supply the indices for various required band numbers and whether to perform the iteration in the QAA-555 algorithm (normally yes).

Definition at line 133 of file qaa.c.

int qaa_is_initialized

(

void

)

determine if qaa algorithm properly initialized

Returns:

1 if qaa_init has been previously called; 0, otherwise

Definition at line 113 of file qaa.c.

int qaa_set_param	(	int	param,
			...
	)

set a parameter for Quasi-Analytical Algorithm

Parameters:

[in]

param

name of parameter

This routine should be called to initialize various parameters that may be adjusted in the QAA algorithm or that must be known apriori. For example, the user must supply the indices for various required band numbers. Optionally, the user may define there own values for some parameters, like S.

Presently the only parameter the user may set is the S value.

Definition at line 165 of file qaa.c.

int qaa_v6	(	int	nbands,
		double *	wavel,
		double *	Rrs,
		double *	aw,
		double *	bbw,
		double *	rrs,
		double *	u,
		double *	a,
		double *	bb,
		unsigned char *	flags
	)

Quasi-Analytical Algorithm v6.

Parameters:

[in]	nbands	number of bands in spectrum
[in]	wavel	wavelength of spectrum (nbands)
[in]	Rrs	above-water remote sensing reflectance (nbands)
[in]	aw	pure-water absorption (nbands)
[in]	bbw	pure-water back scattering (nbands)
[out]	rrs	below-water remote sensing reflectance (nbands)
[out]	u	ratio (nbands)
[out]	a	total absorption (nbands)
[out]	bb	backscattering (nbands)
[out]	flags	quality flags (will be modified) or NULL

This implements version 6 of the Quasi-Analytical Algorithm.

Definition at line 206 of file qaa.c.

int qaaf_decomp	(	int	nbands,
		float *	wavel,
		float *	rrs,
		float *	a,
		float *	aw,
		float *	adg,
		float *	aph,
		unsigned char *	flags
	)

Quasi-Analytical Algorithm - decomposition of total absorption.

See also:

qaa_decomp()

Definition at line 459 of file qaa.c.

int qaaf_v6	(	int	nbands,
		float *	wavel,
		float *	Rrs,
		float *	aw,
		float *	bbw,
		float *	rrs,
		float *	u,
		float *	a,
		float *	bb,
		unsigned char *	flags
	)

Quasi-Analytical Algorithm v4.

See also:

qaa_v6()

Definition at line 286 of file qaa.c.