TABLE OF CONTENTS


MLT_RSS/landmask.f90 [ Programs ]

[ Top ] [ Programs ]

NAME

    module landmask

PURPOSE

    psuedoclass for manipulating landmask data

DESCRIPTION

    psuedoclass for manipulating landmask data
    

  ROUTINES
   subroutine read_land_mask(land_mask,error)

DESCRIPTION

           reads and unpacks land mask data

INPUTS

           none

OUTPUTS

           integer(4) :: land_mask(4320,2160) land mask array.  
           integer(4) :: error

USAGE

           call read_land_mask(land_mask,error)



   integer(4) function find_land_sea(lat,long)

DESCRIPTION

           returns land mask data at the provided longitude and latitude

INPUTS

           real(4) :: lat     ! latitude
           real(4) :: long    ! longitude

OUTPUTS

           integer(4)  :: error  ! error flag
       RETURN VALUE
           integer(4)  1 = SEA, 2= LAND, 0 = UNKNOWN

USAGE

           surf_type = find_land_sea(lat,long)


   real(4) function find_land_fraction(long,lat,no_interp)

DESCRIPTION

           returns land fraction at the provided longitude and latitude

INPUTS

           real(4) :: lat     ! latitude
           real(4) :: long    ! longitude

OUTPUTS

           integer(4)  :: error  ! error flag
       RETURN VALUE
           integer(4)  0.0 means completely oceans, 1.0 completely land.
           horizontal resolution determined by data file loaded in most likely case 144 x 72 (2.5 degree resolution)

USAGE

           surf_type = find_land_fraction(lat,long)

   subroutine read_land_fraction_map(lf_map,error)
           reads and unpacks land fraction data

INPUTS

           none

OUTPUTS

           integer(4) :: lf_map -- data is in dervived type map_str (see map.f90 for more details)
           integer(4) :: error

USAGE

           call read_land_fraction_map(lf_map,error)

AUTHOR

    Carl Mears, Remote Sensing Systems

COPYRIGHT

    THIS SOFTWARE AND ITS DOCUMENTATION ARE CONSIDERED TO BE IN THE PUBLIC DOMAIN AND
    THUS ARE AVAILABLE FOR UNRESTRICTED PUBLIC USE.  THEY ARE FURNISHED "AS IS." THE 
    AUTHORS, THE UNITED STATES GOVERNMENT, ITS INSTRUMENTALITIES, OFFICERS, EMPLOYEES, 
    AND AGENTS MAKE NO WARRANTY, EXPRESS OR IMPLIED, AS TO THE USEFULNESS OF THE 
    SOFTWARE AND DOCUMENTATION FOR ANY PURPOSE. THEY ASSUME NO RESPONSIBILITY (1) FOR
    THE USE OF THE SOFTWARE AND DOCUMENTATION!  OR (2) TO PROVIDE TECHNICAL SUPPORT 
    TO USERS.

HISTORY

    2/21/2012 Initial Version prepared for NCDC

USAGE

    use landmask