modspectra Documentation¶
This is the documentation for modspectra.
Reference/API¶
modspectra Package¶
Functions¶
EllipticalLBD(resolution, bd_max, Hz, …[, …]) |
Creates kinematic disk following Elliptical Orbits of the from from Burton & Liszt (1982) or Krishnarao, Benjamin, Haffner (2019) Numerically solves for ellipse equation for every point within the disk space output is used directly to create a Longitude-Latitude-Velocity SpectralCube object using ‘modspectra.cube.EllipticalLBD’ |
EmissionLBV(lbd_coords_withvel, …[, …]) |
Creates a Longitude-Latitude-Velocity SpectralCube object of neutral (HI 21cm) or ionized (H-Alpha) gas emission Uses output calculated from ‘modspectra.cube.EllipticalLBD’ |
bd_solver(ell, xyz, z_sigma_lim, Hz, bd_max, …) |
Function to solve for the ellipse equation to fit into form of ellipse_equation Chooses only to solve the equation numerically when necessary, avoiding the special cases. |
delayed |
Wraps a function or object to produce a Delayed. |
ellipse_equation(bd, el_constant1, …) |
Equation for an ellipse in the form from Burton & Liszt (1978) Function serves to be used in scipy.optimize.brenth to solve for bd |
find_nannearest_idx(array, value) |
|
find_nearest_idx(array, value) |
|
galactocentric_to_td(galactocentric_coord, …) |
Compute the transformation matrix from Galactocentric coordinates to Tilted Disk coordinates. |
get_transformation_matrix(tilteddisk_frame) |
Create coordinate transformation matrix for converting between the TiltedDisk frame and Galactocentric frame |
td_to_galactocentric(tilteddisk_coord, …) |
Compute the transformation matrix from the Tilted Disk coordinates to Galactocentric coordinates. |
test([package, test_path, args, plugins, …]) |
Run the tests using py.test. |
Classes¶
CartesianDifferential(d_x[, d_y, d_z, unit, …]) |
Differentials in of points in 3D cartesian coordinates. |
CartesianRepresentation(x[, y, z, unit, …]) |
Representation of points in 3D cartesian coordinates. |
CylindricalRepresentation(rho, phi, z[, …]) |
Representation of points in 3D cylindrical coordinates. |
Ellipse(xy, width, height[, angle]) |
A scale-free ellipse. |
EmissionCube([data, wcs, meta, mask, …]) |
Synthetic Emission cube container |
EmissionCubeMixin |
|
LogNorm([vmin, vmax, clip]) |
Normalize a given value to the 0-1 range on a log scale |
ProgressBar([minimum, width, dt, out]) |
A progress bar for dask. |
RectangularFrame(parent_axes, transform[, path]) |
A classic rectangular frame. |
SpectralCube(data, wcs[, mask, meta, …]) |
|
TiltedDisk(*args[, copy, …]) |
A cartesian coordinate system in the frame of the tilted elliptical disk Requires three attributes - currently defaults to version of Krishnarao, Benjamin, Haffner (2019) Three angles describing geometry of the structure Attributes ———- alpha: Quantity, optional, must be keyword Tilt Angle beta: Quantity, optional, must be keyword 90*u.deg - inclination theta: Quantity, optional, must be keyword Major Axis Angle |
UnsupportedPythonError |
|
partial |
partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords. |