Highly Cited Researcher

Michele Cappellari IDL Programs (Legacy)

The following software is freely available. However, if you use it for published research, you are requested to cite the paper where the method is described, highlighted in red. You are not allowed to re-distribute any of these programs (modified or not) without explicit permission from the author.

NOTE: I strongly recommend the more advanced and up-to-date Python version of my programs HERE.

  1. MgeFit: to fit Multi-Gaussian Expansion (MGE) models to galaxy images, to be used as a parametrization for galaxy photometry
  2. JAM: to construct Jeans Anisotropic Models for the stellar kinematics of axisymmetric galaxies
  3. VorBin: to perform adaptive Voronoi spatial binning of Integral-Field Spectroscopy, X-ray or imaging data, to reach a chosen constant signal-to-noise ratio per bin
  4. pPXF: to extract the galaxy stellar or gas kinematics or stellar population from absorption-line spectra
  5. PaFit: to measure the global galaxy kinematical axis from integral field observations
  6. LtsFit: to robustly fit a plane or a line to data with intrinsic scatter
  7. LOESS: to uncover mean trends from noisy one-dimensional or two-dimensional data using the LOESS approach.

See my review on galaxy structure and evolution: Annual Review


NGC4342 MGE fit
Illustration of the steps involved in the MGE fit to the S0 galaxy NGC 4342 using the MgeFit package. The figures were produced by the mge_fit_example.py script included in the Python distribution of the software.

1. The MGE-Fit-Sectors method

Robust technique to perform Multi-Gaussian Expansion (MGE) fits to galaxy images

This software obtains an accurate Multi-Gaussian Expansion (MGE) parameterizations (Emsellem et al. 1994; Cappellari 2002) for a galaxy surface brightness with the fitting algorithm of Cappellari (2002, MNRAS, 333, 400). Given that Gaussians are not orthogonal functions, MGE fits are in general strongly degenerate, with difficult global convergence, but the MGE_FIT_SECTORS method solves all problems, making MGE fitting an automated, reliable and robust process.

See Cappellari et al. (2013) for a large scale application of this software to the study of the M/L ratio and the Fundamental Plane of early-type galaxies and Cappellari et al. (2012, Nature) for an application to the study of the stellar IMF. The MGE parameterization is useful in the construction of realistic dynamical models of galaxies (see JAM modelling below), for PSF deconvolution of images, for the correction and estimation of dust absorption effects, or for galaxy photometry.

Download the MGE_FIT_SECTORS source code in IDL

The source code of the IDL package MGE_FIT_SECTORS, with examples and instructions, can be downloaded here in ZIP format (338 KB). This version was last updated on the 21 November 2017 and the changes are documented in the program file. Optionally the FITS files of the five galaxy images that are required to run the examples routine can be downloaded here in ZIP format (19 MB). The MGE_FIT_SECTORS package was tested with IDL from 6.4 to 8.6.

Also required is the following IDL routine, which must be downloaded separately:

Also included in the MGE_FIT_SECTORS distribution is the MPFIT implementation by Markwardt (2009) of the MINPACK (Moré, Garbow & Hillstrom, 1980) Levenberg-Marquardt nonlinear least-squares optimization algorithm, with some specific modifications to make it work robustly with MGE_FIT_SECTORS.

And if you just started using IDL and still do not have the IDL Astronomy User's Library installed, or if you have an old version, you should immediately get it from here.

NOTE: I would appreciate if you drop me an e-mail (address at the bottom) when you download the above procedures.


JAM

2. Jeans Anisotropic Modelling (JAM)

Jeans Anisotropic Modelling of the dynamics, stellar kinematics or proper motions of axisymmetric or spherical galaxies

JAM 20 galaxiesJAM 12 galaxies
Figure 1: Examples of JAM data-model comparisons. The bi-symmetrized SAURON stellar kinematics of 6 Elliptical (left) and 6 S0 (right) fast-rotator early-type galaxies is compared to the predictions of the anisotropic Jeans models with JAM. The kinematics varies widely for different galaxies, yet these two-parameters (!) models are able to correctly predict the shape of a pair of two-dimensional functions (V and Vrms), once the observed surface brightness is given (this is fig.10 of Cappellari 2016, ARA&A).

