Astro::Catalog::IO::Binary - base class for binary catalogues.


Astro-Catalog documentation  | view source Contained in the Astro-Catalog distribution.

Index


NAME

Top

Astro::Catalog::IO::Binary - base class for binary catalogues.

SYNOPSIS

Top

  $cat = $ioclass->read_catalog( %args );

DESCRIPTION

Top

This class provides a wrapper for reading binary catalogues into Astro::Catalog objects. The method should, in general, only be called from the Astro::Catalog configure method.

METHODS

Top

read_catalog

Read the catalog.

  $cat = $ioclass->read_catalog( %args );

Takes a hash as argument with the list of keywords. Supported options are:

  Data => Contents of catalogue, as a reference to glob (file handle)
          or a scalar containing data to be turned into a catalog.
          This key is used in preference to 'File' if both are present.
  File => File name for catalog on disk. Not used if 'Data' supplied.
  ReadOpt => Reference to hash of options to be forwarded onto the
             format specific catalogue reader. See the IO documentation
             for details.

The options are case-insensitive.

REVISION

Top

  $Id: Binary.pm,v 1.1 2005/03/31 01:26:07 cavanagh Exp $

SEE ALSO

Top

Astro::Catalog

COPYRIGHT

Top

AUTHORS

Top

Brad Cavanagh <b.cavanagh@jach.hawaii.edu>


Astro-Catalog documentation  | view source Contained in the Astro-Catalog distribution.