OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022
VcstViirsStructs.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  ImgL1ADataType
 
struct  ModL1ADataType
 
struct  DnbL1ADataType
 
struct  ASPAnalogDataType
 
struct  ASPConfigL1ADataType
 
struct  ASPOffsetL1ADataType
 
struct  DNBConfigL1ADataType
 
struct  DPPConfigL1ADataType1
 
struct  DPPConfigL1ADataType2
 
struct  EngTempL1ADataType
 
struct  EncoderReadingL1ADataType
 
struct  EngReservedL1ADataType
 
struct  EngStatusL1ADataType
 
struct  ScanLineL1ADataType
 
struct  EngineeringL1ADataType
 

Macros

#define Viirs_Bands   22
 
#define Number_of_Scans_5min   169
 
#define SC_Diary_Records_5min   320
 
#define Number_of_Scans_6min   203
 
#define SC_Diary_Records_6min   381
 
#define Number_of_Scans   203
 
#define SC_Diary_Records   381
 
#define SC_Diary_Records_1Hz   380
 
#define SC_Diary_Records_10Hz   3801
 
#define Mband_detectors   16
 
#define Iband_detectors   32
 
#define Mband_Pixels   3200
 
#define Iband_Pixels   6400
 
#define DNB_Pixels   4064
 
#define Mband_Samples   6304
 
#define Mband_Cal_Samples   48
 
#define Iband_Cal_Samples   96
 
#define DNB_Cal_Samples   64
 
#define Number_of_Mbands   16
 
#define Number_of_Ibands   5
 
#define Number_of_Tbands   7
 
#define Number_of_MTbands   5
 
#define Number_of_ITbands   2
 
#define Number_of_Rbands   14
 
#define Number_of_MRbands   11
 
#define Number_of_IRbands   3
 
#define Number_of_DNBs   1
 
#define Agg_Zones   3
 
#define Parity   2
 
#define High_Gain   0
 
#define Low_Gain   1
 
#define Gain_States   2
 
#define C_Coefs   4
 
#define Quaternion_Elements   4
 
#define Vector_Elements   3
 
#define EV_APIDs   24
 
#define HR_Metadata   146
 
#define Cal_Metadata   134
 
#define Eng_Status   8
 
#define Eng_Block   128
 
#define ASP_Offsets   3072
 
#define SDSM_Data   256
 
#define Encoder_Reading   1290
 
#define Mirror_Sides   2
 
#define Number_of_DG_bands   7
 
#define Number_of_BB_temps   6
 
#define SDSM_Samples   5
 
#define SDSM_Detectors   8
 
#define M13_LUT_Radiance_Values   327681
 
#define LUT_Radiance_Values   65536
 
#define Number_of_Iband_Lines   Iband_detectors*Number_of_Scans
 
#define Number_of_Iband_Pixels   6400
 
#define Number_of_Mband_Lines   Mband_detectors*Number_of_Scans
 
#define Number_of_Mband_Pixels   3200
 
#define Number_of_DNB_Lines   Mband_detectors*Number_of_Scans
 
#define Number_of_DNB_Pixels   4064
 

Enumerations

enum  VIIRS_PLATFORM_ENUM { NPP, J1, J2, PLATFORM_MAXIMUM }
 
enum  GRAN_SEQ_ENUM { BEFORE, CURRENT, AFTER, GRAN_SEQ_MAXIMUM }
 
enum  VIIRS_CATEGORY_ENUM {
  ALL_BANDS, IMG_BANDS, MOD_BANDS, DNB_BAND,
  RSB_BANDS, TEB_BANDS, CATEGORY_MAXIMUM
}
 
enum  VIIRS_BAND_ENUM {
  IMG_1, IMG_2, IMG_3, IMG_4,
  IMG_5, MOD_1, MOD_2, MOD_3,
  MOD_4, MOD_5, MOD_6, MOD_7,
  MOD_8, MOD_9, MOD_10, MOD_11,
  MOD_12, MOD_13, MOD_14, MOD_15,
  MOD_16, DNB_, BAND_MAXIMUM
}
 
