SkyConeMatch2 (Starjava TTOOLS API)

Skip navigation links

All Classes

SEARCH:

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- uk.ac.starlink.ttools.task.ConsumerTask
- - uk.ac.starlink.ttools.task.SingleMapperTask
  - - uk.ac.starlink.ttools.cone.SkyConeMatch2

Direct Known Subclasses:

MultiCone, SqlCone
```
public abstract class SkyConeMatch2
extends SingleMapperTask
```
Crossmatcher which works by performing one cone-search type query for each row of an input table on an external service of some kind. This is not prima facie a very efficient way of doing a cross match, but if the external service represents a table which is too large or otherwise unfeasible to access as one term in a normal cone search it's about the only way to do it.

Since:

9 Aug 2007

Author:

Mark Taylor

Constructor Summary

Constructors
Constructor Description

SkyConeMatch2(java.lang.String purpose, Coner coner, int maxParallel)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TableProducer`	`createProducer(uk.ac.starlink.task.Environment env)`	Returns an object which can produce the effective output table which will be consumed by this task.

Methods inherited from class uk.ac.starlink.ttools.task.ConsumerTask
createExecutable, createProducer, getOutputMode, getParameterList, getParameters, getPurpose

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

Methods inherited from class uk.ac.starlink.ttools.task.SingleMapperTask
createInputProducer

- Constructor Detail
  - SkyConeMatch2
```
public SkyConeMatch2(java.lang.String purpose,
                     Coner coner,
                     int maxParallel)
```
    Constructor.
    
    Parameters:
    
    purpose - one-line description of the purpose of the task
    
    coner - object which provides the sky cone search service
    
    maxParallel - the largest number of parallel threads which will be permitted for multi-threaded operation; 1 means single-threaded only, and <=0 means no limit - use with care!
- Method Detail
  - createProducer
```
public TableProducer createProducer(uk.ac.starlink.task.Environment env)
                             throws uk.ac.starlink.task.TaskException
```
    Description copied from class: ConsumerTask
    
    Returns an object which can produce the effective output table which will be consumed by this task.
    
    Specified by:
    
    createProducer in class ConsumerTask
    
    Parameters:
    
    env - execution environment
    
    Returns:
    
    table producer
    
    Throws:
    
    uk.ac.starlink.task.TaskException

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.