Astro::Corlate - Object a catalog corelation
use Astro::Corlate; $corlate = new Astro::Corlate( Reference => $catalogue, Observation => $observation ); # run the corelation routine $corlate->run_corrlate(); # get the log file my $log = $corlate->logfile(); # get the variable star catalogue my $variables = $corlate->variables(); # fitted colour data catalogue my $data = $corlate->data(); # fit to the colour data my $fit = $corlate->fit(); # get probability histogram file my $histogram = $corlate->histogram(); # get the useful information file my $information = $corlate->information();
This module is an object-orientated interface to the Astro::Corlate::Wrapper module, which in turn wraps the Fortran 95 CORLATE sub-routine. It will save returned files into the ESTAR_DATA directory or to TMP if the ESTAR_DATA environment variable is not defined.
$Id: Corlate.pm,v 1.6 2002/03/31 21:58:20 aa Exp $
Create a new instance from a hash of options
$query = new Astro::Corlate( Reference => $catalogue, Observation => $observation );
returns a reference to an Corlate object.
Runs the catalog corelation subroutine
$corlate->run_corlate();
Sets (or returns) the file name of the reference catalogue
$file_name = $corlate->reference( ); $corlate->reference( $file_name );
this catalogue file should be in CLUSTER format.
Sets (or returns) the file name of the new observation catalogue
$file_name = $corlate->observation( ); $corlate->observation( $file_name );
Returns the full path to the Corlate log file
$file_name = $corlate->logfile( );
Returns the full path to the variable star catalogue file
$file_name = $corlate->variables( );
Returns the full path to the catalogue file containing the fitted colour data
$file_name = $corlate->data( );
Returns the full path to the X-Y file defining the fit to the colour data
$file_name = $corlate->fit( );
Returns the full path to the X-Y data file of the probability histogram
$file_name = $corlate->histogram( );
Returns the full path to the Corlate useful information file
$file_name = $corlate->information( );
Configures the object, takes an options hash as an argument
$corlate->configure( %options );
Does nothing if the array is not supplied.
Copyright (C) 2001 University of Exeter. All Rights Reserved.
This program was written as part of the eSTAR project and is free software; you can redistribute it and/or modify it under the terms of the GNU Public License.
Alasdair Allan <aa@astro.ex.ac.uk>,
1 POD Error
The following errors were encountered while parsing the POD:
You forgot a '=back' before '=head1'
To install Astro::Corlate, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Astro::Corlate
CPAN shell
perl -MCPAN -e shell install Astro::Corlate
For more information on module installation, please visit the detailed CPAN module installation guide.