Package 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:
uk.ac.starlink.task.Task
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 -
Method Summary
Modifier and TypeMethodDescriptioncreateProducer
(uk.ac.starlink.task.Environment env) Returns an object which can produce the effective output table which will be consumed by this task.uk.ac.starlink.task.Parameter
<ConeErrorPolicy> Returns the parameter used to acquire the error policy.getConer()
Returns the coner used by this task.uk.ac.starlink.task.Parameter
<String> Returns the parameter used to acquire declination in degrees.uk.ac.starlink.task.Parameter
<ConeFindMode> Returns the parameter used to acquire the find mode.uk.ac.starlink.task.Parameter
<Integer> Returns the parameter used to acquire the parallelism level.uk.ac.starlink.task.Parameter
<String> Returns the parameter used to acquire radius expression in degrees.uk.ac.starlink.task.Parameter
<String> Returns the parameter used to acquire RA expression in degrees.uk.ac.starlink.task.Parameter
<Boolean> 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
-
Constructor Details
-
SkyConeMatch2
Constructor.- Parameters:
purpose
- one-line description of the purpose of the taskconer
- object which provides the sky cone search servicemaxParallel
- 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 Details
-
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. The table produced by the resulting producer can be fed to theConsumerTask.getIdentity(uk.ac.starlink.table.StarTable)
method.- Specified by:
createProducer
in classConsumerTask
- Parameters:
env
- execution environment- Returns:
- table producer
- Throws:
uk.ac.starlink.task.TaskException
-
getConer
Returns the coner used by this task.- Returns:
- coner
-
getRaParameter
Returns the parameter used to acquire RA expression in degrees.- Returns:
- right ascension parameter
-
getDecParameter
Returns the parameter used to acquire declination in degrees.- Returns:
- declination parameter
-
getRadiusDegreeParameter
Returns the parameter used to acquire radius expression in degrees.- Returns:
- radius parameter
-
getConeErrorPolicyParameter
Returns the parameter used to acquire the error policy.- Returns:
- error policy parameter
-
getFindModeParameter
Returns the parameter used to acquire the find mode.- Returns:
- find mode parameter
-
getUseCoverageParameter
Returns the parameter used to acquire the coverage usage flag. return use coverage parameter -
getParallelParameter
Returns the parameter used to acquire the parallelism level.- Returns:
- parallelism level parameter
-