TABLE OF CONTENTS


MLT_RSS/maps.f90 [ Methods ]

[ Top ] [ Methods ]

NAME

    module maps

PURPOSE

    psuedoclass that defines and manipulates a rectangular gridded map type

DESCRIPTION

    psuedoclass that defines and manipulates a rectangular gridded map type

VARIABLES

    the pseudoclass defines a map type

       type map_str
               real(4)                                                 :: min_x                 ! minimum x value
               real(4)                                                 :: max_x         ! maximum x value
               real(4)                                                 :: delta_x       ! spacing points in x direction
               integer(4)                                              :: num_x                 ! number of x points
               integer(4)                                              :: type_x        ! type of grid in x direction (see explantion below)
               real(4)                                                 :: min_y                 ! minimum y value
               real(4)                                                 :: max_y                 ! maximum x value
               real(4)                                                 :: delta_y               ! spacing points in x direction
               integer(4)                                              :: num_y                 ! number of x points
               integer(4)                                              :: type_y                ! type of grid in x direction (see explantion below)
               integer(4)                                              :: type_bc               ! type of boundary conditions
               real(4),dimension(:,:),pointer  :: dat               ! map data
       end type map_str

REMARKS

  explanation of the grid type flag:

  There are basically two types of evenly spaced rectangular gridded map --

               1. Those for which the value represents the value in a cell - I'll call this cell_centered
                     for these maps, the lower left value represents the value in the cell defined
             by long = (0.0:delta_x), lat = (-90,-90+delta_y), and is associated with at point at
                         (delta_x/2.0, -90+delta_x/2.0)
               2. Those for which the value represents the value on the vertex between cells - I'll call this edge_centered
                         for these maps, the lower left value represents the value at the point 
                         by long = 0.0, lat = (-90).  A peculiar feature of this sort of grid is
                         that the row at -90.0 must be identical, since it all refers to the same point!
               For now, all routines in the module assume that maps obey spherical boundary conditions
               For now, all maps are not redundant at the vertical edges
               
               This means that for both types of grids, 360.0/(delta_x) longitude points are needed, and the only different is
               whether the values are offset by 0.5*delta_x

               For cell_centered grids, 180/(delta_y) latitude points are needed, and for 
               Edge centered grids 180/(delta_y) + 1 latitude points are needed

               note that mixed grid types are allowed, with the lat and long grids being different types

  ROUTINES
    set_up_map(min_x,delta_x,num_x,type_x,min_y,delta_y,num_y,type_y,type_bc,mp,error)
    zero_map(mp,error)
    deallocate_map(mp,error)
    get_map_value(mp,xx,yy,value,error)
    get_map_value_no_interp(mp,xx,yy,value,error)
    wrap_indices(mp,ix,iy,ix_wrapped,iy_wrapped,error)
    map_value(mp,ix,iy,error)
    get_grid_location(mp,ix,iy,x,y,error)
    get_vertex_location(mp,x,y,ix,iy,error)
    get_grid_indices(mp,x,y,ix,iy,error)
    get_vertex_indices(mp,x,y,ix,iy,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 maps

MLT_RSS/maps.f90/calc_relative_position [ Methods ]

[ Top ] [ Methods ]

NAME

   calc_relative_position

PURPOSE

 calculates the relative positon of the point x,y relative to the
 vertex ix,iy.  

DESCRIPTION

 calculates the relative positon of the point x,y relative to the
 vertex ix,iy.  Since x, y is constrained to be within the
 bounds of the map, the modulo arithmatic is relatively simple,
 as long as x,y id within half a delta of the vertex.  This is
 assumed to be the case here

INPUTS

   mp       ! map to be sampled
   x       ! x location in real space
   y       ! x location in real space
   ix       ! x index
   iy       ! y index

OUTPUTS

   x_rel   ! relative x distance to vertex
   y_rel   ! relative y distance to vertex
   error   ! error flag

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

    10/21/2012 Initial Version prepared for NCDC

USAGE

    call calc_relative_position(mp,x,y,ix,iy,x_rel,y_rel,error)

MLT_RSS/maps.f90/deallocate_map [ Methods ]

[ Top ] [ Methods ]

NAME

    deallocate_map

PURPOSE

    deallocates data space in variable of map type

DESCRIPTION

    deallocates data space in variable of map type

INPUTS

   mp       ! map to be deallocated

OUTPUTS

   error    ! error flag

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

    call deallocate_map(mp,error)

MLT_RSS/maps.f90/get_grid_indices [ Methods ]

[ Top ] [ Methods ]

NAME

   get_grid_indices

PURPOSE

 returns the indices of the grid point in whose cell the
 point x,y is located

DESCRIPTION

 returns the indices of the grid point in whose cell the
 point x,y is located

INPUTS

   mp       ! map to be sampled
   x       ! x location in real space
   y       ! x location in real space

OUTPUTS

   ix       ! x index
   iy       ! y index
   error   ! error flag

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

    10/21/2012 Initial Version prepared for NCDC

USAGE

    call get_grid_indices(mp,x,y,ix,iy,error)

MLT_RSS/maps.f90/get_grid_location [ Methods ]

[ Top ] [ Methods ]

NAME

    get_grid_location

PURPOSE

 this subroutine returns the location in real map space of
 the grid point ix,iy

DESCRIPTION

 this subroutine returns the location in real map space of
 the grid point ix,iy

INPUTS

   mp       ! map to be sampled
   ix       ! x index
   iy       ! y index

OUTPUTS

   x       ! x location in real space
   y       ! x location in real space
   error   ! error flag

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

    10/21/2012 Initial Version prepared for NCDC

USAGE

    call get_grid_location(mp,ix,iy,x,y,error)

MLT_RSS/maps.f90/get_map_value [ Methods ]

[ Top ] [ Methods ]

NAME

    get_map_value

PURPOSE

    this subroutine returns the interpolated value at a point x,y

DESCRIPTION

    this subroutine returns the interpolated value at a point x,y
    note that the interpolation is somewhat different depending on 
    what type of grid is used for the map structure

INPUTS

   mp       ! map to be sampled
   xx       ! x location
   yy       ! y location

OUTPUTS

   value    ! interpolated value
   error    ! error flag

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

    10/21/2012 Initial Version prepared for NCDC

USAGE

    call get_map_value(mp,xx,yy,value,error)

MLT_RSS/maps.f90/get_map_value_no_interp [ Methods ]

[ Top ] [ Methods ]

NAME

    get_map_value_no_interp

PURPOSE

    this subroutine returns the non-interpolated value at grid point closest to xx,yy

DESCRIPTION

    this subroutine returns the non-interpolated value at grid point closest to xx,yy

INPUTS

   mp       ! map to be sampled
   xx       ! x location
   yy       ! y location

OUTPUTS

   value    ! interpolated value
   error    ! error flag

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

    10/21/2012 Initial Version prepared for NCDC

USAGE

    call get_map_value_no_interp(mp,xx,yy,value,error)

MLT_RSS/maps.f90/get_vertex_indices [ Methods ]

[ Top ] [ Methods ]

NAME

   get_vertex_indices

PURPOSE

 returns the indices of the vertex point nearest x,y.  The vertex point is
 where the edges of the cells cross

DESCRIPTION

 returns the indices of the vertex point nearest x,y.  The vertex point is
 where the edges of the cells cross

INPUTS

   mp       ! map to be sampled
   x       ! x location in real space
   y       ! x location in real space

OUTPUTS

   ix       ! x index
   iy       ! y index
   error   ! error flag

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

    10/21/2012 Initial Version prepared for NCDC

USAGE

    call get_vertex_indices(mp,x,y,ix,iy,error)

MLT_RSS/maps.f90/get_vertex_location [ Methods ]

[ Top ] [ Methods ]

NAME

   get_vertex_location

PURPOSE

 this subroutine returns the location in real map space of
 the vertex point ix,iy

DESCRIPTION

 this subroutine returns the location in real map space of
 the vertex point ix,iy

INPUTS

   mp       ! map to be sampled
   ix       ! x index
   iy       ! y index

OUTPUTS

   x       ! x location in real space
   y       ! x location in real space
   error   ! error flag

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

    10/21/2012 Initial Version prepared for NCDC

USAGE

    call get_vertex_location(mp,ix,iy,x,y,error)

MLT_RSS/maps.f90/map_value [ Methods ]

[ Top ] [ Methods ]

NAME

    map_value

PURPOSE

 this subroutine returns the value of the map at xi,yi even
 if xi and yi are out of range by applying the appropriate
 boundary conditions

DESCRIPTION

 this subroutine returns the value of the map at xi,yi even
 if xi and yi are out of range by applying the appropriate
 boundary conditions

INPUTS

   mp       ! map to be sampled
   ix       ! x index
   iy       ! y index

OUTPUTS

   error    ! error flag

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

    10/21/2012 Initial Version prepared for NCDC

USAGE

    z = map_value(mp,ix,iy,error)

MLT_RSS/maps.f90/read_map [ Methods ]

[ Top ] [ Methods ]

NAME

   read_map

PURPOSE

    reads in map from a standard, self describing format

DESCRIPTION

    reads in map from a standard, self describing format
    allocated map structure according to description in file

INPUTS

   unit_num ! logical unit to write to

OUTPUTS

   mp       ! map variable to be read into
   error   ! error flag

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

    10/21/2012 Initial Version prepared for NCDC

USAGE

    call ead_map(unit_num,mp,error)

MLT_RSS/maps.f90/set_up_map [ Methods ]

[ Top ] [ Methods ]

NAME

    set_up_map

PURPOSE

    sets up an instance of the map type

DESCRIPTION

    sets up an instance of the map type

INPUTS

   min_x    ! minimum value of x (longitude) coordinate
   delta_x  ! size of grid cell in longitude direction (degrees)
   num_x    ! number of grid cells in longitude direction
   type_x   ! type of grid in x direction(cell centered or edge defined)
   min_y    ! minimum value of y (latitude) coordinate
   delta_y  ! size of grid cell in latitude direction (degrees)
   num_y    ! number of grid cells in latitude direction
   type_y   ! type of grid in x direction(cell centered or edge defined)
   type_bc, ! type of boundary conditions (spherical, cylindrical, or no wrapping)

OUTPUTS

   mp       ! new instance of map type
   error    ! error flag

REMARKS

  explanation of the grid type flag:

  There are basically two types of evenly spaced rectangular gridded map --

               1. Those for which the value represents the value in a cell - I'll call this cell_centered
                     for these maps, the lower left value represents the value in the cell defined
             by long = (0.0:delta_x), lat = (-90,-90+delta_y), and is associated with at point at
                         (delta_x/2.0, -90+delta_x/2.0)
               2. Those for which the value represents the value on the vertex between cells - I'll call this edge_centered
                         for these maps, the lower left value represents the value at the point 
                         by long = 0.0, lat = (-90).  A peculiar feature of this sort of grid is
                         that the row at -90.0 must be identical, since it all refers to the same point!
               For now, all routines in the module assume that maps obey spherical boundary conditions
               For now, all maps are not redundant at the vertical edges
               
               This means that for both types of grids, 360.0/(delta_x) longitude points are needed, and the only different is
               whether the values are offset by 0.5*delta_x

               For cell_centered grids, 180/(delta_y) latitude points are needed, and for 
               Edge centered grids 180/(delta_y) + 1 latitude points are needed

               note that mixed grid types are allowed, with the lat and long grids being different types

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

    call set_up_map(min_x,delta_x,num_x,type_x,min_y,delta_y,num_y,type_y,type_bc,mp,error)

MLT_RSS/maps.f90/wrap_indices [ Methods ]

[ Top ] [ Methods ]

NAME

    wrap_indices

PURPOSE

    wraps map indiced according to boundary conditions

DESCRIPTION

    wraps map indiced according to boundary conditions

INPUTS

   mp       ! map to be sampled
   ix       ! x index
   iy       ! y index

OUTPUTS

   ix_wrapped       ! x index, wrapped
   iy_wrapped       ! y index, wrapped
   error    ! error flag

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

    10/21/2012 Initial Version prepared for NCDC

USAGE

    call wrap_indices(mp,ix,iy,ix_wrapped,iy_wrapped,error)

MLT_RSS/maps.f90/write_map [ Methods ]

[ Top ] [ Methods ]

NAME

   write_map

PURPOSE

    writes out map in a standard, self describing format

DESCRIPTION

    writes out map in a standard, self describing format

INPUTS

   mp       ! map to be written
   unit_num ! logical unit to write to

OUTPUTS

   error   ! error flag

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

    10/21/2012 Initial Version prepared for NCDC

USAGE

    call write_map(mp,unit_num,error)

MLT_RSS/maps.f90/zero_map [ Methods ]

[ Top ] [ Methods ]

NAME

    zero_map

PURPOSE

    zeros data in variable of map type

DESCRIPTION

    zeros data in variable of map type

INPUTS

   mp       ! map to be zeroed

OUTPUTS

   error    ! error flag

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

    call zero_map(mp,error)