NAME

Image::DS9::Constants - predefined constants

SYNOPSIS

# import all of the constants
use Image::DS9::Constants;

# import a subset
use Image::DS9::Constants qw( _const1 _const2 );

# change the prefix
use Image::DS9::Constants Prefix => 'X_';

# change the prefix and import a subset
use Image::DS9::Constants 
   Prefix => 'X_', qw( X_const1 X_const2 );

# list the available constants;
use Image::DS9::Constants;
Image::DS9::Constants::list;
Image::DS9::Constants::list( Prefix => 'X_' );

DESCRIPTION

This module provides a large number of Perl constants for option strings used to communicate with DS9. The constants have a default prefix of _, which may be changed by the user (see "SYNOPSIS"). See the documentation for the Perl constant module for information on what constitutes a legal constant name (for instance, two leading underscores are not allowed).

To determine what the constants are, use the list function:

perl -MImage::DS9::Constants \
        -e 'Image::DS9::Constants::list'

This will print a listing of all of the constants. To specify a different prefix,

perl -MImage::DS9::Constants \
        -e 'Image::DS9::Constants::list( Prefix => "XX")'

LICENSE

This software is released under the GNU General Public License. You may find a copy at

http://www.fsf.org/copyleft/gpl.html

AUTHOR

Diab Jerius ( djerius@cfa.harvard.edu )

SEE ALSO

perl(1), Image::DS9;