Inheritance diagram for lsst.ip.isr.flatGradient.FlatGradient:

Public Member Functions
	__init__ (self, **kwargs)

	setParameters (self, *, radialSplineNodes, radialSplineValues, itlRatio=1.0, centroidX=0.0, centroidY=0.0, centroidDeltaX=0.0, centroidDeltaY=0.0, gradientX=0.0, gradientY=0.0, normalizationFactor=1.0)

	computeRadialSplineModelXY (self, x, y)

	computeRadialSplineModel (self, radius)

	computeGradientModel (self, x, y)

	computeFullModel (self, x, y, is_itl)

	fromDict (cls, dictionary)

	toDict (self)

	fromTable (cls, tableList)

	toTable (self)

	requiredAttributes (self)

	requiredAttributes (self, value)

	__str__ (self)

	__eq__ (self, other)

	metadata (self)

	getMetadata (self)

	setMetadata (self, metadata)

	updateMetadata (self, camera=None, detector=None, filterName=None, setCalibId=False, setCalibInfo=False, setDate=False, **kwargs)

	updateMetadataFromExposures (self, exposures)

	calibInfoFromDict (self, dictionary)

	determineCalibClass (cls, metadata, message)

	readText (cls, filename, **kwargs)

	writeText (self, filename, format="auto")

	readFits (cls, filename, **kwargs)

	writeFits (self, filename)

	fromDetector (self, detector)

	validate (self, other=None)

	apply (self, target)

Public Attributes
	radialSplineNodes = np.zeros(1)

	radialSplineValues = np.zeros(1)

float	itlRatio = 1.0

float	centroidX = 0.0

float	centroidY = 0.0

float	centroidDeltaX = 0.0

float	centroidDeltaY = 0.0

float	gradientX = 0.0

float	gradientY = 0.0

float	normalizationFactor = 1.0

	requiredAttributes = set(["_OBSTYPE", "_SCHEMA", "_VERSION"])

	log = log if log else logging.getLogger(__name__)

Protected Attributes
	_instrument = None

	_raftName = None

	_slotName = None

	_detectorName = None

	_detectorSerial = None

	_detectorId = None

	_filter = None

str	_calibId = None

	_seqfile = None

	_seqname = None

	_seqcksum = None

	_metadata = PropertyList()

	_requiredAttributes

Static Protected Attributes
str	_OBSTYPE = "generic"

str	_SCHEMA = "NO SCHEMA"

int	_VERSION = 0

Detailed Description

Flat gradient measurements.

Parameters
----------
log : `logging.Logger`, optional
    Log to write messages to. If `None` a default logger will be used.
**kwargs :
    Additional parameters.

Definition at line 34 of file flatGradient.py.

Constructor & Destructor Documentation

◆ init()

lsst.ip.isr.flatGradient.FlatGradient.__init__	(		self,
		**	kwargs )

Definition at line 49 of file flatGradient.py.

Member Function Documentation

◆ eq()

lsst.ip.isr.calibType.IsrCalib.__eq__	(		self,
			other )

inherited

Calibration equivalence.

Running ``calib.log.setLevel(0)`` enables debug statements to
identify problematic fields.

Definition at line 105 of file calibType.py.

◆ str()

lsst.ip.isr.calibType.IsrCalib.__str__ ( self )

inherited

Definition at line 102 of file calibType.py.

◆ apply()

lsst.ip.isr.calibType.IsrCalib.apply	(		self,
			target )

inherited

Method to apply the calibration to the target object.

Parameters
----------
target : `object`
    Thing to validate against.

Returns
-------
valid : `bool`
    Returns true if the calibration was applied correctly.

Raises
------
NotImplementedError
    Raised if not implemented.

Definition at line 706 of file calibType.py.

◆ calibInfoFromDict()

lsst.ip.isr.calibType.IsrCalib.calibInfoFromDict	(		self,
			dictionary )

inherited

Handle common keywords.

This isn't an ideal solution, but until all calibrations
expect to find everything in the metadata, they still need to
search through dictionaries.

Parameters
----------
dictionary : `dict` or `lsst.daf.base.PropertyList`
    Source for the common keywords.

Raises
------
RuntimeError
    Raised if the dictionary does not match the expected OBSTYPE.

Definition at line 325 of file calibType.py.

◆ computeFullModel()

lsst.ip.isr.flatGradient.FlatGradient.computeFullModel	(	self,
		x,
		y,
		is_itl )

Compute the full gradient model given x/y and itl booleans.

This returns the full model that can be applied directly
to data that was used in a fit.

Parameters
----------
x : `np.ndarray`
    Array of focal plane x values (mm).
