Package edu.wisc.ssec.mcidasv.probes

Class ReadoutProbe

java.lang.Object

ucar.unidata.collab.SharableImpl

edu.wisc.ssec.mcidasv.probes.ReadoutProbe

All Implemented Interfaces:

PropertyChangeListener, EventListener, Sharable, DisplayListener

public class ReadoutProbe
extends SharableImpl
implements PropertyChangeListener, DisplayListener

ReadoutProbe is a probe that combines a "pickable" probe widget with an adjacent text "readout" of the data value at the probe's current location.

Primarily used with MultiSpectralControl.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReadoutProbe.PointSelector	This class is a reimplementation of PointProbe that whose mouse movement is limited to the x- and y- axes.

Field Summary

Fields

Modifier and Type	Field	Description
private Color	currentColor
private double	currentLatitude
private double	currentLongitude
private String	currentValue
private static final Color	DEFAULT_COLOR
private FlatField	field
private float	lastScale	Used to keep track of the last zoom "level".
private final List<ProbeListener>	listeners
private static final org.slf4j.Logger	logger
private final DisplayMaster	master
private static final DecimalFormat	numFmt
private final ReadoutProbe.PointSelector	pointSelector
private float	pointSize
static final String	SHARE_POSITION
static final String	SHARE_PROFILE
private static final TupleType	TUPTYPE
private final TextDisplayable	valueDisplay	Displays the value of the data at the current position.

Constructor Summary

Constructors

Constructor	Description
ReadoutProbe(DisplayControlImpl control, FlatField flatField, Color color, String pattern, boolean visible)	Create a "HYDRA" probe that allows for displaying things like value at current position, current color, and location.

Method Summary

Modifier and Type	Method	Description
private void	addListeners()	Add this probe instance to the relevant listeners.
void	addProbeListener(ProbeListener listener)	Adds a ProbeListener to the listener list so that it can be notified when the probe is changed.
private static TextDisplayable	createValueDisplay(Color color)
void	displayChanged(DisplayEvent e)	Called for events happening in the DisplayImpl associated with DisplayMaster.
protected void	fireProbeColorChanged(Color previous, Color current)	Notifies the registered ProbeListeners that this probe's color has changed.
protected void	fireProbeFormatPatternChanged(String previous, String current)	Notifies the registered ProbeListeners that this probe's location format pattern has changed.
protected void	fireProbePositionChanged(RealTuple previous, RealTuple current)	Notifies the registered ProbeListeners that this probe's position has changed.
protected void	fireProbeVisibilityChanged(boolean previous)	Notifies registered ProbeListeners that this probe's visibility has changed.
Color	getColor()	Get the current color of this ReadoutProbe instance.
final float	getDisplayScale()	Get the scaling factor for probes and such.
EarthLocationTuple	getEarthPosition()	Get the current "earth location" of the probe.
String	getFormatPattern()	Returns the number format string current being used.
private static RealTuple	getInitialProbePosition()
double	getLatitude()	Get the current latitude of this ReadoutProbe instance.
double	getLongitude()	Get the current longitude of this ReadoutProbe instance.
ReadoutProbe.PointSelector	getPointSelector()
String	getValue()	Get the current "readout value" of this ReadoutProbe instance.
TextDisplayable	getValueDisplay()
RealTuple	getXYPosition()
void	handleProbeRemoval()	Called when this probe has been removed.
void	handleProbeUpdate()
boolean	hasListener(ProbeListener listener)	Determine whether or not a given ProbeListener is listening to the current probe.
static RealTuple	makeEarth2dTuple(double lat, double lon)	Returns a SpatialEarth2DTuple for the given latitude and longitude.
private static TupleType	makeTupleType()
void	projectionChanged(MapProjection newProjection)	Respond to the projection having been changed.
void	propertyChange(PropertyChangeEvent e)	Called whenever the probe fires off a PropertyChangeEvent.
void	quietlySetColor(Color newColor)
void	quietlySetFormatPattern(String pattern)	Update the location format pattern for the current probe, but do not fire off any events.
void	quietlySetVisible(boolean visibility)
void	removeProbeListener(ProbeListener listener)	Removes a ProbeListener from the notification list.
void	setColor(Color color)	Change the color of this ReadoutProbe instance.
private void	setColor(Color color, boolean quietly)	Change the color of this ReadoutProbe instance and control whether or not listeners should be notified.
void	setField(FlatField flatField)	Sets the FlatField associated with this probe to the given field.
void	setFormatPattern(String pattern)	Update the location format pattern for the current probe.
private void	setFormatPattern(String pattern, boolean quietly)	Update the location format pattern for the current probe and optionally fire off an update event.
void	setLatLon(double latitude, double longitude)
void	setXYPosition(RealTuple position)
String	toString()	Returns a brief summary of a ReadoutProbe.
private Tuple	valueAtPosition(RealTuple position, FlatField imageData)

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

