Package edu.wisc.ssec.mcidasv.data.hydra

Class SuomiNPPDataSource

java.lang.Object

ucar.unidata.collab.SharableImpl

ucar.unidata.data.DataSourceImpl

edu.wisc.ssec.mcidasv.data.HydraDataSource

edu.wisc.ssec.mcidasv.data.hydra.SuomiNPPDataSource

All Implemented Interfaces:

Sharable, DataSource, DataSourceFactory, XmlPersistable

public class SuomiNPPDataSource
extends HydraDataSource

A data source for NPOESS Preparatory Project (Suomi NPP) data and JPSS data (JPSS-1 is officially NOAA-20). This should probably move, but we are placing it here for now since we are leveraging some existing code used for HYDRA.

Field Summary

Fields

Modifier and Type	Field	Description
protected MultiDimensionAdapter[]	adapters
private List<DataCategory>	categories
private String	crisFilter
private static final String	DATA_DESCRIPTION
private Map<String,double[]>	defaultSubset
private boolean	derivedInit
private Map<String,double[]>	derivedSubset
protected String	filename	Sources file
(package private) Map<String,List<String>>	filenameMap
protected List<String>	geoSources
(package private) float[]	i04LUT
(package private) float[]	i05LUT
(package private) Attribute	instrumentName
private boolean	isCombinedProduct
private boolean	isDerived
private boolean	isEnterprise
private boolean	isNOAA
private static final org.slf4j.Logger	logger
private Map<String,float[]>	lutMap
(package private) float[]	m12LUT
(package private) float[]	m13LUT
(package private) float[]	m14LUT
(package private) float[]	m15LUT
(package private) float[]	m16LUT
private List<MultiSpectralData>	msd_CrIS
private Map<String,MultiSpectralData>	msdMap
private List<MultiSpectralData>	multiSpectralData
private boolean	nameHasBeenSet
protected MultiDimensionReader	nppAggReader
protected List<String>	oldSources
private String	productName
private Map<String,QualityFlag>	qfMap
(package private) SimpleDateFormat	sdf
(package private) SimpleDateFormat	sdfEnterprise
(package private) SimpleDateFormat	sdfNASA
(package private) SimpleDateFormat	sdfOut
private static final String	SEPARATOR_CHAR
(package private) Map<String,double[]>	subset
(package private) Date	theDate
TrackAdapter	track_adapter
(package private) Map<String,String>	unitsEnterprise
(package private) Map<String,String>	unitsNASA
(package private) String	whichEDR

Fields inherited from class edu.wisc.ssec.mcidasv.data.HydraDataSource

oldSourceFromBundles, request, sources

Fields inherited from class ucar.unidata.data.DataSourceImpl

changeDataPathsCbx, dataCacheKey, dataChoices, geoSelectionPanel, haveBeenUnPersisted, okToContinue, PARAM_SHOW_HIDE, PARAM_SHOW_NO, PARAM_SHOW_YES

Fields inherited from interface ucar.unidata.data.DataSource

DATAPATH_DATE_FORMAT, DATAPATH_DATE_PATTERN, MOST_RECENT, ordinalNames, PROP_AUTOCREATEDISPLAY, PROP_BASEDIRECTORY, PROP_CACHEABLE, PROP_DATACHOICENAME, PROP_DISPLAYPROPERTIES, PROP_DOCUMENTLINKS, PROP_FILEPATTERN, PROP_GEOLOCATION, PROP_ICON, PROP_NAME, PROP_POLLINFO, PROP_RESOLVERURL, PROP_SERVICE_HTTP, PROP_SUBPROPERTIES, PROP_TIMELABELS, PROP_TIMESTRIDE, PROP_TITLE

Constructor Summary

Constructors

Constructor	Description
SuomiNPPDataSource()	Zero-argument constructor for construction via unpersistence.
SuomiNPPDataSource(String fileName)
SuomiNPPDataSource(DataSourceDescriptor descriptor, String fileName, Hashtable properties)	Construct a new Suomi NPP HDF5 data source.
SuomiNPPDataSource(DataSourceDescriptor descriptor, List<String> newSources, Hashtable properties)	Construct a new Suomi NPP HDF5 data source.

Method Summary

