ACID API
Core Classes
Accurate Continuum fItting and Deconvolution (ACID) class. |
|
Class to handle the results from the Acid MCMC sampling, and results processing. |
|
Stores necessary data for the Acid class which can be conveniently updated and saved. |
|
The main class for storing ACID configuration settings, with methods to plot and save/load the configuration state. |
|
A class that stores Data instances in a list indexed by order. The DataList is a useful class for running ACID over multiple orders with parallelization. Fundamentally this class holds Data instances (which ACID updates with the results per order) as a list and can map the true order number from the instrument (stored in the config) to the index of the list. It handles missing/incomplete orders, and the ability to append new orders. For more information and a full example on how to use the DataList, see :ref:`datalist' in the documentation. Note that the DataList is not strictly necessary to run ACID over multiple orders, you can handle the multiple instances yourself. |
|
Class containing all useful functions for performing least-squares deconvolution. |
|
A class for fitting spectral line profiles to Voigt, Gaussian, and Lorentzian models. |
|
Class for handling the MCMC fitting process. |
|
A class to expose the linelist when called in Data. |
|
A simple class to expose the telluric lines when called in Config. |
Utility Functions
Calculates velocity pixel size |
|
All of the utility functions for the ACID package. |
Legacy ACID Functions
These functions are retained for backwards compatibility with ACID v1.
Legacy ACID function |
|
Legacy ACID_HARPS function, deprecated after 1.4.5. |
Type Aliases
- type ACID_code.FloatLike = float | numpy.floating
Any pythonic or numpy floating-point scalar.
- type ACID_code.IntLike = int | numpy.integer
Any pythonic or numpy integer scalar.
- type ACID_code.Scalar = FloatLike | IntLike | numpy.ndarray
A scalar numeric value, including 0D NumPy arrays. The 0D condition is enforced if the value is a 0D NumPy array.
- type ACID_code.Array1D = numpy.ndarray | list[Scalar]
A one-dimensional numpy numeric array or a list of scalar numeric values. The 1D condition is enforced for all array types.
- type ACID_code.Array2D = numpy.ndarray | list[list[Scalar]] | list[Array1D]
A two-dimensional numpy numeric array or nested numeric lists. Can also mix numpy arrays and lists, ie. a list of 1D numpy arrays, or a list of lists of scalar numeric values, etc. The 2D condition is enforced for all array types.
- type ACID_code.Array3D = numpy.ndarray | list[list[list[Scalar]]] | list[list[Array1D]] | list[Array2D]
A three-dimensional numpy numeric array or nested numeric lists. Can also mix numpy arrays and lists, ie. a list of 2D numpy arrays, or a list of lists of 1D numpy arrays, etc. The 3D condition is enforced for all array types.