Module Documentation

Last modified: Mon Feb 2 12:50:44 2004.


List of Modules


Module Descriptions

IRSSE_MODEL

[Next Module] [List of Modules]
 NAME:
       IRSSE_Model

 PURPOSE:
       Control module for the Infrared (IR) sea surface emissivity (SSE)
       model.

 CATEGORY:
       Emissivity : Sensor_Emissivity_Model

 CALLING SEQUENCE:
       USE IRSSE_Model

 OUTPUTS:
       None.

 MODULES:
       Type_Kinds:          Module containing data type kind definitions.

       Error_Handler:       Module to define error codes and handle
                            error conditions.
                            USEs: FILE_UTILITY module

       IRSSE_Coefficients:  Module containing the emissivity model
                            coefficients and their load/destruction
                            routines.
                            USEs: TYPE_KINDS module
                                  ERROR_HANDLER module
                                  PARAMETERS module
                                  EMISCOEFF_DEFINE module
                                  EMISCOEFF_BINARY_IO module


 CONTAINS:
       Model constructor/destructors
       -----------------------------

       Initialize_IRSSE_Model:  Function to initialise the emissivity
                                model.

       Destroy_IRSSE_Model:     Function to destroy the the emissivity
                                model space.


       Model components
       ----------------

       Forward_IRSSE:           Function to compute the infrared (IR) channel
                                sea surface emissivity (SSE) forward model
                                for the requested channels.

       Tangent_Linear_IRSSE:    Function to compute the IRSSE tangent-linear
                                model for the requested channels.

       Adjoint_IRSSE:           Function to compute the IRSSE adjoint
                                model for the requested channels.

       K_Matrix_IRSSE:          Function to compute the IRSSE K-matrix
                                model for the requested channels.

 EXTERNALS:
       None

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
       Shared emissivity coefficient structure(s) in the IRSSE_COEFFICIENTS
       module is allocated and filled during initialisation, and deallocated
       during destruction.

 RESTRICTIONS:
       None.

 CREATION HISTORY:
       Written by:     Paul van Delst, CIMSS/SSEC 01-May-2003
                       paul.vandelst@ssec.wisc.edu

  Copyright (C) 2003 Paul van Delst

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

(See irsse_model.f90)


IRSSE_COEFFICIENTS

[Previous Module] [List of Modules]
 NAME:
       IRSSE_Coefficients

 PURPOSE:
       Module containing the Infrared (IR) sea surface emissivity (SSE) model
       emissivity coefficients and their load/destruction routines. 

 CATEGORY:
       Emissivity : Sensor_Emissivity_Model

 CALLING SEQUENCE:
       USE IRSSE_Coefficients

 PUBLIC DATA:
       EC:   Data structure containing the emissivity coefficient data
             UNITS:      N/A
             TYPE:       EmisCoeff_type
             DIMENSION:  Scalar
             ATTRIBUTES: PUBLIC, SAVE

 MODULES:
       Type_Kinds:                Module containing data type kind definitions.

       Error_Handler:             Module to define error codes and handle error
                                  conditions
                                  USEs: FILE_UTILITY module

       EmisCoeff_Define:          Module defining the EmisCoeff data structure and
                                  containing routines to manipulate it.
                                  USEs: TYPE_KINDS module
                                        ERROR_HANDLER module
                                        COMPUTE_FLOAT_NUMBERS module

       EmisCoeff_Binary_IO:       Module containing routines to read and write
                                  binary format EmisCoeff files.
                                  USEs: TYPE_KINDS module
                                        FILE_UTILITY module
                                        ERROR_HANDLER module
                                        EMISCOEFF_DEFINE module
                                        COEFFICIENT_UTILITY module

 CONTAINS:
       Load_IRSSE_Coefficients:     Function to load the emissivity coefficient
                                    data into the module public data structure EC.

       Destroy_IRSSE_Coefficients:  Function to destroy the module public data
                                    structure EC.

 EXTERNALS:
       None

 COMMON BLOCKS:
       None.

 SIDE EFFECTS:
       None known.

 RESTRICTIONS:
       None.

 CREATION HISTORY:
       Written by:     Paul van Delst, CIMSS/SSEC 01-May-2003
                       paul.vandelst@ssec.wisc.edu

  Copyright (C) 2003 Paul van Delst

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

(See irsse_coefficients.f90)