NAME

Image::DS9::Constants - predefined constants

VERSION

version 0.188

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")'

BUGS AND LIMITATIONS

You can make new bug reports, and view existing ones, through the web interface at https://rt.cpan.org/Public/Dist/Display.html?Name=Image-DS9.

SEE ALSO

Please see those modules/websites for more information related to this module.

AUTHOR

Diab Jerius <djerius@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2017 by Smithsonian Astrophysical Observatory.

This is free software, licensed under:

  The GNU General Public License, Version 3, June 2007