CoverageAnalyzer (McIDAS-V 1.01 Developer Documentation)

java.lang.Object
- edu.wisc.ssec.mcidasv.data.adde.sgp4.CoverageAnalyzer

public class CoverageAnalyzer
extends Object

Author:: Shawn

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`alpha`
`private Color`	`colorbarBGcolor`
`private int`	`colorBarHeight`
`private int`	`colorBarLen`
`private NumberFormat`	`colorBarNumberFormat`
`private Color`	`colorBarTextcolor`
`private int`	`colorBarTextSpacing`
`private double[][]`	`coverageCumTime`
`private boolean`	`dynamicUpdating`
`private double`	`elevationLimit`
`private double`	`lastMJD`
`private double[]`	`latBounds`
`private double[]`	`latGridPoints`
`private double[]`	`latPanelMidPoints`
`private int`	`latPanels`
`private double[]`	`longBounds`
`private int`	`longPanels`
`private double[]`	`lonGridPoints`
`private double[]`	`lonPanelMidPoints`
`private double`	`maxVal`
`private double`	`minNotZeroVal`
`private int`	`pixelsFromBottom`
`private int`	`pixelsFromLeft`
`private boolean`	`plotCoverageGrid`
`(package private) Vector<String>`	`satsUsedInCoverage`
`private boolean`	`showColorBar`
`private Time`	`startTime`

Constructor Summary

Constructors
Constructor and Description

CoverageAnalyzer()

CoverageAnalyzer(Time currentJulianDate)
Constructor with current time - this will allow coverage to start on next time step

