lsst.ts.wep

Wavefront estimation pipeline (WEP) calculates the wavefront error in annular Zernike polynomials up to 22 terms based on the intra- and extra-focal donut images. The wavefront error is determined by solving the transport of intensity equation (TIE) that approximates the change of intensity mainly comes from the wavefront error.

Using lsst.ts.wep

Important classes:

  • WfEstimator calculates the wavefront error in annular Zernike polynomials up to 22 terms based on the defocal donut images.

Important Pipeline Tasks:

Important enums:

  • FilterType defines the type of active filter.

  • CamType defines the type of camera.

  • BscDbType defines the type of bright star catalog database.

Python API reference

lsst.ts.wep Package

Functions

getAmpImagesFromDir(rawExpDir)

Apply regular expression to find repackaged amplifier image files.

getBscDbType(bscDbType)

Get the bright star catalog (BSC) database type.

getCamType(instName)

Get the camera type from instrument name.

getCamTypeFromButlerName(instName, detectorType)

Get the camera type from instrument name used by the LSST DM middleware for each instrument.

getCentroidFindType(centroidFindType)

Get the centroid find type.

getConfigDir()

Get the directory of configuration files.

getDeblendDonutType(deblendDonutType)

Get the deblend donut type.

getDefocalDisInMm(instName)

Get the defocal distance for the instrument

getDonutTemplateType(donutTemplateType)

Get the donut template type.

getImageType(imageType)

Get the image type.

getModulePath()

Get the path of module.

getObsLsstCmdTaskConfigDir()

Get the obs_lsst command line task configuration directory.

mapFilterRefToG(filterType)

Map the reference filter to the G filter.

readPhoSimSettingData(folderPath, fileName, ...)

Read the PhoSim setting data (segmentation or focal plane layout).

runProgram(command[, binDir, argstring])

Run the program w/o arguments.

searchDonutPos(img)

Search the position of donut on image.

writeCleanUpRepoCmd(repoDir, runName)

Format a command line call to clean up the data created by a pipeline.

writeFile(filePath, content)

Write the content to file.

writePipetaskCmd(repoDir, runName, ...[, ...])

Format a command line call to run a Gen 3 pipeline task.

Classes

BscDbType(value)

An enumeration.

CamType(value)

An enumeration.

CentroidFindType(value)

An enumeration.

DeblendDonutType(value)

An enumeration.

DefocalType(value)

An enumeration.

DonutDetector()

Class to detect donuts directly from an out of focus image by convolution with a template image.

DonutTemplateType(value)

An enumeration.

FilterType(value)

An enumeration.

ImageType(value)

An enumeration.

ParamReader([filePath])

Initialization of parameter reader of yaml format class.

WfEstimator(algoDir)

Initialize the wavefront estimator class.

lsst.ts.wep.cwfs Package

Functions

ZernikeAnnularEval(z, x, y, e[, nMax])

Calculate the wavefront surface in the basis of annular Zernike polynomial.

ZernikeAnnularFit(s, x, y, numTerms, e[, nMax])

Get the coefficients of annular Zernike polynomials by fitting the wavefront surface.

ZernikeAnnularGrad(z, x, y, e, axis[, nMax])

Evaluate the gradient of annular Zernike polynomials in a certain direction.

ZernikeAnnularJacobian(z, x, y, e, order[, nMax])

Evaluate the Jacobian of annular Zernike polynomials in a certain order.

ZernikeEval(z, x, y[, nMax])

Calculate the wavefront surface in the basis of Zernike polynomial.

ZernikeFit(s, x, y, numTerms[, nMax])

Get the coefficients of Zernike polynomials by fitting the wavefront surface.

ZernikeGrad(z, x, y, axis[, nMax])

Evaluate the gradient of Zernike polynomials in a certain axis.

ZernikeJacobian(z, x, y, order[, nMax])

Evaluate the Jacobian of Zernike polynomials in a certain order.

ZernikeMaskedFit(s, x, y, numTerms, mask, e)

