SchlegelFilter (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.filter.BasicFilter
- - uk.ac.starlink.ttools.calc.ColumnCalculatorFilter<SchlegelCalculator.Spec>
  - - uk.ac.starlink.ttools.calc.SchlegelFilter

All Implemented Interfaces:

ProcessingFilter
```
public class SchlegelFilter
extends ColumnCalculatorFilter<SchlegelCalculator.Spec>
```
Filter that applies the SchlegelCalculator.

Since:

14 Oct 2011

Author:

Mark Taylor

Constructor Summary

Constructors
Constructor Description

SchlegelFilter()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ProcessingStep`	`createStep(java.util.Iterator<java.lang.String> argIt)`	Creates a new ProcessingStep based on a sequence of command-line arguments.
`protected java.lang.String[]`	`getDescriptionLines()`

Methods inherited from class uk.ac.starlink.ttools.calc.ColumnCalculatorFilter
createCalcStep

Methods inherited from class uk.ac.starlink.ttools.filter.BasicFilter
explainSyntax, getDescription, getName, getUsage

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

- Constructor Detail
  - SchlegelFilter
```
public SchlegelFilter()
```
    Constructor.
- Method Detail
  - getDescriptionLines
```
protected java.lang.String[] getDescriptionLines()
```
    Specified by:
    
    getDescriptionLines in class BasicFilter
  - createStep
```
public ProcessingStep createStep(java.util.Iterator<java.lang.String> argIt)
                          throws ArgException
```
    Description copied from interface: ProcessingFilter
    
    Creates a new ProcessingStep based on a sequence of command-line arguments. The argIt argument is an iterator over the command-line arguments positioned just before any arguments intended for this filter. If legal, any that can be comprehended by this filter should be read (iterated over) and removed, and a ProcessingStep should accordingly be returned. In the case of a successful return, it is essential that no arguments other than the ones intended for this filter are read from the iterator.
    If the argument list is badly-formed as far as this filter is concerned, an ArgException should be thrown.
    
    Parameters:
    
    argIt - iterator over command-line arguments positioned at the first one
    
    Throws:
    
    ArgException