Package ucar.nc2.iosp.dmsp

Class DMSPiosp

  • All Implemented Interfaces:
    Comparable<IOServiceProvider>, IOServiceProvider
    public class DMSPiosp
extends AbstractIOServiceProvider
    This ucar.nc2.iosp.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

    • Constructor Detail

      • DMSPiosp

        public DMSPiosp()

    • Method Detail

      • isValidFile

        public boolean isValidFile​(RandomAccessFile raf)
        Description copied from interface: IOServiceProvider
        Check if this is a valid file for this IOServiceProvider. You must make this method thread safe, ie dont keep any state.
        Parameters:
        raf - RandomAccessFile
        Returns:
        true if valid.

      • getFileTypeId

        public String getFileTypeId()
        Description copied from interface: IOServiceProvider
        Get a unique id for this file type.
        Returns:
        registered id of the file type
        See Also:
        "https://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"

      • getFileTypeDescription

        public String getFileTypeDescription()
        Description copied from interface: IOServiceProvider
        Get a human-readable description for this file type.
        Returns:
        description of the file type
        See Also:
        "https://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"

      • open

        public void open​(RandomAccessFile raf,
                 NetcdfFile ncfile,
                 CancelTask cancelTask)
          throws IOException
        Description copied from interface: IOServiceProvider
        Open existing file, and populate ncfile with it. This method is only called by the NetcdfFile constructor on itself. The provided NetcdfFile object will be empty except for the location String and the IOServiceProvider associated with this NetcdfFile object.
        Specified by:
        open in interface IOServiceProvider
        Overrides:
        open in class AbstractIOServiceProvider
        Parameters:
        raf - the file to work on, it has already passed the isValidFile() test.
        ncfile - add objects to this empty NetcdfFile
        cancelTask - used to monitor user cancellation; may be null.
        Throws:
        IOException - if read error

      • readData

        public Array readData​(Variable v2,
                      Section section)
               throws 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.
        Parameters:
        v2 - a top-level Variable
        section - the section of data to read. There must be a Range for each Dimension in the variable, in order. Note: no nulls allowed. IOSP may not modify.
        Returns:
        the requested data in a memory-resident Array
        Throws:
        IOException - if read error
        InvalidRangeException - if invalid section
        See Also:
        Range