API Reference

salsa Package

salsa Written by: Brendan Boyd boydbre1@msu.edu

Functions

construct_rays(ds_file, start_points, end_points)

Construct rays given a set of starting points and end points.

generate_catalog(ds_file, n_rays, …[, …])

Generates a catalog of absorber properties from a given number of lightrays through a dataset.

generate_lrays(ds, center, n_rays, …[, …])

Generate a sample of trident lightrays that randomly, uniformly cover impact parameter.

get_absorbers(abs_extractor, ray_list, method)

Create catalog of the given rays usin absorber extractor

random_sightlines(ds_file, center, …[, …])

randomly sample impact parameter to get random sightlines from a given galaxy center

Classes

AbsorberExtractor(ds_filename, ray_filename)

Extracts absorbers from a trident lightray for a given ion species.

AbsorberPlotter(ds_filename, ray_filename[, …])

Create’s plot to easily see where absorbers are found along the light ray both directly and through resulting spectra.

salsa.utils Package

Utility scripts

Functions

check_rays(ray_dir, n_rays, fields[, parallel])

Check if a directory already contains a given number of trident lrays and contains necessary fields

collect_files(directory[, file_ext, …])

Finds and returns files in a given directory with given extension.

parse_cut_filter(cuts)

Parses a string defining what cuts to apply to analysis.