LSEatlas_Define.f90

Go to the documentation of this file.

!
! LSEatlas_Define
!
! Module defining the LSEatlas object.
!
!
! CREATION HISTORY:
!       Written by:     Paul van Delst, 17-Aug-2011
!                       paul.vandelst@noaa.gov
 
MODULE lseatlas_define

  ! -----------------
  ! Environment setup
  ! -----------------
  ! Module use
  USE type_kinds           , ONLY: fp, long, double
  USE message_handler      , ONLY: success, failure, information, display_message
  USE compare_float_numbers, ONLY: OPERATOR(.equalto.)
  USE file_utility         , ONLY: file_open, file_exists
  USE binary_file_utility  , ONLY: open_binary_file      , &
                                   writegatts_binary_file, &
                                   readgatts_binary_file
  ! Disable implicit typing
  IMPLICIT NONE


  ! ------------
  ! Visibilities
  ! ------------
  ! Everything private by default
  PRIVATE
  ! Parameters
  PUBLIC :: lseatlas_datatype
  ! Datatypes
  PUBLIC :: lseatlas_type
  ! Operators
  PUBLIC :: OPERATOR(==)
  ! Procedures
  PUBLIC :: lseatlas_associated
  PUBLIC :: lseatlas_destroy
  PUBLIC :: lseatlas_create
  PUBLIC :: lseatlas_inspect
  PUBLIC :: lseatlas_validrelease
  PUBLIC :: lseatlas_info
  PUBLIC :: lseatlas_name
  PUBLIC :: lseatlas_defineversion
  PUBLIC :: lseatlas_setvalue
  PUBLIC :: lseatlas_getvalue
  PUBLIC :: lseatlas_inquirefile
  PUBLIC :: lseatlas_readfile
  PUBLIC :: lseatlas_writefile


  ! ---------------------
  ! Procedure overloading
  ! ---------------------
  INTERFACE OPERATOR(==)
    MODULE PROCEDURE lseatlas_equal
  END INTERFACE OPERATOR(==)


  ! -----------------
  ! Module parameters
  ! -----------------
  CHARACTER(*), PARAMETER :: module_version_id = &
    '$Id: LSEatlas_Define.f90 60152 2015-08-13 19:19:13Z paul.vandelst@noaa.gov $'
  ! Datatype information
  CHARACTER(*), PARAMETER :: lseatlas_datatype = 'LSEatlas'
  ! Current valid release and version
  INTEGER, PARAMETER :: lseatlas_release = 1  ! This determines structure and file formats.
  INTEGER, PARAMETER :: lseatlas_version = 1  ! This is just the default data version.
  ! Close status for write errors
  CHARACTER(*), PARAMETER :: write_error_status = 'DELETE'
  ! Literal constants
  REAL(fp), PARAMETER :: zero = 0.0_fp
  REAL(fp), PARAMETER :: one  = 1.0_fp
  ! String lengths
  INTEGER,  PARAMETER :: ml = 256 ! Message length
  INTEGER,  PARAMETER :: sl =  80 ! String length


  ! ----------------------------------
  ! LSEatlas data type definitions
  ! ----------------------------------
  !:tdoc+:
  TYPE :: lseatlas_type
    PRIVATE
    ! Allocation indicator
    LOGICAL :: is_allocated = .false.
    ! Datatype information
    CHARACTER(SL) :: datatype_name = lseatlas_datatype
    ! Release and version information
    INTEGER(Long) :: release = lseatlas_release
    INTEGER(Long) :: version = lseatlas_version
    ! Dimensions
    INTEGER(Long) :: n_frequencies = 0  ! I dim.
    INTEGER(Long) :: n_latitudes   = 0  ! J dim.
    INTEGER(Long) :: n_longitudes  = 0  ! K dim.
    ! Dimensional vectors
    REAL(Double),  ALLOCATABLE :: frequency(:)      ! Ix1
    REAL(Double),  ALLOCATABLE :: latitude(:)       ! Jx1
    REAL(Double),  ALLOCATABLE :: longitude(:)      ! Kx1
    ! Emissivity LUT data
    REAL(Double),  ALLOCATABLE :: emissivity(:,:,:)  ! IxJxK
  END TYPE lseatlas_type
  !:tdoc-:


CONTAINS


!################################################################################
!################################################################################
!##                                                                            ##
!##                           ## PUBLIC PROCEDURES ##                          ##
!##                                                                            ##
!################################################################################
!################################################################################

!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_Associated
!
! PURPOSE:
!       Elemental function to test the status of the allocatable components
!       of the LSEatlas structure.
!
! CALLING SEQUENCE:
!       Status = LSEatlas_Associated( LSEatlas )
!
! OBJECTS:
!       LSEatlas:   Structure which is to have its member's
!                   status tested.
!                   UNITS:      N/A
!                   TYPE:       LSEatlas_type
!                   DIMENSION:  Scalar or any rank
!                   ATTRIBUTES: INTENT(IN)
!
! FUNCTION RESULT:
!       Status:     The return value is a logical value indicating the
!                   status of the members.
!                    .TRUE.  - if ANY of the allocatable members
!                              are in use.
!                    .FALSE. - if ALL of the allocatable members
!                              are not in use.
!                   UNITS:      N/A
!                   TYPE:       LOGICAL
!                   DIMENSION:  Same as input
!
!:sdoc-:
!--------------------------------------------------------------------------------

  ELEMENTAL FUNCTION lseatlas_associated( self ) RESULT( Status )
    TYPE(lseatlas_type), INTENT(IN) :: self
    LOGICAL :: status
    status = self%Is_Allocated
  END FUNCTION lseatlas_associated

  
