|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.cone.ConeSearchConer
public class ConeSearchConer
Coner implementation which uses remote Cone Search services or similar.
Constructor Summary | |
---|---|
ConeSearchConer()
Constructor. |
Method Summary | |
---|---|
void |
configureParams(Environment env,
Parameter srParam)
Provides this object with a chance to perform custom configuration on certain general cone search parameters. |
ConeSearcher |
createSearcher(Environment env,
boolean bestOnly)
Returns a searcher object which can perform the actual cone searches as configured by this object's parameters. |
Coverage |
getCoverage(Environment env)
Returns a coverage object suitable for use with the cone search service configured by this object's parameters. |
Parameter[] |
getParameters()
Returns any configuration parameters associated with this object. |
String |
getSkySystem()
Returns "ICRS", which is the system defined to be used by the Cone Search specification. |
void |
setNside(int nside)
Sets the NSIDE parameter for MOC coverage maps. |
boolean |
useDistanceFilter(Environment env)
Indicates whether the result table generated by the created ConeSearcher object should be subjected to additional filtering to ensure that only rows in the specified search radius are included in the final output. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConeSearchConer()
Method Detail |
---|
public String getSkySystem()
getSkySystem
in interface Coner
public Parameter[] getParameters()
Coner
getParameters
in interface Coner
public void configureParams(Environment env, Parameter srParam) throws TaskException
Coner
configureParams
in interface Coner
env
- execution environmentsrParam
- search radius parameter
TaskException
public boolean useDistanceFilter(Environment env) throws TaskException
Coner
useDistanceFilter
in interface Coner
env
- execution environment
TaskException
public ConeSearcher createSearcher(Environment env, boolean bestOnly) throws TaskException
Coner
bestOnly
flag is set, then only the best match
is required. The implementation may use this as a hint if it helps
efficiency, but is not obliged to return single-row tables, since
extraneous rows will be filtered out later. Similarly any rows
which do not actually match the given criteria will be filtered out
later, so it is not an error to return too many rows.
createSearcher
in interface Coner
env
- execution environmentbestOnly
- true iff only the best match will be used
TaskException
public Coverage getCoverage(Environment env) throws TaskException
Coner
getCoverage
in interface Coner
env
- execution environment
TaskException
public void setNside(int nside)
nside
- HEALPix NSIDE parameter for MOCs
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |