SurveyWidePropertyMapAnalysisConfig#

class lsst.analysis.tools.tasks.SurveyWidePropertyMapAnalysisConfig(*args, **kw)#

Bases: AnalysisBaseConfig

Attributes Summary

`addOutputNamePrefix`	If True, the connections class output name will be prefixed to the analysis 'atools' name when the value is dispatched to sasquatch.
`atools`	The analysis tools that are to be run by this task at execution (`ConfigurableActionStructField`)
`autozoom`	Automatically zooms in on the RA/Dec range of the map to make better use of its resolution; otherwise, the map is displayed within the full-sky domain.
`bands`	Filter bands on which to run all of the actions (`List`, default `['u', 'g', 'r', 'i', 'z', 'y']`)
`colorbarKwargs`	Keyword arguments to pass to the colorbar.
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`dataset_identifier`	An identifier to be associated with output Metrics (`str`, default `None`)
`metric_tags`	List of tags which will be added to all configurable actions (`List`, default `[]`)
`metrics`	The analysis tools that are to be run by this task at execution (`ConfigurableActionStructField`)
`plots`	The analysis tools that are to be run by this task at execution (`ConfigurableActionStructField`)
`projection`	The projection to use for plotting the map.
`projectionKwargs`	Keyword arguments to use in the projection call, e.g. lon_0.
`publicationStyle`	Make a simplified figure layout for publication use? (`bool`, default `False`)
`reference_package`	A package who's version, at the time of metric upload to a time series database, will be converted to a timestamp of when that version was produced (`str`, default `'lsst_distrib'`)
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`timestamp_version`	Which time stamp should be used as the reference timestamp for a metric in a time series database, valid values are; reference_package_timestamp, run_timestamp, current_timestamp, dataset_timestamp and explicit_timestamp:datetime where datetime is given in the form %Y%m%dT%H%M%S%z (`str`, default `'run_timestamp'`)

Attributes Documentation

addOutputNamePrefix#: If True, the connections class output name will be prefixed to the analysis ‘atools’ name when the value is dispatched to sasquatch. (bool, default False)

atools#: The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)

autozoom#: Automatically zooms in on the RA/Dec range of the map to make better use of its resolution; otherwise, the map is displayed within the full-sky domain. (bool, default True)

bands#: Filter bands on which to run all of the actions (List, default ['u', 'g', 'r', 'i', 'z', 'y'])

colorbarKwargs#: Keyword arguments to pass to the colorbar. (Dict, default {'orientation': 'horizontal', 'location': 'top', 'cmap': 'viridis'})

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

dataset_identifier#: An identifier to be associated with output Metrics (str, default None)

metric_tags#: List of tags which will be added to all configurable actions (List, default [])

metrics#: The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)

plots#: The analysis tools that are to be run by this task at execution (ConfigurableActionStructField)

projection#

The projection to use for plotting the map. See https://skyproj.readthedocs.io/en/latest/projections.html (str, default 'McBryde')

Allowed values:

'McBryde': McBryde
'Mollweide': Mollweide
'Cylindrical': Cylindrical
'Laea': Laea
'Hammer': Hammer
'EqualEarth': EqualEarth
'ObliqueMollweide': ObliqueMollweide
'Albers': Albers
'None': Field is optional

projectionKwargs#: Keyword arguments to use in the projection call, e.g. lon_0. The key ‘ax’ is not permitted. See https://skyproj.readthedocs.io/en/latest/projections.html (Dict, default {})

publicationStyle#: Make a simplified figure layout for publication use? (bool, default False)

reference_package#: A package who’s version, at the time of metric upload to a time series database, will be converted to a timestamp of when that version was produced (str, default 'lsst_distrib')

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

timestamp_version#: Which time stamp should be used as the reference timestamp for a metric in a time series database, valid values are; reference_package_timestamp, run_timestamp, current_timestamp, dataset_timestamp and explicit_timestamp:datetime where datetime is given in the form %Y%m%dT%H%M%S%z (str, default 'run_timestamp')