UNDER DEVELOPMENT

The software package is currently being dramatically improved and updated.
This is a (very) old version, potentially with bugs.

  Shapelets web page     Shapelets IDL code     Installation     Help pages     Simulated images  
List of routines
Instrutions for general code
Instructions for image simulation code

Help pages for shapelets IDL code + image simulation routines:

The first few lines of each .pro file contain a header with a description of the routine and general instructions for its use. These can be accessed from within IDL by typing "doc_library,"routine name"". I am also writing more extensive on-line documentation for many of the routines, although this task is currently proceeding slowly. If the information you want is not available, please ask me at . The help files will grow mainly through answers to such questions.

View for the subroutine.

Comprehensive list of routines:

shapelets_demo --- An example script to demonstrate the most important shapelet routines and structure types.
shapelets_paths --- Stores the location of data and other files for quick reference.
simages: --- Image simulation with shapelets.
simages/shapelets_read_shapecat_hdf --- Reads in a shapelet catalogue containing all of the objects from both Hubble Deep Fields.
simages/simage_add_noise --- Adds a model of background and observational noise to a simulated image.
simages/simage_assemble_image --- Takes objects from a new shapelet catalogue and scatters them about an image, without noise.
simages/simage_generate_shapecat --- Repeatedly calls simage_generate_shapecat.pro to generate a shapelet catalogue for a simulated image.
simages/simage_make_analytic_object --- Given a desired ellipticity, magnitude and radial profile, generates a pixellated image of one simulated galaxy.
simages/simage_make_shapelet_object --- Given a set of shapelet coefficients, generates a pixellated image of one simulated galaxy.
simages/simage_resample_pdf --- Resamples a true population of galaxy shapes to generate a new object for a simulated image.
simages/simage_tests --- Performs some basic statistical tests of a simulated image.
decomp: --- Transform images into shapelet space and back.
decomp/shapelets_chi --- Calculate 2D polar shapelet basis functions.
decomp/shapelets_decomp --- Transform an image into shapelets using overlap integrals or a least-squares fit.
decomp/shapelets_hermite --- Calculate Hermite polynomials quickly.
decomp/shapelets_make_nvec --- Creates an array to index a list of shapelet coefficients (n1,n2) or (n,m).
decomp/shapelets_make_xarr --- Creates an array of pixel coordinates.
decomp/shapelets_phi --- Calculate 1D and 2D Cartesian shapelet basis functions.
decomp/shapelets_recomp --- Transform back from shapelets and realise a pixellated image.
decomp/focus: --- Automated n_max-beta finder, optimising chi^2 for a decomposition as in "Polar Shapelets".
decomp/focus/shapelets_focus --- Optimise nmax, beta and centroid parameters.
decomp/focus/shapelets_focus_beta --- Optimise beta (and centroid) parameters with fixed nmax.
decomp/focus/shapelets_focus_nmax --- Optimise nmax parameter with fixed beta.
decomp/focus/shapelets_geometric_constraints --- Calculate which shapelet basis functions will be orthogonal even with pixellisation and a finite extent.
decomp/focus/shapelets_guess_nmaxbeta --- Make a quick guess at suitable nmax, beta and centroid parameters for an image.
decomp/focus/shapelets_make_chisq_grid --- Calculate the reconstruction residual using many different values of n_max and beta.
decomp/polar: --- Conversion between Cartesian and polar shapelets.
decomp/polar/shapelets_detect_diamond  
decomp/polar/shapelets_polar_convert --- Convert between polar shapelet and Cartesian shapelet coefficients.
decomp/polar/shapelets_polar_expand --- Uncompress complex numbers after shapelets_polar_reduce.
decomp/polar/shapelets_polar_matrix --- Computes the matrix used to convert between polar shapelet and Cartesian shapelet coefficients.
decomp/polar/shapelets_polar_reduce --- Compress unnecessary complex numbers of polar shapelets.
alias: --- Wrapper routines used to maintain backwards compatability with old versions of the code.
alias/plt_chi2_grid  
alias/plt_colbar  
alias/plt_decomp  
alias/plt_decomp_polar  
alias/plt_focus  
alias/plt_image  
alias/plt_imstat  
alias/plt_obj  
alias/plt_polar  
alias/plt_pstamp  
alias/plt_scat  
alias/plt_sexcat  
alias/plt_shcat  
alias/shapelets_c2p  
alias/shapelets_concatenate_shapecats  
alias/shapelets_deconvolve  
alias/shapelets_make_ls_matrix  
alias/shapelets_p2c  
alias/shapelets_shapecat_c2p  
alias/shapelets_shapecat_nmax  
alias/shapelets_split_sexcat  
alias/shapelets_split_shapecat  
alias/shapelets_write_shapecat  
io: --- Data I/O from disc, and conversion of structure types.
io/shapelets_create_decomp --- Initialise an empty decomp structure variable.
io/shapelets_create_focus --- Initialse an empty focus structure variable.
io/shapelets_read  
io/shapelets_read_image --- Read in a fits image (and pixel noise map, etc.) to memory.
io/shapelets_read_psf --- Read an oversampled fits image containing a PSF, and decompose it into shapelets.
io/shapelets_read_sexcat --- Read in a SExtractor catalogue to memory.
io/shapelets_read_shapecat --- Read in a shapelet catalogue to memory.
io/shapelets_sexcat2pstamp --- Extract a postage stamp image around one individual object.
io/shapelets_sexcat2pstampJB  
io/shapelets_shapecat2decomp --- Extract the shapelet coefficients of one object from the catalogue of a whole image.
io/shapelets_structure_type --- Decide whether a given structure is recognised as one of the shapelet types.
io/shapelets_update_history --- Append a string to the history record of a shapelet structure.
io/shapelets_write --- Generic routine to write all different types of shapelet structures to disc.
operations: --- Image manipulation and transformations in shapelet space.
operations/shapelets_add --- Add one image to another, append an object to a catalogue, or concatenate catalogues.
operations/shapelets_circularise --- Circularise image(s).
operations/shapelets_convolution_matrix --- Calculate the matrix needed to perform convolutions.
operations/shapelets_convolve --- Convolve image(s) with another image.
operations/shapelets_dilate --- Enlarge image.
operations/shapelets_exponentiate_operations --- Allows Taylor expansion-type operations to be done to higher than 1st order.
operations/shapelets_extend_nmax --- Increase n_max of a shapelet decomposition or catalogue by padding new coefficients with zeros.
operations/shapelets_flex --- Apply flexion to image(s). This is introduced by gradients in a shear field.
operations/shapelets_keep_it_real  
operations/shapelets_recentre --- Shift an image so that its centre of light lies over the origin.
operations/shapelets_reflect --- Reflect image(s) in a line.
operations/shapelets_rotate --- Rotate image(s).
operations/shapelets_shear --- Shear image(s).
operations/shapelets_split --- Split a catalogue into two parts.
operations/shapelets_subtract --- Subtract one image from another.
operations/shapelets_translate --- Move image(s).
pipeline: --- Object detection and decomposition within an entire astronomical image.
pipeline/sex --- Runs SExtractor, to locate objects on an image.
pipeline/shapelets_interpolate_psf  
pipeline/shapelets_interpolate_psf_lsmatrix  
pipeline/shapelets_make_image_mask  
pipeline/shapelets_select_stars  
pipeline/shapelets_wl_pipeline  
pipeline/shex --- Decomposes all objects found on an image into shapelets.
plotting: --- Various plotting tools.
plotting/plt_gals  
plotting/plt_gals_shcat  
plotting/plt_objs  
plotting/plt_scat_mom  
plotting/plt_sgsep  
plotting/plt_shear  
plotting/plt_shear_scat  
plotting/plt_stars  
plotting/shapelets_plot --- Generic plotting routine. Give it any shapelet structure, and it'll figure out what to do.
plotting/shapelets_plot_basis  
plotting/shapelets_plot_chisq_grid  
plotting/shapelets_plot_colourbar  
plotting/shapelets_plot_decomp  
plotting/shapelets_plot_focus  
plotting/shapelets_plot_image  
plotting/shapelets_plot_image_statitics  
plotting/shapelets_plot_pstamp  
plotting/shapelets_plot_sexcat  
plotting/shapelets_plot_shapecat  
properties: --- Shape analysis and galaxy morphology indices.
properties/shapelets_asymmetry --- Calculate an object's asymmetry index, a commonly used galaxy morphology estimator.
properties/shapelets_centroid --- Calculate an object's centroid from its shapelet coefficients.
properties/shapelets_concentration --- Calculate an object's concentration index, a commonly used galaxy morphology estimator.
properties/shapelets_ellipticity --- Calculate an object's ellipticity from its shapelet coefficients.
properties/shapelets_flux --- Calculate an object's flux from its shapelet coefficients.
properties/shapelets_image_moments --- Calculate the unweighted moments of a pixellated image.
properties/shapelets_moments --- Calculate the unweighted moments of an image in shapelet space (obsolescent).
properties/shapelets_profile --- Calculate an object's azimuthally-averaged radial profile from its shapelet coefficients.
properties/shapelets_quadrupole --- Calculate an object's unweighted quadrupole moments from its shapelet coefficients.
properties/shapelets_rsquared --- Calculate an object's rms size (squared) from its shapelet coefficients.
library: --- Standard IDL library routines, including some from the IDL Astronomy User's Library.
library/astrolib  
library/atanh  
library/check_fits  
library/comb --- Calculates binomial coefficients.
library/cond  
library/congrid  
library/convolve  
library/daycnv  
library/def_dirlist  
library/delvarx  
library/determ  
library/extract_pixsc  
library/factorial  
library/fdecomp  
library/find_all_dir  
library/fits_close  
library/fits_help  
library/fits_info  
library/fits_open  
library/fits_read  
library/fits_write  
library/fxaddpar  
library/fxmove  
library/fxpar  
library/fxposit  
library/gamma  
library/gauss2dfit  
library/get_date  
library/gettok  
library/idl_validname  
library/ieee_to_host  
library/inpoly  
library/inside --- Decides whether a point is inside or outside a polygon.
library/is_ieee_big  
library/loadct  
library/match  
library/mean  
library/mkhdr  
library/mmm  
library/moment  
library/mrd_hread  
library/mrd_skip  
library/mrd_struct  
library/mrdfits  
library/numlines  
library/path_sep  
library/pca  
library/plothist  
library/plt_ellipse  
library/plt_rectangle  
library/randome --- Generates a random number from an Epanechnikov kernel.
library/readcol  
library/readfits  
library/remchar  
library/repchr  
library/reverse  
library/sign --- Returns the (positive, negative or zero) sign of a variable.
library/sky  
library/spec_dir  
library/stddev  
library/strnumber  
library/sxaddpar  
library/sxdelpar  
library/sxpar  
library/tag_exist  
library/valid_num  
library/writefits  
library/xgen --- Creates an equally- or logarithmically-spaced set of numbers.
library/zparcheck  

Return to the shapelets web page or the code download page.


Last modified on 02nd May 2008 by Richard Massey.

Valid HTML 4.01!