FlatFileReader (McIDAS-V 1.6 Developer Documentation)

java.lang.Object
- edu.wisc.ssec.mcidasv.data.FlatFileReader

```
public class FlatFileReader
extends Object
```
Class that can read file formats associated with FlatFileDataSource.

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`band`
`private int`	`bandCount`
`private boolean`	`bigEndian`
`private int`	`dataScale`
`private String`	`delimiter`
`private boolean`	`eastPositive`
`private int`	`elements`
`private float[]`	`floatData` Float values read from the file.
`private String`	`interleave` Data parameters
`private String`	`latFile`
`private int`	`latlonScale`
`private int`	`lines` Dimensions
`private static org.slf4j.Logger`	`logger` Logging object.
`private String`	`lonFile`
`private double`	`lrLat`
`private double`	`lrLon`
`private int`	`myFormat` Format this object is representing.
`private int`	`myNavigation`
`private int`	`navElements`
`(package private) CoordinateSystem`	`navigationCoords`
`(package private) Gridded2DSet`	`navigationSet`
`private int`	`navLines` Nav dimensions
`private int`	`offset`
`private int`	`stride`
`private int`	`strideElements`
`private int`	`strideLines`
`private double`	`ulLat` Nav parameters
`private double`	`ulLon`
`private String`	`unit`
`private String`	`url` The url

Constructor Summary

Constructors
Constructor and Description
`FlatFileReader()` Ctor for xml encoding
`FlatFileReader(String filename)` CTOR
`FlatFileReader(String filename, int lines, int elements)` CTOR

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private static int`	`bytesTo1ByteUInt(byte[] bytes, int offset)`
`private static int`	`bytesTo2ByteSInt(byte[] bytes, int offset)`
`private static int`	`bytesTo2ByteUInt(byte[] bytes, int offset)`
`private static float`	`bytesTo4ByteFloat(byte[] bytes, int offset)`
`private static int`	`bytesTo4ByteSInt(byte[] bytes, int offset)`
`private static double`	`bytesToDouble(byte[] bytes)`
`private static long`	`bytesToLong(byte[] bytes)`
`Data`	`getData()` Return a valid data object for a DataSource.
`private Data`	`getDataFromImage()` Make a `FlatField` from an Image.
`private FlatField`	`getFlatField()` Convert `floatData` into a `FlatField`.
`float[]`	`getFloats()` Return the array of floats making up the data.
`private Gridded2DSet`	`getNavigationSetFromBounds()` Make a Gridded2DSet from bounds.
`private Gridded2DSet`	`getNavigationSetFromFiles()` Make a Gridded2DSet from files.
`private void`	`makeCoordinateSystem()` Create navigation info if it hasn't been built
`private void`	`readFloatsFromAscii()` Read floats from an ASCII file.
`private void`	`readFloatsFromBinary()` Read floats from a binary file.
`void`	`setAsciiInfo(String delimiter, int dataScale)` Change format to ASCII.
`void`	`setBinaryInfo(int format, String interleave, boolean bigEndian, int offset, int band, int bandCount)` Set metadata required to properly read from file.
`void`	`setEastPositive(boolean eastPositive)` Specify whether or not East is positive.
`void`	`setImageInfo()` Change format to image.
`void`	`setNavBounds(double ulLat, double ulLon, double lrLat, double lrLon)` Set the geographic bounding box.
`void`	`setNavFiles(String latFile, String lonFile, int latlonScale)` Specify the files to use for navigation.
`void`	`setStride(int stride)` Change the "stride" to the specified value.
`void`	`setUnit(String unit)` Change the unit.
`String`	`toString()` String representation of the current `FlatFileReader`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logger

private static final org.slf4j.Logger logger

Logging object.

url
```
private String url
```
The url

lines
```
private int lines
```
Dimensions

elements
```
private int elements
```

strideLines
```
private int strideLines
```

strideElements
```
private int strideElements
```

band
```
private int band
```

bandCount
```
private int bandCount
```

unit
```
private String unit
```

stride
```
private int stride
```

navLines
```
private int navLines
```
Nav dimensions

navElements
```
private int navElements
```

interleave
```
private String interleave
```
Data parameters

bigEndian
```
private boolean bigEndian
```

offset
```
private int offset
```

delimiter
```
private String delimiter
```

dataScale
```
private int dataScale
```

ulLat
```
private double ulLat
```
Nav parameters

ulLon
```
private double ulLon
```

lrLat
```
private double lrLat
```

lrLon
```
private double lrLon
```

latFile
```
private String latFile
```

lonFile
```
private String lonFile
```

latlonScale
```
private int latlonScale
```

eastPositive
```
private boolean eastPositive
```

myFormat
```
private int myFormat
```
Format this object is representing. Initial value is HeaderInfo.kFormatUnknown.

myNavigation
```
private int myNavigation
```

floatData
```
private float[] floatData
```
Float values read from the file.

navigationSet
```
Gridded2DSet navigationSet
```

navigationCoords
```
CoordinateSystem navigationCoords
```

Constructor Detail
- FlatFileReader
```
public FlatFileReader()
```
  Ctor for xml encoding
- FlatFileReader
```
public FlatFileReader(String filename)
```
  CTOR
  
  Parameters:
  
  filename - Filename to read.
- FlatFileReader
```
public FlatFileReader(String filename,
                      int lines,
                      int elements)
