observing_strategy: A class to describe the basic properties of the object being...

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

A class to describe the basic properties of the object being observed

Description

The purpose of this function is to generate a class that describes the conditions of the observation for build_datacube().

Usage

observing_strategy(
  dist_z = 0.05,
  dist_Mpc,
  dist_kpc_per_arcsec,
  z,
  inc_deg = 70,
  twist_deg = 0,
  pointing_kpc = c(0, 0),
  pointing_deg,
  blur = F,
  fwhm = 2,
  psf = "Gaussian"
)

Arguments

dist_z	The projected distance at which the galaxy is placed in terms of redshift distance. This parameter is one of three optional ways of describing the distance to the observed galaxy. Only ONE of these three must be specified.
dist_Mpc	The projected distance at which the galaxy is placed in terms of physical distance in units of Mega-parsec. This parameter is the second of three optional ways of describing the distance to the observed galaxy. Only ONE of these three must be specified.
dist_kpc_per_arcsec	The projected distance at which the galaxy is placed in terms of angular distance in units of kilo-parsec per arcsecond. This parameter is the third of three optional ways of describing the distance to the observed galaxy. Only ONE of these three must be specified.
z	The projected distance at which the galaxy is placed in terms of redshift distance. This input will give identical results to the same value input to the dist_z parameter, but is included here for consistency with previous SimSpin versions (> v2.0.5). This input will be depreciated over time and will issue a warning when used.
inc_deg	Numeric describing the projected inclination of the observed galaxy relative to the z-axis - 0 deg places the galaxy face-on, 90 deg is edge-on aligned with the horizontal axis. Default is 70.
twist_deg	Numeric describing the viewer's orientation relative to the x-axis - 0 deg places the galaxy face-on, 90 deg places the galaxy edge-on aligned with the vertical axis. Default is 0.
pointing_kpc	Numeric array 'c(x,y)'. Two elements specifying the position at which the observation is centred given as a shift relative to the centre at (0,0) in units of kilo-parsecs. This parameter is ONE of two optional ways of describing this offset. Default is c(0,0) offset.
pointing_deg	Numeric array 'c(x,y)'. Two elements specifying the position at which the observation is centred given as a shift relative to the centre at (0,0) in units of degrees. This parameter is ONE of two optional ways of describing this offset. Default is c(0,0) offset.
blur	Boolean describing whether seeing conditions should be applied. Default is FALSE.
fwhm	If blur = TRUE, a numeric that describes the full-width half-maximum of the point spread function (PSF) used to blur the image, given in arcsec.
psf	A string to describe the shape of the PSF. Options include "Gaussian" or "Moffat". Input is NOT case sensitive.

Value

Returns an object of class "observing_strategy" that describes the conditions in which the observation is made. Required to run build_datacube().

Examples

conditions = observing_strategy()

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