ConsolidateVisitSummaryConfig#

class lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryConfig(*args, **kw)#

Bases: PipelineTaskConfig

Config for ConsolidateVisitSummaryTask

Attributes Summary

cameraDimensions

The dimensions of the 'camera' prerequisite input connection.

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.

do_write_visit_geometry

Whether to write refit-pointing regions that can be used to update butler dimension records.

full

Whether to propate all exposure components.

refitPointing

A subtask for refitting the boresight pointing and orientation, and using those to produce new regions for butler dimensions.

saveLogOutput

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

Methods Summary

setDefaults()

Subclass hook for computing defaults.

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

cameraDimensions#

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

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. (bool, default True)

do_write_visit_geometry#

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

full#

Whether to propate all exposure components. This adds PSF, aperture correction map, transmission curve, and detector, which can increase file size by more than factor of 10, but it makes the visit summaries produced by this task fully usableby tasks that were designed to run downstream of lsst.drp.tasks.UpdateVisitSummaryTask. (bool, default False)

refitPointing#

A subtask for refitting the boresight pointing and orientation, and using those to produce new regions for butler dimensions. (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)

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.