enum  VIIRS_I_BAND_ENUM {
  I_1, I_2, I_3, I_4,
  I_5, I_BAND_MAXIMUM
}
 
enum  VIIRS_M_BAND_ENUM {
  M_1, M_2, M_3, M_4,
  M_5, M_6, M_7, M_8,
  M_9, M_10, M_11, M_12,
  M_13, M_14, M_15, M_16,
  M_BAND_MAXIMUM
}
 
enum  VIIRS_RSB_BAND_ENUM {
  RSB_I1, RSB_I2, RSB_I3, RSB_M1,
  RSB_M2, RSB_M3, RSB_M4, RSB_M5,
  RSB_M6, RSB_M7, RSB_M8, RSB_M9,
  RSB_M10, RSB_M11, RSB_BAND_MAXIMUM
}
 
enum  VIIRS_TEB_BAND_ENUM {
  TEB_I4, TEB_I5, TEB_M12, TEB_M13,
  TEB_M14, TEB_M15, TEB_M16, TEB_BAND_MAXIMUM
}
 
enum  VIIRS_MOD_SG_BAND_ENUM {
  SG_M6, SG_M8, SG_M9, SG_M10,
  SG_M11, SG_M12, SG_M14, SG_M15,
  SG_M16, SG_BAND_MAXIMUM
}
 
enum  VIIRS_MOD_DG_BAND_ENUM {
  DG_M1, DG_M2, DG_M3, DG_M4,
  DG_M5, DG_M7, DG_M13, DG_BAND_MAXIMUM
}
 
enum  VIIRS_IMG_TEB_BAND_ENUM { I_TEB_I4, I_TEB_I5, I_TEB_BAND_MAXIMUM }
 
enum  VIIRS_MOD_RSB_BAND_ENUM {
  M_RSB_M1, M_RSB_M2, M_RSB_M3, M_RSB_M4,
  M_RSB_M5, M_RSB_M6, M_RSB_M7, M_RSB_M8,
  M_RSB_M9, M_RSB_M10, M_RSB_M11, M_RSB_BAND_MAXIMUM
}
 
enum  VIIRS_MOD_TEB_BAND_ENUM {
  M_TEB_M12, M_TEB_M13, M_TEB_M14, M_TEB_M15,
  M_TEB_M16, M_TEB_BAND_MAXIMUM
}
 
enum  VIIRS_SENSOR_MODES {
  VIIRS_SENSOR_LAUNCH = 0, VIIRS_SENSOR_ACTIVATION, VIIRS_SENSOR_OG, VIIRS_SENSOR_DIAGNOSTIC,
  VIIRS_SENSOR_OP_DAY, VIIRS_SENSOR_OP_NIGHT, VIIRS_SENSOR_SAFE, VIIRS_SENSOR_INVALID
}
 

Functions

bool isImg (VIIRS_BAND_ENUM band)
 
bool isMod (VIIRS_BAND_ENUM band)
 
bool isDG (VIIRS_BAND_ENUM band)
 
bool isDG (VIIRS_M_BAND_ENUM band)
 
bool isTeb (VIIRS_BAND_ENUM band)
 
int ib_index (VIIRS_BAND_ENUM band)
 
int mb_index (VIIRS_BAND_ENUM band)
 
int sg_index (VIIRS_BAND_ENUM band)
 
int dg_index (VIIRS_BAND_ENUM band)
 
int teb_index (VIIRS_BAND_ENUM band)
 
int rsb_index (VIIRS_BAND_ENUM band)
 
int iteb_index (VIIRS_BAND_ENUM band)
 
int irsb_index (VIIRS_BAND_ENUM band)
 
int mteb_index (VIIRS_BAND_ENUM band)
 
int mrsb_index (VIIRS_BAND_ENUM band)
 

