profoundDrawEllipse: Draw Ellipse

View source: R/profoundEllipse.R

profoundDrawEllipseR Documentation

Draw Ellipse

Description

Draws multiple ellipses on a plot window.

Usage

profoundDrawEllipse(xcen = 0, ycen = 0, rad = 1, axrat = 1, ang = 0, box = 0, ...)

Arguments

xcen

Numeric vector; x centre/s of the ellipse/s.

ycen

Numeric vector; y centre/s of the ellipse/s.

rad

Numeric vector; the major axis extent of the ellipse/s.

axrat

Numeric vector; the axial ratio of the ellipse/s as given by radlo/radhi.

ang

Numeric vector; the angle of the ellipse/s in the usual ProFit sense, see profitMakeModel.

box

Numeric vector; the boxiness of the ellipse/s in the usual ProFit sense, see profitMakeModel.

...

Further arguments to be passed to lines to draw the ellipse/s.

Details

This function uses all the standard ProFit conventions to define the input parameters

Value

No value is returned, this function is run purely for the side effect of drawing an ellipse.

Author(s)

Aaron Robotham

See Also

profoundGetEllipsesPlot, profoundGetEllipses, profoundGetEllipse

Examples

## Not run: 
image = Rfits_read_image(system.file("extdata", 'VIKING/mystery_VIKING_Z.fits',
  package="ProFound"))

profound=profoundProFound(image, magzero=30, verbose=TRUE, plot=TRUE)
profoundDrawEllipse(profound$segstats$xcen, profound$segstats$ycen,
profound$segstats$R100/0.339, profound$segstats$axrat, profound$segstats$ang,
col='white', lty=2)

## End(Not run)

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