The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Image-DS9-v1.0.0
River stage zero No dependents
/ Image::DS9::Constants::V1

NAME

Image::DS9::Constants::V1 - predefined constants

VERSION

version v1.0.0

SYNOPSIS

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

# import a subset
use Image::DS9::Constants::V1 qw( const1 const2 );

# change the prefix and import all of the constants
use Image::DS9::Constants::V1 { prefix => 'X_' }, '-all';

# change the prefix and import a subset
# imports X_const1, X_const2
use Image::DS9::Constants::V1
   { prefix => 'X_' }, qw( const1 const2 );

# list the available constants
use Image::DS9::Constants::V1;
Image::DS9::Constants::V1::list;

DESCRIPTION

This module provides Perl constants for option strings used to communicate with DS9, making it easier to spot typos in code. For example,

use Image::DS9::Constants::V1
   { prefix => 'X_' }, qw( reset );

$ds9->regions( 'resett' );

will be caught at run time, while

$ds9->regions( X_resett );

will be caught at compile time.

Renaming constants

Image::DS9::Constants uses Exporter::Tiny, so the constant names can be modified when they are imported into the user's package. See that module's documentation for more information (See also the above "SYNOPSIS").

Groups of constants

Image::DS9 uses CXC::Exporter::Util to provide enumerating functions for groups of constants. To import an entire group (e.g. the DSS_ESO_SURVEYS group)

use Image::DS9::Constants -dss_eso_surveys;

To import the enumerating function for a group (e.g. the DSS_ESO_SURVEYS group):

use Image::DS9::Constants 'DSS_ESO_SURVEYS';

Listing Constants

To list the available constants, use the list function:

perl -MImage::DS9::Constants=list -e 'list'

This will print a listing of all of the constants.

CONSTANT GROUPS

The following groups are available. The group name is also the enumerating function for the constants in the group, e.g.

say $_ for ANGULAR_FORMATS;

results in

degrees
sexagesimal

ANGULAR_FORMATS

ANGULAR_FORMAT_DEGREES => degrees

ANGULAR_FORMAT_SEXAGESIMAL => sexagesimal

ANGULAR_UNITS

ANGULAR_UNIT_ARCMIN => arcmin

ANGULAR_UNIT_ARCSEC => arcsec

ANGULAR_UNIT_DEGREES => degrees

BIN_FUNCTIONS

BIN_FUNCTION_AVERAGE => average

BIN_FUNCTION_SUM => sum

COLORS

BLACK => black

BLUE => blue

CYAN => cyan

GREEN => green

MAGENTA => magenta

RED => red

WHITE => white

YELLOW => yellow

DSS_ESO_SURVEYS

DSS_ESO_DSS1 => DSS1

DSS_ESO_DSS2_BLUE => DSS2-blue

DSS_ESO_DSS2_INFRARED => DSS2-infrared

DSS_ESO_DSS2_RED => DSS2-red

DSS_STSCI_SURVEYS

DSS_STSCI_ALL => all

DSS_STSCI_GSC1 => gsc1

DSS_STSCI_PHASE2 => phase2

DSS_STSCI_PHASE2_GSC2 => phase2_gsc2

DSS_STSCI_QUICKV => quickv

FRAME_COORD_SYSTEMS

FRAME_COORDSYS_IMAGE => image

FRAME_COORDSYS_PHYSICAL => physical

FRAME_COORDSYS_WCS => wcs

FRAME_COORDSYS_WCSA - FRAME_COORDSYS_WCSZ => wcsa - wcsz

MINMAX_MODES

MINMAX_MODE_DATAMIN => datamin

MINMAX_MODE_IRAFMIN => irafmin

MINMAX_MODE_SAMPLE => sample

MINMAX_MODE_SCAN => scan

MOUSE_BUTTON_MODES

MOUSE_BUTTON_MODE_3D => 3d

