edu.uthscsa.ric.mango
Class MangoData

java.lang.Object
  extended by edu.uthscsa.ric.mango.MangoData

public class MangoData
extends Object

MangoData stores viewer image data. It provides access to base image data, overlays, and ROIs. If it is expected that viewer image data will change during the execution of a plug-in (e.g., a user might load another overlay), an updated MangoData can be fetched via ViewerController. ViewerController can also be used to fetch all currently open ViewerControllers, thereby giving access to MangoData from other viewers.


Constructor Summary
MangoData(MangoImage baseImage, MangoImage[] overlays, ScreenImage[] images, ROIData roi)
           
 
Method Summary
 MangoImage getBaseImage()
          Deprecated.  
 ScreenImage getBaseScreenImage()
          Returns the base ScreenImage.
 MangoImage[] getOverlayImages()
          Deprecated.  
 ScreenImage[] getOverlayScreenImages()
          Returns an array of overlay ScreenImages.
 MangoROI getROI()
          Deprecated.  
 ROIData getROIData()
          Returns the ROIController associated with this viewer.
 ScreenImage[] getScreenImages()
          Returns the image stack, including base image and overlays.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MangoData

public MangoData(MangoImage baseImage,
                 MangoImage[] overlays,
                 ScreenImage[] images,
                 ROIData roi)
Method Detail

getBaseScreenImage

public ScreenImage getBaseScreenImage()
Returns the base ScreenImage. This is the same as getScreenImages()[0].

Returns:
the base ScreenImage

getOverlayScreenImages

public ScreenImage[] getOverlayScreenImages()
Returns an array of overlay ScreenImages.

Returns:
an array of overlay ScreenImages

getROIData

public ROIData getROIData()
Returns the ROIController associated with this viewer.

Returns:
the ROIController associated with this viewer

getScreenImages

public ScreenImage[] getScreenImages()
Returns the image stack, including base image and overlays.

Returns:
the image stack

getBaseImage

@Deprecated
public MangoImage getBaseImage()
Deprecated. 

Returns the viewer base image (or first loaded image) as a MangoImage.

Returns:
the viewer base image

getOverlayImages

@Deprecated
public MangoImage[] getOverlayImages()
Deprecated. 

Returns a MangoImage array of loaded overlays.

Returns:
a MangoImage array of loaded overlays

getROI

@Deprecated
public MangoROI getROI()
Deprecated. 

Returns the MangoROI associated with this viewer.

Returns:
the MangoROI associated with this viewer