Help-Site Computer Manuals
Software
Hardware
Programming
Networking
  Algorithms & Data Structures   Programming Languages   Revision Control
  Protocols
  Cameras   Computers   Displays   Keyboards & Mice   Motherboards   Networking   Printers & Scanners   Storage
  Windows   Linux & Unix   Mac

Astro::Corlate
Object a catalog corelation

Astro::Corlate - Object a catalog corelation


NAME

Astro::Corlate - Object a catalog corelation


SYNOPSIS


  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();


DESCRIPTION

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.


REVISION

$Id: Corlate.pm,v 1.6 2002/03/31 21:58:20 aa Exp $


METHODS

Constructor

new
Create a new instance from a hash of options

  $query = new Astro::Corlate( Reference   =>  $catalogue,

                               Observation =>  $observation );

returns a reference to an Corlate object.

Accessor Methods

run_corlate
Runs the catalog corelation subroutine

   $corlate->run_corlate();

Reference
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.

Observation
Sets (or returns) the file name of the new observation catalogue

   $file_name = $corlate->observation( );

   $corlate->observation( $file_name );

this catalogue file should be in CLUSTER format.

Logfile
Returns the full path to the Corlate log file

   $file_name = $corlate->logfile( );

Variables
Returns the full path to the variable star catalogue file

   $file_name = $corlate->variables( );

Data
Returns the full path to the catalogue file containing the fitted colour data

   $file_name = $corlate->data( );

Fit
Returns the full path to the X-Y file defining the fit to the colour data

   $file_name = $corlate->fit( );

Histogram
Returns the full path to the X-Y data file of the probability histogram

   $file_name = $corlate->histogram( );

Information
Returns the full path to the Corlate useful information file

   $file_name = $corlate->information( );

General Methods

configure
Configures the object, takes an options hash as an argument

  $corlate->configure( %options );

Does nothing if the array is not supplied.


COPYRIGHT

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.


AUTHORS

Alasdair Allan <aa@astro.ex.ac.uk>,

Programminig
Wy
Wy
yW
Wy
Programming
Wy
Wy
Wy
Wy