ucar.nc2.iosp.dmsp
Class DMSPiosp

java.lang.Object
  ucar.nc2.iosp.dmsp.DMSPiosp

All Implemented Interfaces:

IOServiceProvider

public class DMSPiosp
extends java.lang.Object
implements IOServiceProvider

This ucar.nc2.IOServiceProvider provides access to DMSP satellite data in the NOAA/NGDC DMSP archive format. Currently only data from the OLS instrument is supported, in particular only NOAA/NGDC DMSP OIS (OLS Integrated Smooth) data files. The OIS data is visible and thermal imagery at 2.7km resolution. The DMSP satellites are polar orbiting satellites crossing the equator, depending on the satellite, at either dawn/dusk or noon/midnight. More information is available at http://dmsp.ngdc.noaa.gov/.

Since:

2004-08-13T13:21:19 MDT

Author:

Ethan Davis

Constructor Summary

DMSPiosp()

Method Summary

void	close() Close the file.
java.lang.String	getDetailInfo() Show debug / underlying implementation details
boolean	isValidFile(RandomAccessFile raf) Check if this is a valid file for this IOServiceProvider.
void	open(RandomAccessFile raf, NetcdfFile ncfile, CancelTask cancelTask) Open existing file, and populate ncfile with it.
Array	readData(Variable v2, java.util.List section) Read data from a top level Variable and return a memory resident Array.
Array	readNestedData(Variable v2, java.util.List section) Read data from a Variable that is nested in one or more Structures.
void	setSpecial(java.lang.Object special) A way to communicate arbitrary information to an iosp.
boolean	sync() Check if file has changed, and reread metadata if needed.
boolean	syncExtend() Extend the file if needed in a way that is compatible with the current metadata.
java.lang.String	toStringDebug(java.lang.Object o) Debug info for this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DMSPiosp

public DMSPiosp()

Method Detail

setSpecial

public void setSpecial(java.lang.Object special)

Description copied from interface: IOServiceProvider

A way to communicate arbitrary information to an iosp. Typically this is set before open() is called.

Specified by:

setSpecial in interface IOServiceProvider

Parameters:

special - opaque special settings.

getDetailInfo

public java.lang.String getDetailInfo()

Description copied from interface: IOServiceProvider

Show debug / underlying implementation details

Specified by:

getDetailInfo in interface IOServiceProvider

isValidFile

public boolean isValidFile(RandomAccessFile raf)

Description copied from interface: IOServiceProvider

Check if this is a valid file for this IOServiceProvider.

Specified by:

isValidFile in interface IOServiceProvider

Parameters:

raf - RandomAccessFile

Returns:

true if valid.

open

public void open(RandomAccessFile raf,
                 NetcdfFile ncfile,
                 CancelTask cancelTask)
          throws java.io.IOException

Description copied from interface: IOServiceProvider

Open existing file, and populate ncfile with it.

Specified by:

open in interface IOServiceProvider

Parameters:

raf - the file to work on, it has already passed the isValidFile() test.

ncfile - add objects to this NetcdfFile

cancelTask - used to monito user cancellation; may be null.

Throws:

java.io.IOException

readData

public Array readData(Variable v2,
                      java.util.List section)
               throws java.io.IOException,
                      InvalidRangeException

Description copied from interface: IOServiceProvider

Read data from a top level Variable and return a memory resident Array. This Array has the same element type as the Variable, and the requested shape.

Specified by:

readData in interface IOServiceProvider

Parameters:

v2 - a top-level Variable

section - List of type Range specifying the section of data to read. There must be a Range for each Dimension in the variable, in order. Note: no nulls.

Returns:

the requested data in a memory-resident Array

Throws:

java.io.IOException

InvalidRangeException

See Also:

Range

readNestedData

public Array readNestedData(Variable v2,
                            java.util.List section)
                     throws java.io.IOException,
                            InvalidRangeException

Description copied from interface: IOServiceProvider

Read data from a Variable that is nested in one or more Structures. If there are no Structures in the file, this will never be called. Return an Array of the same type as the Variable and the requested shape. The shape must be an accumulation of all the shapes of the Structures containing the variable.

v2.getParent() is called to get the containing Structures.

Specified by:

readNestedData in interface IOServiceProvider

Parameters:

v2 - a nested Variable.

section - List of type Range specifying the section of data to read. There must be a Range for each Dimension in each parent, as well as in the Variable itself. Must be in order from outer to inner. Note: no nulls.

Returns:

the requested data in a memory-resident Array

Throws:

java.io.IOException

InvalidRangeException

close

public void close()
           throws java.io.IOException

Description copied from interface: IOServiceProvider

Close the file. It is the IOServiceProvider's job to close the file (even though it didnt open it), and to free any other resources it has used.

Specified by:

close in interface IOServiceProvider

Throws:

java.io.IOException

syncExtend

public boolean syncExtend()

Description copied from interface: IOServiceProvider

Extend the file if needed in a way that is compatible with the current metadata. For example, if the unlimited dimension has grown.

Specified by:

syncExtend in interface IOServiceProvider

Returns:

true if file was exteneed.

sync

public boolean sync()

Description copied from interface: IOServiceProvider

Check if file has changed, and reread metadata if needed.

Specified by:

sync in interface IOServiceProvider

Returns:

true if file was changed.

toStringDebug

public java.lang.String toStringDebug(java.lang.Object o)

Description copied from interface: IOServiceProvider

Debug info for this object.

Specified by:

toStringDebug in interface IOServiceProvider