Variables

const bool bShuffleFilter = true
 
const bool bDeflateFilter = true
 
const int deflateLevel = 5
 
const int dpp_config_index_1 = 0
 
const int dpp_config_index_2 = 15
 
const int bb_htr_temp_index = 122
 

Macro Definition Documentation

◆ Agg_Zones

#define Agg_Zones   3

Definition at line 50 of file VcstViirsStructs.h.

◆ ASP_Offsets

#define ASP_Offsets   3072

Definition at line 64 of file VcstViirsStructs.h.

◆ C_Coefs

#define C_Coefs   4

Definition at line 55 of file VcstViirsStructs.h.

◆ Cal_Metadata

#define Cal_Metadata   134

Definition at line 61 of file VcstViirsStructs.h.

◆ DNB_Cal_Samples

#define DNB_Cal_Samples   64

Definition at line 40 of file VcstViirsStructs.h.

◆ DNB_Pixels

#define DNB_Pixels   4064

Definition at line 36 of file VcstViirsStructs.h.

◆ Encoder_Reading

#define Encoder_Reading   1290

Definition at line 66 of file VcstViirsStructs.h.

◆ Eng_Block

#define Eng_Block   128

Definition at line 63 of file VcstViirsStructs.h.

◆ Eng_Status

#define Eng_Status   8

Definition at line 62 of file VcstViirsStructs.h.

◆ EV_APIDs

#define EV_APIDs   24

Definition at line 59 of file VcstViirsStructs.h.

◆ Gain_States

#define Gain_States   2

Definition at line 54 of file VcstViirsStructs.h.

◆ High_Gain

#define High_Gain   0

Definition at line 52 of file VcstViirsStructs.h.

◆ HR_Metadata

#define HR_Metadata   146

Definition at line 60 of file VcstViirsStructs.h.

◆ Iband_Cal_Samples

#define Iband_Cal_Samples   96

Definition at line 39 of file VcstViirsStructs.h.

◆ Iband_detectors

#define Iband_detectors   32

Definition at line 33 of file VcstViirsStructs.h.

◆ Iband_Pixels

#define Iband_Pixels   6400

Definition at line 35 of file VcstViirsStructs.h.

◆ Low_Gain

#define Low_Gain   1

Definition at line 53 of file VcstViirsStructs.h.

◆ LUT_Radiance_Values

#define LUT_Radiance_Values   65536

Definition at line 74 of file VcstViirsStructs.h.

◆ M13_LUT_Radiance_Values

#define M13_LUT_Radiance_Values   327681

Definition at line 73 of file VcstViirsStructs.h.

◆ Mband_Cal_Samples

#define Mband_Cal_Samples   48

Definition at line 38 of file VcstViirsStructs.h.

◆ Mband_detectors

#define Mband_detectors   16

Definition at line 32 of file VcstViirsStructs.h.

◆ Mband_Pixels

#define Mband_Pixels   3200

Definition at line 34 of file VcstViirsStructs.h.

◆ Mband_Samples

#define Mband_Samples   6304

Definition at line 37 of file VcstViirsStructs.h.

◆ Mirror_Sides

#define Mirror_Sides   2

Definition at line 67 of file VcstViirsStructs.h.

◆ Number_of_BB_temps

#define Number_of_BB_temps   6

Definition at line 69 of file VcstViirsStructs.h.

◆ Number_of_DG_bands

#define Number_of_DG_bands   7

Definition at line 68 of file VcstViirsStructs.h.

◆ Number_of_DNB_Lines

#define Number_of_DNB_Lines   Mband_detectors*Number_of_Scans

Definition at line 79 of file VcstViirsStructs.h.

◆ Number_of_DNB_Pixels

#define Number_of_DNB_Pixels   4064

Definition at line 80 of file VcstViirsStructs.h.

◆ Number_of_DNBs

#define Number_of_DNBs   1

Definition at line 49 of file VcstViirsStructs.h.

