Observation

Input object for AMPy

Observation

class Observation(data, offsets=None, hosts=None, groups=None)

A time series of flux measurements.

The Observation class is designed to be used for MCMC fitting. To reduce the fitting time as much as possible, I made the decision that once the object is instantiated with data, it cannot be updated. This means that you should not add or remove data dynamically.

I did this so that I can store the positions of data at the time of instantiation. This saves quite a bit of time when fitting with MCMC since I reference these locations multiple times in the likelihood calculations.

Parameters

data: np.ndarray of SpectralFlux, IntegratedFlux, SpectralIndex

The observational data.

offsets: dict, optional

Key, value pairs of <offset names> : <np.ndarray of where to apply offsets>.

hosts: dict, optional

Key, value pairs of <host names> : <np.ndarray of where to apply host corrections>.

groups: dict, optional

Key, value pairs of <group names> : <np.ndarray of where to the group is defined>.

Attributes

as_arrays: ObsArray

Array representation of the Observation object. It is highly recommended to use the arrays when performance is important.

data_regimes : dict of Bound

The time bounds for each data group in groups.

length : float

The number of data points.

Properties

flux_loc: np.ndarray of bool

The location of SpectralFlux and IntegratedFlux data.

sflux_loc: np.ndarray of bool

The location of SpectralFlux data.

iflux_loc: np.ndarray of bool

The location of IntegratedFlux data.

sindex_loc: np.ndarray of bool

The location of SpectralIndex data.

extinguishable: np.ndarray of bool

The location of data that is affected by dust extinction.

Methods

Observation.from_csv(path)

Instantiates an Observation from a CSV.

See ?? for the CSV schema.

Parameters

path: str or Path

The path to the CSV file.

Returns

Observation