profoundGainEst: Image Gain Estimator

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/profoundUtility.R

Description

High level function to estimate a rough value for the image gain in cases where you have no idea what the true image gain is. In practice this tends to be accurate to an order of magnitude and provides a reasonable lower limit for the true gain, which is good enough to make a rough first attempt at a sigma map.

Usage

1
profoundGainEst(image = NULL, mask = 0, objects = 0, sky = 0, skyRMS = 1)

Arguments

image

Numeric matrix; required, the image we want to analyse.

mask

Boolean matrix; optional, non galaxy parts of the image to mask out, where 1 means mask out and 0 means use for analysis. If provided, this matrix *must* be the same dimensions as image.

objects

Boolean matrix; optional, object mask where 1 is object and 0 is sky. Pixels set to 0 are interpreted as sky, and set to zero for calculating object shot-noise. If provided, this matrix *must* be the same dimensions as image.

sky

Numeric scalar; user provided estimate of the absolute sky level. If this is not provided then it will be computed internally using profoundSkyEst.

skyRMS

Numeric scalar; user provided estimate of the RMS of the sky. If this is not provided then it will be computed internally using profoundSkyEst.

Details

This function makes use of the fact that a true Poisson distribution cannot generate samples below 0 and the distribution shape properties of the sky pixels. In practice this means the gain estimated is low as it can be. Once the ProFit fit has been made the gain estimated can be improved based on the residuals (assuming the model does a good job of subtracting the data).

Value

Numeric scalar; the estimated gain of the image.

Author(s)

Aaron Robotham

See Also

profoundMakeSegim, profoundMakeSegimExpand, profoundSkyEst, profoundMakeSigma

Examples

1
2
3
4
5
6
7
## Not run: 
image=readFITS(system.file("extdata", 'VIKING/mystery_VIKING_Z.fits',
package="ProFound"))
profound=profoundProFound(image)
profoundGainEst(image$imDat, objects=profound$objects_redo, sky=profound$sky)

## End(Not run)

ProFound documentation built on Jan. 8, 2021, 5:37 p.m.