|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.cone.ConeMatcher
public class ConeMatcher
TableProducer which does the work for a multiple cone search-type sky crossmatch operation.
Constructor Summary | |
---|---|
ConeMatcher(ConeSearcher coneSearcher,
TableProducer inProd,
QuerySequenceFactory qsFact,
boolean bestOnly)
Convenience constructor which selects default values for most options. |
|
ConeMatcher(ConeSearcher coneSearcher,
TableProducer inProd,
QuerySequenceFactory qsFact,
boolean bestOnly,
int parallelism,
String copyColIdList,
String distanceCol,
uk.ac.starlink.table.JoinFixAction inFixAct,
uk.ac.starlink.table.JoinFixAction coneFixAct)
Full-functioned constructor. |
Method Summary | |
---|---|
static uk.ac.starlink.table.StarTable |
getConeResult(ConeSearcher coneSearcher,
boolean bestOnly,
String distanceCol,
double ra0,
double dec0,
double sr)
Performs a cone search and returns the resulting table with appropriate filtering operations applied. |
uk.ac.starlink.table.StarTable |
getTable()
Returns the result, which is a join between the input table and the table on which the cone searches are defined. |
void |
setStreamOutput(boolean streamOutput)
Determines whether this object's getTable() method will
produce a one-read-only table or not. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConeMatcher(ConeSearcher coneSearcher, TableProducer inProd, QuerySequenceFactory qsFact, boolean bestOnly)
coneSearcher
- cone search implementationinProd
- source of input table (containing each crossmatch
specification)qsFact
- object which can produce a ConeQueryRowSequencebestOnly
- true iff only the best match for each input table
row is required, false for all matches within radiuspublic ConeMatcher(ConeSearcher coneSearcher, TableProducer inProd, QuerySequenceFactory qsFact, boolean bestOnly, int parallelism, String copyColIdList, String distanceCol, uk.ac.starlink.table.JoinFixAction inFixAct, uk.ac.starlink.table.JoinFixAction coneFixAct)
coneSearcher
- cone search implementationinProd
- source of input table (containing each crossmatch
specification)qsFact
- object which can produce a ConeQueryRowSequencebestOnly
- true iff only the best match for each input table
row is required, false for all matches within radiusparallelism
- number of threads to concurrently execute matches -
only >1 if coneSearcher is thread-safecopyColIdList
- space-separated list of column identifiers for
columns to be copied to the output table,
"*" for all columnsdistanceCol
- name of column to hold position separation values,
or null for no separation columninFixAct
- column name deduplication action for input tableconeFixAct
- column name deduplication action for result
of cone searchesMethod Detail |
---|
public void setStreamOutput(boolean streamOutput)
getTable()
method will
produce a one-read-only table or not. If set true, then the output
table is good for only a single read (getRowSequence
may be called only once).
The default is false.
streamOutput
- whether output is streamedpublic uk.ac.starlink.table.StarTable getTable() throws IOException, uk.ac.starlink.task.TaskException
Note
: if the streamOut attribute of this class has been set the result will be a one-read-only table, designed for streaming.
getTable
in interface TableProducer
IOException
uk.ac.starlink.task.TaskException
public static uk.ac.starlink.table.StarTable getConeResult(ConeSearcher coneSearcher, boolean bestOnly, String distanceCol, double ra0, double dec0, double sr) throws IOException
If a non-null distanceCol
parameter is supplied,
the final column in the table will contain the angle in degrees
between the region centre and the position described in the row.
If no records in the cone are found, the return value may either be null or (preferably) an empty table with the correct columns.
coneSearcher
- cone search implementationbestOnly
- true iff only the best match for each input table
row is required, false for all matches within radiusdistanceCol
- name of column to hold distance information
int output table, or nullra0
- right ascension in degrees of region centredec0
- declination in degrees of region centresr
- search radius in degrees
IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |