NASA Ocean Color

ocssw V2022

 #include "hdfi.h"
 #include "PH_pkt_hdr.h"
 #include "PD_pkt_data.h"
 #include "SC_scan.h"
 #include "L1A_prototype.h"
  
  
 void   put_earth_data_in_scan (PH_PACKET_HEADER_t  *pkt_header,
                                uint16              *pkt_cont,
                                SC_EV_250M           SC_250m,
                                SC_EV_500M           SC_500m,
                                SC_EV_1KM_DAY        SC_1km_day, 
                                SC_EV_1KM_NIGHT      SC_1km_night)
  
 /*
 !C************************************************************************
  
 !Description:  The routine takes an unpacked daymode packet containing
                radiance data from the Earth View, extracts it, and places 
                the data in the proper arrays within the scan structure. 
  
 !Input Parameters:
                PH_PACKET_HEADER_t  *pkt_header   ** The structure containing **
                                                  ** the current packet's     **
                                                  ** packet header            **
  
                int16               *pkt_cont     ** The structure containing **
                                                  ** the current packet's     **
                                                  ** unpacked contents        **
  
 !Output Parameters:
                None
  
 !Input/Output Parameters:
                SC_EV_250M          SC_250m       ** array that holds earth/  **
                                                  ** calibration sector 250m  **
                                                  ** radiances                **
  
                SC_EV_500M          SC_500m       ** array that holds earth/  **
                                                  ** calibration sector 500m  **
                                                  ** radiances                **
  
                SC_EV_1KM_DAY       SC_1km_day    ** array that holds earth/  **
                                                  ** calibration sector 1km   **
                                                  ** day radiances            **
  
                SC_EV_1KM_NIGHT     SC_1km_night  ** array that holds earth/  **
                                                  ** calibration sector 1km   **
                                                  ** night radiances          **
  
 Return Values: 
                None
  
 Externally Defined:
                int16                                   (hdfi.h)
                SC_EV_250M                              (SC_scan.h)
                SC_EV_500M                              (SC_scan.h)
                SC_EV_1KM_DAY                           (SC_scan.h)
                SC_EV_1KM_NIGHT                         (SC_scan.h)
                PH_PRI_SEQUENCE_SECOND_PKT_IN_GROUP     (PH_pkt_hdr.h)
                PD_DN_FIRST_250M_BAND                   (PD_pkt_data.h)
                PD_DN_LAST_250M_BAND                    (PD_pkt_data.h)
                PD_DN_BAND_RATIO_250M                   (PD_pkt_data.h)
                PD_DN_FIRST_500M_BAND                   (PD_pkt_data.h)
                PD_DN_LAST_500M_BAND                    (PD_pkt_data.h)
                PD_DN_BAND_RATIO_500M                   (PD_pkt_data.h)
                PD_DN_FIRST_1KM_DAY_BAND                (PD_pkt_data.h)
                PD_DN_LAST_1KM_DAY_BAND                 (PD_pkt_data.h)
                PD_DN_FIRST_1KM_NIGHT_BAND              (PD_pkt_data.h)
                PD_DN_LAST_1KM_NIGHT_BAND               (PD_pkt_data.h)
                PD_DN_NUM_1KMDAY_DETECTORS              (PD_pkt_data.h)
                PD_DN_NUM_1KMNIGHT_DETECTORS            (PD_pkt_data.h)
                PD_DN_NUM_IFOVS_IN_DAY_PKT              (PD_pkt_data.h)
                PD_DN_FIRST_IFOV_DAY_PKT_1              (PD_pkt_data.h)
                PD_DN_LAST_IFOV_DAY_PKT_1               (PD_pkt_data.h)
                PD_DN_FIRST_IFOV_DAY_PKT_2              (PD_pkt_data.h)
                PD_DN_LAST_IFOV_DAY_PKT_2               (PD_pkt_data.h)
  
 Called By:
                output_daymode_data_to_scan
  
 Routines Called:
                NONE
  
 !Revision History:
                Revision 2.0  1997/06/18  16:40 EDT 
                Timi Adelekan/SAIC/GSC (adelekan@ltpmail.gsfc.nasa.gov)
                Originated Code. (original design based on version1 
                                  routine: output_daymode_earth_data_to_scan)
  
 !Team-unique Header:
                This software is developed by the MODIS Science
                Data Support Team (SDST) for the National Aeronautics
                and Space Administration (NASA), Goddard Space Flight
                Center (GSFC), under contract NAS5-32373.
  
 !References and Credits:
                None
  
 !Design Notes: The CODE below was developed in C language.
  
                This routine was designed totally under the asumption that 
                the packet header has been priviously validated and there 
                is no need to test for error conditions.
  
                The structure of "SC_*" is determined by the Level 1A 
                project specification.
  
 !END*************************************************************************
 */
  
  {
   /*************************************************************************/
   /*                                                                       */
   /*          Declare the local variables and initialize them.             */
   /*                                                                       */
   /*************************************************************************/
   /*                                                                       */
   /* set start_ifov to 0                                                   */
   /* set end_ifov equal to PD_DN_NUM_IFOVS_IN_DAY_PKT                      */
   /* set pkt_cont_pos equal to PH_NUM_12BIT_WORDS_IN_HEADER                */
   /*                                                                       */
   /*************************************************************************/
  
   int        start_ifov;           /* starting ifov position within scan     */
   int        end_ifov;             /* ending ifov position within scan       */
   int        ifov;                 /* loop variable holding current ifov     */
   int        band;                 /* Band indicator (used as loop variable) */
   int        band_num;             /* Band indicator corrected for each      */
                                    /* detector group's start position        */
   int        sample;               /* Sample indicator for 250m and 500m     */
                                    /* data (used as loop variable)           */
   int        det;                  /* detector multiplier for 250m and 500m  */
                                    /* data (used as loop variable)           */
   int        line_num;             /* Calculated line number; used to        */
                                    /* properly place data in science arrays  */
   int        frame;                /* Calculated frame number; used to       */
                                    /* properly place data in science arrays  */
   int        frame_ifov_offset;    /* Offset used to adjust a packet's       */
                                    /* IFOVs to the proper scan location      */
   int        scan_ifov;            /* IFOV within the scan where the         */
                                    /* current packet's contents belong       */
   int        pkt_cont_pos;         /* index into packet_contents             */
   int16      frame_cnt;            /* Frame count for Earth View packets    */
   
  
   band              = 0;
   band_num          = 0;
   sample            = 0;
   det               = 0;
   line_num          = 0;
   frame             = 0;
   frame_cnt         = 0;
   scan_ifov         = 0;
   ifov              = 0;
   start_ifov        = 0;
   end_ifov          = PD_DN_NUM_IFOVS_IN_DAY_PKT;
   pkt_cont_pos      = PH_NUM_12BIT_WORDS_IN_HEADER;
  
  
  
   /**************************************************************************/
   /*                                                                        */
   /* Get packet frame count. Then determine whether this packet contains    */
   /* IFOVs 1 through 5 or 6 through 10.                                     */
   /*                                                                        */
   /**************************************************************************/
   /*                                                                        */
   /* Set frame_cnt equal to PH_PACKET_HEADER_t.earth_frame_cnt              */
   /*                                                                        */
   /* Set frame_ifov_offset equal to 0                                       */
   /* IF PH_PACKET_HEADER_t.sequence_flag equals                             */
   /*                                 PH_PRI_SEQUENCE_SECOND_PKT_IN_GROUP    */
   /* THEN                                                                   */
   /*    Set frame_ifov_offset equal to 5                                    */
   /* ENDIF                                                                  */
   /*                                                                        */
   /**************************************************************************/
  
      frame_cnt = pkt_header->earth_frame_cnt;
  
      frame_ifov_offset = 0;
      if (pkt_header->sequence_flag == PH_PRI_SEQUENCE_SECOND_PKT_IN_GROUP)
         frame_ifov_offset = 5;
  
  
   /**************************************************************************/
   /*                                                                        */
   /*          Extract the packet contents into the scan structure.          */
   /*                                                                        */
   /**************************************************************************/
   /* FOR ifov equal to start_ifov to end_ifov                               */
   /*    set scan_ifov equal to (ifov + frame_ifov_offset)                   */
   /*                                                                        */
   /**************************************************************************/
  
      for (ifov = start_ifov; ifov < end_ifov; ifov++) {
         scan_ifov = ifov + frame_ifov_offset;
  
  
   /**************************************************************************/
   /*                                                                        */
   /* Within each ifov set, the 250 meter data appear first, organized by    */
   /* band_num, each band's radiances organized by the 4 samples taken by    */
   /* each detector, then by the 4 detectors within the ifov. And the line   */
   /* number is corrected to account for the instrument detector numbering.  */
   /*                                                                        */
   /**************************************************************************/
   /*                                                                        */
   /*    FOR band equal to PD_DN_FIRST_250M_BAND to PD_DN_LAST_250M_BAND     */
   /*       set band_num equal to (band - PD_DN_FIRST_250M_BAND)             */
   /*       FOR sample equal to 0 upto PD_DN_BAND_RATIO_250M                 */
   /*          set frame equal to ((frame_cnt - 1) * PD_DN_BAND_RATIO_250M) +*/
   /*                             sample                                     */
   /*          FOR det equals to 0 upto PD_DN_NUM_250M_DETECTORS_IN_IFOV     */
   /*             set line_num equal to ((PD_DN_NUM_250M_DETECTORS - 1) -    */
   /*                 ((scan_ifov * PD_DN_NUM_250M_DETECTORS_IN_IFOV) + det))*/
   /*             set SC_250m(line_num,band_num,frame) equal to              */
   /*                                                 pkt_cont(pkt_cont_pos) */
   /*             set pkt_cont_pos to  pkt_cont_pos + 1                      */
   /*          ENDFOR (next det)                                             */
   /*       ENDFOR (next sample)                                             */
   /*    ENDFOR (next band)                                                  */
   /*                                                                        */
   /**************************************************************************/
  
         for (band = PD_DN_FIRST_250M_BAND; band <= PD_DN_LAST_250M_BAND; band++){
            band_num = band - PD_DN_FIRST_250M_BAND;
            for (sample = 0; sample < PD_DN_BAND_RATIO_250M; sample++){
               frame = ((frame_cnt - 1) * PD_DN_BAND_RATIO_250M) + sample;
               for (det = 0; det < PD_DN_NUM_250M_DETECTORS_IN_IFOV; det++){
                  line_num = ((PD_DN_NUM_250M_DETECTORS - 1) -
                       ((scan_ifov * PD_DN_NUM_250M_DETECTORS_IN_IFOV) + det));
                  SC_250m[line_num][band_num][frame] = pkt_cont[pkt_cont_pos];
                  pkt_cont_pos++;
               }
            }
         }
  
  
   /**************************************************************************/
   /*                                                                        */
   /* The 500 meter data is next, with each band's radiances organized be    */
   /* band_num, then by the 2 samples taken by each detector, then by the 2  */
   /* detectors within the ifov. And the line number is corrected to         */
   /* account for the instrument detector numbering.                         */
   /*                                                                        */
   /**************************************************************************/
   /*                                                                        */
   /*    FOR band equal to PD_DN_FIRST_500M_BAND to PD_DN_LAST_500M_BAND     */
   /*       set band_num equal to (band - PD_DN_FIRST_500M_BAND)             */
   /*       FOR sample equal to 0 upto PD_DN_BAND_RATIO_500M                 */
   /*          set frame equal to ((frame_cnt - 1) * PD_DN_BAND_RATIO_500M) +*/
   /*                             sample                                     */
   /*          FOR det equals to 0 upto PD_DN_NUM_500M_DETECTORS_IN_IFOV     */
   /*             set line_num equal to ((PD_DN_NUM_500M_DETECTORS - 1) -    */
   /*             ((scan_ifov * PD_DN_NUM_500M_DETECTORS_IN_IFOV) + det))    */
   /*             set SC_500m(line_num,band_num,frame) equal to              */
   /*                                             pkt_cont(pkt_cont_pos)     */
   /*             set pkt_cont_pos to  pkt_cont_pos + 1                      */
   /*          ENDFOR (next det)                                             */
   /*       ENDFOR (next sample)                                             */
   /*    ENDFOR (next band)                                                  */
   /*                                                                        */
   /**************************************************************************/
  
         for (band = PD_DN_FIRST_500M_BAND; band <= PD_DN_LAST_500M_BAND; band++){
            band_num = band - PD_DN_FIRST_500M_BAND;
            for (sample = 0; sample < PD_DN_BAND_RATIO_500M; sample++){
               frame = ((frame_cnt - 1) * PD_DN_BAND_RATIO_500M) + sample;
               for (det = 0; det < PD_DN_NUM_500M_DETECTORS_IN_IFOV; det++){
                  line_num = ((PD_DN_NUM_500M_DETECTORS - 1) -
                        ((scan_ifov * PD_DN_NUM_500M_DETECTORS_IN_IFOV) + det));
                  SC_500m[line_num][band_num][frame] = pkt_cont[pkt_cont_pos];
                  pkt_cont_pos++;
               }
            }
         }
  
  
   /**************************************************************************/
   /*                                                                        */
   /* The 1km day data is next in each ifov set, with one sample per band    */
   /* And the line number is corrected to account for the instrument         */
   /* detector numbering.                                                    */
   /*                                                                        */
   /**************************************************************************/
   /*                                                                        */
   /*    set frame equal to frame_cnt - 1                                    */
   /*    FOR band = PD_DN_FIRST_1KM_DAY_BAND to PD_DN_LAST_1KM_DAY_BAND      */
   /*       set band_num equal to (band - PD_DN_FIRST_1KM_DAY_BAND)          */
   /*       set line_num equal to ((PD_DN_NUM_1KMDAY_DETECTORS - 1) -        */
   /*                             scan_ifov)                                 */
   /*       set SC_1km_day(line_num,band_num,frame) equal to                 */
   /*                                             pkt_cont(pkt_cont_pos)     */
   /*       set pkt_cont_pos to pkt_cont_pos + 1                             */
   /*    ENDFOR (next band)                                                  */
   /*                                                                        */
   /**************************************************************************/
  
         frame = frame_cnt - 1;
         for (band = PD_DN_FIRST_1KM_DAY_BAND;
              band <= PD_DN_LAST_1KM_DAY_BAND;
              band++) {
            band_num = band - PD_DN_FIRST_1KM_DAY_BAND;
            line_num = ((PD_DN_NUM_1KMDAY_DETECTORS - 1) - scan_ifov);
            SC_1km_day[line_num][band_num][frame] = pkt_cont[pkt_cont_pos];
            pkt_cont_pos++;
         }
  
  
   /**************************************************************************/
   /*                                                                        */
   /* The 1km night data is last in each ifov set, with one sample per band  */
   /* And the line number is corrected to account for the instrument         */
   /* detector numbering.                                                    */
   /*                                                                        */
   /**************************************************************************/
   /*                                                                        */
   /*    set frame equal to frame_cnt - 1                                    */
   /*    FOR band = PD_DN_FIRST_1KM_NIGHT_BAND to PD_DN_LAST_1KM_NIGHT_BAND  */
   /*       set band_num equal to (band - PD_DN_FIRST_1KM_NIGHT_BAND)        */
   /*       set line_num equal to ((PD_DN_NUM_1KMNIGHT_DETECTORS - 1 ) -     */
   /*                             scan_ifov)                                 */
   /*       set SC_1km_night(line_num,band_num,frame) equal to               */
   /*                                             pkt_cont(pkt_cont_pos)     */
   /*       set pkt_cont_pos to pkt_cont_pos + 1                             */
   /*    ENDFOR (next band)                                                  */
   /* ENDFOR (next ifov)                                                     */
   /*                                                                        */
   /**************************************************************************/
  
         frame = frame_cnt - 1;
         for (band = PD_DN_FIRST_1KM_NIGHT_BAND;
              band <= PD_DN_LAST_1KM_NIGHT_BAND;
              band++) {
            band_num = band - PD_DN_FIRST_1KM_NIGHT_BAND;
            line_num = ((PD_DN_NUM_1KMNIGHT_DETECTORS - 1 ) - scan_ifov);
            SC_1km_night[line_num][band_num][frame] = pkt_cont[pkt_cont_pos];
            pkt_cont_pos++;
         }
      }     /* next ifov */
  
  } /* End of routine put_earth_data_in_scan */

