ucar.unidata.idv.control
Class DataTransectControl

java.lang.Object
  ucar.unidata.collab.SharableImpl
      ucar.unidata.idv.control.DisplayControlBase
          ucar.unidata.idv.control.DisplayControlImpl
              ucar.unidata.idv.control.GridDisplayControl
                  ucar.unidata.idv.control.CrossSectionControl
                      ucar.unidata.idv.control.DataTransectControl

All Implemented Interfaces:

ActionListener, ItemListener, PropertyChangeListener, EventListener, HyperlinkListener, Sharable, DataChangeListener, DisplayControl, Prototypable, ControlListener, DisplayListener

public class DataTransectControl
extends CrossSectionControl

Class for displaying transects of data along a cross section line.

Version:

$Revision: 1.31 $

Author:

IDV developers

Nested Class Summary

Nested classes/interfaces inherited from class ucar.unidata.idv.control.DisplayControlImpl

DisplayControlImpl.SideLegendLabel

Field Summary

Fields inherited from class ucar.unidata.idv.control.CrossSectionControl

coordTrans, crossSectionView, csSelector, dataIs3D, displayIs3D, endCoord, endLocation, SHARE_XSLINE, sizeX, sizeY, startCoord, startLocation, vcsDisplay, xsDisplay

Fields inherited from class ucar.unidata.idv.control.GridDisplayControl

CMD_CONTOURDIALOG, CMD_SETLEVELS, gridDataInstance, INITIAL_PROBE_EARTHLOCATION, log_, settingLevel

Fields inherited from class ucar.unidata.idv.control.DisplayControlImpl

categories, colorScaleInfo, colorScales, contourInfo, contourInfoParams, controlContext, ctw, cw, dataSelection, defaultView, defaultViewManager, DISPLAY_LIST_NAME, displayListTable, displayMasters, displayUnit, helpUrl, initNoteText, instantiatedWithNoData, noteTextArea, noteWrapper, paramName, requestProperties, settingVisibility, sharables, showNoteText, skipSlider, srw, version, viewManagers

Fields inherited from class ucar.unidata.idv.control.DisplayControlBase

CMD_BARBSIZE, CMD_COLORS, CMD_COLORTABLE, CMD_INTERVAL, CMD_LEVEL, CMD_LINEWIDTH, CMD_POPUP, CMD_REMOVE, DEFAULT_POINT_SIZE, DEFAULT_SAMPLING_MODE, FIND_ALL, FIND_CATEGORY, FIND_CLASS, FIND_SPECIAL, FIND_THIS, FIND_WITHDATA, FIND_WITHTHISDATA, FIND_WITHTHISFIELD, FIND_WITHTHISVIEW, FLAG_COLOR, FLAG_COLORTABLE, FLAG_COLORUNIT, FLAG_CONTOUR, FLAG_DATACONTROL, FLAG_DISPLAYUNIT, FLAG_LINEWIDTH, FLAG_NONE, FLAG_SELECTRANGE, FLAG_SKIPFACTOR, FLAG_TIMERANGE, FLAG_ZPOSITION, GRID_INSETS, ICON_LOCK, ICON_REMOVE, ICON_UNLOCK, LABEL_NONE, MACRO_DATASOURCENAME, MACRO_DISPLAYNAME, MACRO_DISPLAYUNIT, MACRO_LONGNAME, MACRO_POSITION, MACRO_SHORTNAME, MACRO_TIMESTAMP, MACRO_VALUE, NEAREST_NEIGHBOR, PREF_DISPLAYLIST_TEMPLATE, PREF_EXTRALABEL_TEMPLATE, PREF_LEGENDLABEL_TEMPLATE, PROP_REMOVED, SETTINGS_GROUP_DISPLAY, SETTINGS_GROUP_FLAGS, SHARE_CHOICES, SHARE_COLOR, SHARE_COLORSCALE, SHARE_COLORTABLE, SHARE_DISPLAYUNIT, SHARE_POSITION, SHARE_SELECTRANGE, SHARE_SKIPVALUE, SHARE_TRANSECT, SHARE_VISIBILITY, WEIGHTED_AVERAGE

Fields inherited from interface ucar.unidata.idv.DisplayControl

BOTTOM_LEGEND, DEFAULT_PROBEFORMAT, PREF_PREFIX, PREF_PROBEFORMAT, PREF_REMOVEONWINDOWCLOSE, PREF_SAMPLING_MODE, PREF_STANDALONE_REMOVEONCLOSE, PREF_STANDALONE_REMOVEONCLOSE_ASK, PROP_LEGENDICON, SIDE_LEGEND