!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_Destroy
!
! PURPOSE:
!       Elemental subroutine to re-initialize LSEatlas objects.
!
! CALLING SEQUENCE:
!       CALL LSEatlas_Destroy( LSEatlas )
!
! OBJECTS:
!       LSEatlas:     Re-initialized LSEatlas structure.
!                     UNITS:      N/A
!                     TYPE:       LSEatlas_type
!                     DIMENSION:  Scalar or any rank
!                     ATTRIBUTES: INTENT(OUT)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  ELEMENTAL SUBROUTINE lseatlas_destroy( self )
    TYPE(lseatlas_type), INTENT(OUT) :: self
    self%Is_Allocated = .false.
    self%n_Frequencies = 0
    self%n_Latitudes   = 0
    self%n_Longitudes  = 0
  END SUBROUTINE lseatlas_destroy


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_Create
!
! PURPOSE:
!       Elemental subroutine to create an instance of an LSEatlas object.
!
! CALLING SEQUENCE:
!       CALL LSEatlas_Create( LSEatlas     , &
!                             n_Frequencies, &     
!                             n_Latitudes  , &     
!                             n_Longitudes   )         
!
! OBJECTS:
!       LSEatlas:           LSEatlas object structure.
!                           UNITS:      N/A
!                           TYPE:       LSEatlas_type
!                           DIMENSION:  Scalar or any rank
!                           ATTRIBUTES: INTENT(OUT)
!
! INPUTS:
!       n_Frequencies:      Number of spectral frequencies for which there are
!                           data.
!                           Must be > 0.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Conformable with the LSEatlas object
!                           ATTRIBUTES: INTENT(IN)
!
!       n_Latitudes:        Number of latitude values for which there are
!                           data.
!                           Must be > 0.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Conformable with the LSEatlas object
!                           ATTRIBUTES: INTENT(IN)
!
!       n_Longitudes:       Number of longitude values for which there are
!                           data.
!                           Must be > 0.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Conformable with the LSEatlas object
!                           ATTRIBUTES: INTENT(IN)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  ELEMENTAL SUBROUTINE lseatlas_create( &
    self         , &  ! Output
    n_Frequencies, &  ! Input
    n_Latitudes  , &  ! Input
    n_Longitudes   )  ! Input
    ! Arguments
    TYPE(lseatlas_type), INTENT(OUT) :: self
    INTEGER            , INTENT(IN)  :: n_frequencies        
    INTEGER            , INTENT(IN)  :: n_latitudes          
    INTEGER            , INTENT(IN)  :: n_longitudes              
    ! Local variables
    INTEGER :: alloc_stat

    ! Check input
    IF ( n_frequencies < 1 .OR. &
         n_latitudes   < 1 .OR. &
         n_longitudes  < 1 ) RETURN

   
    ! Perform the allocation
    ALLOCATE( self%Frequency( n_frequencies ), &
              self%Latitude( n_latitudes ), &
              self%Longitude( n_longitudes ), &
              self%Emissivity( n_frequencies, n_latitudes, n_longitudes ), &
              stat = alloc_stat )
    IF ( alloc_stat /= 0 ) RETURN


    ! Initialise
    ! ...Dimensions
    self%n_Frequencies = n_frequencies
    self%n_Latitudes   = n_latitudes  
    self%n_Longitudes  = n_longitudes 
    ! ...Arrays
    self%Frequency  = zero
    self%Latitude   = zero
    self%Longitude  = zero
    self%Emissivity = zero

    ! Set allocation indicator
    self%Is_Allocated = .true.

  END SUBROUTINE lseatlas_create


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_Inspect
!
! PURPOSE:
!       Subroutine to print the contents of a LSEatlas object to stdout.
!
! CALLING SEQUENCE:
!       CALL LSEatlas_Inspect( LSEatlas )
!
! OBJECTS:
!       LSEatlas:  LSEatlas object to display.
!                      UNITS:      N/A
!                      TYPE:       LSEatlas_type
!                      DIMENSION:  Scalar
!                      ATTRIBUTES: INTENT(IN)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  SUBROUTINE lseatlas_inspect( self)
    TYPE(lseatlas_type), INTENT(IN) :: self
    WRITE(*,'(1x,"LSEatlas OBJECT")')
    ! Release/version info
    WRITE(*,'(3x,"Release.Version  :",1x,i0,".",i0)') self%Release, self%Version
    ! Dimensions
    WRITE(*,'(3x,"n_Frequencies    :",1x,i0)') self%n_Frequencies
    WRITE(*,'(3x,"n_Latitudes      :",1x,i0)') self%n_Latitudes  
    WRITE(*,'(3x,"n_Longitudes     :",1x,i0)') self%n_Longitudes 
    IF ( .NOT. lseatlas_associated(self) ) RETURN
    ! Dimension arrays
    WRITE(*,'(3x,"Frequency :")')
    WRITE(*,'(5(1x,es13.6,:))') self%Frequency
    WRITE(*,'(3x,"Latitude :")')
    WRITE(*,'(5(1x,es13.6,:))') self%Latitude
    WRITE(*,'(3x,"Longitude :")')
    WRITE(*,'(5(1x,es13.6,:))') self%Longitude
    ! Emissivity array
    WRITE(*,'(3x,"Emissivity :")')
    WRITE(*,'(5(1x,es13.6,:))') self%Emissivity
  END SUBROUTINE lseatlas_inspect



!----------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_ValidRelease
!
! PURPOSE:
!       Function to check the LSEatlas Release value.
!
! CALLING SEQUENCE:
!       IsValid = LSEatlas_ValidRelease( LSEatlas )
!
! INPUTS:
!       LSEatlas:      LSEatlas object for which the Release component
!                      is to be checked.
!                      UNITS:      N/A
!                      TYPE:       LSEatlas_type
!                      DIMENSION:  Scalar
!                      ATTRIBUTES: INTENT(IN)
!
! FUNCTION RESULT:
!       IsValid:       Logical value defining the release validity.
!                      UNITS:      N/A
!                      TYPE:       LOGICAL
!                      DIMENSION:  Scalar
!
!:sdoc-:
!----------------------------------------------------------------------------------

  FUNCTION lseatlas_validrelease( self ) RESULT( IsValid )
    ! Arguments
    TYPE(lseatlas_type), INTENT(IN) :: self
    ! Function result
    LOGICAL :: isvalid
    ! Local parameters
    CHARACTER(*), PARAMETER :: routine_name = 'LSEatlas_ValidRelease'
    ! Local variables
    CHARACTER(ML) :: msg

    ! Set up
    isvalid = .true.


    ! Check release is not too old
    IF ( self%Release < lseatlas_release ) THEN
      isvalid = .false.
      WRITE( msg,'("An LSEatlas data update is needed. ", &
                  &"LSEatlas release is ",i0,". Valid release is ",i0,"." )' ) &
                  self%Release, lseatlas_release
      CALL display_message( routine_name, msg, information ); RETURN
    END IF


    ! Check release is not too new
    IF ( self%Release > lseatlas_release ) THEN
      isvalid = .false.
      WRITE( msg,'("An LSEatlas software update is needed. ", &
                  &"LSEatlas release is ",i0,". Valid release is ",i0,"." )' ) &
                  self%Release, lseatlas_release
      CALL display_message( routine_name, msg, information ); RETURN
    END IF

  END FUNCTION lseatlas_validrelease


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_Info
!
! PURPOSE:
!       Subroutine to return a string containing version and dimension
!       information about a LSEatlas object.
!
! CALLING SEQUENCE:
!       CALL LSEatlas_Info( LSEatlas, Info )
!
! OBJECTS:
!       LSEatlas:      LSEatlas object about which info is required.
!                      UNITS:      N/A
!                      TYPE:       LSEatlas_type
!                      DIMENSION:  Scalar
!                      ATTRIBUTES: INTENT(IN)
!
! OUTPUTS:
!       Info:          String containing version and dimension information
!                      about the LSEatlas object.
!                      UNITS:      N/A
!                      TYPE:       CHARACTER(*)
!                      DIMENSION:  Scalar
!                      ATTRIBUTES: INTENT(OUT)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  SUBROUTINE lseatlas_info( self, Info )
    ! Arguments
    TYPE(lseatlas_type), INTENT(IN)  :: self
    CHARACTER(*),            INTENT(OUT) :: info
    ! Parameters
    INTEGER, PARAMETER :: carriage_return = 13
    INTEGER, PARAMETER :: linefeed = 10
    ! Local variables
    CHARACTER(2000) :: long_string

    ! Write the required data to the local string
    WRITE( long_string, &
           '(a,1x,"LSEatlas RELEASE.VERSION: ",i2,".",i2.2,a,3x, &
           &"N_FREQUENCIES=",i0,2x,&
           &"N_LATITUDES=",i0,2x,&
           &"N_LONGITUDES=",i0 )' ) &
           achar(carriage_return)//achar(linefeed), &
           self%Release, self%Version, &
           achar(carriage_return)//achar(linefeed), &
           self%n_Frequencies, &
           self%n_Latitudes  , &
           self%n_Longitudes 
                       
    ! Trim the output based on the
    ! dummy argument string length
    info = long_string(1:min(len(info), len_trim(long_string)))

  END SUBROUTINE lseatlas_info
 
 
