ViirsBandDnb

#include <VcstViirsBandDnb.h>

Inheritance diagram for ViirsBandDnb:

Collaboration diagram for ViirsBandDnb:

Public Member Functions
	ViirsBandDnb (VcstObc *pObc, VIIRS_BAND_ENUM band)
	~ViirsBandDnb ()
int	initialize ()
int	initialize_L1A_data ()
int	initialize_LUT_data ()
int	initialize_L1B_data ()
int	write_data (const NcFile *nc_output)
int	get_l1bdata (float *l1bdata)
Public Member Functions inherited from ViirsBand
	ViirsBand (VcstObc *pObc, VIIRS_BAND_ENUM band)
virtual	~ViirsBand ()
int	calibrate ()
virtual int	write_rsb (const NcFile *nc_output, float *obs_val, unsigned short *short_val, unsigned short *pixelQuality, int8_t *unc_idx, bool bRad)
virtual int	write_teb (const NcFile *nc_output, float *obs_val, unsigned short *short_val, unsigned int *long_val, unsigned short *pixelQuality, int8_t *unc_idx, bool bRad)
virtual int	write_cdg (const NcFile *nc_output)

Protected Member Functions
int	compute_CRVS ()
int	calibrate_scan (int scan)
bool	precheck_scan (int scan)
virtual int	check_pixel_quality (int scan, int detector, int frame)
int	check_limits (int row, int frame)
virtual int	check_pixel_quality (int band, int scan, int det, short &DN_EV, unsigned short &qual)
Protected Member Functions inherited from ViirsBand
virtual int	check_pixel_quality (int band, int scan, int det, short &DN_EV, unsigned short &qual)

Protected Attributes
float	obs_fill_value_
float	obs_valid_min_
float	obs_valid_max_
unsigned short	pixel_quality_fill_value_
vector< unsigned short >	pixel_quality_flag_masks_
unsigned char	dp_dnb_1a_1b_stage_ [VIIRS_SCANS]
unsigned char	dp_dnb_dark_sub_eth_ [VIIRS_SCANS]
unsigned char	dp_dnb_tmg_mode_ [VIIRS_SCANS]
float	DN_SV_ [VIIRS_SCANS][DETECTORS][CAL_SAMPLES]
float	DN_BB_ [VIIRS_SCANS][DETECTORS][CAL_SAMPLES]
short	DN_EV_ [VIIRS_SCANS][DETECTORS][EV_PIXELS]
unsigned char	EV_GAIN_ [VIIRS_SCANS][DETECTORS][EV_PIXELS]
double	CRVS_ [DETECTORS][EV_PIXELS][GAIN_STATES][MIRROR][C_COEFFS]
bool	strayLightRegion_ [VIIRS_SCANS]
float	radiance_ [VIIRS_SCANS *DETECTORS][EV_PIXELS]
unsigned short	pixelQuality_ [VIIRS_SCANS *DETECTORS][EV_PIXELS]
unsigned char	rowQuality_ [VIIRS_SCANS *DETECTORS]
unsigned char	badDetector_ [DETECTORS]
dnbLutPtrs	pLut_
std::map< std::string, VcstLutInputItem * >	dnbLutItems_
Protected Attributes inherited from ViirsBand
bool	bLWIR_
VcstObc *	pObc_
VIIRS_BAND_ENUM	band_
VIIRS_TEB_BAND_ENUM	teb_band_
VIIRS_RSB_BAND_ENUM	rsb_band_
short	det_432_

Static Protected Attributes
static constexpr unsigned char	L1B_SCAN_QUALITY_DNB_STRAY_LIGHT = 0x80
static constexpr int	DETECTORS = 16
static constexpr int	CAL_SAMPLES = 64
static constexpr int	EV_PIXELS = 4064
static constexpr int	C_COEFFS = 3
static constexpr int	GAIN_STATES = 3
static constexpr int	GAIN_RATIOS = 2
static constexpr int	MIRROR = 2
static constexpr int	AGG_ZONES = 32
static constexpr int	SZA_BINS = 469
static constexpr int	HEMISPHERES = 2
static constexpr int	DNB_HIGH = 1
static constexpr int	DNB_MED = 2
static constexpr int	DNB_LOW = 3
static constexpr float	radOffset = -0.0000000015
static constexpr float	radRange = 0.04
static constexpr unsigned short	SATURATED_DNB_DN = 8191
static constexpr unsigned short	out_of_range_dn = 7860