JAM of Milky Way
Figure 5: This is the first dynamical modelling (using JAMsph) of the high-quality Gaia DR2 kinematics of the Milky Way, with full 6D phase-space coordinates. For the first time, there are no dynamical degeneracies and the model has no freedom to fit the data, yet all features are reproduced. This is an important test of galaxy dynamics. (figure taken from Nitschai et al. 2020)
JAM NGC4258
Figure 4: Validating black hole (BH) recovery with JAM. A detailed JAM modelling accurately recovers the "benchmark" BH mass in NGC4258, as inferred from maser observations (figure taken from Drehmer et al. 2015). An equally good agreement was found with JAM for the "benchmark" BH in the Milky Way (Sec.4.1.2 of Feldmeier-Krause et al. 2017). Other successful BH comparisons, between JAM and Schwarzschild's method, were presented e.g. in Cappellari et al. (2010), for 25 galaxies, and Krajnović et al. (2018), for 7 galaxies.
SPH vs CYL JAM
Figure 3: The JAM package includes an implementation for both the cylindrically-aligned solution JAMcyl of Cappellari (2008) and the spherically-aligned solution JAMsph of Cappellari (2020). Comparisons between these two extreme solutions allows for a robust assessment of possible systematic modeling uncertainties (see Cappellari 2020 for some examples).
JAM tensor
Figure 2: Including both proper motions and radial velocities. Top Panels: the components of the symmetric velocity second moment tensor measured from the particles of a realistic N-body simulation. Bottom Panels: the corresponding JAM model predictions. Note the striking agreement! (Cappellari 2012)

The JAM software in this section can be used for the dynamical modelling of galaxies or other gravitationally-bound systems of particles. It was used e.g. to measure the mass of supermassive black holes in galaxies, to infer their dark-matter content or to measure galaxy masses and density profiles.

JAM implements in Python and in IDL a solution of the Jeans equations which allows for orbital anisotropy (three-integrals distribution function) and also provides the full second moment tensor, including both proper motions and radial velocities, for both axisymmetric (Cappellari 2012) and spherical geometry (Cappellari 2015). The technique was introduced in Cappellari (2008), for the cylindrically-aligned case, and in Cappellari (2020), for the spherically-aligned case (Figure 3), and I called it the Jeans Anisotropic Modelling (JAM) method. It relies on the Multi-Gaussian Expansion parameterization (Emsellem et al. 1994; Cappellari 2002) for the galaxy surface brightness.

With the addition of a single extra parameter βz=1-(σzR)2 (in cylindrical alignment) or β=1-(σθr)2 (in spherical alignment), the simple and user-friendly three-integrals JAM method already provides a dramatic improvement over the classic but less general two-integrals f(E,Lz) Jeans (1922) models. However JAM also allows for tangential anisotropy γ=1-(σφR)2 and/or for spatially varying anisotropy (different for every MGE Gaussian). The JAM models provide a remarkably good descriptions of state-of-the-art integral-field stellar kinematics of real galaxies (Figure 1). This makes the technique well suited to measure the inclination, the dynamical M/L and angular momenta of early-type fast-rotators and spiral galaxies.

The JAM routines are designed for axisymmetric or spherical geometry, (i) they can provide the proper motion dispersion tensor (Cappellari 2012; Cappellari 2015; Figure 2), (ii) allow for the inclusion of dark matter, (iii) variable stellar M/L, (iv) spatially varying anisotropy and (v) multiple kinematic components and (vi) supermassive black holes (BH; Figure 4). The JAM package also includes a routine to compute the circular velocity from the MGE models. Some sample applications of the JAM method are given below:

To construct dynamical models with the JAM method one needs to describe the galaxies surface brightness via the Multi-Gaussian Expansion parametrization using my MGE_FIT_SECTORS package above.

Jin et al. (2019)
Figure 7: JAM works better than Schwarzschild on simulated galaxies. A detailed comparison between the recovered total mass of Illustris simulations using the JAM and Schwarzschild's (SCH) methods, found that JAM recovers the known enclosed total masses more accurately than SCH (this is Fig.4 from Jin et al. 2019). Note the smaller scatter and error bars of the green symbols (JAM) with respect to the red ones (SCH).
Leung et al. (2018)
Figure 6: JAM works better than Schwarzschild on real galaxies. An extensive and detailed comparison between the circular velocity VCO measured from CO gas and the corresponding circular velocity VJAM and VSCH inferred from dynamical modelling of integral-field stellar kinematics using the JAM and Schwarzschild's (SCH) methods, for 54 real disk galaxies with CALIFA data, found that JAM recovers the galaxy densities more accurately than SCH (this is Fig.8 from Leung et al. 2018). The smaller JAM scatter is particularly evident at large radii (inside the red boxes), where the gas Vc is better determined.

Download the JAM source code in IDL

