SpcCoeff_Binary_IO.f90

Go to the documentation of this file.

!
! SpcCoeff_Binary_IO
!
! Module containing routines to read and write Binary format
! SpcCoeff data files.
!
!
! CREATION HISTORY:
!       Written by:     Paul van Delst, 18-Mar-2002
!                       paul.vandelst@noaa.gov
!

MODULE spccoeff_binary_io

  ! ------------------
  ! Environment set up
  ! ------------------
  ! Module use
  USE type_kinds         , ONLY: long, double
  USE file_utility       , ONLY: file_open, file_exists
  USE message_handler    , ONLY: success, failure, information, display_message
  USE binary_file_utility, ONLY: open_binary_file
  USE spccoeff_define    , ONLY: spccoeff_type        , &
                                 spccoeff_associated  , &
                                 spccoeff_destroy     , &
                                 spccoeff_create      , &
                                 spccoeff_validrelease, &
                                 spccoeff_info
  USE accoeff_define     , ONLY: accoeff_associated
  USE accoeff_binary_io  , ONLY: accoeff_binary_readfile , &
                                 accoeff_binary_writefile, &
                                 accoeff_binary_ioversion
  USE nltecoeff_define   , ONLY: nltecoeff_associated
  USE nltecoeff_binary_io, ONLY: nltecoeff_binary_readfile , &
                                 nltecoeff_binary_writefile, &
                                 nltecoeff_binary_ioversion
  ! Disable implicit typing
  IMPLICIT NONE


  ! ------------
  ! Visibilities
  ! ------------
  PRIVATE
  PUBLIC :: spccoeff_binary_inquirefile
  PUBLIC :: spccoeff_binary_readfile
  PUBLIC :: spccoeff_binary_writefile
  PUBLIC :: spccoeff_binary_ioversion


  ! -----------------
  ! Module parameters
  ! -----------------
  CHARACTER(*), PARAMETER :: module_version_id = &
    '$Id: SpcCoeff_Binary_IO.f90 60152 2015-08-13 19:19:13Z paul.vandelst@noaa.gov $'
  ! Default message length
  INTEGER, PARAMETER :: ml = 512
  ! Ancillary data indicator
  INTEGER, PARAMETER :: data_missing = 0
  INTEGER, PARAMETER :: data_present = 1


CONTAINS


!################################################################################
!################################################################################
!##                                                                            ##
!##                         ## PUBLIC MODULE ROUTINES ##                       ##
!##                                                                            ##
!################################################################################
!################################################################################