Additional Inherited Members
Public Attributes inherited from ViirsBand
string	band_str_
string	ev_var_str_
float	obs_fill_value_
float	obs_valid_min_
float	obs_valid_max_
float	flt_valid_min_
float	flt_valid_max_
float	flt_scale_factor_
float	flt_add_offset_
float	shrt_rad_scale_factor_
float	shrt_rad_add_offset_
unsigned short	shrt_fill_value_
unsigned short	shrt_valid_min_
unsigned short	shrt_valid_max_
unsigned int	M13_fill_value_
unsigned int	M13_valid_min_
unsigned int	M13_valid_max_
float	shrt_scale_factor_
float	shrt_add_offset_
float	bt_fill_value_
float	bt_valid_min_
float	bt_valid_max_
unsigned short	pixel_quality_fill_value_
vector< unsigned short >	pixel_quality_flag_masks_
vector< unsigned char >	detector_quality_flag_
unsigned char	detector_quality_flag_masks_ [8]
float	uncidx_scale_factor_
unsigned short	uncidx_fill_value_
unsigned short	uncidx_valid_min_
unsigned short	uncidx_valid_max_
vector< unsigned int >	uncertainty_index_flag_values_
vector< unsigned int >	m13_uncertainty_index_flag_values_
unsigned short *	shrtPtr_
unsigned int *	longPtr_
unsigned short *	qualPtr_
int8_t *	uncPtr_
float *	radPtr_
float *	cdgPtr_
Static Public Attributes inherited from ViirsBand
static const int	processAtNight [Viirs_Bands]
static constexpr int	NUM_TAPS = 201
static constexpr int	RSB_BANDS = 14
static constexpr int	TEB_BANDS = 7
static constexpr int	MIRROR_SIDE = 2
static constexpr int	SATURATED_DN = 4095
static constexpr int	MAX_NUM_HISTORY_ORBITS = 480
static constexpr double	DEGtoRAD = 0.017453292519943296e0
static constexpr double	RADtoDEG = 57.295779513082321e0
static constexpr int	C_COEFFS = 4
static constexpr int	A_COEFFS = 3
static constexpr int	T_FP_LEVELS = 5
static constexpr int	T_ELEC_LEVELS = 5
static constexpr unsigned char	NIGHT_GRAN = 0
static constexpr unsigned char	DAY_GRAN = 1
static constexpr unsigned char	MIXED_GRAN = 2
static constexpr short	NUM_PIXEL_QUALITY_FLAGS = 4
static constexpr unsigned char	L1B_PIXEL_QUALITY_GOOD = 0x00
static constexpr unsigned char	L1B_PIXEL_QUALITY_SUBSTITUTE_CAL = 0x01
static constexpr unsigned char	L1B_PIXEL_QUALITY_OUTOFRANGE_RAD = 0x02
static constexpr unsigned char	L1B_PIXEL_QUALITY_OUTOFRANGE_RFLBT = 0x02
static constexpr unsigned char	L1B_PIXEL_QUALITY_ALLSATURATION = 0x04
static constexpr unsigned char	L1B_PIXEL_QUALITY_TEMP_NOT_NOMINAL = 0x08
static constexpr unsigned char	L1B_PIXEL_QUALITY_LOWER_MASK = 0x0f
static constexpr unsigned char	L1B_PIXEL_QUALITY_UPPER_MASK = 0xf0
static constexpr unsigned char	L1B_PIXEL_QUALITY_NOT_ALLSATURATION = 0xfb
static constexpr unsigned char	L1B_PIXEL_QUALITY_NOT_OUTOFRANGE = 0xfd
static constexpr short	NUM_DG_PIXEL_QUALITY_FLAGS = 8
static constexpr short	NUM_UADG_PIXEL_QUALITY_FLAGS = 6
static constexpr unsigned char	L1B_PIXEL_QUALITY_LOW_GAIN_STATE = 0x10
static constexpr unsigned char	L1B_PIXEL_QUALITY_MIXED_GAIN_STATE = 0x20
static constexpr unsigned char	L1B_PIXEL_QUALITY_DG_ANOMALY = 0x40
static constexpr unsigned char	L1B_PIXEL_QUALITY_SOMESATURATION = 0x80
static constexpr short	NUM_DNB_PIXEL_QUALITY_FLAGS = 5
static constexpr unsigned char	L1B_PIXEL_QUALITY_DNB_STRAY_LIGHT = 0x10
static constexpr short	NUM_BAD_PIXEL_QUALITY_FLAGS = 5
static constexpr short	BAD_PIXEL_QUAL_SHIFT = 8
static constexpr unsigned short	L1B_PIXEL_QUALITY_BOWTIE = 0x0100
static constexpr unsigned short	L1B_PIXEL_QUALITY_MISSING = 0x0200
static constexpr unsigned short	L1B_PIXEL_QUALITY_NOCALIBRATE = 0x0400
static constexpr unsigned short	L1B_PIXEL_QUALITY_DEAD_DETECTOR = 0x0800
static constexpr unsigned short	L1B_PIXEL_QUALITY_NOISY_DETECTOR = 0x1000
static constexpr short	TOTAL_SG_PIXEL_QUALITY_FLAGS = NUM_PIXEL_QUALITY_FLAGS + NUM_BAD_PIXEL_QUALITY_FLAGS
static constexpr short	TOTAL_DG_PIXEL_QUALITY_FLAGS = NUM_DG_PIXEL_QUALITY_FLAGS + NUM_BAD_PIXEL_QUALITY_FLAGS
static constexpr short	TOTAL_UADG_PIXEL_QUALITY_FLAGS = NUM_UADG_PIXEL_QUALITY_FLAGS + NUM_BAD_PIXEL_QUALITY_FLAGS
static constexpr short	TOTAL_DNB_PIXEL_QUALITY_FLAGS = NUM_DNB_PIXEL_QUALITY_FLAGS + NUM_BAD_PIXEL_QUALITY_FLAGS
static constexpr unsigned char	L1B_ROW_QUALITY_SUBSTITUTE_CAL = 0x01
static constexpr unsigned char	L1B_ROW_QUALITY_NO_CALIBRATION = 0x02
static constexpr unsigned char	L1B_ROW_QUALITY_MOON_IN_SPACE_VIEW = 0x04
static constexpr unsigned char	L1B_ROW_QUALITY_DG_ANOMALY = 0x08
static constexpr unsigned char	L1B_ROW_QUALITY_DEAD_DETECTOR = 0x10
static constexpr unsigned char	L1B_ROW_QUALITY_BB_TEMP_NOT_NOMINAL = 0x20
static constexpr unsigned char	L1B_ROW_QUALITY_LWIR_TEMP_NOT_NOMINAL = 0x40
static constexpr unsigned char	L1B_ROW_QUALITY_DNB_STRAY_LIGHT = 0x80
static constexpr int	MOON_IN_SV_SCANS_TO_SKIP_FORWARD = 6
static constexpr int	MOON_IN_SV_SCANS_TO_SKIP_BACK = 4
static constexpr float	L1B_FILL_FLOAT = -999.9f
static constexpr double	L1B_FILL_DOUBLE = -999.9L
static constexpr short	L1B_FILL_SHORT = -999
static constexpr unsigned short	L1B_FILL_USHORT = 65535
static constexpr unsigned int	L1B_FILL_UINT_M13 = 327680
static constexpr char	L1B_FILL_BYTE = -1
static constexpr unsigned char	L1B_FILL_UBYTE = 255
static constexpr float	VDNE_FLOAT32_FILL = -999.9f
static constexpr float	ELLIPSOID_FLOAT32_FILL = -999.9f
static constexpr float	ERR_FLOAT32_FILL = -999.9f
static constexpr float	ONBOARD_PT_FLOAT32_FILL = -999.9f
static constexpr float	MISS_FLOAT32_FILL = -999.9f
static constexpr float	NA_FLOAT32_FILL = -999.9f
static constexpr float	FLOAT_FILL_TEST = -999.0f
static constexpr short	SHORT_FILL_TEST = -990
static constexpr char	BYTE_FILL_TEST = 0
static constexpr unsigned char	UBYTE_FILL_TEST = 247

