MISCToolbox/oc_flag_info.m at master · OceanOptics/MISCToolbox · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
function oc_flag_info(flags, mode)
%OC_FLAG_INFO display the name and description of every flag in flags
%   Information comes from flags from Level 2 and 3 of Ocean Color
%   http://oceancolor.gsfc.nasa.gov/VALIDATION/flags.htm
%
%Syntax:  oc_flag_info(flags)
%
%Inputs:
%    Required:
%        flags <1xN double> l2_flags from Ocean Color (32 bit integer)
%     Optional:
%        mode string containing:
%           oc for ocean color radiometric flags (32 bits) <- default
%           sst for sea surface temperature flags (16 bits)
%
%
%Display: N lines with the name and description of every flag
%
% Tested with Matlab R2015a, 2016a, and 2016b
%
% Author: Nils Haentjens, Ms, University of Maine
% Email: nils.haentjens@maine.edu
% Created: 17 August 2015
% Last update: 17 August 2015

% Check input
if nargin > 2;
   error('Too many input arguments')
elseif nargin < 1;
   error('Not enough input arguments')
end
if nargin == 1;
  mode = 'oc';
end;

switch mode
  case 'oc'
    % The table below shows the flags and masks that are operational
    % in the Level 2 and Level 3 Ocean Color Processing.
    % http://oceancolor.gsfc.nasa.gov/VALIDATION/flags.html
    oc_flag(1).name='ATMFAIL'; oc_flag(1).description='Atmospheric correction failure';
    oc_flag(2).name='LAND'; oc_flag(2).description='Pixel is over land';
    oc_flag(3).name='PRODWARN'; oc_flag(3).description='One or more product warnings';
    oc_flag(4).name='HIGLINT'; oc_flag(4).description='High sun glint';
    oc_flag(5).name='HILT'; oc_flag(5).description='Observed radiance very high or saturated';
    oc_flag(6).name='HISATZEN'; oc_flag(6).description='High sensor view zenith angle';
    oc_flag(7).name='COASTZ'; oc_flag(7).description='Pixel is in shallow water';
    oc_flag(8).name='spare'; oc_flag(8).description='spare';
    oc_flag(9).name='STRAYLIGHT'; oc_flag(9).description='Straylight contamination is likely';
    oc_flag(10).name='CLDICE'; oc_flag(10).description='Probable cloud or ice contamination';
    oc_flag(11).name='COCCOLITH'; oc_flag(11).description='Coccolithofores detected';
    oc_flag(12).name='TURBIDW'; oc_flag(12).description='Turbid water detected';
    oc_flag(13).name='HISOLZEN'; oc_flag(13).description='High solar zenith';
    oc_flag(14).name='spare'; oc_flag(14).description='spare';
    oc_flag(15).name='LOWLW'; oc_flag(15).description='Very low water-leaving radiance (cloud shadow)';
    oc_flag(16).name='CHLFAIL'; oc_flag(16).description='Derived product algorithm failure';
    oc_flag(17).name='NAVWARN'; oc_flag(17).description='Navigation quality is reduced';
    oc_flag(18).name='ABSAER'; oc_flag(18).description='possible absorbing aerosol (disabled)';
    oc_flag(19).name='spare'; oc_flag(19).description='spare';
    oc_flag(20).name='MAXAERITER'; oc_flag(20).description='Aerosol iterations exceeded max';
    oc_flag(21).name='MODGLINT'; oc_flag(21).description='Moderate sun glint contamination';
    oc_flag(22).name='CHLWARN'; oc_flag(22).description='Derived product quality is reduced';
    oc_flag(23).name='ATMWARN'; oc_flag(23).description='Atmospheric correction is suspect';
    oc_flag(24).name='spare'; oc_flag(24).description='spare';
    oc_flag(25).name='SEAICE'; oc_flag(25).description='Possible sea ice contamination';
    oc_flag(26).name='NAVFAIL'; oc_flag(26).description='Bad navigation';
    oc_flag(27).name='FILTER'; oc_flag(27).description='Pixel rejected by user-defined filter';
    oc_flag(28).name='SSTWARN'; oc_flag(28).description='SST quality is reduced';
    oc_flag(29).name='SSTFAIL'; oc_flag(29).description='SST quality is bad';
    oc_flag(30).name='HIPOL'; oc_flag(30).description='High degree of polarization';
    oc_flag(31).name='PRODFAIL'; oc_flag(31).description='Derived product failure';
    oc_flag(32).name='spare'; oc_flag(32).description='spare';

    % Display flags name and description
    for bit=flags;
      fprintf('%2d\t%10s\t%s\n', bit, oc_flag(bit).name, oc_flag(bit).description);
    end;
  case 'sst'
    % Table of 16-bit flag product was created for both the short-wave (sst4)
    % and long-wave (sst) products (flags_sst4 and flags_sst, respectively)
    % http://oceancolor.gsfc.nasa.gov/DOCS/modis_sst/
    oc_flag_sst(16).name='ISMASKED'; oc_flag_sst(16).description='Pixel was aready masked';
    oc_flag_sst(01).name='BTBAD';	oc_flag_sst(01).description='Brightness temperatures are bad';
    oc_flag_sst(02).name='BTRANGE'; oc_flag_sst(2).description='Brightness temperatures are out-of-range';
    oc_flag_sst(03).name='BTDIFF'; oc_flag_sst(3).description='Brightness temperatures are too different';
    oc_flag_sst(04).name='SSTRANGE'; oc_flag_sst(4).description='SST outside valid range';
    oc_flag_sst(05).name='SSTREFDIFF'; oc_flag_sst(5).description='SST is too different from reference';
    oc_flag_sst(06).name='SST4DIFF'; oc_flag_sst(6).description='Longwave SST is different from shortwave SST';
    oc_flag_sst(07).name='SST4VDIFF'; oc_flag_sst(7).description='Longwave SST is very different from shortwave SST';
    oc_flag_sst(08).name='BTNONUNIF'; oc_flag_sst(8).description='Brightness temperatures are spatially non-uniform';
    oc_flag_sst(09).name='BTVNONUNIF'; oc_flag_sst(9).description='Brightness temperatures are very spatially non-uniform';
    oc_flag_sst(10).name='BT4REFDIFF'; oc_flag_sst(10).description='Brightness temperatures differ from reference';
    oc_flag_sst(11).name='REDNONUNIF'; oc_flag_sst(11).description='Red-band spatial non-uniformity or saturation';
    oc_flag_sst(12).name='HISENZ'; oc_flag_sst(12).description='Sensor zenith angle high';
    oc_flag_sst(13).name='VHISENZ'; oc_flag_sst(13).description='Sensor zenith angle very high';
    oc_flag_sst(14).name='SSTREFVDIFF'; oc_flag_sst(14).description='SST is too different from reference';
    oc_flag_sst(15).name='Spare'; oc_flag_sst(15).description='Spare';

    % Display flags name and description
    fprintf('Display of id starts at 1 instead of 0 like Nasa\n');
    for bito=flags;
      bit=bito-1; if bit==0; bit = 16;end;
      fprintf('%2d\t%10s\t%s\n', bit, oc_flag_sst(bit).name, oc_flag_sst(bit).description);
    end;
  otherwise
    error('Only mode available are oc or sst');
end;
end