profoundGetEllipsesPlot: Create diagnostic plot of estimated iso-photal ellipses

In asgr/ProFound: Photometry Tools

Create diagnostic plot of estimated iso-photal ellipses

Description

Generates a useful plot merging a rapidly changing colour mapping with the estimated ellipses.

Usage

profoundGetEllipsesPlot(image = NULL, ellipses = NULL, segim = NULL, segID = 1,
  segellipseID = "all", pixscale = 1, col = rep(rainbow(10, s = 0.5), 4), border = "auto",
  lty = 'auto', lwd = 'auto', ...)

Arguments

image	Numeric matrix; required, the image we want to analyse.
ellipses	Data.frame; the ellipse information, but in practice the ellipse list output of profoundGetEllipses.
segim	Integer matrix; optional, the segmentation map of the image. This matrix *must* be the same dimensions as image.
segID	Integer scalar; optional, the desired segim segment to extract from the image.
segellipseID	Integer vector; the segellipseID to be plotted. The default of 'all' will display all ellipses.
pixscale	Numeric scalar; the pixel scale, where pixscale=asec/pix (e.g. 0.4 for SDSS). This should only be used if the radii columns in ellipses have already been scaled by the pixel scale.
col	The colour palette to be used for the background image. The default is chosen to be high contrast, to make it easier to compare the computed ellipses with the underlying isophotes.
border	The colour of the ellipse border drawn by draw.ellipse. If 'auto' then a sensible default is chosen.
lty	The line type of the ellipse border drawn by draw.ellipse. If 'auto' then a sensible default is chosen (lty=1 within the 90% flux radius and lty=2 outside).
lwd	The line width of the ellipse border drawn by draw.ellipse. If 'auto' then a sensible default is chosen (lwd=0.5 within the 50% flux radius, lwd=1 above the 50% flux radius, except for the annuli at 50%/90% which is lwd=2).
...	Further arguments to be passed to magimage.

Details

The default options should create useful diagnostics, but there are lots of potential plots that can be made with the outputs of profoundGetEllipses, including e.g. making plots of how various parameters behave with radius, which can give helpful insight to starting parameters for bulge and disk profiles. The user is encouraged to experiment.

Value

No value is returned, this function is run purely for the side effect of making a diagnostic plot.

Author(s)

Aaron Robotham

See Also

profoundGetEllipses, profoundGetEllipse, profoundDrawEllipse

Examples

## Not run: 
# We need the ProFit library to show the profile: library(ProFit)
image = Rfits_read_image(system.file("extdata", 'KiDS/G266035fitim.fits',
  package="ProFit"))$imDat
segim = Rfits_read_image(system.file("extdata", 'KiDS/G266035segim.fits',
  package="ProFit"))$imDat
ellipses = profoundGetEllipses(image=image, segim=segim, segID=4, plot=FALSE)

#We can get a good overall idea of how good the ellipses are by running with defaults:
profoundGetEllipsesPlot(image=image, ellipses=ellipses$ellipses)

#We can check a specific ellipse too:
profoundGetEllipsesPlot(image=ellipses$segellipses==8, ellipses=ellipses$ellipses,
segellipseID=8, col=grey(0:1), border='red', lwd=2)

## End(Not run)

asgr/ProFound documentation built on Feb. 10, 2024, 9:04 p.m.