telescope: A class to describe the basic properties of the observing...

In kateharborne/SimSpin: SimSpin - A package for the kinematic analysis of galaxy simulations

A class to describe the basic properties of the observing telescope

Description

The purpose of this function is to generate the observing telescope whose properties will be used to compute the properties of the observation. Several telescope types are included and can be accessed using the type parameter. Alternatively, you may describe the properties of another telescope by specifying type = "IFU" and listing the other required properties explicitly.

Usage

telescope(
  type = "IFU",
  fov,
  aperture_shape = "circular",
  wave_range = c(3700, 5700),
  wave_centre,
  wave_res = 1.04,
  spatial_res,
  filter = "g",
  lsf_fwhm = 2.65,
  signal_to_noise = NA,
  method
)

Arguments

type	String that describes the type of telescope you wish to create. Current pre-loaded types include "SAMI", "MaNGA", "CALIFA", "MUSE" and "Hector". Input is NOT case sensitive. If you wish to specify different observing properties below, set type = "IFU" to define your own.
fov	Numeric describing the field of view of the instrument in arcsec.
aperture_shape	String to describe the shape of the IFU aperture. Options include "circular", "hexagonal" or "square".
wave_range	Numeric vector of length 2 describing the wave range of the IFU (i.e. c(wave_min, wave_max)) in units of angstrom.
wave_centre	Numeric describing the central wavelength of the spectrograph used in the observation in units of angstrom. If unsupplied, default is the exact centre of the provided 'wave_range' parameter.
wave_res	Numeric describing the wavelength resolution in angstrom.
spatial_res	Numeric describing the size of spatial pixels in arcsec.
filter	String describing the relevent filter through which luminosities of individual particles are calculated.
lsf_fwhm	Numeric describing the full-width half-maximum of the Gaussian line spread function.
signal_to_noise	Numeric describing the minimum signal-to-noise ratio per angstrom. Default is NA, meaning that no noise will be added to the observation.
method	Providing backward compatibility for method specification. String to describe whether cubes output are "spectral", "gas", "sf gas" or "velocity" (as in SimSpin v1) along the z-axis. Default is "spectral". For v2.1.6 onwards, method should be specified in build_datacube. Support for this input will remain in all versions 2.X.X.

Value

Returns an object of class "telescope" that describes the properties of the instrument doing the observation. Required to run build_datacube().

Examples

telescope = telescope(type="SAMI")

kateharborne/SimSpin documentation built on April 28, 2024, 2 p.m.