lsst.shapelet ge79ae78c31+093ff98f47
Loading...
Searching...
No Matches
Functions | Variables
lsst.shapelet.tractor Namespace Reference

Functions

 registerRadialProfiles ()
 
 evaluateRadial (basis, r, sbNormalize=False, doComponents=False)
 
 integrateNormalizedFluxes (maxRadius=20.0, nSteps=5000)
 
 plotSuite (doComponents=False)
 

Variables

 _LOG = logging.getLogger(__name__)
 

Detailed Description

Code to load multi-Gaussian approximations to profiles from "The Tractor"
into a lsst.shapelet.MultiShapeletBasis.

Please see the README file in the data directory of the lsst.shapelet
package for more information.

Function Documentation

◆ evaluateRadial()

lsst.shapelet.tractor.evaluateRadial ( basis,
r,
sbNormalize = False,
doComponents = False )
Plot a single-element MultiShapeletBasis as a radial profile.

Parameters
----------
sbNormalize : `bool`
    `True` to normalize.
doComponents : `bool`
    `True` to evaluate components.

Definition at line 83 of file tractor.py.

◆ integrateNormalizedFluxes()

lsst.shapelet.tractor.integrateNormalizedFluxes ( maxRadius = 20.0,
nSteps = 5000 )
Integrate the profiles to compare relative fluxes between the true profiles
and their approximations.

After normalizing by surface brightness at r=1 r_e, integrate the profiles to compare
relative fluxes between the true profiles and their approximations.

Parameters
----------
maxRadius : `float`, optional
    Maximum radius to integrate the profile, in units of r_e.
nSteps : `int`, optional
    Number of concrete points at which to evaluate the profile to
    do the integration (we just use the trapezoidal rule).

Returns
-------
fluxes : `dict` of `float` values
    Dictionary of fluxes (``exp``, ``lux``, ``dev``, ``luv``, ``ser2``, ``ser3``,
    ``ser5``, ``gexp``,  ``glux``, ``gdev``, ``gluv``, ``gser2``, ``gser3``, ``gser5``)

Definition at line 113 of file tractor.py.

◆ plotSuite()

lsst.shapelet.tractor.plotSuite ( doComponents = False)
Plot all the profiles defined in this module together.

Plot all the profiles defined in this module together: true exp and dev,
the SDSS softened/truncated lux and luv, and the multi-Gaussian approximations
to all of these.

Parameters
----------
doComponents : `bool`, optional
    True, to plot the individual Gaussians that form the multi-Gaussian approximations.

Returns
-------
figure : `matplotlib.figure.Figure`
    Figure that contains the plot.
axes : `numpy.ndarray` of `matplotlib.axes.Axes`
    A 2x4 NumPy array of matplotlib axes objects.

Definition at line 146 of file tractor.py.

◆ registerRadialProfiles()

lsst.shapelet.tractor.registerRadialProfiles ( )
Register the pickled profiles in the data directory with the RadialProfile
singleton registry.

This should only be called at import time by this module; it's only a function to
avoid polluting the module namespace with all the local variables used here.

Definition at line 41 of file tractor.py.

Variable Documentation

◆ _LOG

lsst.shapelet.tractor._LOG = logging.getLogger(__name__)
protected

Definition at line 38 of file tractor.py.