FgcmOutputIlluminationCorrectionConfig#

class lsst.fgcmcal.FgcmOutputIlluminationCorrectionConfig(*args, **kw)#

Bases: PipelineTaskConfig

Configuration for FgcmOutputIlluminationCorrectionTask.

Attributes Summary

`approximate_wcs_jacobian`	Use a Chebyshev approximation of the WCS jacobian in illumination correction? (`bool`, default `True`)
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`epoch_format`	Format for time string (e.g. iso, mjd, etc.), used by astropy.time.Time() (`str`, default `'iso'`).
`epoch_time`	Time string (UTC) that corresponds to a date in the desired epoch.
`include_wcs_jacobian`	Include WCS jacobian in illumination correction? (`bool`, default `True`)
`physical_filters`	List of physical filters to produce illumination corrections.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`use_flat_metadata`	Use flat-field metadata for illumination correction metadata? (`bool`, default `True`)

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

approximate_wcs_jacobian#: Use a Chebyshev approximation of the WCS jacobian in illumination correction? (bool, default True)

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

epoch_format#: Format for time string (e.g. iso, mjd, etc.), used by astropy.time.Time() (str, default 'iso')

epoch_time#: Time string (UTC) that corresponds to a date in the desired epoch. (str)

include_wcs_jacobian#: Include WCS jacobian in illumination correction? (bool, default True)

physical_filters#: List of physical filters to produce illumination corrections. (List, default [])

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

use_flat_metadata#: Use flat-field metadata for illumination correction metadata? (bool, default True)

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.