CApphot:BgValue


Returns the value of the background value used by the Measure method.

Syntax

nBgValue = CApphot:BgValue()

where

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

  

The background value is 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. After Measure returns, the actual background value that was used is stored in the nBgValue member of the class data structure. The present method fetches this value. The uncertainty associated with the background measurement can be fetched using BgValueErr.

Related Topics

Class Properties

Measure

BgValueErr

CApphot class