LegacyImageMap (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - net.imagej.legacy.LegacyImageMap

All Implemented Interfaces:

Contextual
```
public class LegacyImageMap
extends AbstractContextual
```
An image map between legacy ImageJ ImagePlus objects and modern ImageJ ImageDisplays. Because every ImagePlus has a corresponding ImageWindow and vice versa, it works out best to associate each ImagePlus with a ImageDisplay rather than with a Dataset.
Any Overlays present in the ImageDisplay are translated to a Roi attached to the ImagePlus, and vice versa.

In the case of one Dataset belonging to multiple ImageDisplay s, there is a separate ImagePlus for each ImageDisplay, with pixels by reference.

In the case of multiple Datasets in a single ImageDisplay, only the first Dataset is translated to the ImagePlus.

Author:

Curtis Rueden, Barry DeZonia

Field Summary

Fields
Modifier and Type Field and Description

static String IMP_KEY
Key for storing ImagePlus instances in a Dataset's map.

Fields
Modifier and Type	Field and Description
`static String`	`IMP_KEY` Key for storing `ImagePlus` instances in a `Dataset`'s map.

Constructor Summary

Constructors
Constructor and Description

LegacyImageMap(LegacyService legacyService)

Constructors
Constructor and Description
`LegacyImageMap(LegacyService legacyService)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Collection<ImageDisplay>`	`getImageDisplays()` Gets a list of `ImageDisplay` instances known to this legacy service.
`Collection<ij.ImagePlus>`	`getImagePlusInstances()` Gets a list of `ImagePlus` instances known to this legacy service.
`ImageDisplay`	`lookupDisplay(ij.ImagePlus imp)` Gets the `ImageDisplay` corresponding to the given `ImagePlus`, or null if there is no existing table entry.
`ij.ImagePlus`	`lookupImagePlus(ImageDisplay display)` Gets the `ImagePlus` corresponding to the given `ImageDisplay`, or null if there is no existing table entry.
`ij.ImagePlus`	`registerDataset(Dataset ds)` This method takes a provided `Dataset`, converts it to an `ImagePlus`, stores the new `ImagePlus` in the `Dataset` 's properties uner `IMP_KEY` and finally creates an `ImageDisplay` using the provided `Dataset`.
`ij.ImagePlus`	`registerDisplay(ImageDisplay display)` Ensures that the given `ImageDisplay` has a corresponding legacy image.
`ij.ImagePlus`	`registerDisplay(ImageDisplay display, boolean createLegacyMappings)` As `registerDisplay(ImageDisplay)` but mappings will go in legacy maps if `createLegacyMappings` is true.
`ImageDisplay`	`registerLegacyImage(ij.ImagePlus imp)` Ensures that the given legacy image has a corresponding `ImageDisplay`.
`void`	`toggleLegacyMode(boolean enteringLegacyMode)`
`void`	`unregisterDisplay(ImageDisplay display)` Removes the mapping associated with the given `ImageDisplay`.
`void`	`unregisterDisplay(ImageDisplay display, boolean deleteImp)` As `unregisterDisplay(ImageDisplay)`, with an optional toggle to delete the associated `ImagePlus`.
`void`	`unregisterLegacyImage(ij.ImagePlus imp)` Removes the mapping associated with the given `ImagePlus`.
`void`	`unregisterLegacyImage(ij.ImagePlus imp, boolean deleteImp)` As `unregisterLegacyImage(ImagePlus)`, with an optional toggle to delete the given `ImagePlus`.

Methods inherited from class org.scijava.AbstractContextual
context, getContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.scijava.Contextual
setContext

- Field Detail
  - IMP_KEY
```
public static final String IMP_KEY
```
    Key for storing ImagePlus instances in a Dataset's map.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LegacyImageMap
```
public LegacyImageMap(LegacyService legacyService)
```
- Method Detail
  - lookupDisplay
```
public ImageDisplay lookupDisplay(ij.ImagePlus imp)
```
    Gets the ImageDisplay corresponding to the given ImagePlus, or null if there is no existing table entry.
  - lookupImagePlus
```
public ij.ImagePlus lookupImagePlus(ImageDisplay display)
```
    Gets the ImagePlus corresponding to the given ImageDisplay, or null if there is no existing table entry.
  - registerDataset
```
public ij.ImagePlus registerDataset(Dataset ds)
```
    This method takes a provided Dataset, converts it to an ImagePlus, stores the new ImagePlus in the Dataset 's properties uner IMP_KEY and finally creates an ImageDisplay using the provided Dataset. This display will not be rendered due to the IMP_KEY mapping. The resulting ImagePlus and ImageDisplay will then be mapped to each other.
    Use this method to create an ImagePlus to Display mapping without rendering the display.
    
    Returns:
    
    the ImagePlus object shadowing the given Dataset.
  - registerDisplay
```
public ij.ImagePlus registerDisplay(ImageDisplay display)
```
    Ensures that the given ImageDisplay has a corresponding legacy image.
    
    Returns:
    
    the ImagePlus object shadowing the given ImageDisplay, creating it if necessary using the ImageTranslator.
  - registerDisplay
```
public ij.ImagePlus registerDisplay(ImageDisplay display,
                                    boolean createLegacyMappings)
```
    As registerDisplay(ImageDisplay) but mappings will go in legacy maps if createLegacyMappings is true.
  - registerLegacyImage
```
public ImageDisplay registerLegacyImage(ij.ImagePlus imp)
```
    Ensures that the given legacy image has a corresponding ImageDisplay.
    
    Returns:
    
    the ImageDisplay object shadowing the given ImagePlus, creating it if necessary using the ImageTranslator.
  - toggleLegacyMode
```
public void toggleLegacyMode(boolean enteringLegacyMode)
```
  - unregisterDisplay
```
public void unregisterDisplay(ImageDisplay display)
```
    Removes the mapping associated with the given ImageDisplay.
  - unregisterLegacyImage
```
public void unregisterLegacyImage(ij.ImagePlus imp)
```
    Removes the mapping associated with the given ImagePlus.
  - unregisterDisplay
```
public void unregisterDisplay(ImageDisplay display,
                              boolean deleteImp)
```
    As unregisterDisplay(ImageDisplay), with an optional toggle to delete the associated ImagePlus.
  - unregisterLegacyImage
```
public void unregisterLegacyImage(ij.ImagePlus imp,
                                  boolean deleteImp)
```
    As unregisterLegacyImage(ImagePlus), with an optional toggle to delete the given ImagePlus.
  - getImageDisplays
```
public Collection<ImageDisplay> getImageDisplays()
```
    Gets a list of ImageDisplay instances known to this legacy service.
    
    Returns:
    
    a collection of ImageDisplay instances linked to legacy ImagePlus instances.
  - getImagePlusInstances
```
public Collection<ij.ImagePlus> getImagePlusInstances()
```
    Gets a list of ImagePlus instances known to this legacy service.
    
    Returns:
    
    a collection of legacy ImagePlus instances linked to ImageDisplay instances.

Class LegacyImageMap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.Contextual

Field Detail

IMP_KEY

Constructor Detail

LegacyImageMap

Method Detail

lookupDisplay

lookupImagePlus

registerDataset

registerDisplay

registerDisplay

registerLegacyImage

toggleLegacyMode

unregisterDisplay

unregisterLegacyImage

unregisterDisplay

unregisterLegacyImage

getImageDisplays

getImagePlusInstances