//
// AreaDirectory.java
//
/*
This source file is part of the edu.wisc.ssec.mcidas package and is
Copyright (C) 1998 - 2017 by Tom Whittaker, Tommy Jasmin, Tom Rink,
Don Murray, James Kelly, Bill Hibbard, Dave Glowacki, Curtis Rueden
and others.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
MA 02111-1307, USA
*/
package edu.wisc.ssec.mcidas;
import java.text.FieldPosition;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
import java.util.Vector;
/**
* AreaDirectory interface for the metadata of McIDAS 'area' file format
* image data.
*
* @author Don Murray
*
*/
public class AreaDirectory implements java.io.Serializable
{
static final long serialVersionUID = -3662123383682335190L;
private int[] dir = new int[AreaFile.AD_DIRSIZE]; // single directory
private Date nominalTime; // time of the image
private Date startTime; // start time of the image
private int[] bands; // array of the band numbers
private double centerLatitude;
private double centerLongitude;
private double centerLatitudeResolution;
private double centerLongitudeResolution;
private Vector[] calInfo = null;
private String calType, srcType, srcTypeOrig;
private String calTypeUnit = null;
private int calTypeScaleFactor = 1;
private String memo;
private String[] sensors = {"Derived Data",
"Test Patterns",
"Graphics",
"Miscellaneous",
"PDUS Meteosat visible",
"PDUS Meteosat infrared",
"PDUS Meteosat water vapor",
"Radar",
"Miscellaneous Aircraft Data",
"Raw Meteosat",
"Composite image",
"Topography image",
"GMS visible",
"GMS infrared",
"ATS 6 visible",
"ATS 6 infrared",
"SMS-1 visible",
"SMS-1 infrared",
"SMS-2 visible",
"SMS-2 infrared",
"GOES-1 visible",
"GOES-1 infrared",
"GOES-2 visible",
"GOES-2 infrared",
"GOES-3 visible",
"GOES-3 infrared",
"GOES-4 visible (VAS)",
"GOES-4 infrared and water vapor (VAS)",
"GOES-5 visible (VAS)",
"GOES-5 infrared and water vapor (VAS)",
"GOES-6 visible",
"GOES-6 infrared",
"GOES-7 visible, Block 1 supplemental data",
"GOES-7 infrared",
"FY-2B",
"FY-2C",
"FY-2D",
"FY-2E",
"FY-2F",
"FY-2G",
"FY-2H",
"TIROS-N (POES)",
"NOAA-6",
"NOAA-7",
"NOAA-8",
"NOAA-9",
"Venus",
"Voyager 1",
"Voyager 2",
"Galileo",
"Hubble space telescope",
"MSG-1",
"MSG-2",
"MSG-3",
"Meteosat-3",
"Meteosat-4",
"Meteosat-5",
"Meteosat-6",
"Meteosat-7",
"",
"NOAA-10",
"NOAA-11",
"NOAA-12",
"NOAA-13",
"NOAA-14",
"NOAA-15",
"NOAA-16",
"NOAA-17",
"NOAA-18",
"NOAA-19",
"GOES 8 imager", // 70
"GOES 8 sounder",
"GOES 9 imager",
"GOES 9 sounder",
"GOES 10 imager",
"GOES 10 sounder",
"GOES 11 imager",
"GOES 11 sounder",
"GOES 12 imager",
"GOES 12 sounder",
"ERBE",
"",
// Some notes on naming for JMA satellites:
// 1. Himawari is the new naming for the 3rd generation of JMA's (Japanese Meteorological
// Agency) GMS series of satellites. We originally reserved Sensor numbers 82 through 86
// for GMS-4 to GMS-8. Meanwhile, JMA renamed to MTSAT for 2nd gen, and Himawari for
// 3rd gen. So, a mapping to keep track of the naming history might look like:
//
// 1st Gen
// GMS-4 -> Himawari-4
// GMS-5 -> Himawari-5
//
// 2nd Gen
// (MTSAT-1 - launch failure)
// GMS-6 -> MTSAT-1R -> Himawari-6
// GMS-7 -> MTSAT-2 -> Himawari-7
//
// 3rd Gen
// GMS-8 -> Himawari-8
"GMS-4",
"GMS-5",
"MTSAT-1R",
"MTSAT-2",
"Himawari-8",
"DMSP F-8",
"DMSP F-9",
"DMSP F-10",
"DMSP F-11",
"DMSP F-12",
"DMSP F-13",
"DMSP F-14",
"DMSP F-15", // 94
"FY-1B",
"FY-1C",
"FY-1D",
"",
"",
"",
"TERRA L1B", // 101
"TERRA CLD",
"TERRA GEO",
"TERRA-AER",
"",
"TERRA TOP",
"TERRA ATM",
"TERRA GUE",
"TERRA RET",
"",
"AQUA L1B", // 111
"AQUA CLD",
"AQUA GEO",
"AQUA AER",
"",
"AQUA TOP",
"AQUA ATM",
"AQUA GUE",
"AQUA RET",
"", // 120
"", "", "", "", "", "", "", "","", "", // 130
"", "", "", "", "", "", "", "","", "", // 140
"", "", "", "", "", "", "", "","", "", // 150
"", "", "", "", "", "", "", "","",
"TERRA NDVI", // 160
"TERRA CREF",
"", "", "", "", "", "", "","",
"AQUA NDVI", // 170
"AQUA CREF",
"", "", "", "", "", "", "","",
"GOES 13 imager", // 180
"GOES 13 sounder",
"GOES 14 imager",
"GOES 14 sounder",
"GOES 15 imager",
"GOES 15 sounder",
"GOES 16 imager",
"GOES 16 sounder",
"", // 188
"","", // 190
"","","","",
"DMSP F-16", // 195
"DMSP F-17",
"","","", // 199
"AIRS L1B", // 200
"","","","","","","","","",
"AMSR-E L1B", // 210
"AMSR-E RAIN",
"","","","","","","","","", // 220
"","","","","","","","","",
"Kalpana-1", // 230
"INSAT-3D Imager", // 231
"INSAT-3D Sounder", // 232
"","","","","","","",
"MetOp-A", // 240
"MetOp-B",
"MetOp-C",
"","","","","","","",
"COMS-1", // 250
"","","","","","","","","","", // 260
"Landsat 1",
"Landsat 2",
"Landsat 3",
"Landsat 4",
"Landsat 5",
"Landsat 6",
"Landsat 7",
"Landsat 8","","", // 270
"","","","","","","","","","",
"","","","","","","","","","",
"","","","","","","","","",
"Suomi NPP-VIIRS", // 300
"","","","","","","","","","",
"","","","","","","","","","",
"","","","","","","","","","",
"","","","","","","","","","",
"","","","","","","","","","",
"","","",
"METEOSAT-11", // 354
"","","","","","",
"","","","","","","","","","",
"","","","","","","","","","",
"","","","","","","","","","",
"","","","","","","","","",
"South Pole Composites", // 400
"North Pole Composites",
"","","","","","","","",
"Megha-Tropiques", // 410
""};
/**
* Create an AreaDirectory from the raw block of data of
* an AreaFile. Byte-flipping will be handled.
*
* @param dirblock the integer block
*
* @exception AreaFileException not a valid directory
*/
public AreaDirectory(int[] dirblock)
throws AreaFileException
{
centerLatitude = Double.NaN;
centerLongitude = Double.NaN;
centerLatitudeResolution = Double.NaN;
centerLongitudeResolution = Double.NaN;
if (dirblock.length != AreaFile.AD_DIRSIZE)
throw new AreaFileException("Directory is not the right size");
dir = dirblock;
// see if the directory needs to be byte-flipped
if (dir[AreaFile.AD_VERSION] != AreaFile.VERSION_NUMBER)
{
McIDASUtil.flip(dir,0,19);
// check again to make sure we got the right type of file
if (dir[AreaFile.AD_VERSION] != AreaFile.VERSION_NUMBER)
throw new AreaFileException(
"Invalid version number - probably not an AREA file");
// word 20 may contain characters -- if small int, flip it
if ( (dir[20] & 0xffff) == 0) McIDASUtil.flip(dir,20,20);
McIDASUtil.flip(dir,21,23);
// words 24-31 contain memo field
McIDASUtil.flip(dir,32,50);
// words 51-2 contain cal info
McIDASUtil.flip(dir,53,55);
// word 56 contains original source type (ascii)
McIDASUtil.flip(dir,57,63);
}
/* Debug
for (int i = 0; i < AreaFile.AD_DIRSIZE; i++)
{
System.out.println("dir[" + i +"] = " + dir[i]);
}
*/
// Pull out some of the important information
nominalTime = new Date(1000* McIDASUtil.mcDayTimeToSecs(
dir[AreaFile.AD_IMGDATE],
dir[AreaFile.AD_IMGTIME]));
if (dir[AreaFile.AD_STARTDATE] == 0 &&
dir[AreaFile.AD_STARTTIME] == 0)
startTime = nominalTime;
else
startTime = new Date( 1000*
McIDASUtil.mcDayTimeToSecs(
dir[AreaFile.AD_STARTDATE],
dir[AreaFile.AD_STARTTIME]));
// create the bands array. Might be more bits set than bands, though cuz of the AVHRR band 3a/b thingy
int numbands = dir[AreaFile.AD_NUMBANDS];
bands = new int[numbands];
int j = 0;
for (int i=0; i<64; i++) { // band bits in two consequtive words
int bandmask = 1 << ( i%32 );
if ( (bandmask & dir[AreaFile.AD_BANDMAP + (i/32) ]) == bandmask) {
bands[j] = i+1 ;
j++;
if (j >= numbands) break; // done, one way or the other...
}
}
// get memo field
int[] memoArray = new int[8];
System.arraycopy(dir, 24, memoArray, 0, memoArray.length);
memo = McIDASUtil.intBitsToString(memoArray);
calType = McIDASUtil.intBitsToString(dir[AreaFile.AD_CALTYPE]).trim();
srcType = McIDASUtil.intBitsToString(dir[AreaFile.AD_SRCTYPE]).trim();
srcTypeOrig = (dir[AreaFile.AD_SRCTYPEORIG] == 0)
? srcType
: McIDASUtil.intBitsToString(dir[AreaFile.AD_SRCTYPEORIG]).trim();
calTypeUnit =
(dir[AreaFile.AD_CALTYPEUNIT] == 0 ||
dir[AreaFile.AD_CALTYPEUNIT] == McIDASUtil.MCMISSING)
? null
: McIDASUtil.intBitsToString(dir[AreaFile.AD_CALTYPEUNIT]).trim();
//System.out.println("AD.calTypeUnit = >"+calTypeUnit+"<");
if (calTypeUnit != null && calTypeUnit.equals("")) calTypeUnit = null;
calTypeScaleFactor =
(dir[AreaFile.AD_CALTYPESCALE] == 0 ||
dir[AreaFile.AD_CALTYPESCALE] == McIDASUtil.MCMISSING)
? 1 : dir[AreaFile.AD_CALTYPESCALE];
}
/**
* Create an AreaDirectory from another AreaDirectory object.
*
* @param directory the source AreaDirectory
*
* @exception AreaFileException not a valid directory
*/
public AreaDirectory(AreaDirectory directory)
throws AreaFileException
{
this(directory.getDirectoryBlock());
}
/**
* Return a specific value from the directory
*
* @param pointer part of the directory you want returned.
* Use AreaFile static fields as pointers.
*
* @exception AreaFileException invalid pointer
*/
public int getValue(int pointer)
throws AreaFileException
{
if (pointer < 0 || pointer > AreaFile.AD_DIRSIZE)
throw new AreaFileException("Invalid pointer " + pointer);
return dir[pointer];
}
/**
* Get the raw directory block
*
* @return integer array of the raw directory values
*/
public int[] getDirectoryBlock()
{
return dir;
}
/**
* returns the nominal time of the image
*
* @return the nominal time as a Date
*/
public Date getNominalTime()
{
return nominalTime;
}
/**
* returns the nominal time of the image
*
* @return the nominal time as a Date
*/
public Date getStartTime()
{
return startTime;
}
/**
* returns the number of bands in the image
*
* @return number of bands
*/
public int getNumberOfBands()
{
return dir[AreaFile.AD_NUMBANDS];
}
/**
* returns the number of lines in the image
*
* @return line number
*/
public int getLines()
{
return dir[AreaFile.AD_NUMLINES];
}
/**
* returns the number of elements in the image
*
* @return number of elements
*/
public int getElements()
{
return dir[AreaFile.AD_NUMELEMS];
}
/**
* set the band calibration info (Vector)
* array order is identical to bands array, each Vector
* element is a pair of String values: first, the code value and
* second the descriptive name.
*
* @param v the list of calibration parameters
*/
public void setCalInfo(Vector[] v) {
calInfo = v;
}
/** get the valid band calibration information
*
* @return array of Vectors of Strings of calibration info
*/
public Vector[] getCalInfo() {
return calInfo;
}
/**
* returns the bands in each of the images
*
* @return a array of bands
*/
public int[] getBands()
{
return bands;
}
/**
* Returns memo field of the directory
*
* @return string representing the memo
*/
public String getMemoField()
{
return memo;
}
/**
* Returns the sensor type
*
* @return string representing the sensor type
*/
public String getSensorType()
{
return sensors[dir[AreaFile.AD_SENSORID]];
}
public int getSensorID() {
return dir[AreaFile.AD_SENSORID];
}
/**
* Returns the source type
*
* @return string representing the cal type
*/
public String getSourceType()
{
String r = srcType;
if (r.equalsIgnoreCase("VISR")) r=srcTypeOrig;
return r;
}
/**
* Returns the calibration type
*
* @return string representing the cal type
*/
public String getCalibrationType()
{
return calType;
}
/** get Latutide at center of image
*
* @return value of latitude; if not available, return Double.NaN
*/
public double getCenterLatitude() {
return centerLatitude;
}
/** set Latitude at center of image
*
* @param lat value of latitude at center point of image
*/
public void setCenterLatitude(double lat) {
centerLatitude = lat;
}
/** get longitude at center of image
*
* @return value of longitude; if not available, return Double.NaN.
*/
public double getCenterLongitude() {
return centerLongitude;
}
/** set Longitude at center of image
*
* @param lon value of Longitude at center point of image
*/
public void setCenterLongitude(double lon) {
centerLongitude = lon;
}
/** get Latutide-wise resolution at center of image
*
* @return value of resolution (usually in KM) . If not available,
* value is Double.NaN.
*/
public double getCenterLatitudeResolution() {
return centerLatitudeResolution;
}
/** set Latitude-wise resolution at center of image
*
* @param res value of latitude-wise resolution at center point of image
*/
public void setCenterLatitudeResolution(double res) {
centerLatitudeResolution = res;
}
/** get longitude-wise resolution at center of image
*
* @return value of longitude-wise resolution (usually in KM)
* return Double.NaN if not available.
*/
public double getCenterLongitudeResolution() {
return centerLongitudeResolution;
}
/** set Longitude-wise resolution at center of image
*
* @param res value of Longitude-wise resolution at center point of image
*/
public void setCenterLongitudeResolution(double res) {
centerLongitudeResolution = res;
}
/**
* Get the string representing the calibration unit
*
* @return name of calibration unit
*/
public String getCalibrationUnitName() {
return calTypeUnit;
}
/**
* Get the scaling factor of the values for this calibration type
*
* @return scaling factor
*/
public int getCalibrationScaleFactor() {
return calTypeScaleFactor;
}
/**
* Check the equality of the object in question with this.
* @param o object in question
*/
public boolean equals(Object o) {
if (!(o instanceof AreaDirectory)) return false;
AreaDirectory that = (AreaDirectory) o;
return (this == that ||
java.util.Arrays.equals(
getDirectoryBlock(), that.getDirectoryBlock()));
}
/**
* Prints out a formatted listing of the directory info
*/
public String toString()
{
StringBuffer buf = new StringBuffer();
SimpleDateFormat sdf = new SimpleDateFormat();
sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
sdf.applyPattern("yyyy-MMM-dd HH:mm:ss");
buf.append(" ");
buf.append(sdf.format(nominalTime,
new StringBuffer(), new FieldPosition(0)).toString());
buf.append(" ");
buf.append(Integer.toString(getLines()));
buf.append(" ");
buf.append(Integer.toString(getElements()));
buf.append(" ");
//buf.append(" "+bands.length);
for (int i = 0; i < bands.length; i++) buf.append(bands[i]);
return buf.toString();
}
/**
* Used for unit testing - for now just prints Sensor ID list
* This provides an easy way to make sure list is current before
* releases.
*/
public static void main(String[] args) {
int[] dirBlock = new int[AreaFile.AD_DIRSIZE];
dirBlock[AreaFile.AD_VERSION] = AreaFile.VERSION_NUMBER;
AreaDirectory ad;
try {
ad = new AreaDirectory(dirBlock);
for (int i = 0; i < ad.sensors.length; i++) {
System.err.println("Sensor ID " + i + ": " + ad.sensors[i]);
}
} catch (AreaFileException e) {
e.printStackTrace();
}
}
}