L3Bin

#include <L3File.h>

Public Member Functions
	L3Bin (int32_t numProducts=1)
	L3Bin (const L3Bin &bin)
	~L3Bin ()
void	clear ()
L3Bin &	operator= (const L3Bin &bin)
L3Bin &	operator+= (const L3Bin &bin)
void	addWeighted (const L3Bin &bin, float weighting)
template<typename Geometry1 , typename Geometry2 >
void	addWeighted (const L3Bin &bin, Geometry1 &box, Geometry2 &geo)
void	setNumProducts (int32_t numProducts)
int32_t	getNumProducts () const
int64_t	getBinNum () const
int32_t	getNobs () const
int32_t	getNscenes () const
int64_t	getRecordNum () const
float	getObsTime () const
float	getWeights () const
uint8_t	getQuality () const
float	getSum (int32_t prodId=0) const
float	getSumSquares (int32_t prodId=0) const
float	getMean (int32_t prodId=0) const
float	getVariance (int32_t prodId=0) const
float	getStdev (int32_t prodId=0) const

Protected Attributes
int32_t	numProducts
int64_t	binNum
int64_t	recordNum
int32_t	nobs
int32_t	nscenes
uint8_t	quality
float	timeRec
float	weights
float *	sums
float *	sumSquares

Friends
class	L3Row
class	L3File
class	L3FileSMI

Detailed Description

class used to return all of the information about a bin

Definition at line 50 of file L3File.h.

Constructor & Destructor Documentation

L3Bin() [1/2]

L3Bin

(

int32_t

numProducts = 1

)

Definition at line 16 of file L3File.cpp.

L3Bin() [2/2]

L3Bin

(

const L3Bin &

bin

)

Definition at line 20 of file L3File.cpp.

~L3Bin()

~L3Bin

(

)

Definition at line 24 of file L3File.cpp.

Member Function Documentation

addWeighted() [1/2]

void addWeighted	(	const L3Bin &	bin,
		float	weighting
	)

Definition at line 142 of file L3File.cpp.

addWeighted() [2/2]

void addWeighted ( const L3Bin &  bin, Geometry1 &  box, Geometry2 &  geo  )

inline

Definition at line 89 of file L3File.h.

clear()

void clear

(

)

Definition at line 29 of file L3File.cpp.

getBinNum()

int64_t getBinNum

(

)

const

get the bin number for this bin

Returns

bin number

Definition at line 186 of file L3File.cpp.

getMean()

float getMean

(

int32_t

prodId = 0

)

const

calculate the mean for this product

Parameters

prodId

index of the product you want

Returns

the average value

Definition at line 263 of file L3File.cpp.

getNobs()

int32_t getNobs

(

)

const

get the number of observations for this bin

Returns

number observations

Definition at line 194 of file L3File.cpp.

getNscenes()

int32_t getNscenes

(

)

const

get the numbers of scenes contributing to this bin

Returns

number of scenes

Definition at line 202 of file L3File.cpp.

getNumProducts()

int32_t getNumProducts

(

)

const

get the number of products in this bin

Returns

number of products

Definition at line 178 of file L3File.cpp.

getObsTime()

float getObsTime

(

)

const

get the observation time. sec since 1993 (TAI93)

Returns

TAI93 time

Definition at line 218 of file L3File.cpp.

getQuality()

uint8_t getQuality

(

)

const

get the SST quality factor. 255 is unused, 0 is best, 2 is poor

Returns

SST quality

Definition at line 234 of file L3File.cpp.

getRecordNum()

int64_t getRecordNum

(

)

const

get the record number in the file for this bin

Returns

record number

Definition at line 210 of file L3File.cpp.

getStdev()

float getStdev

(

int32_t

prodId = 0

)

const

calculate the standard deviation for this product

Parameters

prodId

index of the product you want

Returns

the standard deviation

Definition at line 288 of file L3File.cpp.

getSum()

float getSum

(

int32_t

prodId = 0

)

const

get this bin's sum

Parameters

prodId

index of the product you want

Returns

the sum

Definition at line 243 of file L3File.cpp.

getSumSquares()

float getSumSquares

(

int32_t

prodId = 0

)

const

get the sum of the squares for this product

Parameters

prodId

index of the product you want

Returns

sum of squares

Definition at line 253 of file L3File.cpp.

getVariance()

float getVariance

(

int32_t

prodId = 0

)

const

calculate the variance for this product

Parameters

prodId

index of the product you want

Returns

the variance value

Definition at line 273 of file L3File.cpp.

getWeights()

float getWeights

(

)

const

get the weights for this bin. Used to calculate the mean.

Returns

weights

Definition at line 226 of file L3File.cpp.

operator+=()

L3Bin & operator+=

(

const L3Bin &

bin

)

Definition at line 137 of file L3File.cpp.

operator=()

L3Bin & operator=

(

const L3Bin &

bin

)

Definition at line 132 of file L3File.cpp.

setNumProducts()

void setNumProducts

(

int32_t

numProducts

)

set the number of products this bin can hold

Parameters

numProducts

Definition at line 163 of file L3File.cpp.

Friends And Related Function Documentation

L3File

friend class L3File

friend

Definition at line 52 of file L3File.h.

L3FileSMI

friend class L3FileSMI

friend

Definition at line 53 of file L3File.h.

L3Row

friend class L3Row

friend

Definition at line 51 of file L3File.h.

Member Data Documentation

binNum

int64_t binNum

protected

Definition at line 66 of file L3File.h.

nobs

int32_t nobs

protected

Definition at line 68 of file L3File.h.

nscenes

int32_t nscenes

protected

Definition at line 69 of file L3File.h.

numProducts

int32_t numProducts

protected

Definition at line 65 of file L3File.h.

quality

uint8_t quality

protected

Definition at line 70 of file L3File.h.

recordNum

int64_t recordNum

protected

Definition at line 67 of file L3File.h.

sums

float* sums

protected

Definition at line 73 of file L3File.h.

sumSquares

float* sumSquares

protected

Definition at line 74 of file L3File.h.

timeRec

float timeRec

protected

Definition at line 71 of file L3File.h.

weights

float weights

protected

Definition at line 72 of file L3File.h.

---

The documentation for this class was generated from the following files:

• /gfs-oceanweb/web/ocssw/ocssw_src/oel_hdf4/libbin/L3File.h
• /gfs-oceanweb/web/ocssw/ocssw_src/oel_hdf4/libbin/L3File.cpp