Distance: A class helper function to describe the projected distance to...

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

A class helper function to describe the projected distance to the observed object

Description

The purpose of this function is to generate an object that contains the projected distance to the observed galaxy in a variety of units. Supply a single input (i.e. distance in units of redshift "z", physical distance "Mpc", or angular distance "kpc_per_arcsec") and all others will be contained by the object.

Usage

Distance(z, Mpc, kpc_per_arcsec)

Arguments

z	A numeric describing the distance measured to the observed object in units of redshift, z. Precision to +/- 1e-7.
Mpc	A numeric describing the distance measured to the observed object in units of physical distance in mega-parsec. Precision to +/- 1e-3.
kpc_per_arcsec	A numeric describing the distance measured to the observed object in units of angular distance in kilo-parsec per arcsecond. Precision to +/- 1e-5.

Value

Returns an object of class "Distance" that summarises the projected distance to the object and the associated units.

Examples

Distance(z = 0.3)

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