Constructor Summary

DataTransectControl()
Default Constructor

Method Summary

void	addToRangeMenu(RangeWidget rw, List items) Add an entry into the range menu
protected void	applyDisplayUnit() Apply the display unit to the data depictions.
protected void	applyRange() Apply the data range to the data depictions.
protected void	createCrossSectionSelector() Make a Selector line which shows and controls where cross section is
protected DisplayableData	createVCSDisplay() Create the DisplayableData that will be used to depict the data in the cross section view display.
protected DisplayableData	createXSDisplay() Create the DisplayableData that will be used to depict the data in the main display.
void	getControlWidgets(List controlWidgets) Add control widgets specific to this control to the list
protected String	getCrossSectionViewLabel() Get the label for the CrossSectionView
int	getLineWidth() Get the track width property.
protected int	getSelectorAttributeFlags() Return the attribute flags to apply to the cross section selector.
boolean	init(DataChoice dataChoice) Initialize the class.
protected void	load2DData(FieldImpl twoDData) Load the 2D data into the appropriate display(s)
protected FieldImpl	make2DData(FieldImpl xsectSequence) Make a FieldImpl suitable for the plain 2D vert cross section display; of form (time -> ((x) -> parm)); new x axis positions are in distance along cross section from one end.
void	setLineWidth(int width) Set the line width property.
protected void	setYAxisRange(XSDisplay display, Range range) Methods to do the things that need to be done when the data range changes.
protected void	updateViewParameters() Set the parameters for the view.

Methods inherited from class ucar.unidata.idv.control.CrossSectionControl

addLabelMacros, addPropertiesComponents, addTopographyMap, applyPreferences, canExportData, convertToDisplay, createXFromLatLon, crossSectionChanged, doApplyProperties, doMakeContents, doRemove, getAllowAutoScale, getAnimationInfo, getAutoScaleYAxis, getAutoUpdate, getCrossSectionSelector, getCrossSectionView, getCrossSectionViewManager, getCursorReadoutInner, getDataProjection, getDisplayedData, getDisplayTabComponent, getEditMenuItems, getEndCoord, getGridDisplayable, getInitialZPosition, getLineCoords, getMacroNames, getStartCoord, getVerticalAxisRange, getVerticalCSDisplay, getViewMenuItems, getXSDisplay, getZPositionSliderLabel, initAfterUnPersistence, initDone, loadData, loadDataFromLine, projectionChanged, propertyChange, receiveShareData, reScale, setAllowAutoScale, setAnimationInfo, setAutoScaleYAxis, setAutoUpdate, setBackground, setCrossSectionView, setData, setDisplayMatrix, setEndCoord, setForeground, setStartCoord, setVerticalAxisRange, shouldAddControlListener, transectChanged, updateLocationLabel, viewpointChanged

Methods inherited from class ucar.unidata.idv.control.GridDisplayControl

actionPerformed, addTopographyMap, convertColorRange, doMakeContourLevelControl, doMakeDataInstance, doMakeLevelControl, doMakeLevelControl, getColorParamName, getColorRangeFromData, getColorRangeIndex, getColorUnit, getContourInfo, getCursorReadoutData, getDefaultContourInfo, getDisplayUnit, getGridDataInstance, getInitialColorTable, getInitialRange, getRawDataUnit, haveMultipleFields, initializeDefaultContourInfo, isDisplayUnitAlsoColorUnit, setLevel, setLevel, setLevelFromUser

Methods inherited from class ucar.unidata.idv.control.DisplayControlImpl