Detailed Description

Definition at line 28 of file VcstViirsBandDnb.h.

Constructor & Destructor Documentation

ViirsBandDnb()

ViirsBandDnb	(	VcstObc *	pObc,
		VIIRS_BAND_ENUM	band
	)

Class constructor

~ViirsBandDnb()

~ViirsBandDnb

(

)

Class destructor

Member Function Documentation

calibrate_scan()

int calibrate_scan ( int  scan )

protectedvirtual

calibrate_scan()

Perform calibration for a single DNB scan

Reimplemented from ViirsBand.

check_limits()

int check_limits ( int  row, int  frame  )

protected

check_limits()

Check whether a pixel is within its appropriate range, and set quality flags if it is not.

check_pixel_quality() [1/2]

virtual int check_pixel_quality

protected

check_pixel_quality()

Check a pixel's quality and set quality flags as indicated.

check_pixel_quality() [2/2]

virtual int check_pixel_quality ( int  scan, int  detector, int  frame  )

protectedvirtual

compute_CRVS()

int compute_CRVS ( )

protected

compute_CRVS()

Compute CRVS coefficients

get_l1bdata()

int get_l1bdata ( float *  l1bdata )

inlinevirtual

Get L1b data pointer to pass to l2gen

Reimplemented from ViirsBand.