SHARE_PROFILE

public static final String SHARE_PROFILE

See Also:

• Constant Field Values

SHARE_POSITION

public static final String SHARE_POSITION

See Also:

• Constant Field Values

DEFAULT_COLOR

private static final Color DEFAULT_COLOR

TUPTYPE

private static final TupleType TUPTYPE

logger

private static final org.slf4j.Logger logger

listeners

private final List<ProbeListener> listeners

valueDisplay

private final TextDisplayable valueDisplay

Displays the value of the data at the current position.

pointSelector

private final ReadoutProbe.PointSelector pointSelector

master

private final DisplayMaster master

currentColor

private Color currentColor

currentValue

private String currentValue

currentLatitude

private double currentLatitude

currentLongitude

private double currentLongitude

pointSize

private float pointSize

field

private FlatField field

numFmt

private static final DecimalFormat numFmt

lastScale

private float lastScale

Used to keep track of the last zoom "level".

Constructor Details

ReadoutProbe

public ReadoutProbe(DisplayControlImpl control,
 FlatField flatField,
 Color color,
 String pattern,
 boolean visible)
             throws VisADException,
RemoteException

Create a "HYDRA" probe that allows for displaying things like value at current position, current color, and location.

Note: none of the parameters permit null values.

Parameters:

control - "Layer" that will be probed.

flatField - Data to probe.

color - Color of the probe.

pattern - Format string to use with probe's location values.

visible - Whether or not the probe is visible.

Throws:

NullPointerException - if any of the given parameters are null.

VisADException - if VisAD had problems.

RemoteException - if VisAD had problems.

Method Details

addListeners

private void addListeners()

Add this probe instance to the relevant listeners.

propertyChange

public void propertyChange(PropertyChangeEvent e)

Called whenever the probe fires off a PropertyChangeEvent.

Only handles position changes right now, all other events are discarded.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

e - Object that describes the property change.

Throws:

NullPointerException - if passed a null PropertyChangeEvent.

displayChanged

public void displayChanged(DisplayEvent e)

Called for events happening in the DisplayImpl associated with DisplayMaster.

The only event that is actually handled is DisplayEvent.FRAME_DONE, which allows us to snap the text value displayable to the actual "pickable" probe.

Specified by:

displayChanged in interface DisplayListener

Parameters:

e - Event to handle.

setField

public void setField(FlatField flatField)

Sets the FlatField associated with this probe to the given field.

Parameters:

flatField - New FlatField for this probe.

Throws:

NullPointerException - if passed a null field.

addProbeListener

public void addProbeListener(ProbeListener listener)

Adds a ProbeListener to the listener list so that it can be notified when the probe is changed.

Parameters:

listener - ProbeListener to register. null listeners are not allowed.

Throws:

NullPointerException - if listener is null.

removeProbeListener

public void removeProbeListener(ProbeListener listener)

Removes a ProbeListener from the notification list.

Parameters:

listener - ProbeListener to remove. null values are permitted, but since they are not allowed to be added...

hasListener

public boolean hasListener(ProbeListener listener)

Determine whether or not a given ProbeListener is listening to the current probe.

Parameters:

listener - ProbeListener to check. null values are permitted.

Returns:

true if listener has been added to the list of ProbeListener objects, false otherwise.

fireProbePositionChanged

protected void fireProbePositionChanged(RealTuple previous,
 RealTuple current)

Notifies the registered ProbeListeners that this probe's position has changed.

Parameters:

previous - Previous position. Cannot be null.

current - Current position. Cannot be null.

fireProbeColorChanged

protected void fireProbeColorChanged(Color previous,
 Color current)

Notifies the registered ProbeListeners that this probe's color has changed.

Parameters:

previous - Previous color. Cannot be null.

current - Current color. Cannot be null.

fireProbeVisibilityChanged

protected void fireProbeVisibilityChanged(boolean previous)

Notifies registered ProbeListeners that this probe's visibility has changed. Only takes a "previous" value, which is negated to form the "current" value.

