emissionLines: Emission Line Generation

View source: R/emissionLines.R

emissionLinesR Documentation

Emission Line Generation

Description

Code to generate emission line specra based on Levesque, Kewley & Larson (2010).

Usage

emissionLines(Ha_lum=NULL, Hb_lum=NULL, Hlines_lum=NULL, All_lum=NULL, SFR=NULL,
  Z = 0.02, q = NULL, veldisp = 50, LSF = NULL, z_LSF = 0, lumscale = 21612724,
  log = TRUE, range = 5, res = 0.5, LKL10 = NULL)

Arguments

Ha_lum

Numeric scalar; scaling to be applied to Halpha line, all other lines are scaled relative to this. Uses/requires LKL10_NormHalpha if LKL10=NULL.

Hb_lum

Numeric scalar; scaling to be applied to Hbeta line, all other lines are scaled relative to this. Uses/requires LKL10_NormHbeta if LKL10=NULL.

Hlines_lum

Numeric scalar; scaling to be applied all Hydrogen lines, all other lines are scaled relative to this. Uses/requires LKL10_NormHlines if LKL10=NULL.

All_lum

Numeric scalar; scaling to be applied all emission lines. Uses/requires LKL10_NormAll if LKL10=NULL.

SFR

Numeric scalar; scaling to be applied to Halpha line using SFR2Lum function to scale via the star formation rate, all other lines are scaled relative to this. Uses/requires LKL10_NormHalpha if LKL10=NULL.

Z

Numeric scalar; metallicity. If log=TRUE this will be interpolated in log space if it falls between templates.

q

Numeric scalar; radiation field. If log=TRUE this will be interpolated in log space if it falls between templates. If left as the default of NULL then the function Z2q will be used to approximate the average mapping based on Orsi (2014).

veldisp

Numeric scalar; velocity dispersion (km/s).

LSF

Function, numeric matrix/data.frame, numeric scalar; describes the instrumental line spread function is km/s. This should either scalar (constant throughout), a two column matrix/data.frame (wavelength in Ang, LSF in km/s) or a function that take wavelength (Ang) as an input and returns LSF in km/s. NULL means this is ignored (effectively same as setting to 0, but more efficient).

z_LSF

Numeric scalar; the redshift the LSF is effectively provided at. This is because instruments provide and observed frame LSF, so to compute what it is in our intrinsic frame we need to know the redshift we are working at. If LSF is NULL, this is not required.

lumscale

Numeric scalar; luminosity scaling to use in SFR2Lum. Unless you know what you are doing, leave at the default.

log

Logical; determines if the interpolation is done in log space when using interp_param.

range

Numeric scalar; how many sigma either side of the line should the velocity dispersion spread flux be evaluated (starts to become inaccurate if lower than 5).

res

Numeric scalar; the relative resolution of the line evaluation in fractions of sigma.

LKL10

List; LKL template to use. If LKL10=NULL then the appropriate template is loaded internally (this is the safest option). To speed things up the user can pass in the appropriate LKL10 template, but care must be taken to ensure the scaling used makes use of the correct dataset.

Details

Can be used by users directly (perhaps to generate your own line features to add onto a target spectrum), or more generally.

Value

Data.frame with two columns:

wave

Wavelength (Angstroms).

lum

Emission features scaled as requested (Lum/Ang).

Author(s)

Aaron Robotham

References

Levesque, Kewley & Larson, 2010, AJ, 139, 712

See Also

LKL10, SFR2Lum, Z2q, interp_param

Examples

plot(emissionLines(Ha_lum=1, veldisp=100), type='l', xlim=c(6400,6800), ylim=c(0,0.2))

asgr/ProSpect documentation built on Feb. 21, 2025, 1:43 a.m.