ucar.nc2.iosp.gempak

Class GempakGridReader

java.lang.Object

ucar.nc2.iosp.gempak.GempakFileReader

ucar.nc2.iosp.gempak.GempakGridReader

All Implemented Interfaces:

GempakConstants

public class GempakGridReader
extends GempakFileReader

Read a GEMPAK grid file

Author:

Don Murray

Nested Class Summary

Nested classes/interfaces inherited from class ucar.nc2.iosp.gempak.GempakFileReader

GempakFileReader.DMFileHeaderInfo, GempakFileReader.DMHeaders, GempakFileReader.DMKeys, GempakFileReader.DMLabel, GempakFileReader.DMParam, GempakFileReader.DMPart, GempakFileReader.Key, GempakFileReader.PackingInfo, GempakFileReader.RData

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANLB Grid analysis block identifier
static java.lang.String	GRID Grid identifier
static java.lang.String	NAVB Grid nav block identifier
static boolean	useDP flag for using DP_UGRB or not

Fields inherited from class ucar.nc2.iosp.gempak.GempakFileReader

dmLabel, fileHeaderInfo, fileSize, headers, keys, MTMACH, mvmst, needToSwap, parts, rf

Fields inherited from interface ucar.nc2.iosp.gempak.GempakConstants

COL, IMISSD, LLGDHD, LLNANL, LLNNAV, LLSTHL, MBLKSZ, MDCHAR, MDGDEC, MDGDIF, MDGGRB, MDGNMC, MDGNON, MDGRB2, MDGRID, MDINTG, MDREAL, MDRPCK, MFGD, MFSF, MFSN, MTALPH, MTAPOL, MTHP, MTIBM, MTIGPH, MTIRIS, MTLNUX, MTSUN, MTULTX, MTVAX, RDIFFD, RMISSD, ROW

Method Summary

Methods

Modifier and Type	Method and Description
float[]	DM_RPKG(int isword, int nword, int decimalScale) Unpack a packed grid
GempakGridRecord	findGrid(java.lang.String parm) Find the first grid with this name
int	getGridCount() Get the grid count
ucar.grid.GridIndex	getGridIndex() Get the grid index
java.util.List<ucar.grid.GridRecord>	getGridList() Get list of grids
int	getGridPackingType(int gridNumber) Get the grid packing type
static GempakGridReader	getInstance(RandomAccessFile raf, boolean fullCheck) Initialize the file, read in all the metadata (ala DM_OPEN)
protected boolean	init(boolean fullCheck) Initialize this reader.
static void	main(java.lang.String[] args) Run the program
void	printAnalBlock() Print out the analysis block so it looks something like this:
void	printGrids() Print out the grids.
void	printNavBlock() Print out the navibation block so it looks something like this:
float[]	readGrid(ucar.grid.GridRecord gr) Read the data
void	showGridInfo(boolean printGrids) List out the grid information (aka GDINFO)

Methods inherited from class ucar.nc2.iosp.gempak.GempakFileReader

DM_RDTR, DM_RDTR, DM_RFLT, DM_RFLT, DM_RFLT, DM_RINT, DM_RINT, DM_RINT, DM_RSTR, DM_RSTR, DM_UNPK, findFileHeader, findKey, getBits, getByteOrder, getByteOrder, getDataPointer, getFile, getFileHeader, getFilename, getInitFileSize, getOffset, getPart, getPartNumber, init, init, logError, printFileLabel, printHeaders, printKeys, printParts, readFileHeaderInfo, readHeaders, readKeys, readParts

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GRID

public static final java.lang.String GRID

Grid identifier

See Also:

Constant Field Values

ANLB

public static final java.lang.String ANLB

Grid analysis block identifier

See Also:

Constant Field Values

NAVB

public static final java.lang.String NAVB

Grid nav block identifier

See Also:

Constant Field Values

useDP

public static boolean useDP

flag for using DP_UGRB or not

Method Detail

getInstance

public static GempakGridReader getInstance(RandomAccessFile raf,
                           boolean fullCheck)
                                    throws java.io.IOException

Initialize the file, read in all the metadata (ala DM_OPEN)

Parameters:

raf - RandomAccessFile to read.

fullCheck - if true, check entire structure

Returns:

A GempakGridReader

Throws:

java.io.IOException - problem reading file

init

protected boolean init(boolean fullCheck)
                throws java.io.IOException

Initialize this reader. Get the Grid specific info

Overrides:

init in class GempakFileReader

Parameters:

fullCheck - check to make sure there are grids we can handle

Returns:

true if successful

Throws:

java.io.IOException - problem reading the data

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Run the program

Parameters:

args - [0] filename (required), [1] variable name (X for default), [2] X to not list grids

Throws:

java.io.IOException - problem reading the file

getGridIndex

public ucar.grid.GridIndex getGridIndex()

Get the grid index

Returns:

the GridIndex

getGridCount

public int getGridCount()

Get the grid count

Returns:

the count

getGridPackingType

public int getGridPackingType(int gridNumber)
                       throws java.io.IOException

Get the grid packing type

Parameters:

gridNumber - grid number

Returns:

packing type or error number

Throws:

java.io.IOException - problem reading file

findGrid

public GempakGridRecord findGrid(java.lang.String parm)

Find the first grid with this name

Parameters:

parm - name of grid

Returns:

the grid header or null

readGrid

public float[] readGrid(ucar.grid.GridRecord gr)
                 throws java.io.IOException

Read the data

Parameters:

gr - grid record

Returns:

the data array

Throws:

java.io.IOException - problem reading file

DM_RPKG

public float[] DM_RPKG(int isword,
              int nword,
              int decimalScale)
                throws java.io.IOException

Unpack a packed grid

Overrides:

DM_RPKG in class GempakFileReader

Parameters:

isword - starting word (1 based)

nword - number of words to read

decimalScale - decimal scale

Returns:

array of unpacked data or null;

Throws:

java.io.IOException - problem reading data

printNavBlock

public void printNavBlock()

Print out the navibation block so it looks something like this:

   GRID NAVIGATION:
        PROJECTION:          LCC
        ANGLES:              25.0   -95.0    25.0
        GRID SIZE:           93  65
        LL CORNER:           12.19   -133.46
        UR CORNER:           57.29    -49.38
 

printAnalBlock

public void printAnalBlock()

Print out the analysis block so it looks something like this:

getGridList

public java.util.List<ucar.grid.GridRecord> getGridList()

Get list of grids

Returns:

list of grids

printGrids

public void printGrids()

Print out the grids.

showGridInfo

public void showGridInfo(boolean printGrids)

List out the grid information (aka GDINFO)

Parameters:

printGrids - print each grid record