activateDisplays, addAttributedDisplayable, addAttributedDisplayable, addAttributedDisplayable, addAttributeFlags, addCheckBoxSettings, addDataChoice, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayable, addDisplayMaster, addDisplaySettings, addNewData, addNoteText, addPropertyChangeListener, addSharable, addToRangeMenu, addToRangeMenu, addViewManager, appendDataChoices, applyAttributesToDisplayables, applyColor, applyColorScaleInfo, applyColorTable, applyColorUnit, applyContourInfo, applyDisplaySetting, applyLineWidth, applyProperties, applyProperties, applyPropertyValues, applySelectRange, applySkipFactor, applyTimeRange, applyZPosition, boundsClose, canBeDocked, canSaveDataInCache, captureWindow, changeColorUnit, changeDisplayUnit, checkFlag, checkIfDataOk, checkImageSize, clearDataInstance, clearPrototype, clearViewManagers, close, colorUnitChanged, controlChanged, convertColorRange, convertRange, createDisplayListDisplayable, createIdvWindow, dataChanged, deactivateDisplays, debug, displayableToFront, displayChanged, displayControlFailed, displayUnitChanged, doMakeBottomLegendComponent, doMakeChangeColorMenu, doMakeChangeColorMenu, doMakeChangeParameterMenuItem, doMakeColorControl, doMakeColorControl, doMakeColorScales, doMakeMenuBar, doMakeMenuBarMenus, doMakeRemoveControl, doMakeSideLegendComponent, doMakeSkipFactorSlider, doMakeVisibilityControl, doMakeWidgetComponent, doMakeWindow, doMakeZPositionSlider, exportDisplayedData, findDisplayInfo, findDisplays, findDisplays, firePropertyChangeEvent, firstFrameDone, formatForCursorReadout, getActive, getAnimation, getAnimation, getAnimation, getAnimation, getAnimationWidget, getAttributeFlags, getCachedData, getCanDoRemoveAll, getCategories, getChangeParameterLabel, getCollapseLegend, getColor, getColorDimness, getColorScaleInfo, getColorTable, getColorTableForDisplayable, getColorTableToApply, getColorTableWidget, getColorUnitName, getColorWidgetLabel, getComponentHolder, getContents, getControlChangeSleepTime, getControlContext, getCursorReadout, getDataChoice, getDataChoices, getDataInstance, getDataInstance, getDataProjectionForMenu, getDataProjectionLabel, getDataSelection, getDataSources, getDataTimeRange, getDataTimeRange, getDataTimeSet, getDebugDetails, getDefaultColorScaleInfo, getDefaultDistanceUnit, getDefaultFastRendering, getDefaultSamplingMode, getDefaultSamplingModeValue, getDefaultView, getDefaultViewDescriptor, getDefaultViewManager, getDetailsContents, getDisplayAltitudeType, getDisplayCategory, getDisplayCenter, getDisplayConventions, getDisplayId, getDisplayInfos, getDisplayListColor, getDisplayListData, getDisplayListDisplayable, getDisplayListTemplate, getDisplayMaster, getDisplayName, getDisplayScale, getDisplayUnit, getDisplayUnitName, getDisplayVisibility, getDoCursorReadout, getEditMenuItems, getExpandedInTabs, getExtraLabelTemplate, getExtraLegendComponent, getExtraMenus, getFileMenuItems, getFileMenuItems, getGraphicsConfiguration, getHadDataChoices, getHaveInitialized, getHelpIds, getHelpMenuItems, getId, getIdv, getImage, getImage, getInitDataChoices, getLabel, getLastFileMenuItems, getLegendButtons, getLegendComponent, getLegendLabel, getLegendLabels, getLegendLabelTemplate, getLegendToolTip, getLineWidthWidget, getLineWidthWidgetLabel, getLockVisibilityToggle, getLongParamName, getMainPanel, getMainPanelSize, getMakeWindow, getMapDisplay, getMapViewManager, getMapViewProjection, getMenuLabel, getMyDataChoices, getNavigatedDisplay, getNoteText, getObjectStore, getOkToFireEvents, getOldColorTableOrInitialColorTable, getOriginalDataChoicesLabel, getOuterContents, getProperty, getProperty, getPropertyDisplayName, getRange, getRangeForColorTable, getRangeToApply, getRequestProperties, getSamplingModeName, getSamplingModeValue, getSaveMenuItems, getSelectRange, getSelectRangeEnabled, getSelectRangeWidget, getSettingsPanel, getShortParamName, getShowInDisplayList, getShowInLegend, getShowInTabs, getShowNoteText, getSkipValue, getSkipWidgetLabel, getStore, getTemplateName, getTimeSet, getTitle, getTransientProperty, getUnitForColor, getUseFastRendering, getUseTimesInAnimation, getVersion, getVerticalValue, getViewContext, getViewer, getViewManager, getViewManager, getViewManager, getViewManagerClassNames, getViewManagers, getViewMenuItems, getWasUnPersisted, getWindow, getWindowSize, getWindowVisible, getWindowX, getWindowY, getZPosition, guiExported, guiImported, handleDisplayChanged, handleWindowClosing, hasMapProjection, haveDataTimes, haveParameterDefaults, hide, hyperlinkUpdate, init, init, init, initAfterUnPersistence, initAsPrototype, initAsTemplate, initBasic, initializeWithNewData, initWindow, isDisplay3D, isGuiShown, isInitDone, isInTransectView, isInViewManager, itemStateChanged, makeChangeColorMenuItems, makeLegendLabel, makeLockButton, makeRemoveButton, moveTo, notifyViewManagersOfChange, parseProperties, popup, popupDataDialog, popupDataDialog, popupDataDialog, processRequestProperties, putTransientProperty, redoGuiLayout, reloadDataSource, reloadDataSourceInThread, removeDataChoice, removeDisplayable, removeDisplayables, removeOnWindowClose, removePropertyChangeListener, resetData, resetDimness, resetViewManager, revertToDefaultColorTable, revertToDefaultColorTable, revertToDefaultRange, revertToDefaultRange, saveAsFavorite, saveAsParameterDefaults, saveAsPrototype, saveAsTemplate, saveDataChoiceInCache, saveImage, setAnimationSet, setAttributeFlags, setCachedData, setCanDoRemoveAll, setCategories, setCollapseLegend, setColor, setColorBrighter, setColorDimmer, setColorDimness, setColorScaleInfo, setColorScaleVisible, setColorTable, setColorTable, setColorTableName, setColorUnit, setColorUnitName, setComponentHolder, setContents, setContourInfo, setContourInfoParams, setData, setDataChoices, setDataInstance, setDataInstances, setDataSelection, setDataTimeRange, setDefaultSamplingMode, setDefaultView, setDisplayableVisibility, setDisplayableVisiblity, setDisplayActive, setDisplayCategory, setDisplayId, setDisplayInactive, setDisplayListColor, setDisplayListProperties, setDisplayListTemplate, setDisplayName, setDisplayUnit, setDisplayUnitName, setDisplayVisibility, setDoCursorReadout, setExpandedInTabs, setExtraLabelTemplate, setHadDataChoices, setHelpUrl, setId, setInitDataChoices, setInitialSettings, setLabelAsPreference, setLegendBackground, setLegendForeground, setLegendLabel, setLegendLabelTemplate, setLockVisibilityToggle, setMainPanelDimensions, setMainPanelSize, setMakeWindow, setName, setNameFromUser, setNewColorUnit, setNewDisplayUnit, setNoteText, setOkToFireEvents, setOriginalDataChoicesLabel, setParamName, setPersistedVisadData, setProjectionInView, setProjectionInView, setProperty, setRange, setRange, setSelectRange, setSelectRangeEnabled, setSettingsDisplayUnit, setSharedColorScaleInfo, setShowInDisplayList, setShowInLegend, setShowInTabs, setShowNoteText, setSkipValue, setTemplateName, setTitle, setUnitForColor, setUseFastRendering, setUseTimesInAnimation, setVersion, setViewer, setViewManagerClassNames, setWindowSize, setWindowVisible, setWindowX, setWindowY, setZPosition, shouldAddAnimationListener, shouldAddDisplayListener, shouldApplyFastRendering, shouldBeDocked, shouldWindowBeVisible, show, showColorControlWidget, showColorDialog, showColorDialog, showColorScaleDialog, showColorScales, showColorSwatches, showContourPropertiesDialog, showDetails, showDisplaySettingsDialog, showHelp, showLegendMenu, showNormalCursor, showProperties, showTimeRangeDialog, showWaitCursor, timeChanged, toFront, toggleNoteTextArea, toggleWindow, toString, updateAnimation, updateDisplayList, updateLegendAndList, updateLegendLabel, updateLockButton, useZPosition, viewManagerChanged, viewManagerDestroyed, writeTestArchive, xxxsetDisplayActive, zSliderChanged

