Content-type: text/html Manpage of imframe

imframe

Section: User Commands (1)
Index Return to Main Contents
 

NAME

imframe - Interchange axes of a cube and decrease/enlarge the frame  

PERSON RESPONSIBLE

bpw  

CATEGORIES

map manipulation  

DESCRIPTION

IMFRAME takes any part of an input cube, rotates it over any combination of 90 deg angles and writes the result anywhere in an output cube. This works on any cube whose longest axis is less than 262144 pixels long. Note that IMFRAME does not resample images, only whole-pixel transformations are possible. See REGRID to resample/rotate in a more arbitrary way, or IMSUB for another resampling approach.  

PARAMETERS

in
The input image. No default.
region
This selects a subregion of an image. Multiple subregions can be selected, which are "ored" together. The following subcommands are recognized (each of which can be abbreviated to uniqueness).

  images(z1,z2)
Select image planes z1 to z2 inclusive. z2 defaults to z1.

  quarter(z1,z2)
Select the inner quarter of the image planes z1 to z2 inclusive. If both z1 and z2 are missing, then all planes are selected. If only z2 is omitted, z2 defaults to z1.

  boxes(xmin,ymin,xmax,ymax)(z1,z2)
Select the pixels within a box with corners xmin,ymin,xmax,ymax. z1 and z2 are the same as in the "image" subcommand. If z1 and z2 are omitted, all planes are selected.

  polygon(x0,y0,x1,y1,x2,y2,...)(z1,z2)
Select the pixels within the polygon defined by the list of vertices. z1 and z2 are the same as in the "image" subcommand. If z1 and z2 are missing, all planes are selected. If only z2 is omitted, it defaults to z1.

  mask(file)
Select pixels according to the mask given in the file.

The units of the numbers given in the above commands are, in general, absolute pixels. But this can be changed (and rechanged) by using one of the following subcommands.

  abspixel
Coordinates are interpreted as absolute pixel values, the default.
  relpixel
Coordinates are relative to the reference pixel of the map.
  relcenter
Coordinates are relative to the central pixel of the map, (defined as (naxis1/2+1,naxis2/2+1)).
  arcsec
Coordinates are in arcseconds, relative to the reference pixel.
  kms
Coordinates in the third dimension are in km/s.
box
Some subcommands of the region keyword work only nicely on 3-d cubes. This is too limited for imframe, so an alternative keyword is provided for other cases, which is less fancy than region= but it does the job. The values to be given are a list of ranges for each coordinate axis, in relative pixel coordinates, in the order
  xmin,xmax,ymin,ymax,...
etc. c Note that this is different from the standard region order xmin,ymin,xmax,ymax. The default is to take the whole cube. box= and region= are mutually exclusive.
out
The output image. No default.
frame
The size of the output dataset, The values to be given are a list of ranges for each coordinate axis, in relative pixel coordinates, in the order
  xmin,xmax,ymin,ymax,...
etc. Note that this is different from the standard region order xmin,ymin,xmax,ymax. The defined frame may be bigger or smaller than the input box. The values refer to the axes in the original ordering. If not given, the input box is assumed (from either region= or box=, whichever one was given).
goal
The new axis ordering in terms of the old axis ordering: i.e. 'zxy' makes the original 'z'-axis the 'x'-axis of the output. It is only necessary to give the axes that are changed, the other axes are concatenated to the list, i.e. 'z' would do just as well in the example above. The default is not to exchange axes. Precede an axisname with a - to reverse the direction.


 

Index

NAME
PERSON RESPONSIBLE
CATEGORIES
DESCRIPTION
PARAMETERS

This document was created by man2html, using the manual pages.
Time: 18:35:38 GMT, July 05, 2011