com.c3d.image.hips
Class HipsFilterBank

java.lang.Object
  |
  +--com.c3d.image.hips.HipsFilterBank
public class HipsFilterBank
extends java.lang.Object

Filter a Hips image via one or more external filters. The external filters are executable Hips filters, takeing an image in via the standard input, and outputting the result via the standard output.

Inner Class Summary
 interface HipsFilterBank.HipsFilterBankException
           
 
Constructor Summary
HipsFilterBank()
          Create an empty filter bank
 
Method Summary
 void addFilter(java.lang.String filter)
          Add the filter, with executable name and arguments given by the filter string
 void addFilter(java.lang.String filter, java.lang.String[] args)
          Add a filter program, with the arguments specified separately
 void clearFilters()
          Clear all filters, which leaves the filterbank just returning the image passed in under the filter operation.
 HipsImage filter(HipsImage img)
          Filter an image according to the currently specified filter sequence.
 HipsFilter frontFilter()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HipsFilterBank

public HipsFilterBank()
Create an empty filter bank
Method Detail

frontFilter

public HipsFilter frontFilter()

clearFilters

public void clearFilters()
Clear all filters, which leaves the filterbank just returning the image passed in under the filter operation.

addFilter

public void addFilter(java.lang.String filter)
Add the filter, with executable name and arguments given by the filter string
Parameters:
filter - A command line for sn executable program. Arguments can be supplied, in which case they are parsed using the StringTokenizer parser from java.io.

addFilter

public void addFilter(java.lang.String filter,
                      java.lang.String[] args)
Add a filter program, with the arguments specified separately
Parameters:
filter - The name of an executable program
args - The arguments to be passed to filter

filter

public HipsImage filter(HipsImage img)
                 throws HipsFilterBank.HipsFilterBankException
Filter an image according to the currently specified filter sequence. The input img can be of any type. The output image must be in a Hips format understandable by the HIPS.loadImage method, or an exception will be thrown.
Parameters:
img - The original image
Returns:
An image in any format readable by HIPS.loadImage