SC_scan.h

cubeio::int16

integer, parameter int16

Definition: cubeio.f90:3

PD_DN_FIRST_500M_BAND

#define PD_DN_FIRST_500M_BAND

Definition: PD_pkt_data.h:94

PD_DN_NUM_IFOVS_IN_DAY_PKT

#define PD_DN_NUM_IFOVS_IN_DAY_PKT

Definition: PD_pkt_data.h:111

PD_DN_BAND_RATIO_500M

#define PD_DN_BAND_RATIO_500M

Definition: PD_pkt_data.h:96

SC_EV_500M

int16 SC_EV_500M[PD_DN_NUM_500M_DETECTORS][PD_DN_NUM_500M_BANDS][PH_MOD_SOURCE_ID_EARTH_FRAME_CNT_LIMIT *PD_DN_BAND_RATIO_500M]

Definition: SC_scan.h:186

SC_EV_250M

int16 SC_EV_250M[PD_DN_NUM_250M_DETECTORS][PD_DN_NUM_250M_BANDS][PH_MOD_SOURCE_ID_EARTH_FRAME_CNT_LIMIT *PD_DN_BAND_RATIO_250M]

Definition: SC_scan.h:181

SC_EV_1KM_DAY

int16 SC_EV_1KM_DAY[PD_DN_NUM_1KMDAY_DETECTORS][PD_DN_NUM_1KMDAY_BANDS][PH_MOD_SOURCE_ID_EARTH_FRAME_CNT_LIMIT *PD_DN_BAND_RATIO_1KM]

