JointcalConfig#

class lsst.jointcal.JointcalConfig(*args, **kw)#

Bases: PipelineTaskConfig

Configuration for JointcalTask

Attributes Summary

`allowLineSearch`	Allow a line search during minimization, if it is reasonable for the model (models with a significant non-linear component, e.g. constrainedPhotometry).
`applyColorTerms`	Apply photometric color terms to reference stars?Requires that colorterms be set to a ColortermLibrary (`bool`, default `False`)
`astrometryChipOrder`	Order of the per-chip transform for the constrained astrometry model.
`astrometryDoRankUpdate`	Do the rank update step during minimization (should not change the astrometry fit).
`astrometryModel`	Type of model to fit to astrometry (`str`, default `'constrained'`)
`astrometryOutlierRelativeTolerance`	Convergence tolerance for outlier rejection threshold when fitting astrometry.
`astrometryRefObjLoader`	Reference object loader for astrometric fit (`LoadReferenceObjectsConfig`, default `<class 'lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig'>`)
`astrometryReferenceErr`	Uncertainty on reference catalog coordinates [mas] to use in place of the `coord_*Err` fields.
`astrometryReferenceSelector`	How to down-select the loaded astrometry reference catalog.
`astrometrySimpleOrder`	Polynomial order for fitting the simple astrometry model.
`astrometryVisitOrder`	Order of the per-visit transform for the constrained astrometry model.
`colorterms`	Library of photometric reference catalog name to color term dict.
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`debugOutputPath`	Path to write debug output files to.
`detailedProfile`	Output separate profiling information for different parts of jointcal, e.g. data read, fitting (`bool`, default `False`).
`doAstrometry`	Fit astrometry and write the fitted result.
`doPhotometry`	Fit photometry and write the fitted result.
`matchCut`	Matching radius between fitted and reference stars (arcseconds) (`float`, default `3.0`)
`maxAstrometrySteps`	Maximum number of minimize iterations to take when fitting astrometry.
`maxPhotometrySteps`	Maximum number of minimize iterations to take when fitting photometry.
`minMeasuredStarsPerCcd`	Minimum number of measuredStars per ccdImage before printing warnings (`int`, default `100`)
`minMeasurements`	Minimum number of associated measured stars for a fitted star to be included in the fit (`int`, default `2`)
`minRefStarsPerCcd`	Minimum number of measuredStars per ccdImage before printing warnings (`int`, default `30`)
`outlierRejectSigma`	How many sigma to reject outliers at during minimization.
`photometryDoRankUpdate`	Do the rank update step during minimization.
`photometryErrorPedestal`	Systematic term to apply to the measured error on flux or magnitude as a fraction of source flux or magnitude delta (e.g. 0.05 is 5% of flux or +50 millimag).
`photometryModel`	Type of model to fit to photometry (`str`, default `'constrainedMagnitude'`)
`photometryRefObjLoader`	Reference object loader for photometric fit (`LoadReferenceObjectsConfig`, default `<class 'lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig'>`)
`photometryReferenceSelector`	How to down-select the loaded photometry reference catalog.
`photometryVisitOrder`	Order of the per-visit polynomial transform for the constrained photometry model.
`positionErrorPedestal`	Systematic term to apply to the measured position error (pixels) (`float`, default `0.02`)
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`sourceFluxType`	Source flux field to use in source selection and to get fluxes from the catalog.
`sourceSelector`	How to select sources for cross-matching (`RegistryInstanceDict`, default `'science'`)
`useInputWcs`	Use the input calexp WCSs to initialize a SimpleAstrometryModel.
`writeChi2FilesInitialFinal`	Write .csv files containing the contributions to chi2 for the initialization and final fit.
`writeChi2FilesOuterLoop`	Write .csv files containing the contributions to chi2 for the outer fit loop.
`writeInitMatrix`	Write the pre/post-initialization Hessian and gradient to text files, for debugging.
`writeInitialModel`	Write the pre-initialization model to text files, for debugging.

Methods Summary

`setDefaults`()	Subclass hook for computing defaults.
`validate`()	Validate the Config, raising an exception if invalid.

Attributes Documentation

allowLineSearch#: Allow a line search during minimization, if it is reasonable for the model (models with a significant non-linear component, e.g. constrainedPhotometry). (bool, default False)

applyColorTerms#: Apply photometric color terms to reference stars?Requires that colorterms be set to a ColortermLibrary (bool, default False)

astrometryChipOrder#: Order of the per-chip transform for the constrained astrometry model. (int, default 1)

astrometryDoRankUpdate#: Do the rank update step during minimization (should not change the astrometry fit). Skipping this can help deal with models that are too non-linear. (bool, default True)

astrometryModel#

Type of model to fit to astrometry (str, default 'constrained')

Allowed values:

'simple': One polynomial per ccd
'constrained': One polynomial per ccd, and one polynomial per visit
'None': Field is optional

astrometryOutlierRelativeTolerance#: Convergence tolerance for outlier rejection threshold when fitting astrometry. Iterations will stop when the fractional change in the chi2 cut level is below this value. If tolerance is set to zero, iterations will continue until there are no more outliers. We suggest a value of 0.002as a balance between a shorter minimization runtime and achieving a final fitted model that isclose to the solution found when removing all outliers. (float, default 0)