Modifier and Type	Method	Description
protected Data	applyProperties(Data data, Hashtable requestProperties, Map<String,double[]> subset, int adapterIndex)
boolean	canSaveDataToLocalDisk()	Can this data source save its dat to local disk
private DataChoice	doMakeDataChoice(int idx, MultiSpectralData adapter)
private DataChoice	doMakeDataChoice(int idx, String var, String description)
void	doMakeDataChoices()	Make and insert the DataChoices for this DataSource.
boolean	equals(Object o)	Check to see if this SuomiNPPDataSource is equal to the object in question.
Data	getData(DataChoice dataChoice, DataCategory category, DataSelection dataSelection, Hashtable requestProperties)	Get the data applicable to the DataChoice and selection criteria.
protected Data	getDataInner(DataChoice dataChoice, DataCategory category, DataSelection dataSelection, Hashtable requestProperties)	Get the data for the given DataChoice and selection criteria.
String	getDatasetName()
Map<String,List<String>>	getFilenameMap()
MultiSpectralData	getMultiSpectralData()
MultiSpectralData	getMultiSpectralData(DataChoice choice)
List<String>	getOldSources()
Map<String,QualityFlag>	getQfMap()
Map<String,double[]>	getSubsetFromLonLatRect(MultiDimensionSubset select, GeoSelection geoSelection)
void	initAfterUnpersistence()	Implement the XmlPersistable interface method that is called after this object has been fully created and initialized after being unpersisted by the XmlEncoder.
void	initDataChoice(DataChoice dataChoice)	Sets the global id of the given dataChoice to be a per process unique string value.
protected void	initDataSelectionComponents(List<DataSelectionComponent> components, DataChoice dataChoice)	Add any data selection components
void	initQfTranslations()	Add Integer->String translations to IDV's "translations" resource, so they will be made available to the data probe of Image Display's.
boolean	isNOAA()	Determine if this data source originated from a "NOAA file".
protected List	saveDataToLocalDisk(String filePrefix, Object loadId, boolean changeLinks)	Save the data source files to local disk
void	setDatasetName(String name)
void	setFilenameMap(Map<String,List<String>> filenameMap)
void	setOldSources(List<String> oldSources)
void	setup()

Methods inherited from class edu.wisc.ssec.mcidasv.data.HydraDataSource

addPropertiesTabs, clearCachedData, doMakeDateTimes, getAdapters, isFileBased

Methods inherited from class ucar.unidata.data.DataSourceImpl

addActions, addDataChangeListener, addDataChoice, addReloadTab, applyFieldMask, applyProperties, beginWritingDataToLocalDisk, canAddCurrentName, canCacheDataToDisk, canChangeData, canDoAllLevels, canDoFieldMask, canDoGeoSelection, canDoGeoSelectionMap, canDoGeoSelectionStride, canPoll, canShowParameter, checkForInitAfterUnPersistence, clearFileCache, clearTimes, convertSourceFile, convertToFilesIfDirectory, createAutoDisplay, createCacheKey, createElement, decrOutstandingGetDataCalls, doDirectory, doMakeGeoSelectionPanel, doMakeGeoSelectionPanel, doMakeGeoSelectionPanel, doMakeGeoSubsetPropertiesComponent, doRemove, endWritingDataToLocalDisk, expandIfNeeded, findDataChoice, findDataChoices, flushCache, getAbsoluteDateTimes, getActions, getAlias, getAllDateTimes, getAllDateTimes, getAllLevels, getAllLevels, getAllTimesForTimeDriver, getCache, getCache, getCacheClearDelay, getCacheDataToDisk, getCompositeDataChoices, getData, getDataCachePath, getDataChangeListeners, getDataChoices, getDataContext, getDataInner, getDataIsEditable, getDataPaths, getDataPrefix, getDataSelection, getDataSelectionComponents, getDataSource, getDateTimes, getDateTimeSelection, getDefaultSave, getDescription, getDescriptor, getErrorMessage, getEverChangedName, getExtraGeoSelectionComponent, getExtraTimesComponent, getFileFilterForPolling, getFullDescription, getid, getIdv, getInError, getLocalDirectory, getLocationForPolling, getLocationsForPolling, getMostRecentFiles, getName, getNameForDataSource, getNeedToShowErrorToUser, getNextId, getOutstandingGetDataCalls, getPartialDescription, getPassword, getPathsThatCanBeRelative, getPollingInfo, getProperties, getPropertiesComponents, getPropertiesHeader, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getRelativePaths, getSampleDataProjection, getSaveDataFileLabel, getSelectedDateTimes, getSelectedDateTimes, getTimesFromDataSelection, getTmpPaths, getTypeName, getUserName, handlePropertiesAction, hasPollingInfo, holdsDateTimes, holdsIndices, identifiedBy, identifiedByName, incrOutstandingGetDataCalls, initAfter, initAfterCreation, initFromXml, isPolling, loadFieldMask, loadFieldMask, loadLatestFile, logException, logException, makeDerivedDataChoices, makeSaveLocalActions, newFileFromPolling, newFilesFromPolling, notifyDataChange, propertiesChanged, putCache, putCache, reloadData, reloadData, reloadProperties, removeCache, removeDataChangeListener, removeDataChoice, removeProperty, replaceDataChoice, resetTmpState, saveDataToLocalDisk, saveDataToLocalDisk, selectTimesFromList, setAlias, setAskToUpdate, setCacheClearDelay, setCacheDataToDisk, setDataEditableStrings, setDataIsEditable, setDataIsRelative, setDataRelativeStrings, setDataSelection, setDateTimeSelection, setDefaultSave, setDescription, setDescriptor, setDirectory, setEverChangedName, setInError, setInError, setInError, setName, setNewFiles, setObjectProperties, setObjectProperty, setPassword, setPollingInfo, setPollLocation, setProperties, setProperty, setProperty, setRelativePaths, setTemplateName, setTmpPaths, setUserName, shouldCache, shouldCache, showPasswordDialog, showPropertiesDialog, showPropertiesDialog, showPropertiesDialog, showWaitDialog, tick, toString, toStringTruncated, updateDetailsText, updateState, writeFieldMaskFile, writeFieldMaskFile

