uk.ac.starlink.ttools.cone

Class SkyConeMatch2

java.lang.Object

uk.ac.starlink.ttools.task.ConsumerTask

uk.ac.starlink.ttools.task.SingleMapperTask

uk.ac.starlink.ttools.cone.SkyConeMatch2

All Implemented Interfaces:

Task

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 and Description
SkyConeMatch2(String purpose, Coner coner, int maxParallel) Constructor.

Method Summary

Modifier and Type	Method and Description
TableProducer	createProducer(Environment env) Returns an object which can produce the effective output table which will be consumed by this task.
Parameter<ConeErrorPolicy>	getConeErrorPolicyParameter() Returns the parameter used to acquire the error policy.
Coner	getConer() Returns the coner used by this task.
Parameter<String>	getDecParameter() Returns the parameter used to acquire declination in degrees.
Parameter<ConeFindMode>	getFindModeParameter() Returns the parameter used to acquire the find mode.
Parameter<Integer>	getParallelParameter() Returns the parameter used to acquire the parallelism level.
Parameter<String>	getRadiusDegreeParameter() Returns the parameter used to acquire radius expression in degrees.
Parameter<String>	getRaParameter() Returns the parameter used to acquire RA expression in degrees.
Parameter<Boolean>	getUseCoverageParameter() Returns the parameter used to acquire the coverage usage flag.

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

createInputProducer, getInputFilterParameter, getInputTableParameter

Methods inherited from class uk.ac.starlink.ttools.task.ConsumerTask

createExecutable, createProducer, getIdentity, getOutputMode, getParameterList, getParameters, getPurpose

Methods inherited from class java.lang.Object

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

Constructor Detail

SkyConeMatch2

public SkyConeMatch2(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(Environment env)
                             throws TaskException

Description copied from class: ConsumerTask

Returns an object which can produce the effective output table which will be consumed by this task. The table produced by the resulting producer can be fed to the ConsumerTask.getIdentity(uk.ac.starlink.table.StarTable) method.

Specified by:

createProducer in class ConsumerTask

Parameters:

env - execution environment

Returns:

table producer

Throws:

TaskException

getConer

public Coner getConer()

Returns the coner used by this task.

Returns:

coner

getRaParameter

public Parameter<String> getRaParameter()

Returns the parameter used to acquire RA expression in degrees.

Returns:

right ascension parameter

getDecParameter

public Parameter<String> getDecParameter()

Returns the parameter used to acquire declination in degrees.

Returns:

declination parameter

getRadiusDegreeParameter

public Parameter<String> getRadiusDegreeParameter()

Returns the parameter used to acquire radius expression in degrees.

Returns:

radius parameter

getConeErrorPolicyParameter

public Parameter<ConeErrorPolicy> getConeErrorPolicyParameter()

Returns the parameter used to acquire the error policy.

Returns:

error policy parameter

getFindModeParameter

public Parameter<ConeFindMode> getFindModeParameter()

Returns the parameter used to acquire the find mode.

Returns:

find mode parameter

getUseCoverageParameter

public Parameter<Boolean> getUseCoverageParameter()

Returns the parameter used to acquire the coverage usage flag. return use coverage parameter

getParallelParameter

public Parameter<Integer> getParallelParameter()

Returns the parameter used to acquire the parallelism level.

Returns:

parallelism level parameter