Public Member Functions
	getLocalCalibrationArray (self, x, y)
	instFluxToMagnitudeArray (self, instFluxes, x, y)
	magnitudeToInstFluxArray (self, magnitudes, x, y)
	calibrateImage (self, maskedImage, includeScaleUncertainty=_UnsetEnum.UNSET)
	uncalibrateImage (self, maskedImage, includeScaleUncertainty=_UnsetEnum.UNSET)

Protected Attributes
	_isConstant

Detailed Description

Definition at line 40 of file _photoCalibContinued.py.

Member Function Documentation

◆ calibrateImage()

lsst.afw.image._photoCalibContinued.PhotoCalib.calibrateImage	(	self,
		maskedImage,
		includeScaleUncertainty = _UnsetEnum.UNSET )

Return a flux calibrated image, with pixel values in nJy.

Mask pixels are propagated directly from the input image.

Parameters
----------
maskedImage : `lsst.afw.image.MaskedImage`
    The masked image to calibrate.
includeScaleUncertainty : `bool`, optional
     Deprecated and ignored; will be removed after v29.

Returns
------
calibrated : `lsst.afw.image.MaskedImage`
    The calibrated masked image.

Definition at line 114 of file _photoCalibContinued.py.

◆ getLocalCalibrationArray()

lsst.afw.image._photoCalibContinued.PhotoCalib.getLocalCalibrationArray	(	self,
		x,
		y )

Get the local calibration values (nJy/counts) for numpy arrays (pixels).

Parameters
----------
x : `np.ndarray` (N,)
    Array of x values (pixels).
y : `np.ndarray` (N,)
    Array of y values (pixels).

Returns
-------
localCalibration : `np.ndarray` (N,)
    Array of local calibration values (nJy/counts).

Definition at line 41 of file _photoCalibContinued.py.

◆ instFluxToMagnitudeArray()

lsst.afw.image._photoCalibContinued.PhotoCalib.instFluxToMagnitudeArray	(	self,
		instFluxes,
		x,
		y )

Convert instFlux (counts) to magnitudes for numpy arrays (pixels).

Parameters
----------
instFluxes : `np.ndarray` (N,)
    Array of instFluxes to convert (counts).
x : `np.ndarray` (N,)
    Array of x values (pixels).
y : `np.ndarray` (N,)
    Array of y values (pixels).

Returns
-------
magnitudes : `astropy.units.Magnitude` (N,)
    Array of AB magnitudes.

Definition at line 62 of file _photoCalibContinued.py.

◆ magnitudeToInstFluxArray()

lsst.afw.image._photoCalibContinued.PhotoCalib.magnitudeToInstFluxArray	(	self,
		magnitudes,
		x,
		y )

Convert magnitudes to instFlux (counts) for numpy arrays (pixels).

Parameters
----------
magnitudes : `np.ndarray` or `astropy.units.Magnitude` (N,)
    Array of AB magnitudes.
x : `np.ndarray` (N,)
    Array of x values (pixels).
y : `np.ndarray` (N,)
    Array of y values (pixels).

Returns
-------
instFluxes : `np.ndarray` (N,)
    Array of instFluxes (counts).

Definition at line 84 of file _photoCalibContinued.py.

◆ uncalibrateImage()

lsst.afw.image._photoCalibContinued.PhotoCalib.uncalibrateImage	(	self,
		maskedImage,
		includeScaleUncertainty = _UnsetEnum.UNSET )

Return a un-calibrated image, with pixel values in ADU (or whatever
the original input to this photoCalib was).

Mask pixels are propagated directly from the input image.

Parameters
----------
maskedImage : `lsst.afw.image.MaskedImage`
    The masked image with pixel units of nJy to uncalibrate.
includeScaleUncertainty : `bool`, optional
    Deprecated and ignored; will be removed after v29.

Returns
uncalibrated : `lsst.afw.image.MaskedImage`
    The uncalibrated masked image.

Definition at line 141 of file _photoCalibContinued.py.

Member Data Documentation

◆ _isConstant

lsst.afw.image._photoCalibContinued.PhotoCalib._isConstant

protected

Definition at line 56 of file _photoCalibContinued.py.

The documentation for this class was generated from the following file:

python/lsst/afw/image/_photoCalibContinued.py

Public Member Functions

Protected Attributes