!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_Name
!
! PURPOSE:
!       Function to return the datatype name of an LSEatlas object.
!
! CALLING SEQUENCE:
!       datatype_name = LSEatlas_Name( LSEatlas )         
!
! OBJECTS:
!       LSEatlas:     LSEatlas object structure.
!                     UNITS:      N/A
!                     TYPE:       LSEatlas_type
!                     DIMENSION:  Scalar
!                     ATTRIBUTES: INTENT(IN)
!
! FUNCTION RESULT:
!       Status:       The return value is a the character string containing
!                     the datatype name of the structure.
!                     UNITS:      N/A
!                     TYPE:       CHARACTER
!                     DIMENSION:  Scalar
!
!:sdoc-:
!--------------------------------------------------------------------------------

  FUNCTION lseatlas_name( self ) RESULT( datatype_name )
    ! Arguments
    TYPE(lseatlas_type), INTENT(OUT) :: self
    ! Function result
    CHARACTER(LEN(self%Datatype_Name)) :: datatype_name
    
    datatype_name = self%Datatype_Name

  END FUNCTION lseatlas_name


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_DefineVersion
!
! PURPOSE:
!       Subroutine to return the module version information.
!
! CALLING SEQUENCE:
!       CALL LSEatlas_DefineVersion( Id )
!
! OUTPUTS:
!       Id:    Character string containing the version Id information
!              for the module.
!              UNITS:      N/A
!              TYPE:       CHARACTER(*)
!              DIMENSION:  Scalar
!              ATTRIBUTES: INTENT(OUT)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  SUBROUTINE lseatlas_defineversion( Id )
    CHARACTER(*), INTENT(OUT) :: id
    id = module_version_id
  END SUBROUTINE lseatlas_defineversion



!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_SetValue
!
! PURPOSE:
!       Subroutine to set the contents of a valid LSEatlas object.
!
! CALLING SEQUENCE:
!       CALL LSEatlas_SetValue( LSEatlas, &
!                               Version    = Version   , &
!                               Frequency  = Frequency , &
!                               Latitude   = Latitude  , &
!                               Longitude  = Longitude , &
!                               Emissivity = Emissivity  )
!
! OBJECTS:
!       LSEatlas:           Valid, allocated LSEatlas object for which
!                           values are to be set.
!                           UNITS:      N/A
!                           TYPE:       LSEatlas_type
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(IN OUT)
!
! OPTIONAL INPUTS:
!       Version:            Integer indicating the data version. If not specified
!                           the value of the module parameter LSEatlas_VERSION
!                           is used.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(IN), OPTIONAL
!
!       Frequency:          Real array to which the Frequency component of the
!                           LSEatlas object is to be set. The size of the
!                           input must match the allocated size of the component,
!                           otherwise all the component values are set to zero.
!                           UNITS:      N/A
!                           TYPE:       REAL(fp)
!                           DIMENSION:  Rank-1 (L)
!                           ATTRIBUTES: INTENT(IN), OPTIONAL
!
!       Latitude:           Real array to which the Latitude component of the
!                           LSEatlas object is to be set. The size of the
!                           input must match the allocated size of the component,
!                           otherwise all the component values are set to zero.
!                           UNITS:      N/A
!                           TYPE:       REAL(fp)
!                           DIMENSION:  Rank-1 (I)
!                           ATTRIBUTES: INTENT(IN), OPTIONAL
!
!       Longitude:          Real array to which the Longitude component of the
!                           LSEatlas object is to be set. The size of the
!                           input must match the allocated size of the component,
!                           otherwise all the component values are set to zero.
!                           UNITS:      N/A
!                           TYPE:       REAL(fp)
!                           DIMENSION:  Rank-1 (J)
!                           ATTRIBUTES: INTENT(IN), OPTIONAL
!
!       Emissivity:         Real array to which the Emissivity component of the
!                           LSEatlas object is to be set. The size of the
!                           input must match the allocated size of the component,
!                           otherwise all the component values are set to zero.
!                           UNITS:      N/A
!                           TYPE:       REAL(fp)
!                           DIMENSION:  Rank-3 (L x I x J)
!                           ATTRIBUTES: INTENT(IN), OPTIONAL
!
!:sdoc-:
!--------------------------------------------------------------------------------

  SUBROUTINE lseatlas_setvalue( &
    self      , &  ! Input
    Version   , &  ! Optional input
    Frequency , &  ! Optional input
    Latitude  , &  ! Optional input
    Longitude , &  ! Optional input
    Emissivity  )  ! Optional input
    ! Arguments
    TYPE(lseatlas_type), INTENT(IN OUT) :: self
    INTEGER ,  OPTIONAL, INTENT(IN)     :: version
    REAL(fp),  OPTIONAL, INTENT(IN)     :: frequency(:)
    REAL(fp),  OPTIONAL, INTENT(IN)     :: latitude(:)
    REAL(fp),  OPTIONAL, INTENT(IN)     :: longitude(:)
    REAL(fp),  OPTIONAL, INTENT(IN)     :: emissivity(:,:,:)
   
    IF ( .NOT. lseatlas_associated(self) ) RETURN

    IF ( PRESENT(version) ) self%Version = version
    
    IF ( PRESENT(frequency) ) THEN
      IF ( SIZE(frequency) == self%n_Frequencies ) THEN
        self%Frequency = frequency
      ELSE
        self%Frequency = zero
      END IF
    END IF
   
    IF ( PRESENT(latitude) ) THEN
      IF ( SIZE(latitude) == self%n_Latitudes ) THEN
        self%Latitude = latitude
      ELSE
        self%Latitude = zero
      END IF
    END IF
   
    IF ( PRESENT(longitude) ) THEN
      IF ( SIZE(longitude) == self%n_Longitudes ) THEN
        self%Longitude = longitude
      ELSE
        self%Longitude = zero
      END IF
    END IF
   
    IF ( PRESENT(emissivity) ) THEN
      IF ( SIZE(emissivity,dim=1) == self%n_Frequencies .AND. &
           SIZE(emissivity,dim=2) == self%n_Latitudes   .AND. &
           SIZE(emissivity,dim=3) == self%n_Longitudes        ) THEN
        self%Emissivity = emissivity
      ELSE
        self%Emissivity = zero
      END IF
    END IF
      
  END SUBROUTINE lseatlas_setvalue
 

