merit.contours: Create contour plot of goodness of kinematic fit

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/merit.contours.R

Description

This function visualizes the merit.function as a function of v and sigma around specified values p (in general the best-fit values).

Usage

1
2
merit.contours(galaxy, template, fit=TRUE, p, v.range, s.range,
  plot=TRUE, mask=TRUE,...)

Arguments

galaxy

data.frame containing the galaxy spectrum

template

data.frame containing the template spectrum

fit

logical. If TRUE determine best-fit values automatically via fit.spectrum.

p

two-component vector containing the central v and sigma values. Only required if v.range and s.range are not given and fit=FALSE.

v.range

two-component vector giving range of velocity v. Defaults to 100 km/s around p[1].

s.range

two-component vector givingrange of velocity dispersion sigma. Defaults to 100 km/s around p[2]

plot

logical specifying whether to plot contours or not

mask

mask that is to be applied to the spectrum. Can be in any format accepted by convert.mask. If fit is TRUE, then the updated mask from the fitting is used.

...

Further arguments to be passed to fit.spectrum

Details

The function computes merit.function on a grid of 20x20 of velocity and velocity dispersion. The resulting matrix is either plotted as a contour plot or returned along with the velocity and velocity dispersion vectors.

Value

v

Vector of velocity values

sigma

Vector of velocity dispersion values

gof

Matrix of values of merit.function

Author(s)

Oliver Czoske

See Also

merit.function, fit.spectrum

Examples

1
2
3
4
5
##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## None for now.

oczoske/slacR documentation built on May 20, 2019, 8:23 p.m.