Last modified: Fri Jan 30 12:02:34 2004.
NAME:
Load_IRSSE_Coefficients
PURPOSE:
Function to load the emissivity coefficient data into the public
data structure EC.
CALLING SEQUENCE:
Error_Status = Load_IRSSE_Coefficients( &
! -- Input
Coefficient_File, &
! -- Optional input
Quiet = Quiet, &
Process_ID = Process_ID, &
Output_Process_ID = Output_Process_ID, &
! -- Error messaging
Message_Log = Message_Log )
INPUT ARGUMENTS:
Coefficient_File: Name of the RTM binary format EmisCoeff file
containing the emissivity coefficient data.
UNITS: None
TYPE: CHARACTER(*)
DIMENSION: Scalar
ATTRIBUTES: INTENT( IN )
OPTIONAL INPUT ARGUMENTS:
Quiet: Set this argument to suppress INFORMATION messages
being printed to standard output (or the message
log file if the Message_Log optional argument is
used.) By default, INFORMATION messages are printed.
If QUIET = 0, INFORMATION messages are OUTPUT.
QUIET = 1, INFORMATION messages are SUPPRESSED.
UNITS: None
TYPE: INTEGER
DIMENSION: Scalar
ATTRIBUTES: INTENT( IN ), OPTIONAL
Process_ID: Set this argument to the MPI process ID that this
function call is running under. This value is used
solely for controlling INFORMATIOn message output.
If MPI is not being used, ignore this argument.
This argument is ignored if the Quiet argument is set.
UNITS: None
TYPE: INTEGER
DIMENSION: Scalar
ATTRIBUTES: INTENT( IN ), OPTIONAL
Output_Process_ID: Set this argument to the MPI process ID in which
all INFORMATION messages are to be output. If
the passed Process_ID value agrees with this value
the INFORMATION messages are output.
This argument is ignored if the Quiet argument
is set.
UNITS: None
TYPE: INTEGER
DIMENSION: Scalar
ATTRIBUTES: INTENT( IN ), OPTIONAL
Message_Log: Character string specifying a filename in which
any messages will be logged. If not specified,
or if an error occurs opening the log file, the
default action is to output messages to standard
output.
UNITS: None
TYPE: CHARACTER(*)
DIMENSION: Scalar
ATTRIBUTES: INTENT( IN ), OPTIONAL
OUTPUT ARGUMENTS:
None.
OPTIONAL OUTUPT ARGUMENTS:
None.
FUNCTION RESULT:
Error_Status: The return value is an integer defining the error status.
The error codes are defined in the ERROR_HANDLER module.
If == SUCCESS the emissivity coefficient read was
successful
== FAILURE an unrecoverable error occurred during
the data read.
UNITS: N/A
TYPE: INTEGER
DIMENSION: Scalar
CALLS:
Display_Message: Subroutine to output messages
SOURCE: ERROR_HANDLER module
Initialize_EmisCoeff: Function to initialize the public data
structure used to share the spectral
coefficient data
SOURCE: EMISCOEFF_DEFINE module
Read_EmisCoeff_Binary: Function to read the binary format EmisCoeff
data file.
SOURCE: EMISCOEFF_BINARY_IO module
EXTERNALS:
None
COMMON BLOCKS:
None.
SIDE EFFECTS:
This function modifies the contents of the public data structure EC.
RESTRICTIONS:
None.
CREATION HISTORY:
Written by: Paul van Delst, CIMSS/SSEC 01-May-2003
paul.vandelst@ssec.wisc.edu
(See IRSSE_Coefficients.f90)
NAME:
Destroy_IRSSE_Coefficients
PURPOSE:
Function to deallocate the emissivity coefficient shared
data structure.
CALLING SEQUENCE:
Error_Status = Destroy_IRSSE_Coefficients( &
! -- Optional input
Process_ID = Process_ID, &
! -- Error messaging
Message_Log = Message_Log )
INPUT ARGUMENTS:
None.
OPTIONAL INPUT ARGUMENTS:
Process_ID: Set this argument to the MPI process ID that this
function call is running under. This value is used
solely for controlling message output. If MPI is not
being used, ignore this argument.
UNITS: None
TYPE: INTEGER
DIMENSION: Scalar
ATTRIBUTES: INTENT( IN ), OPTIONAL
Message_Log: Character string specifying a filename in which any
messages will be logged. If not specified, or if an
error occurs opening the log file, the default action
is to output messages to the screen.
UNITS: None
TYPE: CHARACTER(*)
DIMENSION: Scalar
ATTRIBUTES: INTENT( IN ), OPTIONAL
OUTPUT ARGUMENTS:
None.
OPTIONAL OUTUPT ARGUMENTS:
None.
FUNCTION RESULT:
Error_Status: The return value is an integer defining the error status.
The error codes are defined in the ERROR_HANDLER module.
If == SUCCESS structure reinitialisation was successful
== FAILURE error occurred reinitialising the public
emissivity coefficient data structure.
UNITS: N/A
TYPE: INTEGER
DIMENSION: Scalar
CALLS:
Display_Message: Subroutine to output messages
SOURCE: ERROR_HANDLER module
Destroy_EmisCoeff: Function to destroy the public data
structure used to share the emissivity
coefficient data
SOURCE: EMISCOEFF_DEFINE module
EXTERNALS:
None
COMMON BLOCKS:
None.
SIDE EFFECTS:
None.
RESTRICTIONS:
None.
CREATION HISTORY:
Written by: Paul van Delst, CIMSS/SSEC 01-May-2003
paul.vandelst@ssec.wisc.edu
(See IRSSE_Coefficients.f90)