TABLE OF CONTENTS

1. MLT_RSS/check_path.pro [ Programs ]

[ Top ] [ Programs ]

NAME

   check_path.pro

PURPOSE

   Makes sure the path to the filename is valid

DESCRIPTION

   Check to see if the path to a given filename is valid.  If the create keyword is
   set, creates the path if possible

INPUTS:

   file:   filename of file to check
   create: Keyword.  If set to 1, then directory is created if it does not exist

RETURN VALUE:

     0 is path is now valid
     -1 if path is not valid

AUTHOR

   Carl Mears, Remote Sensing Systems

COPYRIGHT

   THIS SOFTWARE AND ITS DOCUMENTATION ARE COPYRIGHT 2012 REMOTE SENSING SYSTEMS.  
   THEY ARE PROVIDED FOR INFORMATIONAL AND ALGORITHM VERIFICATION PURPOSES ONLY 
   AND MAY NOT BE USED IN WHOLE OR IN PART FOR ANY OTHER PURPOSE WITHOUT WRITTEN
   PERMISSION FROM REMOTE SENSING SYSTEMS.  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/29/2019 Initial Version prepared for NCDC

USAGE

   check_path,path,/create

2. MLT_RSS/compute_global_average_from_144_72_map.pro [ Programs ]

[ Top ] [ Programs ]

NAME

   compute_global_average_from_144_72_map.pro

PURPOSE

   calculates the global average of a 144 x 72 map

DESCRIPTION

   calculates the global average of a 144 x 72 map, with parameters
   for latitude weights, surface_type, or cosine lat weighting

INPUTS

   map             (144,72) float32 array.  This is assume to be a 2.5x2.5 degree map, RSS conventions.
   lat_wts         (72) float32 array of latitude weights.
   surf_str        string that describes the surface tpye to average over -- choices are 'Land','Sea','Land_and_Sea'
                   default is 'Land_and_Sea'
   no_cosine       keyword if set do not apply cosine latitude weighting (for example, if this weighting is already included in lat_wts)
   channel         max_alt.  if set to a positive number, only use grid points with average altitudes below that number.

RETURN VALUE

   global average value

AUTHOR

   Carl Mears, Remote Sensing Systems

COPYRIGHT

   THIS SOFTWARE AND ITS DOCUMENTATION ARE COPYRIGHT 2012 REMOTE SENSING SYSTEMS.  
   THEY ARE PROVIDED FOR INFORMATIONAL AND ALGORITHM VERIFICATION PURPOSES ONLY 
   AND MAY NOT BE USED IN WHOLE OR IN PART FOR ANY OTHER PURPOSE WITHOUT WRITTEN
   PERMISSION FROM REMOTE SENSING SYSTEMS.  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/29/2012 Initial Version prepared for NCDC

