Binner (ImageJ2 Javadocs 0-SNAPSHOT API)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.command.ContextCommand
  - - net.imagej.plugins.commands.imglib.Binner<T>

All Implemented Interfaces:

Runnable, Cancelable, Command, Contextual, SciJavaPlugin
```
public class Binner<T extends RealType<T>>
extends ContextCommand
```
Reduces the size of an image by integral scale factors. The scale factors can be manipulated separately per dimension (i.e. scale X by 2 but Y by 3). The resultant pixel is some combination (min, avg, sum, etc.) of the original neighboring pixels. The combination method can be specified as needed.

Author:

Barry DeZonia

Constructor Summary

Constructors
Constructor and Description

Binner()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Dataset`	`getDataset()` Gets the Dataset that the bin operation will be run upon.
`String`	`getError()` Returns the current error message if any.
`int`	`getFactor(int d)` Gets the reduction factor for a given dimension.
`String`	`getValueMethod()` Gets the value method used to combine pixels.
`protected void`	`init()`
`void`	`run()`
`void`	`setDataset(Dataset ds)` Sets the Dataset that the bin operation will be run upon.
`void`	`setFactor(int d, int factor)` Sets the reduction factor for a given dimension.
`void`	`setValueMethod(String str)` Sets the value method used to combine pixels.

Methods inherited from class org.scijava.command.ContextCommand
cancel, getCancelReason, isCanceled

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

- Constructor Detail
  - Binner
```
public Binner()
```
- Method Detail
  - setDataset
```
public void setDataset(Dataset ds)
```
    Sets the Dataset that the bin operation will be run upon.
  - getDataset
```
public Dataset getDataset()
```
    Gets the Dataset that the bin operation will be run upon.
  - setFactor
```
public void setFactor(int d,
                      int factor)
```
    Sets the reduction factor for a given dimension.
  - getFactor
```
public int getFactor(int d)
```
    Gets the reduction factor for a given dimension.
  - setValueMethod
```
public void setValueMethod(String str)
```
    Sets the value method used to combine pixels. Use the constant strings that are exposed by this class.
  - getValueMethod
```
public String getValueMethod()
```
    Gets the value method used to combine pixels. One of the constant strings that are exposed by this class.
  - getError
```
public String getError()
```
    Returns the current error message if any.
  - run
```
public void run()
```
  - init
```
protected void init()
```

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2014–2022 ImageJ. All rights reserved.