astrometryRefObjLoader#: Reference object loader for astrometric fit (LoadReferenceObjectsConfig, default <class 'lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig'>)

astrometryReferenceErr#: Uncertainty on reference catalog coordinates [mas] to use in place of the coord_*Err fields. If None, then raise an exception if the reference catalog is missing coordinate errors. If specified, overrides any existing coord_*Err values. (float, default None)

astrometryReferenceSelector#: How to down-select the loaded astrometry reference catalog. (ConfigurableInstance, default <class 'lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorConfig'>)

astrometrySimpleOrder#: Polynomial order for fitting the simple astrometry model. (int, default 3)

astrometryVisitOrder#: Order of the per-visit transform for the constrained astrometry model. (int, default 5)

colorterms#: Library of photometric reference catalog name to color term dict. (ColortermLibrary, default <class 'lsst.pipe.tasks.colorterms.ColortermLibrary'>)

connections: pexConfig.ConfigField#: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

debugOutputPath#: Path to write debug output files to. Used by writeInitialModel, writeChi2Files*, writeInitMatrix. (str, default '.')

detailedProfile#: Output separate profiling information for different parts of jointcal, e.g. data read, fitting (bool, default False)

doAstrometry#: Fit astrometry and write the fitted result. (bool, default True)

doPhotometry#: Fit photometry and write the fitted result. (bool, default True)

matchCut#: Matching radius between fitted and reference stars (arcseconds) (float, default 3.0)

maxAstrometrySteps#: Maximum number of minimize iterations to take when fitting astrometry. (int, default 20)

maxPhotometrySteps#: Maximum number of minimize iterations to take when fitting photometry. (int, default 20)

minMeasuredStarsPerCcd#: Minimum number of measuredStars per ccdImage before printing warnings (int, default 100)

minMeasurements#: Minimum number of associated measured stars for a fitted star to be included in the fit (int, default 2)

minRefStarsPerCcd#: Minimum number of measuredStars per ccdImage before printing warnings (int, default 30)

outlierRejectSigma#: How many sigma to reject outliers at during minimization. (float, default 5.0)

photometryDoRankUpdate#: Do the rank update step during minimization. Skipping this can help deal with models that are too non-linear. (bool, default True)

photometryErrorPedestal#: Systematic term to apply to the measured error on flux or magnitude as a fraction of source flux or magnitude delta (e.g. 0.05 is 5% of flux or +50 millimag). (float, default 0.0)

photometryModel#

Type of model to fit to photometry (str, default 'constrainedMagnitude')

Allowed values:

'simpleFlux': One constant zeropoint per ccd and visit, fitting in flux space.
'constrainedFlux': Constrained zeropoint per ccd, and one polynomial per visit, fitting in flux space.
'simpleMagnitude': One constant zeropoint per ccd and visit, fitting in magnitude space.
'constrainedMagnitude': Constrained zeropoint per ccd, and one polynomial per visit, fitting in magnitude space.
'None': Field is optional

photometryRefObjLoader#: Reference object loader for photometric fit (LoadReferenceObjectsConfig, default <class 'lsst.meas.algorithms.loadReferenceObjects.LoadReferenceObjectsConfig'>)

photometryReferenceSelector#: How to down-select the loaded photometry reference catalog. (ConfigurableInstance, default <class 'lsst.meas.algorithms.sourceSelector.ReferenceSourceSelectorConfig'>)

photometryVisitOrder#: Order of the per-visit polynomial transform for the constrained photometry model. (int, default 7)

positionErrorPedestal#: Systematic term to apply to the measured position error (pixels) (float, default 0.02)

saveLogOutput#: Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

sourceFluxType#: Source flux field to use in source selection and to get fluxes from the catalog. (str, default 'apFlux_12_0')

sourceSelector#: How to select sources for cross-matching (RegistryInstanceDict, default 'science')

useInputWcs#: Use the input calexp WCSs to initialize a SimpleAstrometryModel. (bool, default True)

writeChi2FilesInitialFinal#: Write .csv files containing the contributions to chi2 for the initialization and final fit. Output files will be written to config.debugOutputPath and will be of the form astrometry_[initial|final]_chi2-TRACT-FILTER. (`bool, default False)

writeChi2FilesOuterLoop#: Write .csv files containing the contributions to chi2 for the outer fit loop. Output files will be written to config.debugOutputPath and will be of the form astrometry_init-NN_chi2-TRACT-FILTER. (bool, default False)

writeInitMatrix#: Write the pre/post-initialization Hessian and gradient to text files, for debugging. Output files will be written to config.debugOutputPath and will be of the form ‘astrometry_[pre|post]init-TRACT-FILTER-mat.txt’. Note that these files are the dense versions of the matrix, and so may be very large. (bool, default False)

writeInitialModel#: Write the pre-initialization model to text files, for debugging. Output files will be written to config.debugOutputPath and will be of the form initial_astrometry_model-TRACT_FILTER.txt. (bool, default False)

Methods Documentation

setDefaults()#: Subclass hook for computing defaults.

Notes#

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

validate()#

Validate the Config, raising an exception if invalid.

Raises#

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes#

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.