get_absorbers

salsa.get_absorbers(abs_extractor, ray_list, method, fields=None, units_dict=None)

Create catalog of the given rays usin absorber extractor

Parameters
  • abs_extractor (SALS.AbsorberExtractor) – Absorber Extractor object that will be used to extract absoprtion feat. for the catalog

  • ray_list (list of str or trident.ray objects) – List of ray objects or list of trident rays whose absorbers will be extracted

  • method (str) – Either ‘spice’ or ‘spectacle’. specifies which method is used to extract absorbers

  • fields (list str, optional) – Fields to extract/add to catalog if using ‘spice’ method. Defaults=None

  • units_dict (dict) – dictionary containing what units to use for each field

Returns

full_df – Catalog of absorber properties in a pandas dataframe.

Return type

pandas.DataFrame