MOUSE_BUTTON_MODE_CATALOG => catalog

MOUSE_BUTTON_MODE_COLORBAR => colorbar

MOUSE_BUTTON_MODE_CROSSHAIR => crosshair

MOUSE_BUTTON_MODE_EXAMINE => examine

MOUSE_BUTTON_MODE_NONE => none

MOUSE_BUTTON_MODE_PAN => pan

MOUSE_BUTTON_MODE_REGION => region

MOUSE_BUTTON_MODE_ROTATE => rotate

MOUSE_BUTTON_MODE_ZOOM => zoom

NAMESERVERS

NAMESERVER_NED_CDS => ned-cds

NAMESERVER_NED_SAO => ned-sao

NAMESERVER_SIMBAD_CDS => simbad-cds

NAMESERVER_SIMBAD_SAO => simbad-sao

NAMESERVER_VIZIER_CDS => vizier-cds

NAMESERVER_VIZIER_SAO => vizier-sao

PAGE_ORIENTATIONS

PAGE_ORIENT_LANDSCAPE => landscape

PAGE_ORIENT_PORTRAIT => portrait

PAGE_SIZES

PAGE_SIZE_A4 => a4

PAGE_SIZE_LEGAL => legal

PAGE_SIZE_LETTER => letter

PAGE_SIZE_POSTER => poster

PAGE_SIZE_TABLOID => tabloid

REGION_FORMATS

REGION_FORMAT_CIAO => ciao

REGION_FORMAT_DS9 => ds9

REGION_FORMAT_PROS => pros

REGION_FORMAT_SAOIMAGE => saoimage

REGION_FORMAT_SAOTNG => saotng

REGION_FORMAT_XML => xml

REGION_FORMAT_XY => xy

SKY_COORD_SYSTEMS

SKY_COORDSYS_ECLIPTIC => ecliptic

SKY_COORDSYS_FK4 => fk4

SKY_COORDSYS_FK5 => fk5

SKY_COORDSYS_GALACTIC => galactic

SKY_COORDSYS_ICRS => icrs

WCS

WCSA - WCSZ => wcsa - wcsz

GRAPH_ORIENTATIONS

GRAPH_VERTICAL => vertical

GRAPH_HORIZONTAL => horizontal

MISC

These are available, but deprecated, as they are common names for existing subroutines. It's best to import them with a prefix, e.g.

use Image::DS9::Constants::V1 { prefix => 'X_' }, -misc;

They have not been updated for DS9 V8.4.1, so some are no longer valid.