The source code of the JAM modelling package in IDL, with documentation and examples, can be downloaded here in ZIP format (45 KB). This version was last updated on the 19 October 2017 and the changes are documented in the program files. The JAM package was tested with IDL from 6.4 to 8.6.

Also required are the generic plotting routines SAURON_COLORMAP and PLOT_VELFIELD which can be found in this ZIP file.

And if you just started using IDL and still do not have the IDL Astronomy User's Library installed, or if you have an old version, you should immediately get it from here.


Cappellari & Copin (2003)
Left: Four-coloring of Voronoi binning; Middle: Unbinned versus Voronoi binned stellar kinematics from Integral-Field Spectroscopy (Cappellari & Copin 2003); Right: Voronoi binning of abundance from X-ray data (Sanders et al. 2004).
VorBin

3. The Voronoi binning method (VorBin)

Adaptively spatial bin two-dimensional data to a constant signal-to-noise ratio per bin

The Voronoi Binning method of Cappellari & Copin (2003, MNRAS, 342, 345) optimally solves the problem of preserving the maximum spatial resolution of general two-dimensional data (or higher dimensions), given a constraint on the minimum signal-to-noise ratio.

The Voronoi binning method has been applied to a variety of types of data. A review of the concepts and applications to (i) X-ray data, (ii) integral-field spectroscopy, (iii) Fabry-Perot interferometry, (iv) N-body simulations, (v) standard images and (vi) other regularly or irregularly sampled data is given in Cappellari (2009).

Download the VorBin source code in IDL

The source code of the IDL program VORONOI_2D_BINNING, with examples and instructions, can be downloaded here in ZIP format (75 KB). This version was last updated on 10 October 2017 and the changes are documented in the program file. Some minor adaptations of the routine may be required to optimally use the method with different types of data. Please ask for suggestions if needed. VORONOI_2D_BINNING was tested with IDL from 6.4 to 8.6.

This optional ZIP file contains the routines display_bins, display_bins_generators, DISPLAY_PIXELS, PLOT_VELFIELD and SAURON_COLORMAP which can be used to visualize Voronoi 2D-binned or unbinned data, either using interpolation, or by showing the actual bins like in the figures above.

NOTE: I would appreciate if you drop me an e-mail (address at the bottom) when you download the above procedures.


pPXF

4. Penalized Pixel-Fitting (pPXF)

Extract the stellar or gas kinematics and stellar population from galaxy spectra via full spectrum fitting

pPXF Fit
Figure 1: Stellar and gas kinematics fit with pPXF. The black line (mostly hidden by the fit) is the relative flux of the observed spectrum. The red line is the pPXF fit for the stellar component, while the orange line is a fit to the gas emission lines. The green symbols at the bottom are the fit residuals, while the blue lines is the gas-only best-fitting spectrum. The main absorption and emission features are indicated at the top of the plot (taken from Cappellari 2017).

This software implements the Penalized Pixel-Fitting method (pPXF) to extract the stellar or gas kinematics and stellar population from absorption-line spectra of galaxies, using a maximum penalized likelihood approach. The method was originally described in Cappellari & Emsellem (2004) and was significantly upgraded in subsequent years and particularly in Cappellari (2017, MNRAS, 466, 798). The method is very general and robust. For this reason it was applied to a variety of situations. The following key features are implemented in the current pPXF program:

See Emsellem et al. (2004, SAURON), Cappellari et al. (2011, ATLAS3D), Falcon-Barroso et al. (2017, CALIFA), van de Sande et al. (2017, SAMI) and Westfall et al. (2019, MaNGA) for some ever increasing large-scale applications of the pPXF method to the measurement of the stellar or gas kinematics of galaxies. Cappellari et al. (2009) demonstrates the use of pPXF to measure the stellar velocity dispersion of a sample of passive galaxies at redshift z~2.

Libraries of stellar templates for stars/gas kinematics with pPXF

The ability of the pPXF method to fit a large set of stellar templates together with the kinematics allows the template mismatch problem to be virtually eliminated. This is particularly useful given the current availability of large stellar libraries spanning wide ranges of physical parameters and having good spectral resolution. Excellent results have been obtained by using a few hundred template stars with pPXF, from which generally about 10-20 are selected by the program to provide detailed fits to high S/N galaxy spectra. An extensive account of the available stellar libraries is maintained by David Montes. An incomplete list of libraries that have been successfully used with pPXF for the kinematics extraction is given below:

