ALBULA  4.0.1
dectris.albula.DRateCorrection Class Reference


Implements the rate correction More...

Public Member Functions

def DRateCorrection ()
 Default constructor. More...
 
def correctImage (image, mask)
 Apply the correction to the image
Throws an exception when an error occurs (e.g. when required correction parameters are missing in the optional data) More...
 
def optionalData ()
 
def setOptionalData (optionalData)
 Use the parameters of this optional data object for the correction instead of the header information of the image. More...
 
def recomputeLookupTable (aBool)
 require the lookup table to be recomputed More...
 

Detailed Description


Implements the rate correction

Constructor & Destructor Documentation

◆ DRateCorrection()

def dectris.albula.DRateCorrection.DRateCorrection ( )

Default constructor.

Member Function Documentation

◆ correctImage()

def dectris.albula.DRateCorrection.correctImage (   image,
  mask 
)

Apply the correction to the image
Throws an exception when an error occurs (e.g. when required correction parameters are missing in the optional data)

Parameters
imageDImage object to be corrected
maskDImage object. All pixels in mask with values different from zero are not taken into account.

◆ optionalData()

def dectris.albula.DRateCorrection.optionalData ( )
Returns
DImageOptionalData object defining the correction parameters

◆ recomputeLookupTable()

def dectris.albula.DRateCorrection.recomputeLookupTable (   aBool)

require the lookup table to be recomputed

Parameters
aBoolTrue or False

◆ setOptionalData()

def dectris.albula.DRateCorrection.setOptionalData (   optionalData)

Use the parameters of this optional data object for the correction instead of the header information of the image.

Parameters
optionalDataDImageOptionalData object containing the header to be used