Methods inherited from class ucar.unidata.idv.control.DisplayControlBase

boxToEarth, boxToEarth, boxToEarth, boxToEarth, boxToEarth, boxToScreen, calculateRectangle, createStationTfo, earthToBox, earthToBox, earthToBoxTuple, earthToScreen, formatLevels, getScreenCenter, getSelectedStation, isLeftButtonDown, logException, logException, makeEarthLocation, screenToBox, screenToBox, screenToEarth, setStations, setStations, toBox, toEarth, userErrorMessage, userMessage

Methods inherited from class ucar.unidata.collab.SharableImpl

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.unidata.collab.Sharable

getShareGroup, getSharing, getUniqueId

Constructor Detail

DataTransectControl

public DataTransectControl()

Default Constructor

Method Detail

createCrossSectionSelector

protected void createCrossSectionSelector()
                                   throws VisADException,
                                          RemoteException

Make a Selector line which shows and controls where cross section is

Overrides:

createCrossSectionSelector in class CrossSectionControl

Throws:

RemoteException - Java RMI error

VisADException - VisAD error

getSelectorAttributeFlags

protected int getSelectorAttributeFlags()

Return the attribute flags to apply to the cross section selector.

Overrides:

getSelectorAttributeFlags in class CrossSectionControl

Returns:

