MocMode (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.mode.MocMode

All Implemented Interfaces:

ProcessingMode
```
public class MocMode
extends java.lang.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.

Constructors
Constructor and Description
`MocMode()` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TableConsumer`	`createConsumer(uk.ac.starlink.task.Environment env)` Creates a TableConsumer, deriving any additional required configuration from a given environment.
`uk.ac.starlink.task.Parameter[]`	`getAssociatedParameters()` Returns a list of any parameters which are associated with this mode.
`java.lang.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 uk.ac.starlink.task.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 java.lang.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(uk.ac.starlink.task.Environment env)
                             throws uk.ac.starlink.task.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:
    
    uk.ac.starlink.task.TaskException
  - setChecked
```
public static void setChecked(cds.moc.HealpixMoc moc,
                              boolean checked)
                       throws java.io.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:
    
    java.io.IOException

Class MocMode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FITS_FORMAT

JSON_FORMAT

Constructor Detail

MocMode

Method Detail

getAssociatedParameters

getDescription

createConsumer

setChecked