GenerateHipsConfig

class lsst.pipe.tasks.hips.GenerateHipsConfig(*args, **kw)

Bases: PipelineTaskConfig

Configuration parameters for GenerateHipsTask.

Attributes Summary

allsky_tilesize	Allsky tile size; must be power of 2.
connections	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
file_extension	Extension for the presisted image, must be png or webp (str, default 'png')
hips_base_uri	URI to HiPS base for output.
min_order	Minimum healpix order for HiPS tree.
parallel_highest_order	If this is set to True, each of the highest order hips pixels will be put into their own quanta, and can be run in parallel.
png_gray_asinh_minimum	AsinhMapping intensity to be mapped to black for grayscale png scaling.
png_gray_asinh_softening	AsinhMapping softening parameter (Q) for grayscale png scaling.
png_gray_asinh_stretch	AsinhMapping linear stretch for grayscale png scaling.
properties	Configuration for properties file.
saveLogOutput	Flag to enable/disable saving of log output for a task, enabled by default.
skip_highest_image	This option should be used if in another task instance parallel_highest_order was set to True.

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

allsky_tilesize

Allsky tile size; must be power of 2. HiPS standard recommends 64x64 tiles. (int, default 64)

connections: pexConfig.ConfigField

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

file_extension

Extension for the presisted image, must be png or webp (str, default 'png')

Allowed values:

'png'

Use the png image extension

'webp'

Use the webp image extension

'None'

Field is optional

hips_base_uri

URI to HiPS base for output. (str)

min_order

Minimum healpix order for HiPS tree. (int, default 3)

parallel_highest_order

If this is set to True, each of the highest order hips pixels will be put into their own quanta, and can be run in parallel. The trade off is the highest order must be run alone by setting min_order to be the the same as the healpix dimension. This will skip writing all sky info, which must be done in another invocation of this task. (bool, default False)

png_gray_asinh_minimum

AsinhMapping intensity to be mapped to black for grayscale png scaling. (float, default 0.0)

png_gray_asinh_softening

AsinhMapping softening parameter (Q) for grayscale png scaling. (float, default 8.0)

png_gray_asinh_stretch

AsinhMapping linear stretch for grayscale png scaling. (float, default 2.0)

properties

Configuration for properties file. (HipsPropertiesConfig, default <class 'lsst.pipe.tasks.hips.HipsPropertiesConfig'>)

saveLogOutput

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

skip_highest_image

This option should be used if in another task instance parallel_highest_order was set to True. This option will skip making and writing png for the highest order. (bool, default False)

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.