Constructors
Constructor and Description
`CoverageAnalyzer()`
`CoverageAnalyzer(Time currentJulianDate)` Constructor with current time - this will allow coverage to start on next time step

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addSatToCoverageAnaylsis(String satName)`
`void`	`clearCoverageData()` Clears the coverage data and resets last update date
`void`	`clearCoverageData(Time currentJulianDate)` Clear coverage data and initalizie update time for next simulation step
`void`	`clearSatCoverageVector()`
`int`	`getAlpha()`
`Color`	`getColorbarBGcolor()`
`int`	`getColorBarHeight()`
`int`	`getColorBarLen()`
`NumberFormat`	`getColorBarNumberFormat()`
`Color`	`getColorBarTextcolor()`
`int`	`getColorBarTextSpacing()`
`double[][]`	`getCoverageCumTime()`
`double`	`getElevationLimit()`
`double`	`getLastMJD()`
`double[]`	`getLatBounds()`
`double[]`	`getLatGridPoints()`
`double[]`	`getLatPanelMidPoints()`
`int`	`getLatPanels()`
`double[]`	`getLongBounds()`
`int`	`getLongPanels()`
`double[]`	`getLonGridPoints()`
`double[]`	`getLonPanelMidPoints()`
`String`	`getLowerBoundLabel()`
`double`	`getMaxVal()`
`double`	`getMinNotZeroVal()`
`int`	`getPixelsFromBottom()`
`int`	`getPixelsFromLeft()`
`Vector<String>`	`getSatVector()`
`Time`	`getStartTime()`
`String`	`getUpperBoundLabel()`
`private void`	`iniParamters()`
`boolean`	`isDynamicUpdating()`
`boolean`	`isPlotCoverageGrid()`
`boolean`	`isShowColorBar()`
`static void`	`main(String[] args)`
`void`	`performCoverageAnalysis(Time currentJulianDate, Hashtable<String,AbstractSatellite> satHash)` Performs coverage anaylsis with given time and satellite array, this fuction should be called only when directly performing coverage analysis, otherwise call updateTime
`void`	`removeSatFromCoverageAnaylsis(String satName)`
`void`	`setAlpha(int alpha)`
`void`	`setColorbarBGcolor(Color colorbarBGcolor)`
`void`	`setColorBarHeight(int colorBarHeight)`
`void`	`setColorBarLen(int colorBarLen)`
`void`	`setColorBarNumberFormat(NumberFormat colorBarNumberFormat)`
`void`	`setColorBarTextcolor(Color colorBarTextcolor)`
`void`	`setColorBarTextSpacing(int colorBarTextSpacing)`
`void`	`setDynamicUpdating(boolean dynamicUpdating)`
`void`	`setElevationLimit(double elevationLimit)`
`void`	`setLatBounds(double[] latBounds)`
`void`	`setLatPanels(int latPanels)`
`void`	`setLongBounds(double[] longBounds)`
`void`	`setLongPanels(int longPanels)`
`void`	`setPixelsFromBottom(int pixelsFromBottom)`
`void`	`setPixelsFromLeft(int pixelsFromLeft)`
`void`	`setPlotCoverageGrid(boolean plotCoverageGrid)`
`void`	`setShowColorBar(boolean showColorBar)`

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

Field Detail

coverageCumTime
```
private double[][] coverageCumTime
```

latPanelMidPoints
```
private double[] latPanelMidPoints
```

lonPanelMidPoints
```
private double[] lonPanelMidPoints
```

latGridPoints
```
private double[] latGridPoints
```

lonGridPoints
```
private double[] lonGridPoints
```

minNotZeroVal
```
private double minNotZeroVal
```

maxVal
```
private double maxVal
```

startTime
```
private Time startTime
```

lastMJD
```
private double lastMJD
```

satsUsedInCoverage
```
Vector<String> satsUsedInCoverage
```

latPanels
```
private int latPanels
```

longPanels
```
private int longPanels
```

latBounds
```
private double[] latBounds
```

longBounds
```
private double[] longBounds
```

alpha
```
private int alpha
```

dynamicUpdating
```
private boolean dynamicUpdating
```

plotCoverageGrid
```
private boolean plotCoverageGrid
```

elevationLimit
```
private double elevationLimit
```

colorBarNumberFormat

private NumberFormat colorBarNumberFormat

showColorBar
```
private boolean showColorBar
```

pixelsFromBottom
```
private int pixelsFromBottom
```

pixelsFromLeft
```
private int pixelsFromLeft
```

colorBarLen
```
private int colorBarLen
```

colorBarHeight
```
private int colorBarHeight
```

colorBarTextSpacing
```
private int colorBarTextSpacing
```

colorbarBGcolor
```
private Color colorbarBGcolor
```

colorBarTextcolor
```
private Color colorBarTextcolor
```

Constructor Detail
- CoverageAnalyzer
```
public CoverageAnalyzer()
```
- CoverageAnalyzer
```
public CoverageAnalyzer(Time currentJulianDate)
```
  Constructor with current time - this will allow coverage to start on next time step
  
  Parameters:
  currentJulianDate - current Julian Date

Method Detail

clearCoverageData
```
public void clearCoverageData(Time currentJulianDate)
```
Clear coverage data and initalizie update time for next simulation step

Parameters:
currentJulianDate -

clearCoverageData
```
public void clearCoverageData()
```
Clears the coverage data and resets last update date

iniParamters
```
private void iniParamters()
```

main

public static void main(String[] args)

performCoverageAnalysis
```
public void performCoverageAnalysis(Time currentJulianDate,
                           Hashtable<String,AbstractSatellite> satHash)