Fit the wavefront surface on pupil (e.g.

extractArray(inArray, dim)

Extract the central image.

padArray(inArray, dim)

Extend the boundary of image.

Classes

Algorithm(algoDir)

Initialize the Algorithm class.

BaseCwfsTestCase()

Base class for CWFS tests

CentroidConvolveTemplate()

CentroidDefault child class to get the centroid of donut by convolution with a template donut image.

CentroidDefault()

Default Centroid class.

CentroidFindFactory()

Factory for creating the centroid find object to calculate the centroid of donut.

CentroidOtsu()

CentroidDefault child class to get the centroid of donut by the Otsu's method.

CentroidRandomWalk()

CentroidDefault child class to get the centroid of donut by the random walk model.

CompensableImage([centroidFindType])

Instantiate the class of CompensableImage.

DonutTemplateDefault()

Default Donut Template class.

DonutTemplateFactory()

Factory used to create template maker object to generate donut template images CentroidConvolveTemplate.

DonutTemplateModel()

Class to make the donut templates from the Instrument model.

DonutTemplatePhosim()

Class to make the donut templates from phosim template images.

Image([centroidFindType])

Image class for wavefront estimation.

Instrument()

Instrument class to have the instrument information used in the Algorithm class to solve the TIE.

lsst.ts.wep.deblend Package

Functions

feval(func[, vars])

Evaluate the function.

nelderMeadModify(func, x_start[, args, ...])

Optimization of the Nelder-Mead algorithm.

Classes

DeblendAdapt()

DeblendDefault child class to do the deblending by the adaptive threshold method.

DeblendDefault()

Default deblend class.

DeblendDonutFactory()

Factory for creating the deblend donut object to deblend the bright star donut from neighboring stars.

lsst.ts.wep.task Package

Classes

CalcZernikesTask(**kwargs)

Run Zernike Estimation on corner wavefront sensors (CWFS)

CalcZernikesTaskConfig(*args, **kw)

CalcZernikesTaskConnections(*[, config])

CombineZernikesBaseConfig(*args, **kw)

CombineZernikesBaseTask(**kwargs)

Base class for algorithms that combine Zernikes from the individual pairs of donuts on a detector into a single array of Zernike values for that detector.

CombineZernikesMeanTask(**kwargs)

Combine the raw Zernike measurements into an average measurement with an unweighted mean.

CombineZernikesSigmaClipTask(**kwargs)

Combine the raw Zernike measurements into an average measurement by rejecting outliers with sigma clipping.

CombineZernikesSigmaClipTaskConfig(*args, **kw)

Configuration for combining Zernike coefficients with sigma clipping.

CutOutDonutsBaseTask(**kwargs)

Base class for CutOutDonuts tasks.

CutOutDonutsBaseTaskConfig(*args, **kw)

CutOutDonutsBaseTaskConnections(*[, config])

CutOutDonutsCwfsTask(**kwargs)

Cut out the donut postage stamps on corner wavefront sensors (CWFS)

CutOutDonutsCwfsTaskConfig(*args, **kw)

CutOutDonutsScienceSensorTask(**kwargs)

Run Zernike Estimation in full-array mode (FAM)

CutOutDonutsScienceSensorTaskConfig(*args, **kw)

CutOutDonutsScienceSensorTaskConnections(*)

DonutSourceSelectorTask(**kwargs)

Donut Source Selector that uses a nearest neighbors radius query to find all donuts within the pixel radius set in the config.

DonutSourceSelectorTaskConfig(*args, **kw)

DonutStamp(stamp_im, sky_position, ...)

Single donut stamp

DonutStamps(stamps[, metadata, use_mask, ...])

Holds a list of DonutStamp objects with additional functions to get metadata as well as save as FITS files.

EstimateZernikesBaseConfig(*args, **kw)

EstimateZernikesBaseConnections(*[, config])

EstimateZernikesBaseTask(**kwargs)

Base class for Zernike estimation tasks.

EstimateZernikesCwfsTask(**kwargs)

Run Zernike Estimation on corner wavefront sensors (CWFS)

EstimateZernikesCwfsTaskConfig(*args, **kw)

EstimateZernikesCwfsTaskConnections(*[, config])

EstimateZernikesLatissTask(**kwargs)

Run Zernike Estimation for Latiss (AuxTel)

EstimateZernikesLatissTaskConfig(*args, **kw)

EstimateZernikesLatissTaskConnections(*[, ...])

EstimateZernikesScienceSensorTask(**kwargs)

Run Zernike Estimation in full-array mode (FAM)

EstimateZernikesScienceSensorTaskConfig(...)

EstimateZernikesScienceSensorTaskConnections(*)

GenerateDonutCatalogOnlineTask(dataIds, ...)

Construct a source catalog from reference catalogs and pointing information.

GenerateDonutCatalogOnlineTaskConfig(*args, **kw)

Configuration for GenerateDonutCatalogOnlineTask.

GenerateDonutCatalogWcsTask(**kwargs)

Create a WCS from boresight info and then use this with a reference catalog to select sources on the detectors for AOS.

GenerateDonutCatalogWcsTaskConfig(*args, **kw)

Configuration settings for GenerateDonutCatalogWcsTask.

GenerateDonutCatalogWcsTaskConnections(*[, ...])

Specify the pipeline connections needed for GenerateDonutCatalogWcsTask.

GenerateDonutDirectDetectTask(**kwargs)

Generate donut template and convolve with the defocal image to detect sources on the detectors for AOS.

GenerateDonutDirectDetectTaskConfig(*args, **kw)

Configuration settings for GenerateDonutDirectDetectTask.

GenerateDonutDirectDetectTaskConnections(*)

Specify the pipeline connections needed for GenerateDonutDirectDetectTask.

RefCatalogInterface(boresightRa, ...)

Class to provide tools to interact with reference catalog in Butler repository and select pieces of the catalog that cover the sky area of a pointing.

Content

Contributing

lsst.ts.wep is developed at https://github.com/lsst-ts/ts_wep.

See Also

Version