SVSImageExtractor (IQM 3.5 API)

java.lang.Object
- javax.swing.SwingWorker<Boolean,Void>
- - at.mug.iqm.commons.util.image.SVSImageExtractor

All Implemented Interfaces:

Runnable, Future<Boolean>, RunnableFuture<Boolean>
```
public class SVSImageExtractor
extends SwingWorker<Boolean,Void>
```
Since:

2012 05 29

Author:

Philipp Kainz

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.SwingWorker
  SwingWorker.StateValue

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`allHeightsEqual`
`private boolean`	`allWidthsEqual`
`private static Class<?>`	`caller`
`private int`	`extension`
`private Vector<File>`	`extractedFiles`
`private File[]`	`files`
`private int`	`firstHeight`
`private int`	`firstWidth`
`private int`	`imageToLoad`
`private int`	`interP`
`private static org.apache.log4j.Logger`	`logger`
`(package private) int`	`numImages`
`private int[]`	`params` Default parameters for the image extraction: first image, no rescale, bilinear interpolation, tif extension.
`private int`	`rescale`
`private float`	`theRatioH`
`private float`	`theRatioW`

Constructor Summary

Constructors
Constructor and Description

SVSImageExtractor()

Constructors
Constructor and Description
`SVSImageExtractor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private File`	`appendTextToImageName(File file, String strAppend)` This method appends String(num) to the image name
`protected Boolean`	`doInBackground()`
`protected void`	`done()`
`boolean`	`extract(File[] files, int[] params)` This method extracts the files with the given params.
`int`	`getExtension()`
`Vector<File>`	`getExtractedFiles()`
`File[]`	`getFiles()`
`int`	`getFirstHeight()`
`int`	`getFirstWidth()`
`int`	`getImageToLoad()`
`int`	`getInterP()`
`int`	`getNumImages()`
`int[]`	`getParams()`
`int`	`getRescale()`
`private int[]`	`getSizeOfFirstImg(File file)` Retrieve the Size of the first image in an SVS file stack.
`float`	`getTheRatioH()`
`float`	`getTheRatioW()`
`boolean`	`isAllHeightsEqual()`
`boolean`	`isAllWidthsEqual()`
`Object[][]`	`readImageMetaData(File file)` This method reads out the image information from a specified image `file`.
`private javax.media.jai.PlanarImage`	`rescaleImage(javax.media.jai.PlanarImage pi, int rescale, int optIntP)` This method rescales an instance of PlanarImage (pi) using a given interpolation method (optIntP).
`void`	`setAllHeightsEqual(boolean allHeightsEqual)`
`void`	`setAllWidthsEqual(boolean allWidthsEqual)`
`void`	`setExtension(int extension)`
`void`	`setExtractedFiles(Vector<File> extractedFiles)`
`void`	`setFiles(File[] files)`
`void`	`setFirstHeight(int firstHeight)`
`void`	`setFirstWidth(int firstWidth)`
`void`	`setImageToLoad(int imageToLoad)`
`void`	`setInterP(int interP)`
`void`	`setNumImages(int numImages)`
`void`	`setParams(int[] params)`
`void`	`setRescale(int rescale)`
`void`	`setTheRatioH(float theRatioH)`
`void`	`setTheRatioW(float theRatioW)`

Methods inherited from class javax.swing.SwingWorker
addPropertyChangeListener, cancel, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, process, publish, removePropertyChangeListener, run, setProgress

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

- Field Detail
  - caller
```
private static Class<?> caller
```
  - logger
```
private static final org.apache.log4j.Logger logger
```
  - params
```
private int[] params
```
    Default parameters for the image extraction: first image, no rescale, bilinear interpolation, tif extension.
  - files
```
private File[] files
```
  - extractedFiles
```
private Vector<File> extractedFiles
```
  - imageToLoad
```
private int imageToLoad
```
  - rescale
```
private int rescale
```
  - interP
```
private int interP
```
  - extension
```
private int extension
```
  - firstWidth
```
private int firstWidth
```
  - firstHeight
```
private int firstHeight
```
  - numImages
```
int numImages
```
  - theRatioW
```
private float theRatioW
```
  - theRatioH
```
private float theRatioH
```
  - allWidthsEqual
```
private boolean allWidthsEqual
```
  - allHeightsEqual
```
private boolean allHeightsEqual
```
- Constructor Detail
  - SVSImageExtractor
```
public SVSImageExtractor()
```
- Method Detail
  - readImageMetaData
```
public Object[][] readImageMetaData(File file)
                             throws UnreadableSVSFileException
```
    This method reads out the image information from a specified image file.
    
    Parameters:
    
    file - - the specified file to be read
    
    Returns:
    
    a 2D Object array
    
    Throws:
    
    UnreadableSVSFileException
  - rescaleImage
```
private javax.media.jai.PlanarImage rescaleImage(javax.media.jai.PlanarImage pi,
                                                 int rescale,
                                                 int optIntP)
```
    This method rescales an instance of PlanarImage (pi) using a given interpolation method (optIntP).
    
    Parameters:
    
    pi -
    
    rescale -
    
    optIntP -
    
    Returns:
    
    a planar image
  - getSizeOfFirstImg
