Terrenus HRPT v2.2

terrenus.instrument
Interface RadiometerCalibrator

All Known Implementing Classes:
AbstractRadiometerCalibrator, AVHRRCalibrator, MVISRCalibrator

public interface RadiometerCalibrator

The RadiometerCalibrator interface is for calibrating raw count data from multichannel radiometers. A calibration RadiometerCalibrator.Record holds calibration coefficients computed using data from a number of scan lines. The getCalibration(int), getCalibration(int,int), and calibrate(int[], double[], int, terrenus.instrument.RadiometerCalibrator.CalibrationType, terrenus.instrument.RadiometerCalibrator.Record) methods are low level developer methods for calibrating data -- users would normally go through the RadiometerData interface for calibrating data.


Nested Class Summary
static class RadiometerCalibrator.CalibrationType
          The types of calibration.
static class RadiometerCalibrator.Record
          The Record class holds radiometer calibration coefficients for a sequence of scan lines.
 
Method Summary
 void calibrate(int[] countData, double[] calData, int channel, RadiometerCalibrator.CalibrationType calType, RadiometerCalibrator.Record record)
          Calibrates radiometer data from raw count data to scientific units.
 RadiometerCalibrator.Record getCalibration(int line)
          Gets the calibration record for the specified scan line.
 RadiometerCalibrator.Record getCalibration(int startLine, int endLine)
          Gets the calibration record for the specified scan line range.
 

Method Detail

getCalibration

RadiometerCalibrator.Record getCalibration(int line)
                                           throws java.io.IOException
Gets the calibration record for the specified scan line. Generally calibration requires a number of radiometer scan lines to compute. The returned record represents the best available calibration data based on lines surrounding or near the specified scan line.

Parameters:
line - the line to retrieve calibration for.
Returns:
the calibration record or null if no record is available.
Throws:
java.io.IOException - if a problem occurred accessing the data.

getCalibration

RadiometerCalibrator.Record getCalibration(int startLine,
                                           int endLine)
                                           throws java.io.IOException
Gets the calibration record for the specified scan line range. Only scan lines in the specified range are used to compute the calibration record.

Parameters:
startLine - the starting scan line for calibration.
endLine - the ending scan line for calibration.
Returns:
the calibration record or null if one could not be computed.
Throws:
java.io.IOException - if a problem occurred accessing the data.

calibrate

void calibrate(int[] countData,
               double[] calData,
               int channel,
               RadiometerCalibrator.CalibrationType calType,
               RadiometerCalibrator.Record record)
Calibrates radiometer data from raw count data to scientific units.

Parameters:
countData - the raw radiometer count data.
calData - the output calibrated data.
channel - the channel to calibrate in the range [1..CHANNELS].
calType - the calibration type to apply.
record - the calibration record to use.

Terrenus HRPT v2.2