!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_GetValue
!
! PURPOSE:
!       Subroutine to get the contents of a valid LSEatlas object.
!
! CALLING SEQUENCE:
!       CALL LSEatlas_GetValue( LSEatlas, &
!                               Version       = Version      , &
!                               n_Frequencies = n_Frequencies, &
!                               n_Latitudes   = n_Latitudes  , &
!                               n_Longitudes  = n_Longitudes , &
!                               Frequency     = Frequency    , & 
!                               Latitude      = Latitude     , & 
!                               Longitude     = Longitude    , & 
!                               Emissivity    = Emissivity     ) 
!
! OBJECTS:
!       LSEatlas:                Valid, allocated LSEatlas object from which
!                                values are to be retrieved.
!                                UNITS:      N/A
!                                TYPE:       LSEatlas_type
!                                DIMENSION:  Scalar
!                                ATTRIBUTES: INTENT(IN OUT)
!
! OPTIONAL OUTPUTS:
!       Version:                 Integer indicating the data version of the object.
!                                UNITS:      N/A
!                                TYPE:       INTEGER
!                                DIMENSION:  Scalar
!                                ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       n_Frequencies:           Number of spectral frequencies for which there are 
!                                data.                                              
!                                UNITS:      N/A                                    
!                                TYPE:       INTEGER                                
!                                DIMENSION:  Scalar                                 
!                                ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       n_Latitudes:             Number of latitude values for which there are      
!                                data.                                              
!                                UNITS:      N/A                                    
!                                TYPE:       INTEGER                                
!                                DIMENSION:  Scalar                                 
!                                ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       n_Longitudes:            Number of longitude values for which there are     
!                                data.                                              
!                                UNITS:      N/A                                    
!                                TYPE:       INTEGER                                
!                                DIMENSION:  Scalar                                 
!                                ATTRIBUTES: INTENT(OUT), OPTIONAL                 
! 
!       Frequency:               Real array to which the Frequency component of the
!                                LSEatlas object will be assigned. The actual
!                                argument must be declared as allocatable.
!                                UNITS:      N/A
!                                TYPE:       REAL(fp)
!                                DIMENSION:  Rank-1 (L)
!                                ATTRIBUTES: INTENT(OUT), OPTIONAL, ALLOCATABLE
!
!       Latitude:                Real array to which the Latitude component of the
!                                LSEatlas object will be assigned. The actual
!                                argument must be declared as allocatable.
!                                UNITS:      N/A
!                                TYPE:       REAL(fp)
!                                DIMENSION:  Rank-1 (I)
!                                ATTRIBUTES: INTENT(OUT), OPTIONAL, ALLOCATABLE
!
!       Longitude:               Real array to which the Longitude component of the
!                                LSEatlas object will be assigned. The actual
!                                argument must be declared as allocatable.
!                                UNITS:      N/A
!                                TYPE:       REAL(fp)
!                                DIMENSION:  Rank-1 (J)
!                                ATTRIBUTES: INTENT(OUT), OPTIONAL, ALLOCATABLE
!
!       Emissivity:              Real array to which the Emissivity component of the
!                                LSEatlas object will be assigned. The actual
!                                argument must be declared as allocatable.
!                                UNITS:      N/A
!                                TYPE:       REAL(fp)
!                                DIMENSION:  Rank-3 (L x I x J)
!                                ATTRIBUTES: INTENT(OUT), OPTIONAL, ALLOCATABLE
!
!:sdoc-:
!--------------------------------------------------------------------------------

  SUBROUTINE lseatlas_getvalue( &
    self         , &  ! Input
    Version      , &  ! Optional input
    n_Frequencies, &  ! Optional output
    n_Latitudes  , &  ! Optional output
    n_Longitudes , &  ! Optional output
    Frequency    , &  ! Optional output
    Latitude     , &  ! Optional output
    Longitude    , &  ! Optional output
    Emissivity     )  ! Optional output
    ! Arguments
    TYPE(lseatlas_type),             INTENT(IN)  :: self
    INTEGER ,              OPTIONAL, INTENT(OUT) :: version
    INTEGER ,              OPTIONAL, INTENT(OUT) :: n_frequencies
    INTEGER ,              OPTIONAL, INTENT(OUT) :: n_latitudes  
    INTEGER ,              OPTIONAL, INTENT(OUT) :: n_longitudes 
    REAL(fp), ALLOCATABLE, OPTIONAL, INTENT(OUT) :: frequency(:)    
    REAL(fp), ALLOCATABLE, OPTIONAL, INTENT(OUT) :: latitude(:)     
    REAL(fp), ALLOCATABLE, OPTIONAL, INTENT(OUT) :: longitude(:)    
    REAL(fp), ALLOCATABLE, OPTIONAL, INTENT(OUT) :: emissivity(:,:,:) 
    
    IF ( .NOT. lseatlas_associated(self) ) RETURN
   
    IF ( PRESENT(version      ) ) version       = self%Version
    IF ( PRESENT(n_frequencies) ) n_frequencies = self%n_Frequencies
    IF ( PRESENT(n_latitudes  ) ) n_latitudes   = self%n_Latitudes  
    IF ( PRESENT(n_longitudes ) ) n_longitudes  = self%n_Longitudes 

    IF ( PRESENT(frequency) ) THEN
      ALLOCATE(frequency(self%n_Frequencies))
      frequency = self%Frequency
    END IF

    IF ( PRESENT(latitude) ) THEN
      ALLOCATE(latitude(self%n_Latitudes))
      latitude = self%Latitude
    END IF

    IF ( PRESENT(longitude) ) THEN
      ALLOCATE(longitude(self%n_Longitudes))
      longitude = self%Longitude
    END IF

    IF ( PRESENT(emissivity) ) THEN
      ALLOCATE(emissivity(self%n_Frequencies,self%n_Latitudes,self%n_Longitudes))
      emissivity = self%Emissivity
    END IF

  END SUBROUTINE lseatlas_getvalue
 