star formation history with pPXF pPXF for Population pPXF for Population
Figure 2: Star-formation history with pPXF. The plot shows the star-formation history of ATLAS3D galaxies, in bins of different galaxy stellar mass. This was recovered with pPXF using regularization (taken from McDermid et al. 2015). Figure 3: Population and gas with pPXF. The plots show the pPXF fit to two MaNGA spectra for the spiral galaxy NGC2916 (from SDSS DR13). The Left Spectrum is located in the galaxy bulge, while the Right Spectrum is in the disk. The "Mass Fraction" maps, below each spectrum, show the corresponding pPXF solution in different age and metallicity intervals. The Left Maps have no regularization. These are the minimum χ2 solutions which all non-regularized full-spectrum fitting programs must return, if they properly converge. However these solutions are noisy and arbitrary as this inverse problem is ill-posed. Regularization is a standard approach to solve ill-posed problems (see Cappellari 2017, Sec.3.5). The Right Maps show the pPXF regularized solutions: here one can clearly recognize the change in the relative contribution of bulge (∼10Gyr) and disk (∼1Gyr) stars at the two spatial locations. The fits used as templates a subset of 24(Ages)×6([M/H])=144 MILES model spectra by Vazdekis et al. (2010), and 12 gas emission lines.

Libraries of models for stellar-population with pPXF

pPXF is the most efficient, reliable and flexible public implementation of the so called "Full-Spectrum Fitting" method to study stellar populations. This technique has replaced the traditional use of line-strength indices, due to the availability of high-quality model spectra. pPXF was designed to be independent on any specific set of stellar-population models and has already been used with nearly every available one. An usage example, using the Vazdekis's models, is included with permission in the pPXF package. This can be easily adapted by users to employ pPXF with other stellar-population models. An incomplete list of the main stellar population models that were used with pPXF is the following:

pPXF allows one to extract multiple kinematic components, with different stellar populations, from a spectrum. Gas emission lines can be fitted simultaneously, avoiding the need for masking them. This is particularly useful when studying the stellar population of galaxies with prominent emission lines (e.g. the Balmer lines) filling important absorption features (see Figures 1 and 3).

Please also cite the source of the MILES stellar population models (Vazdekis et al. 2010) if you use pPXF with the included library of spectral templates.

A number of similar, but less optimized and less general implementations of the Full Spectrum Fitting method exist (e.g. STARLIGHT by Cid Fernandes et al. 2005; STECMAP by Ocvirk, et al. 2006; VESPA by Tojeiro et al. 2007). A major limitation of most available codes is that they ignore the fact that the recovery of the star formation history and chemical composition distribution from the galaxy spectra is an ill-posed problem. A standard technique to solve ill-posed problems is regularization (see Cappellari 2017, Sec.3.5), which is invoked in pPXF via the keyword REGUL. Regularization is essential to make sense of the derived star formation histories and to explore model degeneracies (see Figure 2 and 3). The regularized solution has a simple Bayesian interpretation: it represents the most likely solution for the weights, given an adjustable prior on the amplitude of the fluctuations.

See Cappellari et al. (2012, Nature) for an early pPXF study of the M/L and IMF of stellar populations.

Download the pPXF source code in IDL

NOTE: I recommend using the Python version if you can. The IDL version of pPXF lacks many features that are only present in the Python version. Moreover, the IDL version of pPXF is much slower than the Python version, when fitting many (>100) spectral templates (20× slower in the examples of Figure 3).

The source code of the IDL program pPXF, with examples and instructions, can be downloaded here in ZIP format (2.5 MB). This version was last updated on the 2 March 2018 and the changes are documented in the program file. The pPXF package was tested with IDL from 6.4 to 8.6.

The following two IDL routines are also required to run pPXF. They must be downloaded separately:

And if you just started using IDL and still do not have the IDL Astronomy User's Library installed, or if you have an old version, you should immediately get it from here.

NOTE: I would appreciate if you drop me an e-mail (address at the bottom) when you download the above procedures.

Extracting gas kinematics with GANDALF in IDL

pPXF is a state-of-the-art software for gas kinematics for both Python and IDL. An alternative, in IDL, consists of using pPXF in combination with GANDALF. See Oh et al. (2011) for a large-scale application of the pPXF and GANDALF combination.

Please acknowledge both the pPXF (Cappellari 2017) and the GANDALF (Sarzi et al. 2006) papers if you use the two programs together.


Kin PA
Best fitting symmetrized kinematics of NGC 2974

5. Fit kinematic PA

Fit the global kinematic position-angle of galaxies

This software implements the method presented in Appendix C of Krajnovic et al. (2006, MNRAS, 366, 787) to measure the global kinematic position-angle (PA) from integral field observations of a galaxy stellar or gas kinematics.