Definition at line 75 of file VcstViirsBandDnb.h.

initialize()

int initialize ( )

virtual

Initialize all data required for calibration

Reimplemented from ViirsBand.

initialize_L1A_data()

int initialize_L1A_data ( )

virtual

Initialize L1A data

Reimplemented from ViirsBand.

initialize_L1B_data()

int initialize_L1B_data ( )

virtual

Initialize L1B data

Reimplemented from ViirsBand.

initialize_LUT_data()

int initialize_LUT_data

(

)

Initialize LUT data

precheck_scan()

bool precheck_scan ( int  scan )

protectedvirtual

precheck_scan()

Precheck_scan to determine if it is good for calibration. Returns true or false.

Reimplemented from ViirsBand.

write_data()

int write_data ( const NcFile *  nc_output )

virtual

Write L1B output data

Reimplemented from ViirsBand.

Member Data Documentation

AGG_ZONES

constexpr int AGG_ZONES = 32

staticconstexprprotected

Definition at line 105 of file VcstViirsBandDnb.h.

badDetector_

unsigned char badDetector_[DETECTORS]

protected

Definition at line 143 of file VcstViirsBandDnb.h.

C_COEFFS

constexpr int C_COEFFS = 3

staticconstexprprotected

Definition at line 101 of file VcstViirsBandDnb.h.

CAL_SAMPLES

constexpr int CAL_SAMPLES = 64

staticconstexprprotected

Definition at line 99 of file VcstViirsBandDnb.h.

CRVS_

double CRVS_[DETECTORS][EV_PIXELS][GAIN_STATES][MIRROR][C_COEFFS]

protected

Definition at line 134 of file VcstViirsBandDnb.h.

DETECTORS

constexpr int DETECTORS = 16

staticconstexprprotected

Definition at line 98 of file VcstViirsBandDnb.h.

DN_BB_

float DN_BB_[VIIRS_SCANS][DETECTORS][CAL_SAMPLES]

protected

Definition at line 129 of file VcstViirsBandDnb.h.

DN_EV_

short DN_EV_[VIIRS_SCANS][DETECTORS][EV_PIXELS]

protected

Definition at line 131 of file VcstViirsBandDnb.h.

DN_SV_

float DN_SV_[VIIRS_SCANS][DETECTORS][CAL_SAMPLES]

protected

Definition at line 128 of file VcstViirsBandDnb.h.

DNB_HIGH

constexpr int DNB_HIGH = 1

staticconstexprprotected

Definition at line 109 of file VcstViirsBandDnb.h.

DNB_LOW

constexpr int DNB_LOW = 3

staticconstexprprotected

Definition at line 111 of file VcstViirsBandDnb.h.

DNB_MED

constexpr int DNB_MED = 2

staticconstexprprotected

Definition at line 110 of file VcstViirsBandDnb.h.

dnbLutItems_

std::map<std::string, VcstLutInputItem*> dnbLutItems_

protected

