Provided by: cpl-plugin-kmos-doc_1.2.8+dfsg-2_all 
NAME
kmo_shift - Shift a cube spatially
SYNOPSIS
esorex kmo_shift [OPTIONS] FILE.sof
DESCRIPTION
This recipe shifts a cube spatially. A positive x-shift shifts the data to the left, a
positive y-shift shifts upwards, where a shift of one pixel equals 0.2arcsec. The output
will still have the same dimensions, but the borders will be filled with NaNs accordingly.
To adjust only the WCS without moving the data the --wcs-only parameter has to be set to
TRUE. The WCS is updated in the same way as if the data would have moved as well. This
means that the point at (x,y) has the same coordinates as the point (x+1,y+1) after
updating the WCS (the WCS moved in the opposite direction).
BASIC PARAMETERS
--shifts This parameter must be supplied. It contains the amount of shift to apply. The
unit is in arcsec. If the --shifts parameter contains only two values (x,y), all IFUs will
be shifted by the same amount. If it contains 48 values (x1,y1;x2,y2;...;x24,y24), the
IFUs are shifted individually.
--imethod The interpolation method to apply when the shift value isn’t a multiple of the
pixel scale. There are two methods available:
* BCS: Bicubic spline
* NN: Nearest Neighbor
--ifu If a single IFU should be shifted, it can be defined using the --ifu parameter
(--shifts parameter contains only two values).
ADVANCED PARAMETERS
--flux Specify if flux conservation should be applied.
--extrapolate By default no extrapolation is applied. This means that the output frame
will shrink at most one pixel, because the data is shifted out of the frame. When turning
extrapolation on, the size of the output frame stays the same as for the input frame.
--wcs-only By default data and WCS are shifted in sync. If this parameter is set to TRUE
only the WCS is updated (i.e. if someone thinks that the IFU isn´t pointing exactly to the
correct coordinates.)
Input files:
DO KMOS
category Type Explanation Required #Frames
-------- ----- ----------- -------- -------
<none or any> F3I data frame Y 1
Output files:
DO KMOS
category Type Explanation
-------- ----- -----------
SHIFT F3I Shifted data cube
OPTIONS
--imethod <str>
Method to use for interpolation. ["BCS" (bicubic spline, default), "NN" (nearest
neighbor)] (str; default: ´BCS´). The full name of this option for the EsoRex
configuration file is kmos.kmo_shift.imethod [default = BCS].
--extrapolate <bool>
Applies only to ´method=BCS´ when doing sub-pixel shifts: FALSE: shifted IFU will
be filled with NaN´s at the borders,TRUE: shifted IFU will be extrapolated at the
borders (bool; default: False). The full name of this option for the EsoRex
configuration file is kmos.kmo_shift.extrapolate [default = False].
--shifts <str>
The shifts for each spatial dimension for all specified IFUs."x1,y1;x2,y2;..."
(arcsec) (str; default: ´´). The full name of this option for the EsoRex
configuration file is kmos.kmo_shift.shifts [default = ].
--ifu <long>
The IFU to shift [1 to 24] or shift all IFUs Default value of 0 applies shift to
all IFUs. (long; default: 0). The full name of this option for the EsoRex
configuration file is kmos.kmo_shift.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_shift.flux [default = False].
--wcs-only <bool>
FALSE: if data and wcs should be updated.TRUE: if only wcs should be corrected
(bool; default: False). The full name of this option for the EsoRex configuration
file is kmos.kmo_shift.wcs-only [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_rotate(7), kmo_extract_spec(7), kmo_multi_reconstruct(7),
kmo_stats(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_shift 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