Provided by: cpl-plugin-kmos-doc_1.2.8+dfsg-2_all 
NAME
kmo_rotate - Rotate a cube spatially
SYNOPSIS
esorex kmo_rotate [OPTIONS] FILE.sof
DESCRIPTION
This recipe rotates a cube spatially (CCW). If the rotation angle isn´t a multiple of 90
degrees, the output cube will be interpolated and get larger accordingly.
By default all IFUs will be rotated.
BASIC PARAMETERS
--rotations This parameter must be supplied. It contains the amount of rotation to apply.
The unit is in degrees. If it contains one value (e.g. “3.5”) all IFUs are rotated by the
same amount. If 24 values are supplied each IFU is rotated individually (e.g.
“2.3;15.7;…;-3.3”).
--imethod The interpolation method to apply when rotating an angle not being a multiple of
90. There are two methods available:
* BCS: Bicubic spline
* NN: Nearest Neighbor (currently disabled)
--ifu If a single IFU should be rotated, it can be defined using the --ifu parameter
(--rotations parameter contains only one value).
ADVANCED PARAMETERS
--flux Specify if flux conservation should be applied.
--extrapolate By default the output frame grows when rotating an angle not being a
multiple of 90. In this case none of the input data is lost. When it is desired to keep
the same size as the input frame this parameter can be set to TRUE and the data will be
clipped.
Input files:
DO KMOS
category Type Explanation Required #Frames
-------- ----- ----------- -------- -------
<none or any> F3I data frame Y 1
Output files:
DO KMOS
category Type Explanation
-------- ----- -----------
ROTATE F3I Rotated data cube
OPTIONS
--imethod <str>
Method to use for interpolation: ["BCS" (bicubic spline, default), "NN" (nearest
neighbor), not implemented yet] (str; default: ´BCS´). The full name of this option
for the EsoRex configuration file is kmos.kmo_rotate.imethod [default = BCS].
--extrapolate <bool>
Applies only when rotation angle is different from multiples of 90 degrees: FALSE:
Output IFU will be larger than the input (Default), TRUE: The size of input and
output IFU remains the same. Data will be clipped. (bool; default: False). The full
name of this option for the EsoRex configuration file is
kmos.kmo_rotate.extrapolate [default = False].
--rotations <str>
The rotations for all specified IFUs. "rot1;rot2;..." (degrees) (str; default: ´´).
The full name of this option for the EsoRex configuration file is
kmos.kmo_rotate.rotations [default = ].
--ifu <long>
The IFU to rotate [1 to 24] or rotate all IFUs [0, default]. (long; default: 0).
The full name of this option for the EsoRex configuration file is
kmos.kmo_rotate.ifu [default = 0].
--flux <bool>
Apply flux conservation: (TRUE (apply) or FALSE (don´t apply) (bool; default:
False). The full name of this option for the EsoRex configuration file is
kmos.kmo_rotate.flux [default = False].
Note that it is possible to create a configuration file containing these options, along
with suitable default values. Please refer to the details provided by the 'esorex --help'
command.
SEE ALSO
The full documentation for the kmos pipeline can be downloaded as a PDF file using the
following URL:
ftp://ftp.eso.org/pub/dfs/pipelines/kmos/kmos-pipeline-manual-2.9.pdf
An overview over the existing ESO pipelines can be found on the web page
http://www.eso.org/sci/software/pipelines/.
Basic documentation about the EsoRex program can be found at the esorex (1) man page.
It is possible to call the pipelines from python using the python-cpl package. See
http://packages.python.org/python-cpl/index.html for further information.
The other recipes of the kmos pipeline are kmo_dev_setup(7), kmo_copy(7), kmo_flat(7),
kmo_fits_check(7), kmo_sci_red(7), kmo_illumination(7), kmo_fits_stack(7),
kmo_noise_map(7), kmo_extract_spec(7), kmo_multi_reconstruct(7), kmo_stats(7),
kmo_shift(7), kmo_wave_cal(7), kmo_dark(7), kmo_arithmetic(7), kmo_std_star(7),
kmo_fits_strip(7), kmo_combine(7), kmo_illumination_flat(7), kmo_make_image(7),
kmo_sky_tweak(7), kmo_fit_profile(7), kmo_sky_mask(7), kmo_reconstruct(7)
VERSION
kmo_rotate 1.2.8
AUTHOR
Alex Agudo Berbel <kmos-spark@mpe.mpg.de>
BUG REPORTS
Please report any problems to kmos-spark@mpe.mpg.de. Alternatively, you may send a report
to the ESO User Support Department <usd-help@eso.org>.
LICENSE
This file is part of the KMOS Instrument Pipeline Copyright (C) 2002,2003 European
Southern Observatory
This program is free software; you can redistribute it and/or modify it under the terms of
the GNU General Public License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program;
if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500, Boston, MA
02110-1335 USA