about	       => 'about'	      abs	   => 'abs'
active       => 'active'	      align	   => 'align'
all	       => 'all'		      amplifier	   => 'amplifier'
append       => 'append'	      array	   => 'array'
automatic    => 'automatic'	      average	   => 'average'
background   => 'background'	      black	   => 'black'
blink	       => 'blink'	      blue	   => 'blue'
boxcar       => 'boxcar'	      buffersize   => 'buffersize'
buttons      => 'buttons'	      center	   => 'center'
clear	       => 'clear'	      colorbar	   => 'colorbar'
cols	       => 'cols'	      column	   => 'column'
command      => 'command'	      coordformat  => 'coordformat'
coordinate   => 'coordinate'	      copy	   => 'copy'
crosshair    => 'crosshair'	      cyan	   => 'cyan'
datasec      => 'datasec'	      degrees	   => 'degrees'
delete       => 'delete'	      deleteall	   => 'deleteall'
delim	       => 'delim'	      depth	   => 'depth'
destination  => 'destination'	      detector	   => 'detector'
dss	       => 'dss'		      dss2blue	   => 'dss2blue'
dss2red      => 'dss2red'	      ecliptic	   => 'ecliptic'
eso	       => 'eso'		      examine	   => 'examine'
exclude      => 'exclude'	      factor	   => 'factor'
file	       => 'file'	      filename	   => 'filename'
filter       => 'filter'	      first	   => 'first'
fits	       => 'fits'	      fk4	   => 'fk4'
fk5	       => 'fk5'		      format	   => 'format'
function     => 'function'	      galactic	   => 'galactic'
gap	       => 'gap'		      gaussian	   => 'gaussian'
global       => 'global'	      green	   => 'green'
grid	       => 'grid'	      gz	   => 'gz'
hide	       => 'hide'	      horzgraph	   => 'horzgraph'
icrs	       => 'icrs'	      image	   => 'image'
include      => 'include'	      info	   => 'info'
interpolate  => 'interpolate'	      interval	   => 'interval'
invert       => 'invert'	      jpeg	   => 'jpeg'
last	       => 'last'	      layout	   => 'layout'
level	       => 'level'	      limits	   => 'limits'
linear       => 'linear'	      load	   => 'load'
local	       => 'local'	      log	   => 'log'
magenta      => 'magenta'	      magnifier	   => 'magnifier'
manual       => 'manual'	      minmax	   => 'minmax'
mode	       => 'mode'	      mosaic	   => 'mosaic'
mosaicimage  => 'mosaicimage'	      mosaicimages => 'mosaicimages'
moveback     => 'moveback'	      movefront	   => 'movefront'
name	       => 'name'	      new	   => 'new'
next	       => 'next'	      nl	   => 'nl'
no	       => 'no'		      off	   => 'off'
on	       => 'on'		      orientation  => 'orientation'
page	       => 'page'	      pagescale	   => 'pagescale'
pagesize     => 'pagesize'	      palette	   => 'palette'
pan	       => 'pan'		      panner	   => 'panner'
paste	       => 'paste'	      physical	   => 'physical'
png	       => 'png'		      pointer	   => 'pointer'
ppm	       => 'ppm'		      prev	   => 'prev'
pros	       => 'pros'	      radius	   => 'radius'
red	       => 'red'		      refresh	   => 'refresh'
rel	       => 'rel'		      replace	   => 'replace'
resample     => 'resample'	      reset	   => 'reset'
resolution   => 'resolution'	      rotate	   => 'rotate'
row	       => 'row'		      sao	   => 'sao'
saoimage     => 'saoimage'	      saotng	   => 'saotng'
save	       => 'save'	      scope	   => 'scope'
selectall    => 'selectall'	      selected	   => 'selected'
selectnone   => 'selectnone'	      semicolon	   => 'semicolon'
server       => 'server'	      setup	   => 'setup'
sexagesimal  => 'sexagesimal'	      show	   => 'show'
single       => 'single'	      size	   => 'size'
sky	       => 'sky'		      skyformat	   => 'skyformat'
smooth       => 'smooth'	      source	   => 'source'
sqrt	       => 'sqrt'	      squared	   => 'squared'
state	       => 'state'	      strip	   => 'strip'
stsci	       => 'stsci'	      sum	   => 'sum'
survey       => 'survey'	      system	   => 'system'
tiff	       => 'tiff'	      tile	   => 'tile'
to	       => 'to'		      to_fit	   => 'to fit'
tofit	       => 'tofit'	      type	   => 'type'
url	       => 'url'		      user	   => 'user'
value	       => 'value'	      vertgraph	   => 'vertgraph'
wcs	       => 'wcs'		      white	   => 'white'
x	       => 'x'		      xy	   => 'xy'
y	       => 'y'		      yellow	   => 'yellow'
yes	       => 'yes'		      zoom	   => 'zoom'
zscale       => 'zscale'

SUPPORT

Bugs

Please report any bugs or feature requests to bug-image-ds9@rt.cpan.org or through the web interface at: https://rt.cpan.org/Public/Dist/Display.html?Name=Image-DS9

Source

Source is available at

https://gitlab.com/djerius/image-ds9

and may be cloned from

https://gitlab.com/djerius/image-ds9.git

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