Quick Start

Let’s get started with CRISPy. Use the navigation bar on the right to skip ahead as needed.

Ridge Finding

Note

Install: If you haven’t installed CRISPy yet, see Install.

To detect density ridges in a .fits image:

from crispy import image_ridge_find as irf

# Input parameters
image_name = "input_image.fits" # Input image file
thres = 0.5                     # Minimum density threshold for valid data points
h = 2                           # Smoothing bandwidth (recommended: Nyquist-sampled resolution)

# Finding ridges
ridge_data = irf.run(image_name, h=h, thres=thres)

To save the results to a .txt file

# Save the results to a file
irf.write_output(ridge_data, "ridge_coords.txt")

For more details, please see Tutorials