ImageBlockDeblock (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- edu.utexas.archipelago.image.ImageBlockDeblock

All Implemented Interfaces:

Serializable
```
public class ImageBlockDeblock
extends Object
implements Serializable
```
A FijiArchipelago-compatible class for splitting an image into smaller blocks, then recombining into the original image shape, potentially after processing.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ImageBlockDeblock.BlockCallable

Nested Classes
Modifier and Type	Class and Description
`class`	`ImageBlockDeblock.BlockCallable`

Constructor Summary

Constructors
Constructor and Description
`ImageBlockDeblock(File inFile, File outFile, int[] bs, int[] o)`
`ImageBlockDeblock(File inFile, File outFileFormat, int[] bs, int[] o, int nOutput)` Creates an ImageBlockDeblock that will split a file into blocks of size at most bs, plus an overlap determined by o.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArrayList<File>`	`blockFile()` Splits the input file into blocks.
`File`	`deblockFile(int idx)` Recombine image blocks into the original image shape.
`int`	`getHeight()`
`File`	`getInputFile()`
`int`	`getNumOutput()`
`File`	`getOutputFile(int idx)`
`String`	`getOutputFileName(int idx)`
`int`	`getWidth()`
`Callable<ImageBlockDeblock>`	`imageBlockCallable()`
`ArrayList<File>`	`imageBlockFiles()`
`Callable<ImageBlockDeblock>`	`imageDeblockCallable()`
`void`	`mapChunks(File origChunk, File newChunk)` Map a new block file of the same size to the original one given.
`void`	`mapChunks(File origChunk, File newChunk, int idx)`
`int`	`numUnmappedBlocks()`
`int`	`numUnmappedBlocks(int idx)`
`void`	`setSubfolder(String folder)`

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

- Constructor Detail
  - ImageBlockDeblock
```
public ImageBlockDeblock(File inFile,
                         File outFile,
                         int[] bs,
                         int[] o)
```
  - ImageBlockDeblock
```
public ImageBlockDeblock(File inFile,
                         File outFileFormat,
                         int[] bs,
                         int[] o,
                         int nOutput)
```
    Creates an ImageBlockDeblock that will split a file into blocks of size at most bs, plus an overlap determined by o.
    
    Parameters:
    
    inFile - input file.
    
    outFileFormat - re-combined output file format string.
    
    bs - a 2-element array containing the size of the blocks, not including overlap.
    
    o - the total block overlap in pixels. Each image block will be of size at most bs + o.
- Method Detail
  - blockFile
```
public ArrayList<File> blockFile()
                          throws ExecutionException,
                                 InterruptedException
```
    Splits the input file into blocks. Computation is done in parallel.
    
    Returns:
    
    An ArrayList containing Files representing the file paths for each image block file.
    
    Throws:
    
    ExecutionException - if an ExecutionError is encountered
    
    InterruptedException - if this method is interrupted,
  - deblockFile
```
public File deblockFile(int idx)
                 throws ExecutionException
```
    Recombine image blocks into the original image shape.
    
    Parameters:
    
    idx - the slice index to deblock
    
    Returns:
    
    a File containing the output file.
    
    Throws:
    
    ExecutionException - if something goes wrong, probably file IO related
  - mapChunks
```
public void mapChunks(File origChunk,
                      File newChunk)
```
    Map a new block file of the same size to the original one given. The new block file will be used in the output. This method is intended for use in the case that a block image file has been opened, processed, then written to a new file.
    
    Parameters:
    
    origChunk - the File representing the original image block file, created by blockImage().
    
    newChunk - the File representing a new image block file representing the output of processing on the original block image.
  - mapChunks
```
public void mapChunks(File origChunk,
                      File newChunk,
                      int idx)
```
  - setSubfolder
```
public void setSubfolder(String folder)
```
  - getInputFile
```
public File getInputFile()
```
  - getOutputFile
```
public File getOutputFile(int idx)
```
  - getOutputFileName
```
public String getOutputFileName(int idx)
```
  - imageBlockCallable
```
public Callable<ImageBlockDeblock> imageBlockCallable()
```
  - imageDeblockCallable
```
public Callable<ImageBlockDeblock> imageDeblockCallable()
```
  - imageBlockFiles
```
public ArrayList<File> imageBlockFiles()
```
  - numUnmappedBlocks
```
public int numUnmappedBlocks()
```
  - numUnmappedBlocks
```
public int numUnmappedBlocks(int idx)
```
  - getWidth
```
public int getWidth()
```
  - getHeight
```
public int getHeight()
```
  - getNumOutput
```
public int getNumOutput()
```

Class ImageBlockDeblock

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageBlockDeblock

ImageBlockDeblock

Method Detail

blockFile

deblockFile

mapChunks

mapChunks

setSubfolder

getInputFile

getOutputFile

getOutputFileName

imageBlockCallable

imageDeblockCallable

imageBlockFiles

numUnmappedBlocks

numUnmappedBlocks

getWidth

getHeight

getNumOutput