Methods inherited from class ucar.unidata.collab.SharableImpl

applySharableProperties, doShare, doShare, doShareExternal, doShareInternal, getReceiveShareTime, getSharablePropertiesComponent, getShareGroup, getSharing, getUniqueId, initSharable, receiveShareData, removeSharable, setReceiveShareTime, setShareGroup, setSharing, setUniqueId, showSharableDialog

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.unidata.data.DataSource

getUniqueId

Field Details

logger

private static final org.slf4j.Logger logger

filename

protected String filename

Sources file

oldSources

protected List<String> oldSources

geoSources

protected List<String> geoSources

filenameMap

Map<String,List<String>> filenameMap

nppAggReader

protected MultiDimensionReader nppAggReader

adapters

protected MultiDimensionAdapter[] adapters

msd_CrIS

private List<MultiSpectralData> msd_CrIS

multiSpectralData

private List<MultiSpectralData> multiSpectralData

msdMap

private Map<String,MultiSpectralData> msdMap

qfMap

private Map<String,QualityFlag> qfMap

lutMap

private Map<String,float[]> lutMap

DATA_DESCRIPTION

private static final String DATA_DESCRIPTION

See Also:

• Constant Field Values

instrumentName

Attribute instrumentName

productName

private String productName

whichEDR

String whichEDR

crisFilter

private String crisFilter

defaultSubset

private Map<String,double[]> defaultSubset

track_adapter

public TrackAdapter track_adapter

categories

private List<DataCategory> categories

isCombinedProduct

private boolean isCombinedProduct

isDerived

private boolean isDerived

nameHasBeenSet

private boolean nameHasBeenSet

isNOAA

private boolean isNOAA

isEnterprise

private boolean isEnterprise

SEPARATOR_CHAR

private static final String SEPARATOR_CHAR

See Also:

• Constant Field Values

sdfNASA

SimpleDateFormat sdfNASA

sdfEnterprise

SimpleDateFormat sdfEnterprise

m12LUT

float[] m12LUT

m13LUT

float[] m13LUT

m14LUT

float[] m14LUT

m15LUT

float[] m15LUT

m16LUT

float[] m16LUT

i04LUT

float[] i04LUT

i05LUT

float[] i05LUT

unitsNASA

Map<String,String> unitsNASA

unitsEnterprise

Map<String,String> unitsEnterprise

sdf

SimpleDateFormat sdf

sdfOut

SimpleDateFormat sdfOut

theDate

Date theDate

subset

Map<String,double[]> subset

derivedSubset

private Map<String,double[]> derivedSubset

derivedInit

private boolean derivedInit

Constructor Details

SuomiNPPDataSource

public SuomiNPPDataSource()

Zero-argument constructor for construction via unpersistence.

SuomiNPPDataSource

public SuomiNPPDataSource(String fileName)
                   throws VisADException

Throws:

VisADException

SuomiNPPDataSource

public SuomiNPPDataSource(DataSourceDescriptor descriptor,
 String fileName,
 Hashtable properties)
                   throws VisADException

Construct a new Suomi NPP HDF5 data source.

Parameters:

descriptor - descriptor for this DataSource

fileName - name of the hdf file to read

properties - hashtable of properties

Throws:

VisADException - problem creating data

SuomiNPPDataSource

public SuomiNPPDataSource(DataSourceDescriptor descriptor,
 List<String> newSources,
 Hashtable properties)
                   throws VisADException

Construct a new Suomi NPP HDF5 data source.

Parameters:

descriptor - Descriptor for this DataSource.

newSources - List of filenames.

properties - Hashtable of properties.

Throws:

VisADException - problem creating data

Method Details

setup

public void setup()
           throws VisADException

Throws:

VisADException

initDataChoice

public void initDataChoice(DataChoice dataChoice)

Description copied from class: ucar.unidata.data.DataSourceImpl

Sets the global id of the given dataChoice to be a per process unique string value. Used (for now) for persistence.

Overrides:

initDataChoice in class DataSourceImpl

Parameters:

dataChoice - dataChoice to initialize