Definition: SC_scan.h:191

PH_PACKET_HEADER_t::sequence_flag

int8 sequence_flag

Definition: PH_pkt_hdr.h:247

band

PARAM_TYPE_NONE Default value No parameter is buried in the product name name_prefix is case insensitive string compared to the product name PARAM_TYPE_VIS_WAVE The visible wavelength bands from the sensor are buried in the product name The product name is compared by appending and name_suffix ie aph_412_giop where prod_ix will be set to PARAM_TYPE_IR_WAVE same search method as PARAM_TYPE_VIS_WAVE except only wavelength above are looped through but prod_ix is still based ie aph_2_giop for the second band

Definition: HOWTO_Add_a_product.txt:42

PH_PRI_SEQUENCE_SECOND_PKT_IN_GROUP

#define PH_PRI_SEQUENCE_SECOND_PKT_IN_GROUP

Definition: PH_pkt_hdr.h:128

PD_DN_NUM_250M_DETECTORS

#define PD_DN_NUM_250M_DETECTORS

Definition: PD_pkt_data.h:91

PH_pkt_hdr.h

PD_DN_NUM_500M_DETECTORS

#define PD_DN_NUM_500M_DETECTORS

Definition: PD_pkt_data.h:98

PD_DN_NUM_1KMNIGHT_DETECTORS

