Ubuntu Manpage: kmo_fit_profile - Fit spectral line profiles as well as spatial profiles with a simple function

name
synopsis
description
options
see also
version
author
bug reports
license

Provided by: cpl-plugin-kmos-doc_1.4.3+dfsg-1_all

NAME

       kmo_fit_profile  -  Fit  spectral  line profiles as well as spatial profiles with a simple function - for
       example to measure resolution or find the centre of a source

SYNOPSIS

       esorex kmo_fit_profile [OPTIONS] FILE.sof

DESCRIPTION

This recipe creates either spectral or spatial profiles of sources using dif- ferent functions to fit.
Spectral profiles can be created for F1I frames (if WCS is defined in the input frame, the output
parameters are in respect to the defined WCS).

Spatial profiles can be created for F2I frames (any WCS information is ignored here).

If the frames contain no noise information, constant noise is assumed for the fitting procedure.

BASIC PARAMETERS
--method F1I frames can be fitted using either ´gauss´, ´moffat´ or ´lorentz´ function.

F2I frames can be fitted using either ´gauss´ or ´moffat´ function.

ADVANCED PARAMETERS
--range For F1I frames the spectral range can be defined. With available WCS informa- tion the range can
be provided in units (e.g. “1.2;1.5”), otherwise in pixels (e.g. “112;224).

For F2I frames the spatial range can be defined as follow: “x1,x2;y1,y2”

Input files:

DO KMOS
category Type Explanation Required #Frames
-------- ----- ----------- -------- -------
<none or any> F1I or Frame with or Y 1
F2I without noise

Output files:

DO KMOS
category Type Explanation
-------- ----- -----------
FIT_PROFILE F1I Fitted profile (without noise frame)
or (3 Extensions)
F2I

OPTIONS

       --method <str>
              Either  fit "gauss", "moffat" or "lorentz" for 1D data.Either fit "gauss" or "moffat" for 2D data.
              (str; default: ´gauss´). The full name of  this  option  for  the  EsoRex  configuration  file  is
              kmos.kmo_fit_profile.method [default = gauss].

       --range <str>
              The  spectral  or  spatial  range  to  combine.  Default  is the whole range.  e.g. F1I: "0.5,2.1"
              (microns), e.g. F2I: "1,7;3,10" (pixels: x1,x2;y1,y2), pixels are counted from 1.  (str;  default:
              ´´).  The full name of this option for the EsoRex configuration file is kmos.kmo_fit_profile.range
              [default = ].

       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.

       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_arithmetic(7),  kmo_copy(7),  kmo_fits_strip(7),
       kmo_make_image(7),  kmo_noise_map(7),   kmo_rotate(7),   kmo_shift(7),   kmo_sky_mask(7),   kmo_stats(7),
       kmos_combine(7),      kmos_dark(7),     kmos_extract_spec(7),     kmos_flat(7),     kmos_gen_reflines(7),
       kmos_gen_telluric(7),  kmos_illumination(7),  kmos_reconstruct(7),  kmos_sci_red(7),   kmos_sky_tweak(7),
       kmos_std_star(7), kmos_test(7), kmos_wave_cal(7)

VERSION

       kmo_fit_profile 1.4.3

AUTHOR

       Alex Agudo Berbel <usd-help@eso.org>

BUG REPORTS

       Please  report  any  problems  to  usd-help@eso.org. Alternatively, you may send a report to the ESO User
       Support Department <usd-help@eso.org>.

LICENSE

       This file is part of the CRIRES 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, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA