uk.ac.starlink.ttools.join

Class SkyMatch2Mapper

java.lang.Object

uk.ac.starlink.ttools.join.SkyMatch2Mapper

All Implemented Interfaces:

TableMapper

public class SkyMatch2Mapper
extends Object
implements TableMapper

TableMapper which does the work for sky-specific pair matching (tskymatch2).

Since:

2 Nov 2007

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
SkyMatch2Mapper() Constructor.

Method Summary

Modifier and Type	Method and Description
TableMapping	createMapping(Environment env, int nin) Creates a new mapping object, using a given execution environment for any additional required state.
StringParameter[]	getDecParameters() Returns the parameters used to acquire the Declination value expressions in degrees for the two input tables.
Parameter<Double>	getErrorArcsecParameter() Returns the parameter used to acquire the match error in arcsec.
Parameter<Integer>	getHealpixLevelParameter() Returns the parameter used to acquire the HEALPix level.
Parameter<JoinType>	getJoinTypeParameter() Returns the parameter used to acquire the join type.
Parameter<PairMode>	getPairModeParameter() Returns the parameter used to acquire the pair mode.
Parameter<?>[]	getParameters() Returns the parameters defined by this mapper.
StringParameter[]	getRaParameters() Returns the parameters used to acquire the RA value expressions in degrees for the two input tables.

Methods inherited from class java.lang.Object

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

Constructor Detail

SkyMatch2Mapper

public SkyMatch2Mapper()

Constructor.

Method Detail

getParameters

public Parameter<?>[] getParameters()

Description copied from interface: TableMapper

Returns the parameters defined by this mapper.

Specified by:

getParameters in interface TableMapper

Returns:

parameter array

getRaParameters

public StringParameter[] getRaParameters()

Returns the parameters used to acquire the RA value expressions in degrees for the two input tables.

Returns:

2-element array of RA parameters

getDecParameters

public StringParameter[] getDecParameters()

Returns the parameters used to acquire the Declination value expressions in degrees for the two input tables.

Returns:

2-element array of declination parameters

getErrorArcsecParameter

public Parameter<Double> getErrorArcsecParameter()

Returns the parameter used to acquire the match error in arcsec.

Returns:

match error parameter

getPairModeParameter

public Parameter<PairMode> getPairModeParameter()

Returns the parameter used to acquire the pair mode.

Returns:

pair mode parameter

getJoinTypeParameter

public Parameter<JoinType> getJoinTypeParameter()

Returns the parameter used to acquire the join type.

Returns:

join type parameter

getHealpixLevelParameter

public Parameter<Integer> getHealpixLevelParameter()

Returns the parameter used to acquire the HEALPix level.

Returns:

healpix level parameter

createMapping

public TableMapping createMapping(Environment env,
                                  int nin)
                           throws TaskException

Description copied from interface: TableMapper

Creates a new mapping object, using a given execution environment for any additional required state.

Specified by:

createMapping in interface TableMapper

Parameters:

env - execution environment

nin - number of input tables that the mapping will operate on if known; -1 if not

Throws:

TaskException