initAfterUnpersistence

public void initAfterUnpersistence()

Description copied from class: ucar.unidata.data.DataSourceImpl

Implement the XmlPersistable interface method that is called after this object has been fully created and initialized after being unpersisted by the XmlEncoder.

Specified by:

initAfterUnpersistence in interface DataSource

Overrides:

initAfterUnpersistence in class DataSourceImpl

canSaveDataToLocalDisk

public boolean canSaveDataToLocalDisk()

Description copied from class: HydraDataSource

Can this data source save its dat to local disk

Specified by:

canSaveDataToLocalDisk in interface DataSource

Overrides:

canSaveDataToLocalDisk in class HydraDataSource

Returns:

can save to local disk

saveDataToLocalDisk

protected List saveDataToLocalDisk(String filePrefix,
 Object loadId,
 boolean changeLinks)
                            throws Exception

Description copied from class: ucar.unidata.data.DataSourceImpl

Save the data source files to local disk

Overrides:

saveDataToLocalDisk in class DataSourceImpl

Parameters:

filePrefix - This is the directory path to write the files to with the unique file identifier append to it

loadId - For stopping the load through the JobManager

changeLinks - Should this data source also change its internal data references

Returns:

List of the files that were written

Throws:

Exception - On badness

getOldSources

public List<String> getOldSources()

setOldSources

public void setOldSources(List<String> oldSources)

getFilenameMap

public Map<String,List<String>> getFilenameMap()

setFilenameMap

public void setFilenameMap(Map<String,List<String>> filenameMap)

doMakeDataChoices

public void doMakeDataChoices()

Make and insert the DataChoices for this DataSource.

Overrides:

doMakeDataChoices in class DataSourceImpl

doMakeDataChoice

private DataChoice doMakeDataChoice(int idx,
 String var,
 String description)
                             throws Exception

Throws:

Exception

doMakeDataChoice

private DataChoice doMakeDataChoice(int idx,
 MultiSpectralData adapter)
                             throws Exception

Throws:

Exception

equals

public boolean equals(Object o)

Check to see if this SuomiNPPDataSource is equal to the object in question.

Overrides:

equals in class DataSourceImpl

Parameters:

o - object in question

Returns:

true if they are the same or equivalent objects

getMultiSpectralData

public MultiSpectralData getMultiSpectralData()

getMultiSpectralData

public MultiSpectralData getMultiSpectralData(DataChoice choice)

getDatasetName

public String getDatasetName()

getQfMap

public Map<String,QualityFlag> getQfMap()

Returns:

the qfMap

setDatasetName

public void setDatasetName(String name)

isNOAA

public boolean isNOAA()

Determine if this data source originated from a "NOAA file".

Returns:

true if file came from NOAA, false otherwise.

getSubsetFromLonLatRect

public Map<String,double[]> getSubsetFromLonLatRect(MultiDimensionSubset select,
 GeoSelection geoSelection)

getData

public Data getData(DataChoice dataChoice,
 DataCategory category,
 DataSelection dataSelection,
 Hashtable requestProperties)
             throws VisADException,
RemoteException

Description copied from class: ucar.unidata.data.DataSourceImpl

Get the data applicable to the DataChoice and selection criteria.

Specified by:

getData in interface DataSource

Overrides:

getData in class DataSourceImpl

Parameters:

dataChoice - choice that defines the data

category - the data category

dataSelection - DataSelection for subsetting

requestProperties - extra request properties

Returns:

the associated data

Throws:

VisADException - VisAD problem

RemoteException - Java RMI problem

getDataInner

protected Data getDataInner(DataChoice dataChoice,
 DataCategory category,
 DataSelection dataSelection,
 Hashtable requestProperties)
                     throws VisADException,
RemoteException

Description copied from class: HydraDataSource

Get the data for the given DataChoice and selection criteria.

Overrides:

getDataInner in class HydraDataSource

Parameters:

dataChoice - DataChoice for selection

category - DataCategory for the DataChoice (not used)

dataSelection - subsetting criteria

requestProperties - extra request properties

Returns:

the Data object for the request

Throws:

VisADException - couldn't create the data

RemoteException - couldn't create a remote data object

applyProperties

protected Data applyProperties(Data data,
 Hashtable requestProperties,
 Map<String,double[]> subset,
 int adapterIndex)
                        throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

initDataSelectionComponents

protected void initDataSelectionComponents(List<DataSelectionComponent> components,
 DataChoice dataChoice)

Description copied from class: ucar.unidata.data.DataSourceImpl

Add any data selection components

Overrides:

initDataSelectionComponents in class DataSourceImpl

Parameters:

components - list of components

dataChoice - the data choice

initQfTranslations

public void initQfTranslations()

Add Integer->String translations to IDV's "translations" resource, so they will be made available to the data probe of Image Display's.