API Documentation

edge_pydb Package

Classes

EdgeTable([file, path, cols, data, masked, ...])

Definition of the EdgeTable class.

edge_pydb.beam_sample Module

Functions

beam_sample(edgetab[, gallist, columnlist, ...])

Process one or more galaxies from an allpix HDF5 file and output central surface brightness after convolution to a user-specified Gaussian beam.

edge_pydb.conversion Module

Functions

K_cardelli(wave[, Rv])

P_hydro(sigmol, sigstar[, c_gas, sigHI, R_half])

Calculate the hydrostatic (dynamical equilibrium) pressure from Sigma_mol and Sigma_*, following Sun+20 (2020ApJ...892..148S)

ZOH_M13(fluxtab[, ext, method, name, err])

Adds gas-phase metallicity from Marino+13 calibration to flux_elines table.

bpt_prob(n2ha_u, o3hb_u, bpt_type[, grid_size])

Calculate the probability that a measurement with uncertainty is in a particular region of the BPT diagram, as specified by the parameter bpt_type.

bpt_region(n2ha, o3hb[, good])

Determine BPT classification based on [NII]/Ha and [OIII]/Hb.

bpt_type(fluxtab[, ext, name, sf, prob, ...])

Adds BPT classification to the flux_elines table.

cidfer10(nii)

findIntersec(fun1, fun2, x0)

gc_polr(ra, dec, ra_gc, dec_gc, pa, inc[, ...])

Returns galactocentric polar coordinates (radius in arcsec, azimuthal angle in degrees from receding major axis).

get_AHa(flux_ha, flux_hb, log10)

Returns Halpha extinction in magnitudes given flux_ha and flux_hb.

get_Alambda(fluxtab, colnames, A_Ha[, ...])

Corrects a set of columns in a table for extinction.

kauffm03(nii)

kewley01(nii)

msd_co(sb_co[, alphaco, name])

Convert CO intensity to H_2 (+ He) mass surface density.

sfr_ha(flux_ha[, flux_hb, e_flux_ha, ...])

Convert Halpha intensity to SFR surface density, optionally with extinction estimates and corrections (if flux_hb is provided).

stmass_pc2(stmass_as2[, dz, dist, pixsca, name])

Convert units for stellar surface density to Msol/pc2, optionally applying dezonification image.

uarray_to_list(target)

Break array of uncertainties values into 2 separate arrays.

edge_pydb.fitsextract Module

Functions

fitsextract(input[, header, stride, ...])

Sample data from an image into an AstroPy table indexed by coordinates.

getlabels(product[, p3dstruct])

hex_sampler(tab, sidelen, keepref, ref_pix, ...)

a wrapper function to generate the hex grid and then interpolate and output the sampled data in Astropy Table precision = 0 -> full precision hexgrid_output -> output file to check

edge_pydb.hexgrid Module

Functions

gc_polr(ra, dec, ra_gc, dec_gc, pa, inc[, ...])

Returns galactocentric polar coordinates (radius in arcsec, azimuthal angle in degrees from receding major axis).

hex_basis(ref, hex_sidelen, bound)

hex_grid(ref, sidelen, bound, ...)

hex_sampler(tab, sidelen, keepref, ref_pix, ...)

a wrapper function to generate the hex grid and then interpolate and output the sampled data in Astropy Table precision = 0 -> full precision hexgrid_output -> output file to check

interpolate_all_points(tab, datapoint, ...)

interpolate_neighbor(point, bound[, step_size])

find the adjacent pixels of the point to interpolate from if the point is directly on one of the pixel, we take that value directly

jit(func)

njit([parallel])

py_jit(func)

py_njit([parallel])

wraps(wrapped[, assigned, updated])

Decorator factory to apply update_wrapper() to a wrapper function

ylin_hex(pos, hex_sidelen, bound)

going along y dir

edge_pydb.plotting Module

Functions

dotpatch(x, y, imval[, blank, dotsize, ...])

Generate and plot a patch collection for a dot plot.

gridplot([edgetab, gallist, columnlist, ...])

Plot one column for multiple galaxies or multiple columns for one galaxy on a grid.

imarrayplot(x, y, imval[, blank, clipedge, ...])

Plot a pixel image from a data column.

make_axes_locatable(axes)

plot_uncertainty_ellipse(xval_n, xval_s, ...)

parameters xval_n, yval_u : list of nominal values of coordinates (pixels) xval_s, yval_s : list of standard deviation of coordinates (pixels) indices : indices of the list of coordinates to plot with save_to: file to save the plot to, optional

xy2binned(xarr, yarr[, log, bins, range, yval])

Prepare binned averages from a scatterplot.

xy2hist(xarr, yarr[, log, bins])

Prepare a 2D density histogram from a scatterplot.

edge_pydb.util Module

Functions

add_from_dir(src[, dest, copy, overwrite, ...])

This function copy files from a src directory to dest directory, if dest is empty, then it creates a directory just under the edge_pydb package directory.

add_url([file, root_url])

Add hyperlinks to the index_csv.md file

addfile(src[, dest, copy, overwrite])

download(file, url[, loc, user, password])

Download and install a file from a www location

getPath(file)

get the hdf5 path

listfiles([contain, values, printing])

List the current available files in the package data directory.

load_config(src[, readonly])

Read the config from a file

md_generate([csv_output, h5_output])

Generate markdown file for csv and txt for hdf5

plotgallery([hdf_files, cmap, clobber, ...])

Make multi-page gridplots for all galaxies in all available HDF5 files.

save_config(src)

This function will write _config back to a file.

to_markdown([csv_out, h5_out, addurl])

Generate index files index_csv.md and index_hdf.txt

updatefiles([dir, max_depth])

Update the files and rewrite json file