!------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_InquireFile
!
! PURPOSE:
!       Function to inquire LSEatlas object files.
!
! CALLING SEQUENCE:
!       Error_Status = LSEatlas_InquireFile( &
!                        Filename                     , &
!                        n_Frequencies = n_Frequencies, &
!                        n_Latitudes   = n_Latitudes  , &
!                        n_Longitudes  = n_Longitudes , &
!                        Release       = Release      , &
!                        Version       = Version        )
!
! INPUTS:
!       Filename:           Character string specifying the name of the
!                           data file to inquire.
!                           UNITS:      N/A
!                           TYPE:       CHARACTER(*)
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(IN)
!
! OPTIONAL OUTPUTS:
!       n_Frequencies:      Number of spectral frequencies for which there are 
!                           data.                                              
!                           UNITS:      N/A                                    
!                           TYPE:       INTEGER                                
!                           DIMENSION:  Scalar                                 
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       n_Latitudes:        Number of latitude values for which there are      
!                           data.                                              
!                           UNITS:      N/A                                    
!                           TYPE:       INTEGER                                
!                           DIMENSION:  Scalar                                 
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       n_Longitudes:       Number of longitude values for which there are     
!                           data.                                              
!                           UNITS:      N/A                                    
!                           TYPE:       INTEGER                                
!                           DIMENSION:  Scalar                                 
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL                 
! 
!       Release:            The data/file release number. Used to check
!                           for data/software mismatch.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       Version:            The data/file version number. Used for
!                           purposes only in identifying the dataset for
!                           a particular release.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL
!
! FUNCTION RESULT:
!       Error_Status:       The return value is an integer defining the error
!                           status. The error codes are defined in the
!                           Message_Handler module.
!                           If == SUCCESS the file inquire was successful
!                              == FAILURE an unrecoverable error occurred.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Scalar
!
!:sdoc-:
!------------------------------------------------------------------------------

  FUNCTION lseatlas_inquirefile( &
    Filename     , &  ! Input
    n_Frequencies, &  ! Optional output  
    n_Latitudes  , &  ! Optional output  
    n_Longitudes , &  ! Optional output  
    Release      , &  ! Optional output
    Version      , &  ! Optional output
    Title        , &  ! Optional output
    History      , &  ! Optional output
    Comment      ) &  ! Optional output
  result( err_stat )
    ! Arguments
    CHARACTER(*),           INTENT(IN)  :: filename
    INTEGER     , OPTIONAL, INTENT(OUT) :: n_frequencies
    INTEGER     , OPTIONAL, INTENT(OUT) :: n_latitudes  
    INTEGER     , OPTIONAL, INTENT(OUT) :: n_longitudes 
    INTEGER     , OPTIONAL, INTENT(OUT) :: release        
    INTEGER     , OPTIONAL, INTENT(OUT) :: version        
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: title           
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: history         
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: comment         
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'LSEatlas_InquireFile'
    ! Function variables
    CHARACTER(ML) :: msg
    CHARACTER(ML) :: io_msg
    INTEGER :: io_stat
    INTEGER :: fid
    TYPE(lseatlas_type) :: lseatlas

 
    ! Setup
    err_stat = success
    ! ...Check that the file exists
    IF ( .NOT. file_exists( filename ) ) THEN
      msg = 'File '//trim(filename)//' not found.'
      CALL inquire_cleanup(); RETURN
    END IF


    ! Open the file
    err_stat = open_binary_file( filename, fid )
    IF ( err_stat /= success ) THEN
      msg = 'Error opening '//trim(filename)
      CALL inquire_cleanup(); RETURN
    END IF


    ! Read and check the datatype name
    err_stat = read_datatype( fid, lseatlas%Datatype_name )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading Datatype_Name'
      CALL inquire_cleanup(); RETURN
    END IF
    IF ( trim(lseatlas%Datatype_Name) /= lseatlas_datatype ) THEN
      msg = lseatlas_datatype//' datatype name check failed.'
      CALL inquire_cleanup(); RETURN
    END IF


    ! Read the release and version
    READ( fid, iostat=io_stat, iomsg=io_msg ) &
      lseatlas%Release, &
      lseatlas%Version
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading Release/Version - '//trim(io_msg)
      CALL inquire_cleanup(); RETURN
    END IF
    IF ( .NOT. lseatlas_validrelease( lseatlas ) ) THEN
      msg = 'LSEatlas Release check failed.'
      CALL inquire_cleanup(); RETURN
    END IF


    ! Read the dimensions
    READ( fid, iostat=io_stat, iomsg=io_msg ) &
      lseatlas%n_Frequencies, &
      lseatlas%n_Latitudes  , &
      lseatlas%n_Longitudes 
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading dimension values from '//trim(filename)//' - '//trim(io_msg)
      CALL inquire_cleanup(); RETURN
    END IF


    ! Read the global attributes
    err_stat = readgatts_binary_file( &
                 fid, &
                 title   = title  , &
                 history = history, &
                 comment = comment  )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading global attributes'
      CALL inquire_cleanup(); RETURN
    END IF


    ! Close the file
    CLOSE( fid, iostat=io_stat, iomsg=io_msg )
    IF ( io_stat /= 0 ) THEN
      msg = 'Error closing '//trim(filename)//' - '//trim(io_msg)
      CALL inquire_cleanup(); RETURN
    END IF


    ! Assign the return arguments
    IF ( PRESENT(n_frequencies) ) n_frequencies = lseatlas%n_Frequencies
    IF ( PRESENT(n_latitudes  ) ) n_latitudes   = lseatlas%n_Latitudes  
    IF ( PRESENT(n_longitudes ) ) n_longitudes  = lseatlas%n_Longitudes     
    IF ( PRESENT(release      ) ) release       = lseatlas%Release        
    IF ( PRESENT(version      ) ) version       = lseatlas%Version        
    
  CONTAINS
  
    SUBROUTINE inquire_cleanup()
      ! Close file if necessary
      IF ( file_open(fid) ) THEN
        CLOSE( fid, iostat=io_stat, iomsg=io_msg )
        IF ( io_stat /= 0 ) &
          msg = trim(msg)//'; Error closing input file during error cleanup - '//trim(io_msg)
      END IF
      ! Set error status and print error message
      err_stat = failure
      CALL display_message( routine_name, msg, err_stat )
    END SUBROUTINE inquire_cleanup
    
  END FUNCTION lseatlas_inquirefile


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_ReadFile
!
! PURPOSE:
!       Function to read LSEatlas object files.
!
! CALLING SEQUENCE:
!       Error_Status = LSEatlas_ReadFile( &
!                        LSEatlas           , &
!                        Filename           , &
!                        No_Close = No_Close, &
!                        Quiet    = Quiet     )
!
! OBJECTS:
!       LSEatlas:       LSEatlas object containing the data read from file.
!                       UNITS:      N/A
!                       TYPE:       LSEatlas_type
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(OUT)
!
! INPUTS:
!       Filename:       Character string specifying the name of a
!                       LSEatlas data file to read.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN)
!
! OPTIONAL INPUTS:
!       No_Close:       Set this logical argument to *NOT* close the datafile
!                       upon exiting this routine. This option is required if
!                       the LSEatlas data is embedded within another file.
!                       If == .FALSE., File is closed upon function exit [DEFAULT].
!                          == .TRUE.,  File is NOT closed upon function exit
!                       If not specified, default is .FALSE.
!                       UNITS:      N/A
!                       TYPE:       LOGICAL
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN), OPTIONAL
!
!       Quiet:          Set this logical argument to suppress INFORMATION
!                       messages being printed to stdout
!                       If == .FALSE., INFORMATION messages are OUTPUT [DEFAULT].
!                          == .TRUE.,  INFORMATION messages are SUPPRESSED.
!                       If not specified, default is .FALSE.
!                       UNITS:      N/A
!                       TYPE:       LOGICAL
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN), OPTIONAL
!
! FUNCTION RESULT:
!       Error_Status:   The return value is an integer defining the error status.
!                       The error codes are defined in the Message_Handler module.
!                       If == SUCCESS, the file read was successful
!                          == FAILURE, an unrecoverable error occurred.
!                       UNITS:      N/A
!                       TYPE:       INTEGER
!                       DIMENSION:  Scalar
!
!:sdoc-:
!------------------------------------------------------------------------------

  FUNCTION lseatlas_readfile( &
    LSEatlas, &  ! Output
    Filename   , &  ! Input
    No_Close   , &  ! Optional input
    Quiet      , &  ! Optional input
    Title      , &  ! Optional output
    History    , &  ! Optional output
    Comment    , &  ! Optional output
    Debug      ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    TYPE(lseatlas_type)   , INTENT(OUT) :: lseatlas
    CHARACTER(*),           INTENT(IN)  :: filename
    LOGICAL,      OPTIONAL, INTENT(IN)  :: no_close
    LOGICAL,      OPTIONAL, INTENT(IN)  :: quiet
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: title
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: history
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: comment
    LOGICAL,      OPTIONAL, INTENT(IN)  :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'LSEatlas_ReadFile'
    ! Function variables
    CHARACTER(ML) :: msg
    CHARACTER(ML) :: io_msg
    LOGICAL :: close_file
    LOGICAL :: noisy
    INTEGER :: io_stat
    INTEGER :: fid
    TYPE(lseatlas_type) :: dummy
    
    ! Setup
    err_stat = success
    ! ...Check No_Close argument
    close_file = .true.
    IF ( PRESENT(no_close) ) close_file = .NOT. no_close
    ! ...Check Quiet argument
    noisy = .true.
    IF ( PRESENT(quiet) ) noisy = .NOT. quiet
    ! ...Override Quiet settings if debug set.
    IF ( PRESENT(debug) ) THEN
      IF ( debug ) noisy = .true.
    END IF

   
    ! Check if the file is open.
    IF ( file_open( filename ) ) THEN
      ! ...Inquire for the logical unit number
      INQUIRE( file=filename, number=fid )
      ! ...Ensure it's valid
      IF ( fid < 0 ) THEN
        msg = 'Error inquiring '//trim(filename)//' for its FileID'
        CALL read_cleanup(); RETURN
      END IF
    ELSE
      ! ...Open the file if it exists
      IF ( file_exists( filename ) ) THEN
        err_stat = open_binary_file( filename, fid )
        IF ( err_stat /= success ) THEN
          msg = 'Error opening '//trim(filename)
          CALL read_cleanup(); RETURN
        END IF
      ELSE
        msg = 'File '//trim(filename)//' not found.'
        CALL read_cleanup(); RETURN
      END IF
    END IF


    ! Read and check the datatype name
    err_stat = read_datatype( fid, dummy%Datatype_name )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading Datatype_Name'
      CALL read_cleanup(); RETURN
    END IF
    IF ( trim(dummy%Datatype_Name) /= lseatlas_datatype ) THEN
      msg = lseatlas_datatype//' datatype name check failed.'
      CALL read_cleanup(); RETURN
    END IF
    

    ! Read and check the release and version
    READ( fid, iostat=io_stat, iomsg=io_msg ) &
      dummy%Release, &
      dummy%Version
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading Release/Version - '//trim(io_msg)
      CALL read_cleanup(); RETURN
    END IF
    IF ( .NOT. lseatlas_validrelease( dummy ) ) THEN
      msg = 'LSEatlas Release check failed.'
      CALL read_cleanup(); RETURN
    END IF


    ! Read the dimensions
    READ( fid, iostat=io_stat, iomsg=io_msg ) &
      dummy%n_Frequencies, &
      dummy%n_Latitudes  , &
      dummy%n_Longitudes 
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading data dimensions - '//trim(io_msg)
      CALL read_cleanup(); RETURN
    END IF
    ! ...Allocate the object
    CALL lseatlas_create( &
           lseatlas           , &
           dummy%n_Frequencies, &        
           dummy%n_Latitudes  , &        
           dummy%n_Longitudes   )                  
    IF ( .NOT. lseatlas_associated( lseatlas ) ) THEN
      msg = 'LSEatlas object allocation failed.'
      CALL read_cleanup(); RETURN
    END IF
    ! ...Explicitly assign the version number
    lseatlas%Version = dummy%Version
        

    ! Read the global attributes
    err_stat = readgatts_binary_file( &
                 fid, &
                 title   = title  , &
                 history = history, &
                 comment = comment  )
    IF ( err_stat /= success ) THEN
      msg = 'Error reading global attributes'
      CALL read_cleanup(); RETURN
    END IF


    ! Read the coefficient data
    ! ...Read the dimensional vectors
    READ( fid, iostat=io_stat, iomsg=io_msg ) &
      lseatlas%Frequency, &
      lseatlas%Latitude , &
      lseatlas%Longitude
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading dimensional vectors - '//trim(io_msg)
      CALL read_cleanup(); RETURN
    END IF
    ! ...Read the emissivity data
    READ( fid, iostat=io_stat, iomsg=io_msg ) &
      lseatlas%Emissivity
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading emissivity data - '//trim(io_msg)
      CALL read_cleanup(); RETURN
    END IF


    ! Close the file
    IF ( close_file ) THEN
      CLOSE( fid, iostat=io_stat, iomsg=io_msg )
      IF ( io_stat /= 0 ) THEN
        msg = 'Error closing '//trim(filename)//' - '//trim(io_msg)
        CALL read_cleanup(); RETURN
      END IF
    END IF


    ! Output an info message
     IF ( noisy ) THEN
       CALL lseatlas_info( lseatlas, msg )
       CALL display_message( routine_name, 'FILE: '//trim(filename)//'; '//trim(msg), information )
     END IF

   CONTAINS
   
     SUBROUTINE read_cleanup()
       IF ( file_open(filename) ) THEN
         CLOSE( fid, iostat=io_stat, iomsg=io_msg )
         IF ( io_stat /= 0 ) &
           msg = trim(msg)//'; Error closing input file during error cleanup - '//trim(io_msg)
       END IF
       CALL lseatlas_destroy( lseatlas )
       err_stat = failure
       CALL display_message( routine_name, msg, err_stat )
     END SUBROUTINE read_cleanup

  END FUNCTION lseatlas_readfile


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       LSEatlas_WriteFile
!
! PURPOSE:
!       Function to write LSEatlas object files.
!
! CALLING SEQUENCE:
!       Error_Status = LSEatlas_WriteFile( &
!                        LSEatlas           , &
!                        Filename           , &
!                        No_Close = No_Close, &
!                        Quiet    = Quiet     )
!
! OBJECTS:
!       LSEatlas:       LSEatlas object containing the data to write to file.
!                       UNITS:      N/A
!                       TYPE:       LSEatlas_type
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN)
!
! INPUTS:
!       Filename:       Character string specifying the name of a
!                       LSEatlas format data file to write.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN)
!
! OPTIONAL INPUTS:
!       No_Close:       Set this logical argument to *NOT* close the datafile
!                       upon exiting this routine. This option is required if
!                       the LSEatlas data is to be embedded within another file.
!                       If == .FALSE., File is closed upon function exit [DEFAULT].
!                          == .TRUE.,  File is NOT closed upon function exit
!                       If not specified, default is .FALSE.
!                       UNITS:      N/A
!                       TYPE:       LOGICAL
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN), OPTIONAL
!
!       Quiet:          Set this logical argument to suppress INFORMATION
!                       messages being printed to stdout
!                       If == .FALSE., INFORMATION messages are OUTPUT [DEFAULT].
!                          == .TRUE.,  INFORMATION messages are SUPPRESSED.
!                       If not specified, default is .FALSE.
!                       UNITS:      N/A
!                       TYPE:       LOGICAL
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN), OPTIONAL
!
! FUNCTION RESULT:
!       Error_Status:   The return value is an integer defining the error status.
!                       The error codes are defined in the Message_Handler module.
!                       If == SUCCESS, the file write was successful
!                          == FAILURE, an unrecoverable error occurred.
!                       UNITS:      N/A
!                       TYPE:       INTEGER
!                       DIMENSION:  Scalar
!
!:sdoc-:
!------------------------------------------------------------------------------

  FUNCTION lseatlas_writefile( &
    LSEatlas, &  ! Input
    Filename   , &  ! Input
    No_Close   , &  ! Optional input
    Quiet      , &  ! Optional input
    Title      , &  ! Optional input
    History    , &  ! Optional input
    Comment    , &  ! Optional input
    Debug      ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    TYPE(lseatlas_type), INTENT(IN) :: lseatlas
    CHARACTER(*),           INTENT(IN) :: filename
    LOGICAL,      OPTIONAL, INTENT(IN) :: no_close
    LOGICAL,      OPTIONAL, INTENT(IN) :: quiet
    CHARACTER(*), OPTIONAL, INTENT(IN) :: title
    CHARACTER(*), OPTIONAL, INTENT(IN) :: history
    CHARACTER(*), OPTIONAL, INTENT(IN) :: comment
    LOGICAL,      OPTIONAL, INTENT(IN) :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'LSEatlas_WriteFile'
    ! Function variables
    CHARACTER(ML) :: msg
    CHARACTER(ML) :: io_msg
    LOGICAL :: close_file
    LOGICAL :: noisy
    INTEGER :: io_stat
    INTEGER :: fid
    

    ! Setup
    err_stat = success
    ! ...Check No_Close argument
    close_file = .true.
    IF ( PRESENT(no_close) ) close_file = .NOT. no_close
    ! ...Check Quiet argument
    noisy = .true.
    IF ( PRESENT(quiet) ) noisy = .NOT. quiet
    ! ...Override Quiet settings if debug set.
    IF ( PRESENT(debug) ) THEN
      IF ( debug ) noisy = .true.
    END IF
    ! ...Check there is data to write
    IF ( .NOT. lseatlas_associated( lseatlas ) ) THEN
      msg = 'LSEatlas object is empty.'
      CALL write_cleanup(); RETURN
    END IF

   
    ! Check if the file is open.
    IF ( file_open( filename ) ) THEN
      ! ...Inquire for the logical unit number
      INQUIRE( file=filename, number=fid )
      ! ...Ensure it's valid
      IF ( fid < 0 ) THEN
        msg = 'Error inquiring '//trim(filename)//' for its FileID'
        CALL write_cleanup(); RETURN
      END IF
    ELSE
      ! ...Open the file for output
      err_stat = open_binary_file( filename, fid, for_output=.true. )
      IF ( err_stat /= success ) THEN
        msg = 'Error opening '//trim(filename)
        CALL write_cleanup(); RETURN
      END IF
    END IF


    ! Write the datatype name
    WRITE( fid, iostat=io_stat, iomsg=io_msg ) &
      len(lseatlas%Datatype_Name)
    IF ( io_stat /= 0 ) THEN
      msg = 'Error writing Datatype_Name length - '//trim(io_msg)
      CALL write_cleanup(); RETURN
    END IF
    WRITE( fid, iostat=io_stat, iomsg=io_msg ) &
      lseatlas%Datatype_Name
    IF ( io_stat /= 0 ) THEN
      msg = 'Error writing Datatype_Name - '//trim(io_msg)
      CALL write_cleanup(); RETURN
    END IF
    

    ! Write the release and version
    WRITE( fid, iostat=io_stat, iomsg=io_msg ) &
      lseatlas%Release, &
      lseatlas%Version
    IF ( io_stat /= 0 ) THEN
      msg = 'Error writing Release/Version - '//trim(io_msg)
      CALL write_cleanup(); RETURN
    END IF


    ! Write the dimensions
    WRITE( fid, iostat=io_stat, iomsg=io_msg ) &
      lseatlas%n_Frequencies, &
      lseatlas%n_Latitudes  , &
      lseatlas%n_Longitudes 
    IF ( io_stat /= 0 ) THEN
      msg = 'Error writing data dimensions - '//trim(io_msg)
      CALL write_cleanup(); RETURN
    END IF


    ! Write the global attributes
    err_stat = writegatts_binary_file( &
                 fid, &
                 write_module = module_version_id, &
                 title        = title  , &
                 history      = history, &
                 comment      = comment  )
    IF ( err_stat /= success ) THEN
      msg = 'Error writing global attributes'
      CALL write_cleanup(); RETURN
    END IF


    ! Write the coefficient data
    ! ...Write the dimensional vectors
    WRITE( fid, iostat=io_stat, iomsg=io_msg ) &
      lseatlas%Frequency, &
      lseatlas%Latitude , &
      lseatlas%Longitude
    IF ( io_stat /= 0 ) THEN
      msg = 'Error writing dimensional vectors - '//trim(io_msg)
      CALL write_cleanup(); RETURN
    END IF
    ! ...Write the emissivity data
    WRITE( fid, iostat=io_stat, iomsg=io_msg ) &
      lseatlas%Emissivity
    IF ( io_stat /= 0 ) THEN
      msg = 'Error writing emissivity data - '//trim(io_msg)
      CALL write_cleanup(); RETURN
    END IF


    ! Close the file
    IF ( close_file ) THEN
      CLOSE( fid, iostat=io_stat, iomsg=io_msg )
      IF ( io_stat /= 0 ) THEN
        msg = 'Error closing '//trim(filename)//' - '//trim(io_msg)
        CALL write_cleanup(); RETURN
      END IF
    END IF


    ! Output an info message
     IF ( noisy ) THEN
       CALL lseatlas_info( lseatlas, msg )
       CALL display_message( routine_name, 'FILE: '//trim(filename)//'; '//trim(msg), information )
     END IF

   CONTAINS
   
     SUBROUTINE write_cleanup()
       IF ( file_open(filename) ) THEN
         CLOSE( fid, iostat=io_stat, iomsg=io_msg )
         IF ( io_stat /= 0 ) &
           msg = trim(msg)//'; Error closing output file during error cleanup - '//trim(io_msg)
       END IF
       err_stat = failure
       CALL display_message( routine_name, msg, err_stat )
     END SUBROUTINE write_cleanup

  END FUNCTION lseatlas_writefile

  
!################################################################################
!################################################################################
!##                                                                            ##
!##                          ## PRIVATE PROCEDURES ##                          ##
!##                                                                            ##
!################################################################################
!################################################################################

!--------------------------------------------------------------------------------
!
! NAME:
!       LSEatlas_Equal
!
! PURPOSE:
!       Elemental function to test the equality of two LSEatlas objects.
!       Used in OPERATOR(==) interface block.
!
! CALLING SEQUENCE:
!       is_equal = LSEatlas_Equal( x, y )
!
!         or
!
!       IF ( x == y ) THEN
!         ...
!       END IF
!
! OBJECTS:
!       x, y:          Two LSEatlas objects to be compared.
!                      UNITS:      N/A
!                      TYPE:       LSEatlas_type
!                      DIMENSION:  Scalar or any rank
!                      ATTRIBUTES: INTENT(IN)
!
! FUNCTION RESULT:
!       is_equal:      Logical value indicating whether the inputs are equal.
!                      UNITS:      N/A
!                      TYPE:       LOGICAL
!                      DIMENSION:  Same as inputs.
!
!--------------------------------------------------------------------------------

  ELEMENTAL FUNCTION lseatlas_equal( x, y ) RESULT( is_equal )
    TYPE(lseatlas_type), INTENT(IN) :: x, y
    LOGICAL :: is_equal

    ! Set up
    is_equal = .false.
   
    ! Check the object association status
    IF ( (.NOT. lseatlas_associated(x)) .OR. &
         (.NOT. lseatlas_associated(y))      ) RETURN

   ! Check contents
    ! ...Release/version info
    IF ( (x%Release /= y%Release) .OR. &
         (x%Version /= y%Version) ) RETURN
    ! ...Dimensions
    IF ( (x%n_Frequencies /= y%n_Frequencies ) .OR. &
         (x%n_Latitudes   /= y%n_Latitudes   ) .OR. &
         (x%n_Longitudes  /= y%n_Longitudes  ) ) RETURN
    ! ...Arrays
    IF ( all(x%Frequency  .equalto. y%Frequency ) .AND. &
         all(x%Latitude   .equalto. y%Latitude  ) .AND. &
         all(x%Longitude  .equalto. y%Longitude ) .AND. &
         all(x%Emissivity .equalto. y%Emissivity ) ) &
      is_equal = .true.

  END FUNCTION lseatlas_equal
  
  
  FUNCTION read_datatype( fid, datatype_name ) RESULT( err_stat )
    ! Arguments
    INTEGER     , INTENT(IN)  :: fid
    CHARACTER(*), INTENT(OUT) :: datatype_name
    ! Function result
    INTEGER :: err_stat
    ! Local variables
    CHARACTER(1), ALLOCATABLE :: dummy(:)
    INTEGER :: i, strlen
    INTEGER :: io_stat
    INTEGER :: alloc_stat

    ! Set up
    err_stat = failure
    datatype_name = ''

    ! Get the string length
    READ( fid, iostat=io_stat ) strlen
    IF ( io_stat /= 0 ) RETURN
    
    ! Allocate dummy string array
    ALLOCATE( dummy(strlen), stat=alloc_stat )
    IF ( alloc_stat /= 0 ) RETURN

    ! Read the string into the dummy array
    READ( fid, iostat=io_stat ) dummy
    IF ( io_stat /= 0 ) RETURN

    ! Transfer array into string
    DO i = 1, min(strlen,len(datatype_name))
      datatype_name(i:i) = dummy(i)
    END DO

    ! Done
    err_stat = success
  END FUNCTION read_datatype
  
END MODULE lseatlas_define