kmo_shift7
Shift a cube spatially
Usage
esorex kmo_shift [OPTIONS] FILE.sof
Overview
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.
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.
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 <int> -
The IFU to shift [1 to 24] or shift all IFUs Default value of 0 applies shift to all IFUs. (int; 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].
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.
Version
kmo_shift 2.1.0
Releases
3 releases since Debian 8 (Jessie); the text changed 2 times.
--wcs-only until Debian 9 (Stretch).