DESCRIPTION

Image::DS9 provides the user access to DS9's directives via methods which closely mirror their syntax. This document provides the list of methods, as generated from Image::DS9's internal grammar

Most methods exactly parallel the DS9 XPA commands. For more information on what the methods do, or how the arguments affect things, please consult the DS9 documentation.

In general each element in a command is passed as a separate argument to the method. For example, to change the binning factor:

  $dsp->bin( factor => 0.2 );

Some commands have more arguments:

  $dsp->bin( smooth => function => 'boxcar' );
  $dsp->bin( smooth => radius => 33 );
  $dsp->bin( about => ( 3, 3 ) );
  $dsp->bin( cols => ( 'rt_x', 'rt_y' ) );

Note the use of the => operator to force preceding barewords to be treated as strings, and the frivolous use of extra parenthesis for aesthetics. Some arguments are concatenated to avoid confusion; see the documentation for the individual methods.

Some commands can query DS9 for state information as well as set it. For example,

        $function = $dsp->bin( smooth => function );

Image::DS9 differentiates between the setting and requesting of values by the presence or absence of the argument containing the information.

Some commands take a hash as their last argument, which contains attributes which are passed on to DS9.

True Boolean values may be one of the following: 1, yes, true. False Boolean values may be one of the following: 0, no, false. Boolean values returned by a command are always translated into either 0 or 1.

The documentation for the commands lists the options supported and any deviations from the general approach described above. Refer to the DS9 XPA documentation to determine which commands permit queries and the allowed data types for the arguments. Image::DS9 checks that all data passed to DS9 is of the appropriate type.

Arguments and Return values

Please see Image::DS9::Manual::Interface for the general concepts around argument passing and return values.

%DOCS%