```
  CTOR
  
  Parameters:
  
  filename - Filename to read.
  
  lines - Number of lines.
  
  elements - Number of elements.

Method Detail
- setBinaryInfo
```
public void setBinaryInfo(int format,
                          String interleave,
                          boolean bigEndian,
                          int offset,
                          int band,
                          int bandCount)
```
  Set metadata required to properly read from file.
  
  Parameters:
  
  format - New format.
  
  interleave - Interleaving type.
  
  bigEndian - Whether or not data is big endian.
  
  offset - Data offset within file being read.
  
  band - Band to read.
  
  bandCount - Total number of bands.
- setAsciiInfo
```
public void setAsciiInfo(String delimiter,
                         int dataScale)
```
  Change format to ASCII.
  
  Parameters:
  
  delimiter - Data value delimiter.
  
  dataScale - Data scale factor.
- setImageInfo
```
public void setImageInfo()
```
  Change format to image.
- setNavBounds
```
public void setNavBounds(double ulLat,
                         double ulLon,
                         double lrLat,
                         double lrLon)
```
  Set the geographic bounding box.
  
  Parameters:
  
  ulLat - Upper left latitude.
  
  ulLon - Upper left longitude.
  
  lrLat - Lower right latitude.
  
  lrLon - Lower right longitude.
- setNavFiles
```
public void setNavFiles(String latFile,
                        String lonFile,
                        int latlonScale)
```
  Specify the files to use for navigation.
  
  Parameters:
  
  latFile - Path to the latitude file.
  
  lonFile - Path to the longitude file.
  
  latlonScale - Navigation value scaling.
- setEastPositive
```
public void setEastPositive(boolean eastPositive)
```
  Specify whether or not East is positive.
  
  Parameters:
  
  eastPositive - Whether or not East is positive.
- setStride
```
public void setStride(int stride)
```
  Change the "stride" to the specified value.
  
  Parameters:
  
  stride - New stride value. Values less than one will result in the stride being set to one.
- setUnit
```
public void setUnit(String unit)
```
  Change the unit.
  
  Parameters:
  
  unit - New unit.
- readFloatsFromBinary
```
private void readFloatsFromBinary()
```
  Read floats from a binary file.
- readFloatsFromAscii
```
private void readFloatsFromAscii()
```
  Read floats from an ASCII file.
- getDataFromImage
```
private Data getDataFromImage()
```
  Make a FlatField from an Image.
  
  Returns:
  
  VisAD data object built from contents of url.
- getNavigationSetFromBounds
```
private Gridded2DSet getNavigationSetFromBounds()
```
  Make a Gridded2DSet from bounds.
  
  Returns:
  
  VisAD bounding box.
- getNavigationSetFromFiles
```
private Gridded2DSet getNavigationSetFromFiles()
```
  Make a Gridded2DSet from files.
  
  Returns:
  
  VisAD bounding box.
- makeCoordinateSystem
```
private void makeCoordinateSystem()
```
  Create navigation info if it hasn't been built
- getData
```
public Data getData()
```
  Return a valid data object for a DataSource.
  
  Returns:
  
  VisAD data object representing what has been read.
- getFloats
```
public float[] getFloats()
```
  Return the array of floats making up the data.
  
  Returns:
  
  Floats found within the file.
- getFlatField
```
private FlatField getFlatField()
                        throws IOException,
                               VisADException
```
  Convert floatData into a FlatField.
  
  Returns:
  
  floatData converted into a VisAD FlatField.
  
  Throws:
  
  IOException - if there was a general IO problem.
  
  VisADException - if there was a VisAD-related problem.
- toString
```
public String toString()
```
  String representation of the current FlatFileReader.
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  String containing things like the URL along with lines and elements.
- bytesTo1ByteUInt
```
private static int bytesTo1ByteUInt(byte[] bytes,
                                    int offset)
```
- bytesTo2ByteUInt
```
private static int bytesTo2ByteUInt(byte[] bytes,
                                    int offset)
```
- bytesTo2ByteSInt
```
private static int bytesTo2ByteSInt(byte[] bytes,
                                    int offset)
```
- bytesTo4ByteSInt
```
private static int bytesTo4ByteSInt(byte[] bytes,
                                    int offset)
```
- bytesTo4ByteFloat
```
private static float bytesTo4ByteFloat(byte[] bytes,
                                       int offset)
```
- bytesToLong
```
private static long bytesToLong(byte[] bytes)
```
- bytesToDouble
```
private static double bytesToDouble(byte[] bytes)
```

Class FlatFileReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

url

lines

elements

strideLines

strideElements

band

bandCount

unit

stride

navLines

navElements

interleave

bigEndian

offset

delimiter

dataScale

ulLat

ulLon

lrLat

lrLon

latFile

lonFile

latlonScale

eastPositive

myFormat

myNavigation

floatData

navigationSet

navigationCoords

Constructor Detail

FlatFileReader

FlatFileReader

FlatFileReader

Method Detail

setBinaryInfo

setAsciiInfo

setImageInfo

setNavBounds

setNavFiles

setEastPositive

setStride

setUnit

readFloatsFromBinary

readFloatsFromAscii

getDataFromImage

getNavigationSetFromBounds

getNavigationSetFromFiles

makeCoordinateSystem

getData

getFloats

getFlatField

toString

bytesTo1ByteUInt

bytesTo2ByteUInt

bytesTo2ByteSInt

bytesTo4ByteSInt

bytesTo4ByteFloat

bytesToLong

bytesToDouble