uk.ac.starlink.ttools.mode

Class MocMode

java.lang.Object

uk.ac.starlink.ttools.mode.MocMode

All Implemented Interfaces:

ProcessingMode

public class MocMode
extends Object
implements ProcessingMode

Turns a table into a Multi-Order Coverage map.

Since:

8 Mar 2012

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static MocFormat	FITS_FORMAT MocFormat implementation that writes MOC 1.0-compliant FITS files.
static MocFormat	JSON_FORMAT MocFormat implementation that writes JSON files.

Constructor Summary

Constructors

Constructor and Description
MocMode() Constructor.

Method Summary

Modifier and Type	Method and Description
TableConsumer	createConsumer(Environment env) Creates a TableConsumer, deriving any additional required configuration from a given environment.
Parameter<?>[]	getAssociatedParameters() Returns a list of any parameters which are associated with this mode.
String	getDescription() Returns a textual description of this processing mode.
static void	setChecked(cds.moc.HealpixMoc moc, boolean checked) Sets the continuous checking flag for the MOC object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FITS_FORMAT

public static final MocFormat FITS_FORMAT

MocFormat implementation that writes MOC 1.0-compliant FITS files.

JSON_FORMAT

public static final MocFormat JSON_FORMAT

MocFormat implementation that writes JSON files.

Constructor Detail

MocMode

public MocMode()

Constructor.

Method Detail

getAssociatedParameters

public Parameter<?>[] getAssociatedParameters()

Description copied from interface: ProcessingMode

Returns a list of any parameters which are associated with this mode.

Specified by:

getAssociatedParameters in interface ProcessingMode

Returns:

parameter list

getDescription

public String getDescription()

Description copied from interface: ProcessingMode

Returns a textual description of this processing mode. This will be included in the user document so should be in XML.

Specified by:

getDescription in interface ProcessingMode

Returns:

textual description of this mode

createConsumer

public TableConsumer createConsumer(Environment env)
                             throws TaskException

Description copied from interface: ProcessingMode

Creates a TableConsumer, deriving any additional required configuration from a given environment.

Specified by:

createConsumer in interface ProcessingMode

Parameters:

env - execution environment

Throws:

TaskException

setChecked

public static void setChecked(cds.moc.HealpixMoc moc,
                              boolean checked)
                       throws IOException

Sets the continuous checking flag for the MOC object. When continuous checking is on, parent pixels are supposed to get weeded out as adds are done. However, it's much slower.

Parameters:

moc - MOC to affect

checked - true iff continuous checking should be performed

Throws:

IOException