Documentation for /Users/drupke/Dropbox/git/ifsfit/

Generated by IDLdoc

common/

ifsf_cmplin.pro


top ifsf_cmplin

IFSFIT

result = ifsf_cmplin(instr, line, comp [, velsig=byte])

Compute emission line profile of a given line and velocity component.

Return value

Array of fluxes representing emission line profile.

Parameters

instr in required type=structure

Contains parameters of line profile. Required tags are PARAM, which is an array of best fit line parameters output from MPFIT; LINELABEL, which is an array of line labels; and WAVE, which is the wavelength array of the full spectrum.

line in required type=string

Name of line for which to compute profile.

comp in required type=integer

Number of velocity component for which to compute line profile.

Keywords

velsig in optional type=byte default=0

Set if line sigma in PARAM array is in velocity space (km/s).

Author information

Author:

David S. N. Rupke:

Rhodes College Department of Physics 2000 N. Parkway Memphis, TN 38104 drupke@gmail.com

Copyright:

Copyright (C) 2013 David S. N. Rupke

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 3 of the License or 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, see http://www.gnu.org/licenses/.

History:

ChangeHistory:

2013sep12 DSNR made into stand-alone routine 2013oct09, DSNR, added documentation 2013nov13, DSNR, renamed, added license and copyright

File attributes

Modification date: Wed Nov 13 14:24:45 2013
Lines: 79
Docformat: rst rst