Package noaa.coastwatch.util

Class SatellitePassInfo

java.lang.Object

noaa.coastwatch.util.MetadataContainer

noaa.coastwatch.util.EarthDataInfo

noaa.coastwatch.util.SatelliteDataInfo

noaa.coastwatch.util.SatellitePassInfo

All Implemented Interfaces:

Cloneable

public class SatellitePassInfo
extends SatelliteDataInfo

A satellite pass info object holds information about one pass of a satellite over the Earth.

Since:

3.1.3

Author:

Peter Hollemans

Constructor Summary

Constructors

Constructor	Description
SatellitePassInfo(String passID, ServerQuery query, int result)	Creates a new satellite pass info object using the specified ID and query results.

Method Summary

Modifier and Type	Method	Description
EarthLocation	getCenter()	Gets the pass center point.
LineFeature	getCoveragePolygon()	Gets the pass coverage polygon.
int[]	getDimensions()	Gets the pass dimensions as [lines, samples].
String	getGroundStation()	Gets the pass ground capture station.
String	getOrbitType()	Gets the orbit type: 'ascending' or 'descending'.
String	getPassID()	Gets the pass identifier.
String	getPreviewURL()	Gets the pass preview URL.
String	getSceneTime()	Gets the pass scene time: 'day', 'night', or 'day/night'.
String	getSceneTime(int[] dims)	Gets the scene time in terms of day or night for the specified 2D scene dimensions.
String	getSceneTime(DataLocation upperLeft, DataLocation lowerRight)	Gets the scene time in terms of day or night for the specified 2D scene bounds.

Methods inherited from class noaa.coastwatch.util.SatelliteDataInfo

append, getSatellite, getSensor

Methods inherited from class noaa.coastwatch.util.EarthDataInfo

appendWithDuplicates, appendWithoutDuplicates, clearHistory, clone, collapseTimePeriods, formatDate, formatDate, formatDate, getDate, getEndDate, getHistory, getOrigin, getSource, getStartDate, getTimePeriods, getTransform, isInstantaneous, setTimePeriods, setTransform, updateHistory

Methods inherited from class noaa.coastwatch.util.MetadataContainer

getMetadataMap

Methods inherited from class java.lang.Object

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

Constructor Details

SatellitePassInfo

public SatellitePassInfo(String passID,
 ServerQuery query,
 int result)

Creates a new satellite pass info object using the specified ID and query results.

Parameters:

passID - the satellite pass identifier used for the query.

query - the server query results.

result - the server query result index.

Method Details

getCenter

public EarthLocation getCenter()

Gets the pass center point.

getPassID

public String getPassID()

Gets the pass identifier.

getOrbitType

public String getOrbitType()

Gets the orbit type: 'ascending' or 'descending'.

getDimensions

public int[] getDimensions()

Gets the pass dimensions as [lines, samples].

getGroundStation

public String getGroundStation()

Gets the pass ground capture station.

getCoveragePolygon

public LineFeature getCoveragePolygon()

Gets the pass coverage polygon.

getPreviewURL

public String getPreviewURL()

Gets the pass preview URL.

getSceneTime

public String getSceneTime()

Gets the pass scene time: 'day', 'night', or 'day/night'.

getSceneTime

public String getSceneTime(DataLocation upperLeft,
 DataLocation lowerRight)

Description copied from class: EarthDataInfo

Gets the scene time in terms of day or night for the specified 2D scene bounds. The date and time used to determine the scene time is the starting date of the first time period.

Overrides:

getSceneTime in class EarthDataInfo

Parameters:

upperLeft - the upper-left 2D scene boundary.

lowerRight - the lower-right 2D scene boundary.

Returns:

a descriptive scene time string. The scene time is day for daytime scenes, night for nighttime scenes, or day/night for a scene that crosses the terminator.

getSceneTime

public String getSceneTime(int[] dims)

Description copied from class: EarthDataInfo

Gets the scene time in terms of day or night for the specified 2D scene dimensions. The date and time used to determine the scene time is the starting date of the first time period.

Overrides:

getSceneTime in class EarthDataInfo

Parameters:

dims - the scene boundary dimensions as [rows, columns].

Returns:

a descriptive scene time string. The scene time is day for daytime scenes, night for nighttime scenes, or day/night for a scene that crosses the terminator.