Functions
def	noDistort (src)

def	linearXDistort (src, frac=.001)

def	quadraticDistortX (src, frac=1e-6)

def	cubicDistortX (src, frac=1e-9)

def	manyTermX (src, frac=1e-9)

def	linearYDistort (src, frac=.001)

def	quadraticDistortY (src, frac=1e-6)

def	cubicDistortY (src, frac=1e-9)

def	manyTermY (src, frac=1e-9)

def	crossTerms1 (src, frac=1e-11)

def	crossTerms2 (src, frac=1e-11)

def	crossTerms3 (src, frac=1e-9)

def	quadraticDistort (src, frac=1e-6)

def	T2DistortX (src, frac=1e-6)

def	distortList (srcList, function)

Function Documentation

◆ crossTerms1()

def lsst.meas.astrom.sip.genDistortedImage.crossTerms1	(	src,
		frac = `1e-11`
	)

Distort image Y by X, leaving X unchanged, 'x**3 - 2*x**2'.

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change Y by

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of Y changed

Definition at line 255 of file genDistortedImage.py.

◆ crossTerms2()

def lsst.meas.astrom.sip.genDistortedImage.crossTerms2	(	src,
		frac = `1e-11`
	)

Distort image X by Y, leaving Y unchanged, 'y**3 - 2*y**2 + 4*y - 9'.

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change X by

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of X changed

Definition at line 280 of file genDistortedImage.py.

◆ crossTerms3()

def lsst.meas.astrom.sip.genDistortedImage.crossTerms3	(	src,
		frac = `1e-9`
	)

Distort image X and Y , 'dx=x**3 - 2*x**2 + 4*x - 9',
'dy=y**3 - 2*y**2 + 4*y - 9'.

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change X and Y by

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of X and Y changed

Definition at line 305 of file genDistortedImage.py.

◆ cubicDistortX()

def lsst.meas.astrom.sip.genDistortedImage.cubicDistortX	(	src,
		frac = `1e-9`
	)

Distort image by terms with power <=2
i.e y, y^2, x, xy, x^2

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change X by

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of x changed

Definition at line 101 of file genDistortedImage.py.

◆ cubicDistortY()

def lsst.meas.astrom.sip.genDistortedImage.cubicDistortY	(	src,
		frac = `1e-9`
	)

Distort image by terms with power <=2
i.e y, y^2, x, xy, x^2

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change Y by

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of Y changed

Definition at line 203 of file genDistortedImage.py.

◆ distortList()

def lsst.meas.astrom.sip.genDistortedImage.distortList	(	srcList,
		function
	)

Create a copy of srcList, and apply function to distort the
values of x and y.

Parameters
----------
srcList : `list` of `lsst.afw.table.SourceRecord`
    Input list of source to distort.
function : `callable`
    A function that does a deep copy of a single Source

Returns
-------
out : `lsst.afw.table.SourceCatalog`
    Output catalog with distorted positions.

Definition at line 384 of file genDistortedImage.py.

◆ linearXDistort()

def lsst.meas.astrom.sip.genDistortedImage.linearXDistort	(	src,
		frac = `.001`
	)

Increase the x value in a Source object by frac. E.g
src.x = 1000 --> 1001 if frac=.001

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change X by

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of x changed

Definition at line 52 of file genDistortedImage.py.

◆ linearYDistort()

def lsst.meas.astrom.sip.genDistortedImage.linearYDistort	(	src,
		frac = `.001`
	)

Increase the y value in a Source object by frac. E.g
src.x = 1000 --> 1001 if frac=.001

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change Y by

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of Y changed

Definition at line 154 of file genDistortedImage.py.

◆ manyTermX()

def lsst.meas.astrom.sip.genDistortedImage.manyTermX	(	src,
		frac = `1e-9`
	)

Distort image by multiple powers of x, 'x**3 - 2*x**2 + 4*x - 9'.

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change X by

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of x changed

Definition at line 128 of file genDistortedImage.py.

◆ manyTermY()

def lsst.meas.astrom.sip.genDistortedImage.manyTermY	(	src,
		frac = `1e-9`
	)

Distort image by multiple terms of Y, 'y**3 - 2*y**2 + 4*y - 9'.

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change Y by

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of Y changed

Definition at line 230 of file genDistortedImage.py.

◆ noDistort()

def lsst.meas.astrom.sip.genDistortedImage.noDistort ( src )

Do no distortion. Used for sanity checking

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    Input record

Returns
-------
out : `lsst.afw.table.SourceRecord`
    Copy of input record.

Definition at line 34 of file genDistortedImage.py.

◆ quadraticDistort()

def lsst.meas.astrom.sip.genDistortedImage.quadraticDistort	(	src,
		frac = `1e-6`
	)

Distort image by terms with power <=2
i.e y, y^2, x, xy, x^2

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change X

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of X

Definition at line 332 of file genDistortedImage.py.

◆ quadraticDistortX()

def lsst.meas.astrom.sip.genDistortedImage.quadraticDistortX	(	src,
		frac = `1e-6`
	)

Distort image by terms with power <=2
i.e y, y^2, x, xy, x^2

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change X by

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of x changed

Definition at line 74 of file genDistortedImage.py.

◆ quadraticDistortY()

def lsst.meas.astrom.sip.genDistortedImage.quadraticDistortY	(	src,
		frac = `1e-6`
	)

Distort image by terms with power <=2
i.e y, y^2, x, xy, x^2

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change Y by

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of Y changed

Definition at line 176 of file genDistortedImage.py.

◆ T2DistortX()

def lsst.meas.astrom.sip.genDistortedImage.T2DistortX	(	src,
		frac = `1e-6`
	)

Distort image by a 2nd order Cheby polynomial

Parameters
----------
src : `lsst.afw.table.SourceRecord`
    A Source object
frac : `float`
    How much to change X

Returns
-------
out : `lsst.afw.table.SourceRecord`
    A deep copy of src, with the value of X

Definition at line 361 of file genDistortedImage.py.

Functions