USAGE

   global_average = compute_global_average_from_144_72_map(map,lat_wts=replicate(1.0,72),surf_str = 'Land',/no_cosine,max_alt=3000

3. MLT_RSS/create_harmonic_basis.pro [ Programs ]

[ Top ] [ Programs ]

NAME

   create_harmonic_basis.pro

PURPOSE

   creates a basis of harmonic functions for fitting purposes

DESCRIPTION

   creates a basis of harmonic functions for fitting purposes

INPUTS:

   num_harmonics         ; number of harmonics in basis
   length                ; length of basis in time steps
   period                ; period of fundamental in time steps
   linear = linear       ; set to include a linear trend term basis
   constant=constant     ; set to include a constant term in basis
   delta_t = delta_t     ; time shift in basis -- default = 0.0

OUTPUTS:

   basis
   coeff       ; coefficients of fit

AUTHOR

   Carl Mears, Remote Sensing Systems

COPYRIGHT

   THIS SOFTWARE AND ITS DOCUMENTATION ARE COPYRIGHT 2012 REMOTE SENSING SYSTEMS.  
   THEY ARE PROVIDED FOR INFORMATIONAL AND ALGORITHM VERIFICATION PURPOSES ONLY 
   AND MAY NOT BE USED IN WHOLE OR IN PART FOR ANY OTHER PURPOSE WITHOUT WRITTEN
   PERMISSION FROM REMOTE SENSING SYSTEMS.  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

   6/18/2012 Initial Version prepared for NCDC

USAGE

   create_harmonic_basis,4,300,12,basis,linear = 1,constant=1,delta_t = 0.0

4. MLT_RSS/current_month_number.pro [ Programs ]

[ Top ] [ Programs ]

NAME

   current_month_number.pro

PURPOSE

   returns the number of the current month, with January, 1978 set to zero 

DESCRIPTION

   Uses IDL internal date routines to compute the month number for the current date

AUTHOR

   Carl Mears, Remote Sensing Systems

COPYRIGHT

   THIS SOFTWARE AND ITS DOCUMENTATION ARE COPYRIGHT 2012 REMOTE SENSING SYSTEMS.  
   THEY ARE PROVIDED FOR INFORMATIONAL AND ALGORITHM VERIFICATION PURPOSES ONLY 
   AND MAY NOT BE USED IN WHOLE OR IN PART FOR ANY OTHER PURPOSE WITHOUT WRITTEN
   PERMISSION FROM REMOTE SENSING SYSTEMS.  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

   current_month_number = current_month_number()

5. MLT_RSS/latitude_wts.pro [ Programs ]

[ Top ] [ Programs ]

NAME

   latitude_wts.pro

PURPOSE

   computes latitude weights for data gridded on an equally spaced latitude grid for
   a given latitude range.  Grids are assumed to start at 90S and continue to 90N. 

DESCRIPTION

   It is assumed that the latitude grid contains num_lats grid cells of equal width in
   latitude.  A fine grid with 100*num_lats points is constructed.
   This fine grid is set to 1.0 between lat_range[0] and lat_range[1] and used to calculate
   the weight in the original grid.  By default, each latitude grid cell is futher weighted by
   cosine(latitude) to account for the different areas of different latitude bands.  Setting the
   no_cos flag to one removes the cosine(latitude) weighting.

AUTHOR

   Carl Mears, Remote Sensing Systems

COPYRIGHT

   THIS SOFTWARE AND ITS DOCUMENTATION ARE COPYRIGHT 2012 REMOTE SENSING SYSTEMS.  
   THEY ARE PROVIDED FOR INFORMATIONAL AND ALGORITHM VERIFICATION PURPOSES ONLY 
   AND MAY NOT BE USED IN WHOLE OR IN PART FOR ANY OTHER PURPOSE WITHOUT WRITTEN
   PERMISSION FROM REMOTE SENSING SYSTEMS.  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

   lat_wts = latitude_weights(72,[-60.0,60.0],/no_cos)

6. MLT_RSS/read_L2A_inventory.pro [ Programs ]

[ Top ] [ Programs ]

NAME

   read_L2A_inventory.pro

PURPOSE

   Reads RSS L2A inventory file.

DESCRIPTION

   Reads RSS L2A inventory file.

INPUTS

   sat_num
   channel

OUTPUTS:

   exists          ;intarr(80000)  1 if orbit exists, 0 if does not exist
   start_scan      ;intarr(80000)  first scan number in oribt 
   end_scan        ;intarr(80000)  last scan number in orbit
   start_rd_2000   ;dlbarr(80000)  begin date, in rd_2000 format
   end_rd_2000     ;dblarr(80000)  end date, in rd_2000 format
   eqx_rd_2000     ;dblarr(80000)  scending node crossing time, in rd_2000 format

FILE READ

   L2A inventory file in text form
   e.g. AQUA_Channel_05_L2A.inv.txt

AUTHOR

   Carl Mears, Remote Sensing Systems

COPYRIGHT

   THIS SOFTWARE AND ITS DOCUMENTATION ARE COPYRIGHT 2012 REMOTE SENSING SYSTEMS.  
   THEY ARE PROVIDED FOR INFORMATIONAL AND ALGORITHM VERIFICATION PURPOSES ONLY 
   AND MAY NOT BE USED IN WHOLE OR IN PART FOR ANY OTHER PURPOSE WITHOUT WRITTEN
   PERMISSION FROM REMOTE SENSING SYSTEMS.  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/28/2012 Initial Version prepared for NCDC

USAGE

   read_L2A_inventory,10,5,exists,start_scan,end_scan,start_rd_2000,end_rd_2000,eqx_rd_2000

7. MLT_RSS/read_land_fraction_144_72.pro [ Programs ]

[ Top ] [ Programs ]

NAME

   read_land_fraction_144_72.pro

PURPOSE

   reads a file containing the land fraction on a 144x72 grid

DESCRIPTION

   Reads a flat binary file called land_fraction_144_72.dat.  This file is
   real(4) little endian, and written using RSS gridded data conventions.

AUTHOR

   Carl Mears, Remote Sensing Systems

COPYRIGHT

   THIS SOFTWARE AND ITS DOCUMENTATION ARE COPYRIGHT 2012 REMOTE SENSING SYSTEMS.  
   THEY ARE PROVIDED FOR INFORMATIONAL AND ALGORITHM VERIFICATION PURPOSES ONLY 
   AND MAY NOT BE USED IN WHOLE OR IN PART FOR ANY OTHER PURPOSE WITHOUT WRITTEN
   PERMISSION FROM REMOTE SENSING SYSTEMS.  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

   read_land_fraction_144_72,land_fraction

8. MLT_RSS/read_topography_144_72.pro [ Programs ]

[ Top ] [ Programs ]

NAME

   read_topography_144_72.pro

PURPOSE

   reads a file containing the mean altitude above sea level in each grid box in a 144 x 72 grid

DESCRIPTION

   Reads a flat binary file called hgt_144x72_map.dat.  This file is
   float little endian, and written using RSS self-describing map data conventions.

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/29/2012 Initial Version prepared for NCDC

USAGE

   read_topography_144x72,hgt

9. MLT_RSS/set_up_ps.pro [ Programs ]

[ Top ] [ Programs ]

NAME

   set_up_ps.pro

PURPOSE

   Sets up a postscript file for output from IDL

DESCRIPTION

    Sets up a postscript file for output from IDL.  Default size (7.0 by 3.5 inches) can
    be overridden by passing keywords (with two alternate spellings!)

INPUTS

   file    filename of file to open.  Should end in .ps
   x_size  size of ps plot in inches in x direction
   xsize   size of ps plot in inches in x direction
   y_size  size of ps plot in inches in y direction
   ysize   size of ps plot in inches in y direction   
   cmyk    flag.  set this flag to force output to be in cmyk colorspace
   
   note:  two spellings of xsize(x_size) and ysize(y_size) are allowed to reduce stupid coding errors.
          if both are set (a REALLY stupid coding error), then the one with the underscore (eg x_size) takes precedent.

OUTPUT

   none

AUTHOR

   Carl Mears, Remote Sensing Systems

COPYRIGHT

   THIS SOFTWARE AND ITS DOCUMENTATION ARE COPYRIGHT 2012 REMOTE SENSING SYSTEMS.  
   THEY ARE PROVIDED FOR INFORMATIONAL AND ALGORITHM VERIFICATION PURPOSES ONLY 
   AND MAY NOT BE USED IN WHOLE OR IN PART FOR ANY OTHER PURPOSE WITHOUT WRITTEN
   PERMISSION FROM REMOTE SENSING SYSTEMS.  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/2019 Initial Version prepared for NCDC

USAGE

   set_up_ps,file=file,x_size=x_size,y_size=y_size,xsize=xsize,ysize=ysize,cmyk=cmyk

10. MLT_RSS/smooth_offsets.pro [ Programs ]

[ Top ] [ Programs ]

NAME

   smooth_offsets.pro

PURPOSE

   smooths AMSU zonal intersatellite offsets in the north/south direction. 

DESCRIPTION

   smooths AMSU zonal intersatellite offsets in the north/south direction.  A simple, "boxcar" smooth
   is used of width 5 2.5 degree bins

INPUTS

   offsets         (num_lats,num_sats) float32 array of offsets

OUTPUTS

   offsets_smooth  (num_lats,num_sats) float32 array of smoothed offsets

AUTHOR

   Carl Mears, Remote Sensing Systems

COPYRIGHT

   THIS SOFTWARE AND ITS DOCUMENTATION ARE COPYRIGHT 2012 REMOTE SENSING SYSTEMS.  
   THEY ARE PROVIDED FOR INFORMATIONAL AND ALGORITHM VERIFICATION PURPOSES ONLY 
   AND MAY NOT BE USED IN WHOLE OR IN PART FOR ANY OTHER PURPOSE WITHOUT WRITTEN
   PERMISSION FROM REMOTE SENSING SYSTEMS.  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/29/2012 Initial Version prepared for NCDC

USAGE

   smooth_offsets,offsets,offsets_smooth