!------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       SpcCoeff_Binary_InquireFile
!
! PURPOSE:
!       Function to inquire a Binary format SpcCoeff file.
!
! CALLING SEQUENCE:
!       Error_Status = SpcCoeff_Binary_InquireFile( &
!                        Filename                           , &
!                        n_Channels       = n_Channels      , &
!                        Release          = Release         , &
!                        Version          = Version         , &
!                        Sensor_Id        = Sensor_Id       , &
!                        WMO_Satellite_Id = WMO_Satellite_Id, &
!                        WMO_Sensor_Id    = WMO_Sensor_Id     )
!
! INPUTS:
!       Filename:           Character string specifying the name of the binary
!                           SpcCoeff data file to inquire.
!                           UNITS:      N/A
!                           TYPE:       CHARACTER(*)
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(IN)
!
! OPTIONAL OUTPUTS:
!       n_Channels:         Number of sensor channels.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(IN)
!
!       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
!
!       Sensor_Id:          Character string sensor/platform identifier.
!                           UNITS:      N/A
!                           TYPE:       CHARACTER(*)
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       WMO_Satellite_Id:   The WMO code used to identify satellite platforms.
!                           UNITS:      N/A
!                           TYPE:       INTEGER
!                           DIMENSION:  Scalar
!                           ATTRIBUTES: INTENT(OUT), OPTIONAL
!
!       WMO_Sensor_Id:      The WMO code used to identify sensors.
!                           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 spccoeff_binary_inquirefile( &
    Filename        , &  ! Input
    n_Channels      , &  ! Optional output  
    Release         , &  ! Optional Output
    Version         , &  ! Optional Output
    Sensor_Id       , &  ! Optional Output
    WMO_Satellite_Id, &  ! Optional Output
    WMO_Sensor_Id   ) &  ! Optional Output
  result( err_stat )
    ! Arguments
    CHARACTER(*),           INTENT(IN)  :: filename
    INTEGER     , OPTIONAL, INTENT(OUT) :: n_channels
    INTEGER     , OPTIONAL, INTENT(OUT) :: release
    INTEGER     , OPTIONAL, INTENT(OUT) :: version
    CHARACTER(*), OPTIONAL, INTENT(OUT) :: sensor_id       
    INTEGER     , OPTIONAL, INTENT(OUT) :: wmo_satellite_id
    INTEGER     , OPTIONAL, INTENT(OUT) :: wmo_sensor_id   
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'SpcCoeff_InquireFile(Binary)'
    ! Function variables
    CHARACTER(ML) :: msg
    INTEGER :: io_stat
    INTEGER :: fid
    TYPE(spccoeff_type) :: spccoeff

 
    ! 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 the release and version
    READ( fid,iostat=io_stat ) spccoeff%Release, spccoeff%Version
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error reading Release/Version. IOSTAT = ",i0)' ) io_stat
      CALL inquire_cleanup(); RETURN
    END IF


    ! Read the dimensions
    READ( fid, iostat=io_stat ) &
      spccoeff%n_Channels
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error reading dimension values from ",a,". IOSTAT = ",i0)' ) &
             trim(filename), io_stat
      CALL inquire_cleanup(); RETURN
    END IF


    ! Read the sensor ids
    READ( fid, iostat=io_stat ) &
      spccoeff%Sensor_Id       , &
      spccoeff%Sensor_Type     , &
      spccoeff%WMO_Satellite_Id, &
      spccoeff%WMO_Sensor_Id    
    IF ( io_stat /= 0 ) THEN
      WRITE( msg, '("Error reading sensor information from ",a,". IOSTAT = ",i0)' ) &
             trim(filename), io_stat
      CALL inquire_cleanup(); RETURN
    END IF


    ! Close the file
    CLOSE( fid, iostat=io_stat )
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error closing ",a,". IOSTAT = ",i0)' ) trim(filename), io_stat
      CALL inquire_cleanup(); RETURN
    END IF


    ! Assign the return arguments
    IF ( PRESENT(n_channels      ) ) n_channels       = spccoeff%n_Channels    
    IF ( PRESENT(release         ) ) release          = spccoeff%Release
    IF ( PRESENT(version         ) ) version          = spccoeff%Version
    IF ( PRESENT(sensor_id       ) ) sensor_id        = spccoeff%Sensor_Id
    IF ( PRESENT(wmo_satellite_id) ) wmo_satellite_id = spccoeff%WMO_Satellite_Id
    IF ( PRESENT(wmo_sensor_id   ) ) wmo_sensor_id    = spccoeff%WMO_Sensor_Id   
    
  CONTAINS
  
    SUBROUTINE inquire_cleanup()
      ! Close file if necessary
      IF ( file_open(fid) ) THEN
        CLOSE( fid,iostat=io_stat )
        IF ( io_stat /= 0 ) &
          msg = trim(msg)//'; Error closing input file during error cleanup'
      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 spccoeff_binary_inquirefile


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       SpcCoeff_Binary_ReadFile
!
! PURPOSE:
!       Function to read SpcCoeff object files in Binary format.
!
! CALLING SEQUENCE:
!       Error_Status = SpcCoeff_Binary_ReadFile( &
!                        Filename     , &
!                        SpcCoeff     , &
!                        Quiet = Quiet  )
!
! INPUTS:
!       Filename:       Character string specifying the name of a
!                       SpcCoeff format data file to read.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN)
!
! OUTPUTS:
!       SpcCoeff:       SpcCoeff object containing the spectral
!                       coefficient data.
!                       UNITS:      N/A
!                       TYPE:       SpcCoeff_type
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(OUT)
!
! OPTIONAL INPUTS:
!       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 spccoeff_binary_readfile( &
    Filename, &  ! Input
    SpcCoeff, &  ! Output
    Quiet   , &  ! Optional input
    Debug   ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    CHARACTER(*),        INTENT(IN)  :: filename
    TYPE(spccoeff_type), INTENT(OUT) :: spccoeff
    LOGICAL,   OPTIONAL, INTENT(IN)  :: quiet
    LOGICAL,   OPTIONAL, INTENT(IN)  :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'SpcCoeff_ReadFile(Binary)'
    ! Function variables
    CHARACTER(ML) :: msg, io_msg
    LOGICAL :: noisy
    INTEGER :: io_stat
    INTEGER :: fid
    INTEGER(Long) :: ac_present
    INTEGER(Long) :: nc_present
    TYPE(spccoeff_type) :: dummy
    

    ! Setup
    err_stat = success
    ! ...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

   
    ! Open the file
    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


    ! Read and check the release and version
    READ( fid, iostat=io_stat ) &
      dummy%Release, &
      dummy%Version
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error reading Release/Version. IOSTAT = ",i0)' ) io_stat
      CALL read_cleanup(); RETURN
    END IF
    IF ( .NOT. spccoeff_validrelease( dummy ) ) THEN
      msg = 'SpcCoeff Release check failed.'
      CALL read_cleanup(); RETURN
    END IF


    ! Read the spectral coefficient data
    ! ...Read the dimensions
    READ( fid, iostat=io_stat ) dummy%n_Channels
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error reading data dimensions. IOSTAT = ",i0)' ) io_stat
      CALL read_cleanup(); RETURN
    END IF
    ! ...Allocate the object
    CALL spccoeff_create( spccoeff        , &
                          dummy%n_Channels  )                  
    IF ( .NOT. spccoeff_associated( spccoeff ) ) THEN
      msg = 'SpcCoeff object allocation failed.'
      CALL read_cleanup(); RETURN
    END IF
    ! ...Read the sensor info
    READ( fid, iostat=io_stat ) &
      spccoeff%Sensor_Id       , &
      spccoeff%Sensor_Type     , &
      spccoeff%WMO_Satellite_Id, &
      spccoeff%WMO_Sensor_Id   
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error reading sensor ids. IOSTAT = ",i0)' ) io_stat
      CALL read_cleanup(); RETURN
    END IF
    ! ...Read the channel data
    READ( fid, iostat=io_stat, iomsg=io_msg ) &
      spccoeff%Sensor_Channel            , &
      spccoeff%Polarization              , &
      spccoeff%Channel_Flag              , &
      spccoeff%Frequency                 , &
      spccoeff%Wavenumber                , &
      spccoeff%Planck_C1                 , &
      spccoeff%Planck_C2                 , &
      spccoeff%Band_C1                   , &
      spccoeff%Band_C2                   , &
      spccoeff%Cosmic_Background_Radiance, &
      spccoeff%Solar_Irradiance
    IF ( io_stat /= 0 ) THEN
      msg = 'Error reading channel data. '//trim(io_msg)
      CALL read_cleanup(); RETURN
    END IF


    ! Explicitly assign the version number
    spccoeff%Version = dummy%Version
    
    
    ! Read the antenna correction data if it's present
    ! ...Read the data indicator
    READ( fid, iostat=io_stat ) ac_present
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error reading antenna correction data indicator. IOSTAT = ",i0)' ) io_stat
      CALL read_cleanup(); RETURN
    END IF
    ! ...Read the antenna correction data
    IF ( ac_present == data_present ) THEN
      err_stat = accoeff_binary_readfile( &
                   filename         , &
                   spccoeff%AC      , &
                   no_close = .true., &
                   quiet    = quiet , &
                   debug    = debug   )
      IF ( err_stat /= success ) THEN
        msg = 'Error reading antenna correction data.'
        CALL read_cleanup(); RETURN
      END IF
      ! ..Check that the ACCoeff data is for the same sensor
      IF ( spccoeff%Sensor_Id           /= spccoeff%AC%Sensor_Id        .OR. &
           spccoeff%WMO_Satellite_Id    /= spccoeff%AC%WMO_Satellite_Id .OR. &
           spccoeff%WMO_Sensor_Id       /= spccoeff%AC%WMO_Sensor_Id    .OR. &
           any( spccoeff%Sensor_Channel /= spccoeff%AC%Sensor_Channel ) ) THEN
        msg = 'Antenna correction sensor information is inconsistent with SpcCoeff'
        CALL read_cleanup(); RETURN
      END IF
    END IF
    
    
    ! Read the NLTE correction data if it's present
    ! ...Read the data indicator
    READ( fid, iostat=io_stat ) nc_present
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error reading NLTE correction data indicator. IOSTAT = ",i0)' ) io_stat
      CALL read_cleanup(); RETURN
    END IF
    ! ...Read the NLTE correction data
    IF ( nc_present == data_present ) THEN
      err_stat = nltecoeff_binary_readfile( &
                   filename         , &
                   spccoeff%NC      , &
                   no_close = .true., &
                   quiet    = quiet , &
                   debug    = debug   )
      IF ( err_stat /= success ) THEN
        msg = 'Error reading NLTE correction data.'
        CALL read_cleanup(); RETURN
      END IF
      ! ..Check that the NLTECoeff data is for the same sensor
      IF ( spccoeff%Sensor_Id           /= spccoeff%NC%Sensor_Id        .OR. &
           spccoeff%WMO_Satellite_Id    /= spccoeff%NC%WMO_Satellite_Id .OR. &
           spccoeff%WMO_Sensor_Id       /= spccoeff%NC%WMO_Sensor_Id    .OR. &
           any( spccoeff%Sensor_Channel /= spccoeff%NC%Sensor_Channel ) ) THEN
        msg = 'non-LTE correction sensor information is inconsistent with SpcCoeff'
        CALL read_cleanup(); RETURN
      END IF
    END IF
    
    
    ! Close the file
    CLOSE( fid,iostat=io_stat )
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error closing ",a,". IOSTAT = ",i0)' ) trim(filename), io_stat
      CALL read_cleanup(); RETURN
    END IF


    ! Output an info message
     IF ( noisy ) THEN
       CALL spccoeff_info( spccoeff, msg, nocomponents = .true. )
       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 )
         IF ( io_stat /= 0 ) &
           msg = trim(msg)//'; Error closing input file during error cleanup.'
       END IF
       CALL spccoeff_destroy( spccoeff )
       err_stat = failure
       CALL display_message( routine_name, msg, err_stat )
     END SUBROUTINE read_cleanup

  END FUNCTION spccoeff_binary_readfile


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       SpcCoeff_Binary_WriteFile
!
! PURPOSE:
!       Function to write SpcCoeff object files in Binary format.
!
! CALLING SEQUENCE:
!       Error_Status = SpcCoeff_Binary_WriteFile( &
!                        Filename     , &
!                        SpcCoeff     , &
!                        Quiet = Quiet  )
!
! INPUTS:
!       Filename:       Character string specifying the name of a
!                       SpcCoeff format data file to write.
!                       UNITS:      N/A
!                       TYPE:       CHARACTER(*)
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN)
!
!       SpcCoeff:       SpcCoeff object containing the spectral
!                       coefficient data.
!                       UNITS:      N/A
!                       TYPE:       SpcCoeff_type
!                       DIMENSION:  Scalar
!                       ATTRIBUTES: INTENT(IN)
!
! OPTIONAL INPUTS:
!       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 spccoeff_binary_writefile( &
    Filename, &  ! Input
    SpcCoeff, &  ! Output
    Quiet   , &  ! Optional input
    Debug   ) &  ! Optional input (Debug output control)
  result( err_stat )
    ! Arguments
    CHARACTER(*),        INTENT(IN) :: filename
    TYPE(spccoeff_type), INTENT(IN) :: spccoeff
    LOGICAL,   OPTIONAL, INTENT(IN) :: quiet
    LOGICAL,   OPTIONAL, INTENT(IN) :: debug
    ! Function result
    INTEGER :: err_stat
    ! Function parameters
    CHARACTER(*), PARAMETER :: routine_name = 'SpcCoeff_WriteFile(Binary)'
    CHARACTER(*), PARAMETER :: write_error_status = 'DELETE'
    ! Function variables
    CHARACTER(ML) :: msg
    LOGICAL :: noisy
    INTEGER :: io_stat
    INTEGER :: fid
    INTEGER :: ac_present
    INTEGER :: nc_present
    

    ! Setup
    err_stat = success
    ! ...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. spccoeff_associated( spccoeff ) ) THEN
      msg = 'SpcCoeff object is empty.'
      CALL write_cleanup(); RETURN
    END IF

   
    ! Open the file
    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


    ! Write the release and version
    WRITE( fid,iostat=io_stat ) &
      spccoeff%Release, &
      spccoeff%Version
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error writing Release/Version. IOSTAT = ",i0)' ) io_stat
      CALL write_cleanup(); RETURN
    END IF


    ! Write the spectral coefficient data
    ! ...Write the dimensions
    WRITE( fid, iostat=io_stat ) spccoeff%n_Channels
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error writing data dimensions. IOSTAT = ",i0)' ) io_stat
      CALL write_cleanup(); RETURN
    END IF
    ! ...Write the sensor info
    WRITE( fid, iostat=io_stat ) &
      spccoeff%Sensor_Id       , &
      spccoeff%Sensor_Type     , &
      spccoeff%WMO_Satellite_Id, &
      spccoeff%WMO_Sensor_Id   
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error writing sensor ids. IOSTAT = ",i0)' ) io_stat
      CALL write_cleanup(); RETURN
    END IF
    ! ...Write the channel data
    WRITE( fid, iostat=io_stat ) &
      spccoeff%Sensor_Channel            , &
      spccoeff%Polarization              , &
      spccoeff%Channel_Flag              , &
      spccoeff%Frequency                 , &
      spccoeff%Wavenumber                , &
      spccoeff%Planck_C1                 , &
      spccoeff%Planck_C2                 , &
      spccoeff%Band_C1                   , &
      spccoeff%Band_C2                   , &
      spccoeff%Cosmic_Background_Radiance, &
      spccoeff%Solar_Irradiance             
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error writing channel data. IOSTAT = ",i0)' ) io_stat
      CALL write_cleanup(); RETURN
    END IF


    ! Write the antenna correction data if it's present
    IF ( accoeff_associated( spccoeff%AC ) ) THEN
      ac_present = data_present
    ELSE
      ac_present = data_missing
    END IF
    ! ...Write the data indicator
    WRITE( fid, iostat=io_stat ) ac_present
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error writing antenna correction data indicator. IOSTAT = ",i0)' ) io_stat
      CALL write_cleanup(); RETURN
    END IF
    ! ...Write the antenna correction data
    IF ( ac_present == data_present ) THEN
      err_stat = accoeff_binary_writefile( &
                   filename         , &
                   spccoeff%AC      , &
                   no_close = .true., &
                   quiet    = quiet , &
                   debug    = debug   )
      IF ( err_stat /= success ) THEN
        msg = 'Error writing antenna correction data.'
        CALL write_cleanup(); RETURN
      END IF
      ! ..Check that the ACCoeff data is for the same sensor
      IF ( spccoeff%Sensor_Id           /= spccoeff%AC%Sensor_Id        .OR. &
           spccoeff%WMO_Satellite_Id    /= spccoeff%AC%WMO_Satellite_Id .OR. &
           spccoeff%WMO_Sensor_Id       /= spccoeff%AC%WMO_Sensor_Id    .OR. &
           any( spccoeff%Sensor_Channel /= spccoeff%AC%Sensor_Channel ) ) THEN
        msg = 'Antenna correction sensor information is inconsistent with SpcCoeff'
        CALL write_cleanup(); RETURN
      END IF
    END IF
    
    
    ! Write the NLTE correction data if it's present
    IF ( nltecoeff_associated( spccoeff%NC ) ) THEN
      nc_present = data_present
    ELSE
      nc_present = data_missing
    END IF
    ! ...Write the data indicator
    WRITE( fid, iostat=io_stat ) nc_present
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error writing NLTE correction data indicator. IOSTAT = ",i0)' ) io_stat
      CALL write_cleanup(); RETURN
    END IF
    ! ...Write the NLTE correction data
    IF ( nc_present == data_present ) THEN
      err_stat = nltecoeff_binary_writefile( &
                   filename         , &
                   spccoeff%NC      , &
                   no_close = .true., &
                   quiet    = quiet , &
                   debug    = debug   )
      IF ( err_stat /= success ) THEN
        msg = 'Error writing NLTE correction data.'
        CALL write_cleanup(); RETURN
      END IF
      ! ..Check that the NLTECoeff data is for the same sensor
      IF ( spccoeff%Sensor_Id           /= spccoeff%NC%Sensor_Id        .OR. &
           spccoeff%WMO_Satellite_Id    /= spccoeff%NC%WMO_Satellite_Id .OR. &
           spccoeff%WMO_Sensor_Id       /= spccoeff%NC%WMO_Sensor_Id    .OR. &
           any( spccoeff%Sensor_Channel /= spccoeff%NC%Sensor_Channel ) ) THEN
        msg = 'non-LTE correction sensor information is inconsistent with SpcCoeff'
        CALL write_cleanup(); RETURN
      END IF
    END IF
    
    
    ! Close the file
    CLOSE( fid,status='KEEP',iostat=io_stat )
    IF ( io_stat /= 0 ) THEN
      WRITE( msg,'("Error closing ",a,". IOSTAT = ",i0)' ) trim(filename), io_stat
      CALL write_cleanup(); RETURN
    END IF


    ! Output an info message
     IF ( noisy ) THEN
       CALL spccoeff_info( spccoeff, msg, nocomponents = .true. )
       CALL display_message( routine_name, 'FILE: '//trim(filename)//'; '//trim(msg), information )
     END IF

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

  END FUNCTION spccoeff_binary_writefile


!--------------------------------------------------------------------------------
!:sdoc+:
!
! NAME:
!       SpcCoeff_Binary_IOVersion
!
! PURPOSE:
!       Subroutine to return the version information for the
!       I/O module(s).
!
! CALLING SEQUENCE:
!       CALL SpcCoeff_IOVersion( Id )
!
! OUTPUTS:
!       Id:     Character string containing the version Id information for the
!               structure I/O module(s). If the string length is sufficient,
!               the version information for all the modules (this, and those
!               for the derived type components) are concatenated. Otherwise
!               only the version id for this module is returned.
!               UNITS:      N/A
!               TYPE:       CHARACTER(*)
!               DIMENSION:  Scalar
!               ATTRIBUTES: INTENT(OUT)
!
!:sdoc-:
!--------------------------------------------------------------------------------

  SUBROUTINE spccoeff_binary_ioversion( Id )
    CHARACTER(*), INTENT(OUT) :: id
    INTEGER, PARAMETER :: carriage_return = 13
    INTEGER, PARAMETER :: linefeed = 10
    INTEGER, PARAMETER :: sl = 256
    CHARACTER(SL)   :: ac_id
    CHARACTER(SL)   :: nc_id
    CHARACTER(SL*3) :: io_id
    CALL accoeff_binary_ioversion( ac_id )
    CALL nltecoeff_binary_ioversion( nc_id )
    io_id = module_version_id//';'//achar(carriage_return)//achar(linefeed)//&
            '    '//trim(ac_id)//';'//achar(carriage_return)//achar(linefeed)//&
            '    '//trim(nc_id)
    IF ( len_trim(io_id) <= len(id) ) THEN
      id = io_id
    ELSE
      id = module_version_id
    END IF
  END SUBROUTINE spccoeff_binary_ioversion

END MODULE spccoeff_binary_io