observation: A class to describe the basic properties of the observation

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

A class to describe the basic properties of the observation

Description

The purpose of this function is to generate an object that describes how the galaxy has been observed.

Usage

observation(telescope, observing_strategy, method)

Arguments

telescope	A telescope object. See telescope help for more details.
observing_strategy	An observing_strategy object. See observing_strategy help for more details.
method	String to describe whether cubes output are "spectral", "gas", "sf gas" or "velocity" (as in SimSpin v1) along the z-axis.

Value

Returns an object of class "observation" that summarises the properties of the observation. Run within the build_datacube() function.

Examples

sami = telescope(type="SAMI")
conditions = observing_strategy()
observation_summary = observation(telescope=sami,
                                 observing_strategy=conditions,
                                 method = "spectral")

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