NASA Ocean Color

ocssw V2022
 module mod06albedoecomodule
  
 ! HI
 !****************************************************************************
   ! !F90
   !
   ! !Description:
   !    This module contains the subroutines used to provide albedo and ecosystem
   !     maps for processing a MOD06 granule.
   !    There is only one callable routine, getAlbedoEco, which returns albedo 
   !     values and IGBP ecosystem classification for each pixel of the MOD06 granule,
   !     and for the wavelengths specified.  Also returned are values of snow albedos
   !     by ecosystem class for the wavelengths specified.
   !  
   ! !Callable routines:
   !    getAlbedoEco()
   ! 
   ! !Revision History:
   !
   ! Revision 1.0  2003/12/18  12:43:43  EGMoody
   ! Initial revision.
   !
   ! !Team-Unique Header:
   !   Cloud Retrieval Group, NASA Goddard Space Flight Center
   !
   ! !References and Credits:
   !   Written by
   !    Eric Moody
   !    Climate and Radiation Branch, Code 913
   !    NASA/GSFC
   !    Greenbelt MD 20771
   !    Eric.Moody@gsfc.nasa.gov
   !
   ! !Design Notes:
   !
   ! !END
   !*****************************************************************************
  
   !Dependencies:
  
   use nonscience_parameters
   implicit none
  
   include 'netcdf.inc'
  
   private
  
   ! WDR public :: GetNISEType, ReadSnowAlbStats, init_NISE_processing
   public :: readsnowalbstats
  
  
  
   !local variables:
   !counters:
   integer                          :: i,j,k,l,m,n
  
   !HDF variables:
   integer                           :: HDFstatus
   integer, dimension(10)                         :: hdfStart, hdfStride, hdfEdge
   integer                          :: sds_id, sds_index
   !  HDFstatus: Used for error checking.
   !  hdfstart : Follows HDF conventions. The array element from which to begin reading the
   !              HDF array. Zero based.
   !  hdfstride: Follows HDF conventions. The frequency with which data should be read in
   !              each dimension. Stride 1 means read every element.
   !  hdfedge  : Follows HDF conventions. The number of elements to read in each dimension. 
   !              If start(:) == 0 and stride(:) == 1, setting edge equal to the shape of 
   !              the underlying array reads all elements. 
  
  
   INTEGER, PARAMETER                              :: gridsize = 721  
   integer*2, DIMENSION(gridsize, gridsize) :: niseNorth, niseSouth
  
  
 contains
  
 !   subroutine init_NISE_processing(nise_file)
 !   
 !       character(len=*), intent(in) :: nise_file
 !       integer :: iret
 !   
 !       iret = Read_NISE(nise_file, gridsize, niseNorth, niseSouth)
 !
 !
 !   
 !   end subroutine init_NISE_processing
  
  
  
   ! ----------------------------------------------------------------------------------
   ! ----------------------------------------------------------------------------------
  
   subroutine readsnowalbstats  ( StatsFN, NumSnowTypes, NumAlbBnds, numEco, &
                                  AlbedoMean,  errorLevel                    )
                                  
     character (len = *),                 intent( in)  :: statsfn
     real      ,  &
               dimension(:,0:,:),         intent(inout):: albedomean
     integer   , intent( in)  :: numalbbnds,       &
                                                          numeco,           &
                                                          numsnowtypes
     INTEGER,            INTENT(OUT) :: errorlevel
                                                          
     ! !Description:
     !   This routine will output only a single band of albedo, for the specified amount
     !    of data, to the specified position within the hdf file.
     !  
     ! !Input Parameters:
     !    StatsFN : The name, only, of the new HDF file.
     !    Albedo          : Contains the single band of albedo to be stored.
     !    NumSnowTypes    : 2, Dry or wet, via NISE classes.
     !    NumAlbBnds      : Number of Albedo wavelengths.
     !    numEco          : Number of Ecosystem Classes.
     !
     ! !Output Parameters:
     !    AlbedoMean      : Mean statistic
     !
     ! !Revision History:
     !   See Module revision history at the beginning of the file.
     !
     ! !Team-Unique Header:
     !   Cloud Retrieval Group, NASA Goddard Space Flight Center
     !
     ! !References and Credits:
     !   Written by
     !    Eric Moody
     !    Climate and Radiation Branch, Code 913
     !    NASA/GSFC
     !    Greenbelt MD 20771
     !    Eric.Moody@gsfc.nasa.gov
     !
     ! !Design Notes:
     !
     ! !END
     
     !local variables: 
     !HDF variables:
     integer               :: status
     integer , dimension(10) :: hdfstart, hdfstride, hdfedge
     integer               :: sds_id, newhdfid, sds_index
     character(len =  200)                :: sdsname
     real      ,  &
               dimension(1:2,1:NumAlbBnds,0:numEco,1:1,1:2)   :: dummyalb
     !  status    : Used for error checking.
     !  hdfstart  : Follows HDF conventions. The array element from which to begin reading the
     !               HDF array. Zero based.
     !  hdfstride : Follows HDF conventions. The frequency with which data should be read in
     !               each dimension. Stride 1 means read every element.
     !  hdfedge   : Follows HDF conventions. The number of elements to read in each dimension. 
     !               If start(:) == 0 and stride(:) == 1, setting edge equal to the shape of 
     !               the underlying array reads all elements.
     !  sds_id,
     !   newHDFID : HDF SDS ID.
     !  sds_index : Index of the SDS in the HDF file.
     ! SDSName    : Stores the name of the SDS being procesed.
  
    integer :: fail = -1
  
   !Set error level
   errorlevel = success 
  
     !************************************************************************************
     ! Open the input file:
     !************************************************************************************
     !Open the albedo HDF file:
     status = nf_open( trim(statsfn), nf_nowrite, newhdfid )
     call cld_fchk( status, __file__, __line__ )
  
     !  WDR the errorLevel was passed back and not dealt with.  The above will
     !  halt the program here
  
     !************************************************************************************
     ! Input the Albedo mean statistic:
     !************************************************************************************   
     !Set up the output hdf variables, in this case we are writing a Belt:
     ! hdfStart, note that we are storing the entire Longitude, Albedo Bands and Ecosystems
     ! so these start at 0, however we are storing a box of Latitude, so this starts at the
     ! starty counter.
     hdfstart( : ) = 1
     hdfstart( 5 ) = 1  !Latitude, 0 = NH, 1 = SH
     hdfstart( 4 ) = 1  !Longitude, only 1, so 0
     hdfstart( 3 ) = 1  !Eco
     hdfstart( 2 ) = 1  !AlbBands
     hdfstart( 1 ) = 1  !NumSnowTypes
  
     !Strides = 1, since we are not skiping points
     hdfstride( : ) = 1
     
     !Edge is the total number of points being read:
     ! It is the number of Albedo bands, the number of Ecosystems, the Number of Longitude
     ! boxes, and 1 lat box:
     hdfedge( : ) = 1
     hdfedge( 5 ) = 2
     hdfedge( 4 ) = 1
     hdfedge( 3 ) = numeco
     hdfedge( 2 ) = numalbbnds
     hdfedge( 1 ) = numsnowtypes
     
     !Read the Mean data:
     sdsname = 'Snow_Albedo_Year_Mean'
     !determine the sds_index for the SDS:
     status = nf_inq_varid( newhdfid, trim(sdsname), sds_id )
     call cld_fchk( status, __file__, __line__ )
  
     !get access to this SDS:
         
     !Read the data:
     status = nf_get_vara_real( newhdfid, sds_id, hdfstart, hdfedge, dummyalb )
     call cld_fchk( status, __file__, __line__ )
  
     !Store the dummy data in the final array:
     do i = 1, numalbbnds
       do j = 0, numeco-1
         do k = 1, numsnowtypes
            albedomean(i,j,k) = dummyalb(k,i,j,1,1)
         end do
       end do
     end do
  
     !Error Checking:
     if (sds_index == fail .or. &
         sds_id    == fail .or. &
         status    == fail)     then
         errorlevel = fail
         return
      end if
     
     !************************************************************************************
     ! Close the file:
     !************************************************************************************
     !Close the  HDF file:
     status = nf_close( newhdfid )
     call cld_fchk( status, __file__, __line__ )
  
   end subroutine readsnowalbstats
  
 end module mod06albedoecomodule
nonscience_parameters::success
integer success
Definition: nonscience_parameters.f90:8
cld_fchk
subroutine cld_fchk(status, file, line)
Definition: cld_fchk.f90:2
nonscience_parameters
Definition: nonscience_parameters.f90:4
trim
string & trim(string &s, const string &delimiters)
Definition: EnvsatUtil.cpp:29
mod06albedoecomodule
Definition: MOD06AlbedoEcoModule.f90:1
mod06albedoecomodule::readsnowalbstats
subroutine, public readsnowalbstats(StatsFN, NumSnowTypes, NumAlbBnds, numEco, AlbedoMean, errorLevel)
Definition: MOD06AlbedoEcoModule.f90:95