Astro::Correlate::Method::FINDOFF - Correlation using Starlink FINDOFF.
( $corrcat1, $corrcat2 ) = Astro::Correlate::Method::FINDOFF->correlate( catalog1 => $cat1, catalog2 => $cat2 );
This class implements catalogue cross-correlation using Starlink's FINDOFF application.
Cross-correlates two catalogues.
This method takes two mandatory arguments, both Astro::Catalog objects. It returns two Astro::Catalog objects containing Astro::Catalog::Star objects that matched spatially between the two input catalogues. The first returned catalogue contains matched objects from the first input catalogue, and ditto for the second. The Astro::Catalog::Star objects in the returned catalogues are not in the original order, nor do they have the same IDs as in the input catalogues. A matched object has the same ID in the two returned catalogues, allowing for further comparisons between matched objects.
Astro::Catalog
Astro::Catalog::Star
This method takes the following optional named arguments:
This method uses the Starlink FINDOFF task, which is part of CCDPACK. In order for this method to work it must be able to find FINDOFF. It first looks in the directory pointed to by the CCDPACK_DIR environment variable, then it looks in the Starlink binary files directory pointed to by the Starlink::Config module, with /ccdpack appended. If either of these fail, then this method will croak. See the Starlink::Config module for information on overriding the base Starlink directory for non-standard installations.
/ccdpack
Starlink::Config
Astro::Correlate, Starlink::Config
Astro::Correlate
Starlink User Note 139.
$Id$
Brad Cavanagh <brad.cavanagh@gmail.com>
Copyright (C) 2005 Particle Physics and Astronomy Research Council. All Rights Reserved.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place,Suite 330, Boston, MA 02111-1307, USA
To install Astro::Correlate, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Astro::Correlate
CPAN shell
perl -MCPAN -e shell install Astro::Correlate
For more information on module installation, please visit the detailed CPAN module installation guide.