◆ Number_of_Iband_Lines

#define Number_of_Iband_Lines   Iband_detectors*Number_of_Scans

Definition at line 75 of file VcstViirsStructs.h.

◆ Number_of_Iband_Pixels

#define Number_of_Iband_Pixels   6400

Definition at line 76 of file VcstViirsStructs.h.

◆ Number_of_Ibands

#define Number_of_Ibands   5

Definition at line 42 of file VcstViirsStructs.h.

◆ Number_of_IRbands

#define Number_of_IRbands   3

Definition at line 48 of file VcstViirsStructs.h.

◆ Number_of_ITbands

#define Number_of_ITbands   2

Definition at line 45 of file VcstViirsStructs.h.

◆ Number_of_Mband_Lines

#define Number_of_Mband_Lines   Mband_detectors*Number_of_Scans

Definition at line 77 of file VcstViirsStructs.h.

◆ Number_of_Mband_Pixels

#define Number_of_Mband_Pixels   3200

Definition at line 78 of file VcstViirsStructs.h.

◆ Number_of_Mbands

#define Number_of_Mbands   16

Definition at line 41 of file VcstViirsStructs.h.

◆ Number_of_MRbands

#define Number_of_MRbands   11

Definition at line 47 of file VcstViirsStructs.h.

◆ Number_of_MTbands

#define Number_of_MTbands   5

Definition at line 44 of file VcstViirsStructs.h.

◆ Number_of_Rbands

#define Number_of_Rbands   14

Definition at line 46 of file VcstViirsStructs.h.

◆ Number_of_Scans

#define Number_of_Scans   203

Definition at line 27 of file VcstViirsStructs.h.

◆ Number_of_Scans_5min

#define Number_of_Scans_5min   169

Definition at line 20 of file VcstViirsStructs.h.

◆ Number_of_Scans_6min

#define Number_of_Scans_6min   203

Definition at line 22 of file VcstViirsStructs.h.

◆ Number_of_Tbands

#define Number_of_Tbands   7

Definition at line 43 of file VcstViirsStructs.h.

◆ Parity

#define Parity   2

Definition at line 51 of file VcstViirsStructs.h.

◆ Quaternion_Elements

#define Quaternion_Elements   4

Definition at line 57 of file VcstViirsStructs.h.

◆ SC_Diary_Records

#define SC_Diary_Records   381

Definition at line 28 of file VcstViirsStructs.h.

◆ SC_Diary_Records_10Hz

#define SC_Diary_Records_10Hz   3801

Definition at line 30 of file VcstViirsStructs.h.

◆ SC_Diary_Records_1Hz

#define SC_Diary_Records_1Hz   380

Definition at line 29 of file VcstViirsStructs.h.

◆ SC_Diary_Records_5min

#define SC_Diary_Records_5min   320

Definition at line 21 of file VcstViirsStructs.h.

◆ SC_Diary_Records_6min

#define SC_Diary_Records_6min   381

Definition at line 23 of file VcstViirsStructs.h.

◆ SDSM_Data

#define SDSM_Data   256

Definition at line 65 of file VcstViirsStructs.h.

◆ SDSM_Detectors

#define SDSM_Detectors   8

Definition at line 71 of file VcstViirsStructs.h.

◆ SDSM_Samples

#define SDSM_Samples   5

Definition at line 70 of file VcstViirsStructs.h.

◆ Vector_Elements

#define Vector_Elements   3

Definition at line 58 of file VcstViirsStructs.h.

◆ Viirs_Bands

#define Viirs_Bands   22

Definition at line 16 of file VcstViirsStructs.h.

Enumeration Type Documentation

◆ GRAN_SEQ_ENUM

Enumerator
BEFORE 
CURRENT 
AFTER 
GRAN_SEQ_MAXIMUM 

Definition at line 97 of file VcstViirsStructs.h.

◆ VIIRS_BAND_ENUM

