DuplicateImage (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.module.AbstractModule
- - org.scijava.module.DefaultMutableModule
  - - org.scijava.command.DynamicCommand
    - - net.imagej.plugins.commands.imglib.DuplicateImage

All Implemented Interfaces:

Runnable, Cancelable, Command, Contextual, Module, MutableModule, SciJavaPlugin
```
public class DuplicateImage
extends DynamicCommand
```
Duplicates data from one input display to an output display. The planes to be duplicated can be specified via dialog parameters. The XY coordinates can be further constrained to be a subset of the current selection bounds.

Author:

Barry DeZonia

Field Summary
- Fields inherited from class org.scijava.command.DynamicCommand
  moduleService, pluginService

Constructor Summary

Constructors
Constructor and Description

DuplicateImage()

Constructors
Constructor and Description
`DuplicateImage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImageDisplay`	`getInputDisplay()` Returns the the input image to be sampled.
`ImageDisplay`	`getOutputDisplay()` The output image resulting after executing the run() method.
`protected void`	`initializer()`
`protected void`	`initName()`
`boolean`	`isDefaultBehavior()` Returns true if current behavior is default.
`void`	`run()`
`String`	`setAxisRange(AxisType axis, String axisDefinition, boolean originIsOne)` Sets the range of values to copy from the input display for the given axis.
`void`	`setDefaultBehavior(boolean value)` Specifies whether to use default behavior or special behavior.
`void`	`setInputDisplay(ImageDisplay disp)` Sets the the input image to be sampled.

Methods inherited from class org.scijava.command.DynamicCommand
cancel, context, getCancelReason, getContext, getInfo, getInput, getOutput, isCanceled, saveInputs, setContext, setInput, setOutput, uncancel

Methods inherited from class org.scijava.module.AbstractModule
cancel, getDelegateObject, getInputs, getOutputs, initialize, isInputResolved, isOutputResolved, preview, resolveInput, resolveOutput, setInputs, setOutputs, unresolveInput, unresolveOutput

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

Methods inherited from interface org.scijava.module.MutableModule
addInput, addInput, addOutput, addOutput, removeInput, removeOutput

Methods inherited from interface org.scijava.module.Module
cancel, getDelegateObject, getInputs, getOutputs, initialize, isInputResolved, isOutputResolved, isResolved, preview, resolveInput, resolveOutput, setInputs, setOutputs, setResolved, unresolveInput, unresolveOutput

- Constructor Detail
  - DuplicateImage
```
public DuplicateImage()
```
- Method Detail
  - setDefaultBehavior
```
public void setDefaultBehavior(boolean value)
```
    Specifies whether to use default behavior or special behavior. Default behavior copies the current composite XY plane. Special behavior is set when user defined axis definitions are to follow. If no axis definitions follow then all planes within the selected region will be copied.
  - isDefaultBehavior
```
public boolean isDefaultBehavior()
```
    Returns true if current behavior is default. Otherwise current behavior is special. Default behavior copies the current composite XY plane. When special behavior is set then user defined axis definitions may have been specifed and if so those definitions are used during copying. Otherwise if no user defined axis definitions were specified then all planes within the selected region will be copied.
  - setInputDisplay
```
public void setInputDisplay(ImageDisplay disp)
```
    Sets the the input image to be sampled.
  - getInputDisplay
```
public ImageDisplay getInputDisplay()
```
    Returns the the input image to be sampled.
  - getOutputDisplay
```
public ImageDisplay getOutputDisplay()
```
    The output image resulting after executing the run() method. This method returns null if the run() method has not yet been called.
  - setAxisRange
```
public String setAxisRange(AxisType axis,
                           String axisDefinition,
                           boolean originIsOne)
```
    Sets the range of values to copy from the input display for the given axis. The definition is a textual language that allows one or more planes to be defined by one or more comma separated values. Some examples:
    - "1" : plane 1
    - "3,5" : planes 3 and 5
    - "1-10" : planes 1 through 10
    - "1-10,20-30" : planes 1 through 10 and 20 through 30
    - "1-10-2,20-30-3" : planes 1 through 10 by 2 and planes 20 through 30 by 3
    - "1,3-5,12-60-6" : this shows each type of specification can be combined
    Parameters:
    
    axis -
    
    axisDefinition -
    
    originIsOne -
    
    Returns:
    
    null if successful else a message describing input error
  - run
```
public void run()
```
  - initializer
```
protected void initializer()
```
  - initName
```
protected void initName()
```

Class DuplicateImage

Field Summary

Fields inherited from class org.scijava.command.DynamicCommand

Constructor Summary

Method Summary

Methods inherited from class org.scijava.command.DynamicCommand

Methods inherited from class org.scijava.module.AbstractModule

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.module.MutableModule

Methods inherited from interface org.scijava.module.Module

Constructor Detail

DuplicateImage

Method Detail

setDefaultBehavior

isDefaultBehavior

setInputDisplay

getInputDisplay

getOutputDisplay

setAxisRange

run

initializer

initName