Definition at line 151 of file VcstViirsBandDnb.h.

dp_dnb_1a_1b_stage_

unsigned char dp_dnb_1a_1b_stage_[VIIRS_SCANS]

protected

Definition at line 122 of file VcstViirsBandDnb.h.

dp_dnb_dark_sub_eth_

unsigned char dp_dnb_dark_sub_eth_[VIIRS_SCANS]

protected

Definition at line 123 of file VcstViirsBandDnb.h.

dp_dnb_tmg_mode_

unsigned char dp_dnb_tmg_mode_[VIIRS_SCANS]

protected

Definition at line 124 of file VcstViirsBandDnb.h.

EV_GAIN_

unsigned char EV_GAIN_[VIIRS_SCANS][DETECTORS][EV_PIXELS]

protected

Definition at line 132 of file VcstViirsBandDnb.h.

EV_PIXELS

constexpr int EV_PIXELS = 4064

staticconstexprprotected

Definition at line 100 of file VcstViirsBandDnb.h.

GAIN_RATIOS

constexpr int GAIN_RATIOS = 2

staticconstexprprotected

Definition at line 103 of file VcstViirsBandDnb.h.

GAIN_STATES

constexpr int GAIN_STATES = 3

staticconstexprprotected

Definition at line 102 of file VcstViirsBandDnb.h.

HEMISPHERES

constexpr int HEMISPHERES = 2

staticconstexprprotected

Definition at line 107 of file VcstViirsBandDnb.h.

L1B_SCAN_QUALITY_DNB_STRAY_LIGHT

constexpr unsigned char L1B_SCAN_QUALITY_DNB_STRAY_LIGHT = 0x80

staticconstexprprotected

Definition at line 94 of file VcstViirsBandDnb.h.

MIRROR

constexpr int MIRROR = 2

staticconstexprprotected

Definition at line 104 of file VcstViirsBandDnb.h.

obs_fill_value_

float obs_fill_value_

protected

Definition at line 83 of file VcstViirsBandDnb.h.

obs_valid_max_

float obs_valid_max_

protected

Definition at line 85 of file VcstViirsBandDnb.h.

obs_valid_min_

float obs_valid_min_

protected

Definition at line 84 of file VcstViirsBandDnb.h.

out_of_range_dn

constexpr unsigned short out_of_range_dn = 7860

staticconstexprprotected

Definition at line 117 of file VcstViirsBandDnb.h.

pixel_quality_fill_value_

unsigned short pixel_quality_fill_value_

protected

Definition at line 89 of file VcstViirsBandDnb.h.

pixel_quality_flag_masks_

vector<unsigned short> pixel_quality_flag_masks_

protected

Definition at line 90 of file VcstViirsBandDnb.h.

pixelQuality_

unsigned short pixelQuality_[VIIRS_SCANS *DETECTORS][EV_PIXELS]

protected

Definition at line 141 of file VcstViirsBandDnb.h.

pLut_

dnbLutPtrs pLut_

protected

Definition at line 147 of file VcstViirsBandDnb.h.

radiance_

float radiance_[VIIRS_SCANS *DETECTORS][EV_PIXELS]

protected

Definition at line 140 of file VcstViirsBandDnb.h.

radOffset

constexpr float radOffset = -0.0000000015

staticconstexprprotected

Definition at line 113 of file VcstViirsBandDnb.h.

radRange

constexpr float radRange = 0.04

staticconstexprprotected

Definition at line 114 of file VcstViirsBandDnb.h.

rowQuality_

unsigned char rowQuality_[VIIRS_SCANS *DETECTORS]

protected

Definition at line 142 of file VcstViirsBandDnb.h.

SATURATED_DNB_DN

constexpr unsigned short SATURATED_DNB_DN = 8191

staticconstexprprotected

Definition at line 116 of file VcstViirsBandDnb.h.

strayLightRegion_

bool strayLightRegion_[VIIRS_SCANS]

protected

Definition at line 136 of file VcstViirsBandDnb.h.

SZA_BINS

constexpr int SZA_BINS = 469

staticconstexprprotected

Definition at line 106 of file VcstViirsBandDnb.h.

---

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

• /gfs-oceanweb/web/ocssw/ocssw_src/include/ViirsCal/VcstViirsBandDnb.h