Flags to use

getControlWidgets

public void getControlWidgets(List controlWidgets)
                       throws VisADException,
                              RemoteException

Add control widgets specific to this control to the list

Overrides:

getControlWidgets in class CrossSectionControl

Parameters:

controlWidgets - list of control widgets

Throws:

RemoteException - Java RMI error

VisADException - VisAD Error

createVCSDisplay

protected DisplayableData createVCSDisplay()
                                    throws VisADException,
                                           RemoteException

Create the DisplayableData that will be used to depict the data in the cross section view display.

Specified by:

createVCSDisplay in class CrossSectionControl

Returns:

depictor for data in main display

Throws:

VisADException - unable to create depictor

RemoteException - unable to create depictor (shouldn't happen)

createXSDisplay

protected DisplayableData createXSDisplay()
                                   throws VisADException,
                                          RemoteException

Create the DisplayableData that will be used to depict the data in the main display.

Specified by:

createXSDisplay in class CrossSectionControl

Returns:

depictor for data in main display

Throws:

VisADException - unable to create depictor

RemoteException - unable to create depictor (shouldn't happen)

init

public boolean init(DataChoice dataChoice)
             throws VisADException,
                    RemoteException

Initialize the class.

Overrides:

init in class CrossSectionControl

Parameters:

dataChoice - data description

Returns:

true if successful

Throws:

RemoteException - Java RMI error

VisADException - VisAD error

load2DData

protected void load2DData(FieldImpl twoDData)
                   throws VisADException,
                          RemoteException

Load the 2D data into the appropriate display(s)

Overrides:

load2DData in class CrossSectionControl

Parameters:

twoDData - cross section slice converted to 2D

Throws:

RemoteException - Java RMI error

VisADException - VisAD error

addToRangeMenu

public void addToRangeMenu(RangeWidget rw,
                           List items)

Add an entry into the range menu

Overrides:

addToRangeMenu in class DisplayControlImpl

Parameters:

rw - The widget that manages the range dialog

items - List of menu items

applyDisplayUnit

protected void applyDisplayUnit()
                         throws VisADException,
                                RemoteException

Apply the display unit to the data depictions.

Overrides:

applyDisplayUnit in class DisplayControlImpl

Throws:

VisADException - error applying unit

RemoteException - error applying unit

applyRange

protected void applyRange()
                   throws VisADException,
                          RemoteException

Apply the data range to the data depictions.

Overrides:

applyRange in class DisplayControlImpl

Throws:

VisADException - error applying unit

RemoteException - error applying unit

getCrossSectionViewLabel

protected String getCrossSectionViewLabel()

Get the label for the CrossSectionView

Overrides:

getCrossSectionViewLabel in class CrossSectionControl

Returns:

return the name of the cross section view

updateViewParameters

protected void updateViewParameters()
                             throws VisADException,
                                    RemoteException

Set the parameters for the view. Mostly deals with the vertical scale.

Overrides:

updateViewParameters in class CrossSectionControl

Throws:

RemoteException - Java RMI error

VisADException - VisAD error

setYAxisRange

protected void setYAxisRange(XSDisplay display,
                             Range range)
                      throws VisADException,
                             RemoteException

Methods to do the things that need to be done when the data range changes.

Overrides:

setYAxisRange in class CrossSectionControl

Parameters:

display - the display to modify

range - Range of values in units of Y Axis

Throws:

RemoteException - Java RMI error

VisADException - VisAD error

make2DData

protected FieldImpl make2DData(FieldImpl xsectSequence)
                        throws VisADException,
                               RemoteException

Make a FieldImpl suitable for the plain 2D vert cross section display; of form (time -> ((x) -> parm)); new x axis positions are in distance along cross section from one end. override from superclass since we are dealing only with 2D data.

Overrides:

make2DData in class CrossSectionControl

Parameters:

xsectSequence - the time sequence of cross section data

Returns:

xsectSequence transformed to 2D

Throws:

RemoteException - Java RMI error

VisADException - VisAD error

setLineWidth

public void setLineWidth(int width)

Set the line width property. Used by persistence

Overrides:

setLineWidth in class DisplayControlImpl

Parameters:

width - width for line (pixels)

getLineWidth

public int getLineWidth()

Get the track width property. Used by persistence

Overrides:

getLineWidth in class DisplayControlImpl

Returns:

width