```
private int[] getSizeOfFirstImg(File file)
```
    Retrieve the Size of the first image in an SVS file stack.
    
    Parameters:
    
    file -
    
    Returns:
    
    the integer array containing [width,height]
  - extract
```
public boolean extract(File[] files,
                       int[] params)
```
    This method extracts the files with the given params.
    Parameters:
    
    files - - the file list
    params - - parameters for processing the file list:
    
    [0]... image number of the stack
    
    [1]... rescaling factor
    
    [2]... interpolation method
    
    [3]... file extension
    Returns:
    
    true if successful, false otherwise
  - appendTextToImageName
```
private File appendTextToImageName(File file,
                                   String strAppend)
```
    This method appends String(num) to the image name
  - doInBackground
```
protected Boolean doInBackground()
                          throws Exception
```
    Specified by:
    
    doInBackground in class SwingWorker<Boolean,Void>
    
    Throws:
    
    Exception
  - done
```
protected void done()
```
    Overrides:
    
    done in class SwingWorker<Boolean,Void>
  - getParams
```
public int[] getParams()
```
    Returns:
    
    the params
  - getImageToLoad
```
public int getImageToLoad()
```
    Returns:
    
    the imageToLoad
  - getRescale
```
public int getRescale()
```
    Returns:
    
    the rescale
  - getInterP
```
public int getInterP()
```
    Returns:
    
    the interP
  - getExtension
```
public int getExtension()
```
    Returns:
    
    the extension
  - getFirstWidth
```
public int getFirstWidth()
```
    Returns:
    
    the firstWidth
  - getFirstHeight
```
public int getFirstHeight()
```
    Returns:
    
    the firstHeight
  - getNumImages
```
public int getNumImages()
```
    Returns:
    
    the numImages
  - getTheRatioW
```
public float getTheRatioW()
```
    Returns:
    
    the theRatioW
  - getTheRatioH
```
public float getTheRatioH()
```
    Returns:
    
    the theRatioH
  - isAllWidthsEqual
```
public boolean isAllWidthsEqual()
```
    Returns:
    
    the allWidthsEqual
  - isAllHeightsEqual
```
public boolean isAllHeightsEqual()
```
    Returns:
    
    the allHeightsEqual
  - setParams
```
public void setParams(int[] params)
```
    Parameters:
    
    params - the params to set
  - setImageToLoad
```
public void setImageToLoad(int imageToLoad)
```
    Parameters:
    
    imageToLoad - the imageToLoad to set
  - setRescale
```
public void setRescale(int rescale)
```
    Parameters:
    
    rescale - the rescale to set
  - setInterP
```
public void setInterP(int interP)
```
    Parameters:
    
    interP - the interP to set
  - setExtension
```
public void setExtension(int extension)
```
    Parameters:
    
    extension - the extension to set
  - setFirstWidth
```
public void setFirstWidth(int firstWidth)
```
    Parameters:
    
    firstWidth - the firstWidth to set
  - setFirstHeight
```
public void setFirstHeight(int firstHeight)
```
    Parameters:
    
    firstHeight - the firstHeight to set
  - setNumImages
```
public void setNumImages(int numImages)
```
    Parameters:
    
    numImages - the numImages to set
  - setTheRatioW
```
public void setTheRatioW(float theRatioW)
```
    Parameters:
    
    theRatioW - the theRatioW to set
  - setTheRatioH
```
public void setTheRatioH(float theRatioH)
```
    Parameters:
    
    theRatioH - the theRatioH to set
  - setAllWidthsEqual
```
public void setAllWidthsEqual(boolean allWidthsEqual)
```
    Parameters:
    
    allWidthsEqual - the allWidthsEqual to set
  - setAllHeightsEqual
```
public void setAllHeightsEqual(boolean allHeightsEqual)
```
    Parameters:
    
    allHeightsEqual - the allHeightsEqual to set
  - getFiles
```
public File[] getFiles()
```
    Returns:
    
    the files
  - setFiles
```
public void setFiles(File[] files)
```
    Parameters:
    
    files - the files to set
  - getExtractedFiles
```
public Vector<File> getExtractedFiles()
```
    Returns:
    
    the extractedFiles
  - setExtractedFiles
```
public void setExtractedFiles(Vector<File> extractedFiles)
```
    Parameters:
    
    extractedFiles - the extractedFiles to set

Class SVSImageExtractor

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.SwingWorker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.swing.SwingWorker

Methods inherited from class java.lang.Object

Field Detail

caller

logger

params

files

extractedFiles

imageToLoad

rescale

interP

extension

firstWidth

firstHeight

numImages

theRatioW

theRatioH

allWidthsEqual

allHeightsEqual

Constructor Detail

SVSImageExtractor

Method Detail

readImageMetaData

rescaleImage

getSizeOfFirstImg

extract

appendTextToImageName

doInBackground

done

getParams

getImageToLoad

getRescale

getInterP

getExtension

getFirstWidth

getFirstHeight

getNumImages

getTheRatioW

getTheRatioH

isAllWidthsEqual

isAllHeightsEqual

setParams

setImageToLoad

setRescale

setInterP

setExtension

setFirstWidth

setFirstHeight

setNumImages

setTheRatioW

setTheRatioH

setAllWidthsEqual

setAllHeightsEqual

getFiles

setFiles

getExtractedFiles

setExtractedFiles