y : `np.ndarray`
    Array of focal plane y values (mm).
is_itl : `np.ndarray`
    Boolean array of whether each point is from an ITL detector.

Returns
-------
model : `np.ndarray`
    Model values at each position.

Definition at line 215 of file flatGradient.py.

◆ computeGradientModel()

lsst.ip.isr.flatGradient.FlatGradient.computeGradientModel	(	self,
		x,
		y )

Compute the gradient model values.

The gradient model is a plane constrained to be 1.0 at the
``centroidX``, ``centroidY`` values. Dividing by this model will
remove the planar gradient in a flat field. Note that the planar
gradient pivot is always at the same position, and does not
move with the radial gradient centroid so as to keep the
model fit more stable.

Parameters
----------
x : `np.ndarray`
    Array of focal plane x values (mm).
y : `np.ndarray`
    Array of focal plane y values (mm).

Returns
-------
gradientModel : `np.ndarray`
    Gradient model values at the x/y positions.

Definition at line 189 of file flatGradient.py.

◆ computeRadialSplineModel()

lsst.ip.isr.flatGradient.FlatGradient.computeRadialSplineModel	(		self,
			radius )

Compute the radial spline model values from radii.

The spline model is a 1D Akima spline. When computed, the values
from the model describe the radial function of the full focal
plane flat-field. Dividing by this model will yield a radially
flattened flat-field.

Parameters
----------
radius : `np.ndarray`
    Array of focal plane radii (mm).

Returns
-------
splineModel : `np.ndarray`
    Spline model values at the radius positions.

Definition at line 167 of file flatGradient.py.

◆ computeRadialSplineModelXY()

lsst.ip.isr.flatGradient.FlatGradient.computeRadialSplineModelXY	(	self,
		x,
		y )

Compute the radial spline model values from x/y.

The spline model is a 1D Akima spline. When computed, the values
from the model describe the radial function of the full focal
plane flat-field. Dividing by this model will yield a radially
flattened flat-field.

Parameters
----------
x : `np.ndarray`
    Array of focal plane x values (mm).
y : `np.ndarray`
    Array of focal plane y values (mm).

Returns
-------
splineModel : `np.ndarray`
    Spline model values at the x/y positions.

Definition at line 140 of file flatGradient.py.

◆ determineCalibClass()

lsst.ip.isr.calibType.IsrCalib.determineCalibClass	(	cls,
		metadata,
		message )

inherited

Attempt to find calibration class in metadata.

Parameters
----------
metadata : `dict` or `lsst.daf.base.PropertyList`
    Metadata possibly containing a calibration class entry.
message : `str`
    Message to include in any errors.

Returns
-------
calibClass : `object`
    The class to use to read the file contents.  Should be an
    `lsst.ip.isr.IsrCalib` subclass.

Raises
------
ValueError
    Raised if the resulting calibClass is the base
    `lsst.ip.isr.IsrClass` (which does not implement the
    content methods).

Definition at line 391 of file calibType.py.

◆ fromDetector()

lsst.ip.isr.calibType.IsrCalib.fromDetector	(		self,
			detector )

inherited

Modify the calibration parameters to match the supplied detector.

Parameters
----------
detector : `lsst.afw.cameraGeom.Detector`
    Detector to use to set parameters from.

Raises
------
NotImplementedError
    Raised if not implemented by a subclass.
    This needs to be implemented by subclasses for each
    calibration type.

Reimplemented in lsst.ip.isr.crosstalk.CrosstalkCalib, lsst.ip.isr.deferredCharge.DeferredChargeCalib, lsst.ip.isr.linearize.Linearizer, and lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.

Definition at line 588 of file calibType.py.

◆ fromDict()

lsst.ip.isr.flatGradient.FlatGradient.fromDict	(		cls,
			dictionary )

Construct a FlatGradient from a dictionary of properties.

Parameters
----------
dictionary : `dict`
    Dictionary of properties.

Returns
-------
calib : `lsst.ip.isr.FlatGradient`
    Constructed calibration.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 241 of file flatGradient.py.

◆ fromTable()

lsst.ip.isr.flatGradient.FlatGradient.fromTable	(		cls,
			tableList )

Construct a calibration from a list of tables.

Parameters
----------
tableList : `list` [`astropy.table.Table`]
    List of table(s) to use to construct the FlatGradient.

Returns
-------
calib : `lsst.ip.isr.FlatGradient`
    The calibration defined in the table(s).

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 300 of file flatGradient.py.

◆ getMetadata()

lsst.ip.isr.calibType.IsrCalib.getMetadata ( self )

inherited

Retrieve metadata associated with this calibration.