#define PD_DN_NUM_1KMNIGHT_DETECTORS

Definition: PD_pkt_data.h:109

PD_pkt_data.h

PD_DN_LAST_1KM_NIGHT_BAND

#define PD_DN_LAST_1KM_NIGHT_BAND

Definition: PD_pkt_data.h:104

put_earth_data_in_scan

void put_earth_data_in_scan(PH_PACKET_HEADER_t *pkt_header, uint16 *pkt_cont, SC_EV_250M SC_250m, SC_EV_500M SC_500m, SC_EV_1KM_DAY SC_1km_day, SC_EV_1KM_NIGHT SC_1km_night)

Definition: put_earth_data_in_scan.c:8

PD_DN_FIRST_1KM_NIGHT_BAND

#define PD_DN_FIRST_1KM_NIGHT_BAND

Definition: PD_pkt_data.h:103

PD_DN_NUM_250M_DETECTORS_IN_IFOV

#define PD_DN_NUM_250M_DETECTORS_IN_IFOV

Definition: PD_pkt_data.h:92

PD_DN_FIRST_1KM_DAY_BAND

#define PD_DN_FIRST_1KM_DAY_BAND

Definition: PD_pkt_data.h:101

PH_NUM_12BIT_WORDS_IN_HEADER

#define PH_NUM_12BIT_WORDS_IN_HEADER