CApphot:BgValueErr


Returns the statistical uncertainty, or random error, in the background measurement used by the Measure method.

Syntax

nBgValueErr = CApphot:BgValueErr()

where

    nBgValueErr is the value of the uncertainty in the background value, measured in counts, or digital numbers.

  

The background value and its random error (or uncertainty) are controlled by parameters set using the SetBgMethod method. The Measure method then either computes the background using these parameters or uses the specified background value and background error. After Measure returns, the background uncertainty is stored in the nBgValueErr member of the class data structure. The present method returns this value. The background value that was actually used can be fetched using BgValue.

Related Topics

Class Properties

Measure

BgValue

CApphot class