Returns
-------
meta : `lsst.daf.base.PropertyList`
    Metadata. The returned `~lsst.daf.base.PropertyList` can be
    modified by the caller and the changes will be written to
    external files.

Definition at line 174 of file calibType.py.

◆ metadata()

lsst.ip.isr.calibType.IsrCalib.metadata ( self )

inherited

Definition at line 171 of file calibType.py.

◆ readFits()

lsst.ip.isr.calibType.IsrCalib.readFits	(		cls,
			filename,
		**	kwargs )

inherited

Read calibration data from a FITS file.

Parameters
----------
filename : `str`
    Filename to read data from.
kwargs : `dict` or collections.abc.Mapping`, optional
    Set of key=value pairs to pass to the ``fromTable``
    method.

Returns
-------
calib : `lsst.ip.isr.IsrCalib`
    Calibration contained within the file.

Definition at line 517 of file calibType.py.

◆ readText()

lsst.ip.isr.calibType.IsrCalib.readText	(		cls,
			filename,
		**	kwargs )

inherited

Read calibration representation from a yaml/ecsv file.

Parameters
----------
filename : `str`
    Name of the file containing the calibration definition.
kwargs : `dict` or collections.abc.Mapping`, optional
    Set of key=value pairs to pass to the ``fromDict`` or
    ``fromTable`` methods.

Returns
-------
calib : `~lsst.ip.isr.IsrCalibType`
    Calibration class.

Raises
------
RuntimeError
    Raised if the filename does not end in ".ecsv" or ".yaml".

Definition at line 425 of file calibType.py.

◆ requiredAttributes() [1/2]

lsst.ip.isr.calibType.IsrCalib.requiredAttributes ( self )

inherited

Definition at line 162 of file calibType.py.

◆ requiredAttributes() [2/2]

lsst.ip.isr.calibType.IsrCalib.requiredAttributes	(		self,
			value )

inherited

Definition at line 166 of file calibType.py.

◆ setMetadata()

lsst.ip.isr.calibType.IsrCalib.setMetadata	(		self,
			metadata )

inherited

Store a copy of the supplied metadata with this calibration.

Parameters
----------
metadata : `lsst.daf.base.PropertyList`
    Metadata to associate with the calibration.  Will be copied and
    overwrite existing metadata.

Reimplemented in lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.

Definition at line 186 of file calibType.py.

◆ setParameters()

lsst.ip.isr.flatGradient.FlatGradient.setParameters	(		self,
		*	,
			radialSplineNodes,
			radialSplineValues,
			itlRatio = 1.0,
			centroidX = 0.0,
			centroidY = 0.0,
			centroidDeltaX = 0.0,
			centroidDeltaY = 0.0,
			gradientX = 0.0,
			gradientY = 0.0,
			normalizationFactor = 1.0 )

Set the parameters for the gradient model.

Parameters
----------
radialSplineNodes : `np.ndarray`
    Array of spline nodes.
radialSplineValues : `np.ndarray`
    Array of spline values (same length as ``radialSplineNodes``).
itlRatio : `float`, optional
    Ratio of flat for ITL detectors to E2V detectors.
centroidX : `float`, optional
    X centroid of the focal plane (mm). This will be used as the
    pivot for the gradient plane.
centroidY : `float`, optional
    Y centroid of the focal plane (mm). This will be used as the
    pivot for the gradient plane.
centroidDeltaX : `float`, optional
    Centroid offset (mm). This is used in the radial function to
    allow for mis-centering in the illumination gradient.
centroidDeltaY : `float`, optional
    Centroid offset (mm). This is used in the radial function to
    allow for mis-centering in the illumination gradient.
gradientX : `float`, optional
    Slope of gradient in x direction (throughput/mm).
gradientY : `float`, optional
    Slope of gradient in y direction (throughput/mm).