Parameters:

previous - Visibility before change.

fireProbeFormatPatternChanged

protected void fireProbeFormatPatternChanged(String previous,
 String current)

Notifies the registered ProbeListeners that this probe's location format pattern has changed.

Parameters:

previous - Previous location format pattern.

current - Current location format pattern.

setColor

public void setColor(Color color)

Change the color of this ReadoutProbe instance.

Parameters:

color - New color. Cannot be null.

getPointSelector

public ReadoutProbe.PointSelector getPointSelector()

getValueDisplay

public TextDisplayable getValueDisplay()

setColor

private void setColor(Color color,
 boolean quietly)

Change the color of this ReadoutProbe instance and control whether or not listeners should be notified.

Note that if color is the same as currentColor, nothing will happen (the method exits early).

Parameters:

color - New color for this probe. Cannot be null.

quietly - Whether or not to notify the list of ProbeListeners of a color change.

getColor

public Color getColor()

Get the current color of this ReadoutProbe instance.

Returns:

Color of this ReadoutProbe.

getValue

public String getValue()

Get the current "readout value" of this ReadoutProbe instance.

Returns:

The value of the data at the probe's current location.

getLatitude

public double getLatitude()

Get the current latitude of this ReadoutProbe instance.

Returns:

Current latitude of the probe.

getLongitude

public double getLongitude()

Get the current longitude of this ReadoutProbe instance.

Returns:

Current longitude of the probe.

setLatLon

public void setLatLon(double latitude,
 double longitude)

quietlySetVisible

public void quietlySetVisible(boolean visibility)

quietlySetColor

public void quietlySetColor(Color newColor)

setFormatPattern

public void setFormatPattern(String pattern)

Update the location format pattern for the current probe.

Parameters:

pattern - New location format pattern. Cannot be null.

quietlySetFormatPattern

public void quietlySetFormatPattern(String pattern)

Update the location format pattern for the current probe, but do not fire off any events.

Parameters:

pattern - New location format pattern. Cannot be null.

setFormatPattern

private void setFormatPattern(String pattern,
 boolean quietly)

Update the location format pattern for the current probe and optionally fire off an update event.

Parameters:

pattern - New location format pattern. Cannot be null.

quietly - Whether or not to fire a format pattern change update.

getFormatPattern

public String getFormatPattern()

Returns the number format string current being used.

Returns:

Location format pattern string.

handleProbeUpdate

public void handleProbeUpdate()

handleProbeRemoval

public void handleProbeRemoval()

Called when this probe has been removed.

getDisplayScale

public final float getDisplayScale()

Get the scaling factor for probes and such. The scaling is the parameter that gets passed to TextControl.setSize() and ShapeControl.setScale().

Returns:

ratio of the current matrix scale factor to the saved matrix scale factor.

setXYPosition

public void setXYPosition(RealTuple position)

getXYPosition

public RealTuple getXYPosition()

getEarthPosition

public EarthLocationTuple getEarthPosition()

Get the current "earth location" of the probe.

Note: this method will attempt to change the currentLatitude and currentLongitude fields.

Returns:

Location of pointSelector, or null if the location could not be determined.

projectionChanged

public void projectionChanged(MapProjection newProjection)

Respond to the projection having been changed.

Parameters:

newProjection - New projection. Can be null.

valueAtPosition

private Tuple valueAtPosition(RealTuple position,
 FlatField imageData)

makeEarth2dTuple

public static RealTuple makeEarth2dTuple(double lat,
 double lon)
                                  throws VisADException,
RemoteException

Returns a SpatialEarth2DTuple for the given latitude and longitude.

Be aware that for whatever reason VisAD wants the longitude first, then the latitude.

Parameters:

lat - Latitude of the position.

lon - Longitude of the position.

Returns:

SpatialEarth2DTuple containing lat and lon.

Throws:

VisADException - Problem creating VisAD object.

RemoteException - Java RMI error.

getInitialProbePosition

private static RealTuple getInitialProbePosition()

createValueDisplay

private static TextDisplayable createValueDisplay(Color color)

makeTupleType

private static TupleType makeTupleType()

toString

public String toString()

Returns a brief summary of a ReadoutProbe. Please note that this format is subject to change.

Overrides:

toString in class Object

Returns:

String that looks like [ReadProbe@HASHCODE: color=..., latitude=..., longitude=..., value=...]