Pointing: A class to describe the center pointing of the telescope...

View source: R/Pointing.R

PointingR Documentation

A class to describe the center pointing of the telescope relative to the centre of the observed object. The purpose of this function is to generate an object that contains the pointing of the centre of the observation relative to the centre of the observed galaxy in a variety of units. Supply a single pair of inputs (i.e. pointing in units of physical distance, "x_kpc" and "y_kpc" OR angular distance, "x_deg" and "y_deg") and all others will be contained by the object.

Description

A class to describe the center pointing of the telescope relative to the centre of the observed object. The purpose of this function is to generate an object that contains the pointing of the centre of the observation relative to the centre of the observed galaxy in a variety of units. Supply a single pair of inputs (i.e. pointing in units of physical distance, "x_kpc" and "y_kpc" OR angular distance, "x_deg" and "y_deg") and all others will be contained by the object.

Usage

Pointing(xy_deg, xy_kpc, distance)

Arguments

xy_deg

Offset from centre (0,0) in angular units of degrees along the x-axis and y-axis respectively.

xy_kpc

Offset from centre (0,0) in physical units of kilo-parsec along the x-axis and y-axis respectively.

distance

The Distance object used to describe the projected distance of the observed galaxy.

Value

Returns an object of class "Pointing" that summarises the pointing position of the telescope relative to the centre of the object being observed in all associated units.

Examples

dist = Distance(z=0.3)
Pointing(xy_kpc = c(-1,0), distance = dist)


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