Enumerator
IMG_1 
IMG_2 
IMG_3 
IMG_4 
IMG_5 
MOD_1 
MOD_2 
MOD_3 
MOD_4 
MOD_5 
MOD_6 
MOD_7 
MOD_8 
MOD_9 
MOD_10 
MOD_11 
MOD_12 
MOD_13 
MOD_14 
MOD_15 
MOD_16 
DNB_ 
BAND_MAXIMUM 

Definition at line 111 of file VcstViirsStructs.h.

◆ VIIRS_CATEGORY_ENUM

Enumerator
ALL_BANDS 
IMG_BANDS 
MOD_BANDS 
DNB_BAND 
RSB_BANDS 
TEB_BANDS 
CATEGORY_MAXIMUM 

Definition at line 101 of file VcstViirsStructs.h.

◆ VIIRS_I_BAND_ENUM

Enumerator
I_1 
I_2 
I_3 
I_4 
I_5 
I_BAND_MAXIMUM 

Definition at line 119 of file VcstViirsStructs.h.

◆ VIIRS_IMG_TEB_BAND_ENUM

Enumerator
I_TEB_I4 
I_TEB_I5 
I_TEB_BAND_MAXIMUM 

Definition at line 149 of file VcstViirsStructs.h.

◆ VIIRS_M_BAND_ENUM

Enumerator
M_1 
M_2 
M_3 
M_4 
M_5 
M_6 
M_7 
M_8 
M_9 
M_10 
M_11 
M_12 
M_13 
M_14 
M_15 
M_16 
M_BAND_MAXIMUM 

Definition at line 123 of file VcstViirsStructs.h.

◆ VIIRS_MOD_DG_BAND_ENUM

Enumerator
DG_M1 
DG_M2 
DG_M3 
DG_M4 
DG_M5 
DG_M7 
DG_M13 
DG_BAND_MAXIMUM 

Definition at line 145 of file VcstViirsStructs.h.

◆ VIIRS_MOD_RSB_BAND_ENUM

Enumerator
M_RSB_M1 
M_RSB_M2 
M_RSB_M3 
M_RSB_M4 
M_RSB_M5 
M_RSB_M6 
M_RSB_M7 
M_RSB_M8 
M_RSB_M9 
M_RSB_M10 
M_RSB_M11 
M_RSB_BAND_MAXIMUM 

Definition at line 153 of file VcstViirsStructs.h.

◆ VIIRS_MOD_SG_BAND_ENUM

Enumerator
SG_M6 
SG_M8 
SG_M9 
SG_M10 
SG_M11 
SG_M12 
SG_M14 
SG_M15 
SG_M16 
SG_BAND_MAXIMUM 

Definition at line 140 of file VcstViirsStructs.h.

◆ VIIRS_MOD_TEB_BAND_ENUM

Enumerator
M_TEB_M12 
M_TEB_M13 
M_TEB_M14 
M_TEB_M15 
M_TEB_M16 
M_TEB_BAND_MAXIMUM 

Definition at line 159 of file VcstViirsStructs.h.

◆ VIIRS_PLATFORM_ENUM

Enumerator
NPP 
J1 
J2 
PLATFORM_MAXIMUM 

Definition at line 90 of file VcstViirsStructs.h.

◆ VIIRS_RSB_BAND_ENUM

Enumerator
RSB_I1 
RSB_I2 
RSB_I3 
RSB_M1 
RSB_M2 
RSB_M3 
RSB_M4 
RSB_M5 
RSB_M6 
RSB_M7 
RSB_M8 
RSB_M9 
RSB_M10 
RSB_M11 
RSB_BAND_MAXIMUM 

Definition at line 129 of file VcstViirsStructs.h.

◆ VIIRS_SENSOR_MODES

Enumerator
VIIRS_SENSOR_LAUNCH 
VIIRS_SENSOR_ACTIVATION 
VIIRS_SENSOR_OG 
VIIRS_SENSOR_DIAGNOSTIC 
VIIRS_SENSOR_OP_DAY 
VIIRS_SENSOR_OP_NIGHT 
VIIRS_SENSOR_SAFE 
VIIRS_SENSOR_INVALID 