See Cappellari et al. (2007) and Krajnovic et al. (2011) for two large scale application of this software to the study of the stellar kinematical misalignment of early-type galaxies. See Davor's Krajnovic page for the related Kinemetry package.

Download the FIT_KINEMATIC_PA source code in IDL

The source code of the IDL program FIT_KINEMATIC_PA, with examples and instructions, can be downloaded here in ZIP format (9 KB). This version was last updated on 2 February 2017 and the changes are documented in the program file. FIT_KINEMATICS_PA was tested with IDL from 6.4 to 8.6.

Also required are the generic plotting routines SAURON_COLORMAP and PLOT_VELFIELD which can be found in this ZIP file.

And if you just started using IDL and still do not have the IDL Astronomy User's Library installed, or if you have an old version, you should immediately get it from here.

NOTE: I would appreciate if you drop me an e-mail (address at the bottom) when you download FIT_KINEMATIC_PA.


lts_linefit
Figure 1: Fitting of the (M/L)-σ relation in the Virgo cluster using LTS_LINEFIT (taken from Cappellari et al. 2013a). The green outliers above the relation are automatically removed from the fit. They turn out to be background galaxies and for this reason they do not follow the cluster relation.

6. Robust linear regression with scatter in one or two dimensions

Fit lines and planes to data with errors in all variables, possible outliers and intrinsic scatter

This software implements the method presented in Sec. 3.2 of Cappellari et al. (2013a, MNRAS, 432, 1709) to to perform extremely robust fit of lines or planes to data with errors in all variables, possible large outliers (bada data) and unknown intrinsic scatter.

The code combines the Least Trimmed Squares (LTS) robust technique, proposed by Rousseeuw (1984) and speeded up in Rousseeuw & Driessen (2006), into a least-squares fitting algorithm which allows for intrinsic scatter and errors in all coordinates. This method makes the fit converge to the correct solution even in the presence of a large number of catastrophic outliers (like in Figure 1), where the much simpler σ-clipping approach can converge to the wrong solution.

Download the LTS_LINEFIT and LTS_PLANEFIT source code in IDL

The source code of the IDL programs LTS_LINEFIT and LTS_PLANEFIT can be downloaded here in ZIP format (9 KB). This version was last updated on the 26 July 2017 and the changes are documented in the program file. LTS_LINEFIT and LTS_PLANEFIT were tested with IDL from 6.4 to 8.6.

The following two IDL routine are also required to run the two programs. They must be downloaded separately:

And if you just started using IDL and still do not have the IDL Astronomy User's Library installed, or if you have an old version, you should immediately get it from here.

NOTE: I would appreciate if you drop me an e-mail (address at the bottom) when you download LTS_LINEFIT and LTS_PLANEFIT.


LOESS
Application of the CAP_LOESS_2D routine (with FRAC=0.6) to the recovery of two underlying functions from a noisy distribution of 200 scattered values. For comparison, the right panels show the distribution obtained via simple averaging on a grid, but using 100× more values than the ones used for the LOESS recovery. The LOESS approach achieves a comparable result while requiring a much smaller number of input values.

7. Adaptive LOESS smoothing in one or two dimensions

Recover mean trends from noisy data in one or two dimension

This software provides an improved implementation of the one-dimensional (Cleveland 1979) and two-dimensional (Cleveland & Devlin 1988) Locally Weighted Regression (LOESS) method to recover the mean trends of the population from noisy data in one or two dimensions. It includes a robust approach to deal with outliers (bad data).

These programs were implemented and used to produce the two-dimensional maps and the one-dimensional mean trends in Cappellari et al. (2013b, MNRAS, 432, 1862).

Download the CAP_LOESS_1D and CAP_LOESS_2D source code in IDL

The source code of the IDL programs CAP_LOESS_1D and CAP_LOESS_2D can be downloaded here in ZIP format (6 KB). This version was last updated on 31 October 2013 and the changes are documented in the program file. CAP_LOESS_1D and CAP_LOESS_2D were tested with IDL from 6.4 to 8.6.

And if you just started using IDL and still do not have the IDL Astronomy User's Library installed, or if you have an old version, you should immediately get it from here.

NOTE: I would appreciate if you drop me an e-mail (address at the bottom) when you download the code.


Comments and suggestions are welcome to the address michele.cappellaribest@physics.ox.ac.uk

Latest changes: 14/SEP/2021

Go back to Michele Cappellari Homepage

Valid HTML 4.0 Transitional