```
Performs coverage anaylsis with given time and satellite array, this fuction should be called only when directly performing coverage analysis, otherwise call updateTime

Parameters:
currentJulianDate -
satHash -

addSatToCoverageAnaylsis

public void addSatToCoverageAnaylsis(String satName)

clearSatCoverageVector
```
public void clearSatCoverageVector()
```

removeSatFromCoverageAnaylsis

public void removeSatFromCoverageAnaylsis(String satName)

getSatVector
```
public Vector<String> getSatVector()
```

getLatPanels
```
public int getLatPanels()
```

setLatPanels

public void setLatPanels(int latPanels)

getLongPanels
```
public int getLongPanels()
```

setLongPanels

public void setLongPanels(int longPanels)

getLatBounds
```
public double[] getLatBounds()
```

setLatBounds

public void setLatBounds(double[] latBounds)

getLongBounds
```
public double[] getLongBounds()
```

setLongBounds

public void setLongBounds(double[] longBounds)

getAlpha
```
public int getAlpha()
```

setAlpha
```
public void setAlpha(int alpha)
```

isDynamicUpdating
```
public boolean isDynamicUpdating()
```

setDynamicUpdating

public void setDynamicUpdating(boolean dynamicUpdating)

isPlotCoverageGrid
```
public boolean isPlotCoverageGrid()
```

setPlotCoverageGrid

public void setPlotCoverageGrid(boolean plotCoverageGrid)

getElevationLimit
```
public double getElevationLimit()
```

setElevationLimit

public void setElevationLimit(double elevationLimit)

getColorBarNumberFormat

public NumberFormat getColorBarNumberFormat()

setColorBarNumberFormat

public void setColorBarNumberFormat(NumberFormat colorBarNumberFormat)

isShowColorBar
```
public boolean isShowColorBar()
```

setShowColorBar

public void setShowColorBar(boolean showColorBar)

getPixelsFromBottom
```
public int getPixelsFromBottom()
```

setPixelsFromBottom

public void setPixelsFromBottom(int pixelsFromBottom)

getPixelsFromLeft
```
public int getPixelsFromLeft()
```

setPixelsFromLeft

public void setPixelsFromLeft(int pixelsFromLeft)

getColorBarLen
```
public int getColorBarLen()
```

setColorBarLen

public void setColorBarLen(int colorBarLen)

getColorBarHeight
```
public int getColorBarHeight()
```

setColorBarHeight

public void setColorBarHeight(int colorBarHeight)

getColorBarTextSpacing
```
public int getColorBarTextSpacing()
```

setColorBarTextSpacing

public void setColorBarTextSpacing(int colorBarTextSpacing)

getColorbarBGcolor
```
public Color getColorbarBGcolor()
```

setColorbarBGcolor

public void setColorbarBGcolor(Color colorbarBGcolor)

getColorBarTextcolor
```
public Color getColorBarTextcolor()
```

setColorBarTextcolor

public void setColorBarTextcolor(Color colorBarTextcolor)

getCoverageCumTime

public double[][] getCoverageCumTime()

getLatPanelMidPoints

public double[] getLatPanelMidPoints()

getLonPanelMidPoints

public double[] getLonPanelMidPoints()

getLatGridPoints
```
public double[] getLatGridPoints()
```

getLonGridPoints
```
public double[] getLonGridPoints()
```

getMinNotZeroVal
```
public double getMinNotZeroVal()
```

getMaxVal
```
public double getMaxVal()
```

getLowerBoundLabel
```
public String getLowerBoundLabel()
```

getUpperBoundLabel
```
public String getUpperBoundLabel()
```

getStartTime
```
public Time getStartTime()
```

getLastMJD
```
public double getLastMJD()
```

Class CoverageAnalyzer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

coverageCumTime

latPanelMidPoints

lonPanelMidPoints

latGridPoints

lonGridPoints

minNotZeroVal

maxVal

startTime

lastMJD

satsUsedInCoverage

latPanels

longPanels

latBounds

longBounds

alpha

dynamicUpdating

plotCoverageGrid

elevationLimit

colorBarNumberFormat

showColorBar

pixelsFromBottom

pixelsFromLeft

colorBarLen

colorBarHeight

colorBarTextSpacing

colorbarBGcolor

colorBarTextcolor

Constructor Detail

CoverageAnalyzer

CoverageAnalyzer

Method Detail

clearCoverageData

clearCoverageData

iniParamters

main

performCoverageAnalysis

addSatToCoverageAnaylsis

clearSatCoverageVector

removeSatFromCoverageAnaylsis

getSatVector

getLatPanels

setLatPanels

getLongPanels

setLongPanels

getLatBounds

setLatBounds

getLongBounds

setLongBounds

getAlpha

setAlpha

isDynamicUpdating

setDynamicUpdating

isPlotCoverageGrid

setPlotCoverageGrid

getElevationLimit

setElevationLimit

getColorBarNumberFormat

setColorBarNumberFormat

isShowColorBar

setShowColorBar

getPixelsFromBottom

setPixelsFromBottom

getPixelsFromLeft

setPixelsFromLeft

getColorBarLen

setColorBarLen

getColorBarHeight

setColorBarHeight

getColorBarTextSpacing

setColorBarTextSpacing

getColorbarBGcolor

setColorbarBGcolor

getColorBarTextcolor

setColorBarTextcolor