UpdateVisitSummaryConfig

class lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryConfig(*args, **kw)

Bases: PipelineTaskConfig

Configuration for UpdateVisitSummaryTask.

Notes

The configuration defaults for this task reflect a simple or “least common denominator” pipeline, not the more complete, more sophisticated pipeline we run on the instruments we support best. The expectation is that the various full pipeline definitions will generally import the simpler definition, so making the defaults correspond to any full pipeline would just lead to the simple pipeline setting them back to the simple-pipeline values and the full pipeline still having to then override them to the full-pipeline values.

Attributes Summary

background_provider	Which connection(s) and behavior to use when applying background overrides.
camera_dimensions	The dimensions of the 'camera' prerequisite input connection.
compute_summary_stats	Subtask that computes summary statistics from Exposure components.
connections	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
do_refit_pointing	Whether to re-fit the pointing model and add TAN-SIP WCS approximations.
do_write_visit_geometry	Whether to write refit-pointing regions that can be used to update butler dimension records.
photo_calib_provider	Which connection and behavior to use when applying photometric calibration overrides.
refit_pointing	A subtask for refitting the boresight pointing and orientation, and fitting WCS SIP approximations.
saveLogOutput	Flag to enable/disable saving of log output for a task, enabled by default.
wcs_consistency_threshold	Maximum distance (in arcseconds) between the on-sky corners of a wcs_provider WCS and the input_summary WCS.
wcs_provider	Which connection and behavior to use when applying WCS overrides.The string should be one of the following: - input_summary: Propagate the WCS from the input visit summary catalog and do not recompute WCS-based summary statistics.

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

background_provider

Which connection(s) and behavior to use when applying background overrides. (str, default 'input_summary')

Allowed values:

'input_summary'

The input visit summary catalog already includes summary statistics for the final backgrounds that can be used as-is.

'replacement'

{“The ‘background_originals’ connection refers to a background model that has been superseded by the model referred to by the ‘background_overrides’ connection.”}

camera_dimensions

The dimensions of the ‘camera’ prerequisite input connection. (List, default ['instrument'])

compute_summary_stats

Subtask that computes summary statistics from Exposure components. (ConfigurableInstance, default <class 'lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig'>)

connections: pexConfig.ConfigField

Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

do_refit_pointing

Whether to re-fit the pointing model and add TAN-SIP WCS approximations. (bool, default True)

do_write_visit_geometry

Whether to write refit-pointing regions that can be used to update butler dimension records. (bool, default False)

photo_calib_provider

Which connection and behavior to use when applying photometric calibration overrides. (str, default 'input_summary')

Allowed values:

'input_summary'

Propagate the PhotoCalib from the input visit summary catalog and do not recompute photometric calibration summary statistics.

'tract'

{“Use the ‘photo_calib_overrides_tract’ connection to load an ExposureCatalog with {visit, tract} dimensions and per-detector rows, and recommpute photometric calibration summary statistics.”}

'global'

{“Use the ‘photo_calib_overrides_global’ connection to load an ExposureCatalog with {visit} dimensions and per-detector rows, and recommpute photometric calibration summary statistics.”}

refit_pointing

A subtask for refitting the boresight pointing and orientation, and fitting WCS SIP approximations. (ConfigurableInstance, default <class 'lsst.meas.astrom.refit_pointing.RefitPointingConfig'>)

saveLogOutput

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

wcs_consistency_threshold

Maximum distance (in arcseconds) between the on-sky corners of a wcs_provider WCS and the input_summary WCS. When this threshold is exceeded, the WCS is set to None. When this is not None and there is no input summary WCS, the WCS is also nulled. (float, default None)

wcs_provider

Which connection and behavior to use when applying WCS overrides.The string should be one of the following: - input_summary: Propagate the WCS from the input visit summary catalog and do not recompute WCS-based summary statistics. - tract: Use the ‘wcs_overrides_tract’ connection to load an ExposureCatalog with {visit, tract} dimensions and per-detector rows, and recommpute WCS-based summary statistics. - global: Use the ‘wcs_overrides_global’ connection to load an ExposureCatalog with {visit} dimensions and per-detector rows, and recommpute WCS-based summary statistics. - healpixN: Use the ‘wcs_overrides_skypix’ connection to load an ExposureCatalog with {visit, healpixN} dimensions and per-detector rows, and recommpute WCS-based summary statistics. (str, default 'input_summary')

Methods Documentation

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.