uk.ac.starlink.ttools.filter

Class PixSampleFilter

java.lang.Object

uk.ac.starlink.ttools.filter.BasicFilter

uk.ac.starlink.ttools.filter.PixSampleFilter

All Implemented Interfaces:

ProcessingFilter

public class PixSampleFilter
extends BasicFilter

Filter for sampling pixel data from a HEALPix all-sky table file.

Since:

5 Dec 2011

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
PixSampleFilter() Constructor.

Method Summary

Modifier and Type	Method and Description
ProcessingStep	createStep(Iterator<String> argIt) Creates a new ProcessingStep based on a sequence of command-line arguments.
String[]	getDescriptionLines()

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

PixSampleFilter

public PixSampleFilter()

Constructor.

Method Detail

getDescriptionLines

public String[] getDescriptionLines()

Specified by:

getDescriptionLines in class BasicFilter

createStep

public ProcessingStep createStep(Iterator<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