normalizationFactor : `float`, optional
    Overall normalization factor (used to, e.g. make the
    center of the focal plane equal to 1.0 vs. a focal-plane
    average.

Definition at line 81 of file flatGradient.py.

◆ toDict()

lsst.ip.isr.flatGradient.FlatGradient.toDict ( self )

Return a dictionary containing the calibration properties.

Returns
-------
dictionary : `dict`
    Dictionary of properties.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 272 of file flatGradient.py.

◆ toTable()

lsst.ip.isr.flatGradient.FlatGradient.toTable ( self )

Construct a list of table(s) containing the FlatGradient data.

Returns
-------
tableList : `list` [`astropy.table.Table`]
    List of tables containing the FlatGradient information.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 331 of file flatGradient.py.

◆ updateMetadata()

lsst.ip.isr.calibType.IsrCalib.updateMetadata	(		self,
			camera = None,
			detector = None,
			filterName = None,
			setCalibId = False,
			setCalibInfo = False,
			setDate = False,
		**	kwargs )

inherited

Update metadata keywords with new values.

Parameters
----------
camera : `lsst.afw.cameraGeom.Camera`, optional
    Reference camera to use to set ``_instrument`` field.
detector : `lsst.afw.cameraGeom.Detector`, optional
    Reference detector to use to set ``_detector*`` fields.
filterName : `str`, optional
    Filter name to assign to this calibration.
setCalibId : `bool`, optional
    Construct the ``_calibId`` field from other fields.
setCalibInfo : `bool`, optional
    Set calibration parameters from metadata.
setDate : `bool`, optional
    Ensure the metadata ``CALIBDATE`` fields are set to the current
    datetime.
kwargs : `dict` or `collections.abc.Mapping`, optional
    Set of ``key=value`` pairs to assign to the metadata.

Reimplemented in lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel, lsst.ip.isr.calibType.IsrProvenance, lsst.ip.isr.crosstalk.CrosstalkCalib, lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix, lsst.ip.isr.linearize.Linearizer, lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection, and lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.

Definition at line 208 of file calibType.py.

◆ updateMetadataFromExposures()

lsst.ip.isr.calibType.IsrCalib.updateMetadataFromExposures	(		self,
			exposures )

inherited

Extract and unify metadata information.

Parameters
----------
exposures : `list`
    Exposures or other calibrations to scan.

Definition at line 294 of file calibType.py.

◆ validate()

lsst.ip.isr.calibType.IsrCalib.validate	(		self,
			other = None )

inherited

Validate that this calibration is defined and can be used.

Parameters
----------
other : `object`, optional
    Thing to validate against.

Returns
-------
valid : `bool`
    Returns true if the calibration is valid and appropriate.

Reimplemented in lsst.ip.isr.linearize.Linearizer, and lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection.

Definition at line 691 of file calibType.py.

◆ writeFits()

lsst.ip.isr.calibType.IsrCalib.writeFits	(		self,
			filename )

inherited

Write calibration data to a FITS file.

Parameters
----------
filename : `str`
    Filename to write data to.

Returns
-------
used : `str`
    The name of the file used to write the data.

Reimplemented in lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.

Definition at line 565 of file calibType.py.

◆ writeText()

lsst.ip.isr.calibType.IsrCalib.writeText	(	self,
		filename,
		format = "auto" )

inherited

Write the calibration data to a text file.

Parameters
----------
filename : `str`
    Name of the file to write.
format : `str`
    Format to write the file as.  Supported values are:
        ``"auto"`` : Determine filetype from filename.
        ``"yaml"`` : Write as yaml.
        ``"ecsv"`` : Write as ecsv.

Returns
-------
used : `str`
    The name of the file used to write the data.  This may
    differ from the input if the format is explicitly chosen.

Raises
------
RuntimeError
    Raised if filename does not end in a known extension, or
    if all information cannot be written.

Notes
-----
The file is written to YAML/ECSV format and will include any
associated metadata.

Definition at line 463 of file calibType.py.

Member Data Documentation

◆ _calibId

str lsst.ip.isr.calibType.IsrCalib._calibId = None

protectedinherited

Definition at line 76 of file calibType.py.

◆ _detectorId

lsst.ip.isr.calibType.IsrCalib._detectorId = None

protectedinherited

Definition at line 74 of file calibType.py.

◆ _detectorName

lsst.ip.isr.calibType.IsrCalib._detectorName = None

protectedinherited

Definition at line 72 of file calibType.py.

◆ _detectorSerial

lsst.ip.isr.calibType.IsrCalib._detectorSerial = None

protectedinherited

Definition at line 73 of file calibType.py.

◆ _filter

lsst.ip.isr.calibType.IsrCalib._filter = None

protectedinherited

Definition at line 75 of file calibType.py.

◆ _instrument

lsst.ip.isr.calibType.IsrCalib._instrument = None

protectedinherited

Definition at line 69 of file calibType.py.

◆ _metadata

lsst.ip.isr.calibType.IsrCalib._metadata = PropertyList()

protectedinherited

Definition at line 80 of file calibType.py.

◆ _OBSTYPE

str lsst.ip.isr.calibType.IsrCalib._OBSTYPE = "generic"

staticprotectedinherited

Definition at line 64 of file calibType.py.

◆ _raftName

lsst.ip.isr.calibType.IsrCalib._raftName = None

protectedinherited

Definition at line 70 of file calibType.py.

◆ _requiredAttributes

lsst.ip.isr.calibType.IsrCalib._requiredAttributes

protectedinherited

Definition at line 115 of file calibType.py.

◆ _SCHEMA

str lsst.ip.isr.calibType.IsrCalib._SCHEMA = "NO SCHEMA"

staticprotectedinherited

Definition at line 65 of file calibType.py.

◆ _seqcksum

lsst.ip.isr.calibType.IsrCalib._seqcksum = None

protectedinherited

Definition at line 79 of file calibType.py.

◆ _seqfile

lsst.ip.isr.calibType.IsrCalib._seqfile = None

protectedinherited

Definition at line 77 of file calibType.py.

◆ _seqname

lsst.ip.isr.calibType.IsrCalib._seqname = None

protectedinherited

Definition at line 78 of file calibType.py.

◆ _slotName

lsst.ip.isr.calibType.IsrCalib._slotName = None

protectedinherited

Definition at line 71 of file calibType.py.

◆ _VERSION

int lsst.ip.isr.calibType.IsrCalib._VERSION = 0

staticprotectedinherited

Definition at line 66 of file calibType.py.

◆ centroidDeltaX

float lsst.ip.isr.flatGradient.FlatGradient.centroidDeltaX = 0.0

Definition at line 56 of file flatGradient.py.

◆ centroidDeltaY

float lsst.ip.isr.flatGradient.FlatGradient.centroidDeltaY = 0.0

Definition at line 57 of file flatGradient.py.

◆ centroidX

float lsst.ip.isr.flatGradient.FlatGradient.centroidX = 0.0

Definition at line 54 of file flatGradient.py.

◆ centroidY

float lsst.ip.isr.flatGradient.FlatGradient.centroidY = 0.0

Definition at line 55 of file flatGradient.py.

◆ gradientX

float lsst.ip.isr.flatGradient.FlatGradient.gradientX = 0.0

Definition at line 58 of file flatGradient.py.

◆ gradientY

float lsst.ip.isr.flatGradient.FlatGradient.gradientY = 0.0

Definition at line 59 of file flatGradient.py.

◆ itlRatio

float lsst.ip.isr.flatGradient.FlatGradient.itlRatio = 1.0

Definition at line 53 of file flatGradient.py.

◆ log

lsst.ip.isr.calibType.IsrCalib.log = log if log else logging.getLogger(__name__)

inherited

Definition at line 96 of file calibType.py.

◆ normalizationFactor

float lsst.ip.isr.flatGradient.FlatGradient.normalizationFactor = 1.0

Definition at line 60 of file flatGradient.py.

◆ radialSplineNodes

lsst.ip.isr.flatGradient.FlatGradient.radialSplineNodes = np.zeros(1)

Definition at line 51 of file flatGradient.py.

◆ radialSplineValues

lsst.ip.isr.flatGradient.FlatGradient.radialSplineValues = np.zeros(1)

Definition at line 52 of file flatGradient.py.

◆ requiredAttributes

lsst.ip.isr.calibType.IsrCalib.requiredAttributes = set(["_OBSTYPE", "_SCHEMA", "_VERSION"])

inherited

Definition at line 90 of file calibType.py.

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

python/lsst/ip/isr/flatGradient.py

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __str__()

◆ apply()

◆ calibInfoFromDict()

◆ computeFullModel()

◆ computeGradientModel()

◆ computeRadialSplineModel()

◆ computeRadialSplineModelXY()

◆ determineCalibClass()

◆ fromDetector()

◆ fromDict()

◆ fromTable()

◆ getMetadata()

◆ metadata()

◆ readFits()

◆ readText()

◆ requiredAttributes() [1/2]

◆ requiredAttributes() [2/2]

◆ setMetadata()

◆ setParameters()

◆ toDict()

◆ toTable()

◆ updateMetadata()

◆ updateMetadataFromExposures()

◆ validate()

◆ writeFits()

◆ writeText()

Member Data Documentation

◆ _calibId

◆ _detectorId

◆ _detectorName

◆ _detectorSerial

◆ _filter

◆ _instrument

◆ _metadata

◆ _OBSTYPE

◆ _raftName

◆ _requiredAttributes

◆ _SCHEMA

◆ _seqcksum

◆ _seqfile

◆ _seqname

◆ _slotName

◆ _VERSION

◆ centroidDeltaX

◆ centroidDeltaY

◆ centroidX

◆ centroidY

◆ gradientX

◆ gradientY

◆ itlRatio

◆ log

◆ normalizationFactor

◆ radialSplineNodes

◆ radialSplineValues

◆ requiredAttributes

◆ init()

◆ eq()

◆ str()