Definition at line 164 of file VcstViirsStructs.h.

◆ VIIRS_TEB_BAND_ENUM

Enumerator
TEB_I4 
TEB_I5 
TEB_M12 
TEB_M13 
TEB_M14 
TEB_M15 
TEB_M16 
TEB_BAND_MAXIMUM 

Definition at line 135 of file VcstViirsStructs.h.

Function Documentation

◆ dg_index()

int dg_index ( VIIRS_BAND_ENUM  band)
inline

Definition at line 648 of file VcstViirsStructs.h.

◆ ib_index()

int ib_index ( VIIRS_BAND_ENUM  band)
inline

ib_index(), mb_index(), dg_index(), teb_index(), rsb_index(), iteb_index(), mteb_index(), irsb_index(), mrsb_index

Band categories identification

Definition at line 623 of file VcstViirsStructs.h.

◆ irsb_index()

int irsb_index ( VIIRS_BAND_ENUM  band)
inline

Definition at line 692 of file VcstViirsStructs.h.

◆ isDG() [1/2]

bool isDG ( VIIRS_BAND_ENUM  band)
inline

Definition at line 598 of file VcstViirsStructs.h.

◆ isDG() [2/2]

bool isDG ( VIIRS_M_BAND_ENUM  band)
inline

Definition at line 604 of file VcstViirsStructs.h.

◆ isImg()

bool isImg ( VIIRS_BAND_ENUM  band)
inline

isImg(), isTeb(), isRSB(), isDG()

Band categories identification

Definition at line 589 of file VcstViirsStructs.h.

◆ isMod()

bool isMod ( VIIRS_BAND_ENUM  band)
inline

Definition at line 593 of file VcstViirsStructs.h.

◆ isTeb()

bool isTeb ( VIIRS_BAND_ENUM  band)
inline

Definition at line 610 of file VcstViirsStructs.h.

◆ iteb_index()

int iteb_index ( VIIRS_BAND_ENUM  band)
inline

Definition at line 686 of file VcstViirsStructs.h.

◆ mb_index()

int mb_index ( VIIRS_BAND_ENUM  band)
inline

Definition at line 628 of file VcstViirsStructs.h.

◆ mrsb_index()

int mrsb_index ( VIIRS_BAND_ENUM  band)
inline

Definition at line 708 of file VcstViirsStructs.h.

◆ mteb_index()

int mteb_index ( VIIRS_BAND_ENUM  band)
inline

Definition at line 699 of file VcstViirsStructs.h.

◆ rsb_index()

int rsb_index ( VIIRS_BAND_ENUM  band)
inline

Definition at line 668 of file VcstViirsStructs.h.

◆ sg_index()

int sg_index ( VIIRS_BAND_ENUM  band)
inline

Definition at line 633 of file VcstViirsStructs.h.

◆ teb_index()

int teb_index ( VIIRS_BAND_ENUM  band)
inline

Definition at line 657 of file VcstViirsStructs.h.

Variable Documentation

◆ bb_htr_temp_index

const int bb_htr_temp_index = 122

Definition at line 514 of file VcstViirsStructs.h.

◆ bDeflateFilter

const bool bDeflateFilter = true

Definition at line 85 of file VcstViirsStructs.h.

◆ bShuffleFilter

const bool bShuffleFilter = true

Definition at line 84 of file VcstViirsStructs.h.

◆ deflateLevel

const int deflateLevel = 5

Definition at line 86 of file VcstViirsStructs.h.

◆ dpp_config_index_1

const int dpp_config_index_1 = 0

Definition at line 342 of file VcstViirsStructs.h.

◆ dpp_config_index_2

const int dpp_config_index_2 = 15

Definition at line 391 of file VcstViirsStructs.h.