Package gov.nih.mipav.view

Interface VOIHandlerInterface

All Superinterfaces:

java.awt.event.ActionListener, java.util.EventListener, javax.swing.event.MouseInputListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener

All Known Implementing Classes:

VOILatticeManagerInterface, VOIManagerInterface

public interface VOIHandlerInterface
extends java.awt.event.ActionListener, javax.swing.event.MouseInputListener

VOIHandlerInterface. Defines a list of functions expected of the VOI handling classes. Some are deprecated and should be replaced with the actionPerformed(ActionEvent) function.

See Also:

which implements this VOIHandlerInterface.

Method Summary

Modifier and Type	Method	Description
void	addVOIUpdateListener(UpdateVOISelectionListener listener)	Add a UpdateVOISelectionListener so it will receive VOI selection updates.
void	deleteSelectedVOI(boolean contoursOnly)	Deprecated.
void	deleteVOIs()	Delete all VOIs.
void	disposeLocal(boolean flag)	Dispose of the implementing class.
void	fireVOISelectionChange(VOI voi)	Communicates a selection change to all UpdateVOISelectionListeners.
void	fireVOISelectionChange(VOI voi, VOIBase curve)	Communicates a selection change to all UpdateVOISelectionListeners.
ModelImage	getActiveImage()	Returns the current active image.
java.awt.Component	getComponentImage()	Returns the Component displaying the current active image.
int	getVOI_ID()	Deprecated.
void	graph25VOI_CalcInten(boolean totalIntensity, boolean useThreshold, float threshold)	Generates and displays a 1D graph of the average or total intensity of 2.5 VOI of 2.5D image (3D).
boolean	isNewVoiNeeded(int voiType)	Deprecated.
void	newVOI(float presetHue)	Initiate a new VOI.
boolean	propVOI(int direction, boolean active)	Deprecated.
boolean	propVOIAll()	Deprecated.
void	removeVOIUpdateListener(UpdateVOISelectionListener listener)	Removes the UpdateVOISelectionListener from the list.
void	resetLivewire()	Resets the current livewire VOI.
void	selectAllVOIs(boolean doSelect)	Deprecated.
void	setCenter(WildMagic.LibFoundation.Mathematics.Vector3f center)	Deprecated.
void	setCenter(WildMagic.LibFoundation.Mathematics.Vector3f center, boolean bParent)	Sets the current displayed slice for 3D images.
void	setPresetHue(float presetHue)	Sets the hue that will be used to draw the new VOI.
void	setVOI_IDs(int ID, int UID)	Deprecated.
void	showColorDialog()	Opens the color dialog for changing the selected VOI color.

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Method Detail

addVOIUpdateListener

void addVOIUpdateListener(UpdateVOISelectionListener listener)

Add a UpdateVOISelectionListener so it will receive VOI selection updates.

Parameters:

listener - new UpdateVOISelectionListener.

deleteSelectedVOI

void deleteSelectedVOI(boolean contoursOnly)

Deprecated.

Delete the selected VOI. This function is deprecated, replace with actionPerformed() using CustomUIBuilder.PARAM_VOI_DELETE

Parameters:

contoursOnly - when true only delete the selected contours in the VOI, do not delete the VOI.

deleteVOIs

void deleteVOIs()

Delete all VOIs.

disposeLocal

void disposeLocal(boolean flag)

Dispose of the implementing class.

Parameters:

flag - not used.

fireVOISelectionChange

void fireVOISelectionChange(VOI voi)

Communicates a selection change to all UpdateVOISelectionListeners.

Parameters:

voi - the modified VOI.

fireVOISelectionChange

void fireVOISelectionChange(VOI voi,
                            VOIBase curve)

Communicates a selection change to all UpdateVOISelectionListeners.

Parameters:

voi - modified VOI.

curve - modified VOIBase.

getActiveImage

ModelImage getActiveImage()

Returns the current active image.

Returns:

current active image.

getComponentImage

java.awt.Component getComponentImage()

Returns the Component displaying the current active image.

Returns:

the Component displaying the current active image.

getVOI_ID

int getVOI_ID()

Deprecated.

Returns:

0.

graph25VOI_CalcInten

void graph25VOI_CalcInten(boolean totalIntensity,
                          boolean useThreshold,
                          float threshold)

Generates and displays a 1D graph of the average or total intensity of 2.5 VOI of 2.5D image (3D).

Parameters:

totalIntensity - if true calculates total sum of the intensity else calculates the average pixel intensity

useThreshold - whether or not to threshold this intensity plot

threshold - the threshold value to use, if thresholding.

isNewVoiNeeded

boolean isNewVoiNeeded(int voiType)

Deprecated.

Parameters:

voiType -

Returns:

false

newVOI

void newVOI(float presetHue)

Initiate a new VOI.

Parameters:

presetHue - new VOI color

propVOI

boolean propVOI(int direction,
                boolean active)

Deprecated.

Propagates the selected VOI in a given direction. This function is deprecated, replace with actionPerformed(ActionEvent) using CustomUIBuilder.PARAM_VOI_PROPAGATE_UP or CustomUIBuilder.PARAM_VOI_PROPAGATE_DOWN

Parameters:

direction - Up +1, or Down -1

active - unused.

Returns:

true if success, false otherwise

propVOIAll

boolean propVOIAll()

Deprecated.

Propagates the selected VOI to all slices. This function is deprecated, replace with actionPerformed(ActionEvent) using CustomUIBuilder.PARAM_VOI_PROPAGATE_ALL.

Returns:

true if success, false otherwise

removeVOIUpdateListener

void removeVOIUpdateListener(UpdateVOISelectionListener listener)

Removes the UpdateVOISelectionListener from the list.

Parameters:

listener - the UpdateVOIselectionListener to remove.

resetLivewire

void resetLivewire()

Resets the current livewire VOI.

selectAllVOIs

void selectAllVOIs(boolean doSelect)

Deprecated.

Selects all VOIs. This function is deprecated, replace with actionPerformed(ActionEvent) using CustomUIBuilder.PARAM_VOI_SELECT_ALL and CustomUIBuilder.PARAM_VOI_SELECT_NONE

Parameters:

doSelect -

setCenter

void setCenter(WildMagic.LibFoundation.Mathematics.Vector3f center)

Deprecated.

Sets the current displayed slice for 3D images. The current center is the slice value of the three orthogonal planes displayed in the ViewJFrameTriImage. When this function is called from ViewJFrameImage the X,Y, parameters are ignored and current slice is the Z-value.

Parameters:

center - ModelImage file coordinates representation of the slice values of the three orthogonal image planes.

setCenter

void setCenter(WildMagic.LibFoundation.Mathematics.Vector3f center,
               boolean bParent)

Sets the current displayed slice for 3D images. The current center is the slice value of the three orthogonal planes displayed in the ViewJFrameTriImage. When this function is called from ViewJFrameImage the X,Y, parameters are ignored and current slice is the Z-value.

Parameters:

center - ModelImage file coordinates representation of the slice values of the three orthogonal image planes.

bParent - when true call parent.setCenter()

setPresetHue

void setPresetHue(float presetHue)

Sets the hue that will be used to draw the new VOI.

Parameters:

presetHue - the hue to be used

setVOI_IDs

void setVOI_IDs(int ID,
                int UID)

Deprecated.

This function is deprecated.

Parameters:

ID - not used.

UID - not used.

showColorDialog

void showColorDialog()

Opens the color dialog for changing the selected VOI color.