GenerateColorHipsConfig#

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

Bases: GenerateHipsConfig

Configuration parameters for GenerateColorHipsTask.

Attributes Summary

`allsky_tilesize`	Allsky tile size; must be power of 2.
`blue_channel_band`	Band to use for blue channel of color pngs in lupton color mapping.
`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'`)
`green_channel_band`	Band to use for green channel of color pngs in lupton color mapping.
`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_color_asinh_minimum`	AsinhMapping intensity to be mapped to black for color png scaling in lupton color mapping.
`png_color_asinh_softening`	AsinhMapping softening parameter (Q) for color png scaling in lupton color mapping.
`png_color_asinh_stretch`	AsinhMapping linear stretch for color png scaling in lupton color mapping.
`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.
`red_channel_band`	Band to use for red channel of color pngs in lupton color mapping.
`rgbGenerator`	The task to use to generate an RGB image (`ConfigurableInstance`, default `<class 'lsst.pipe.tasks.prettyPictureMaker._task.PrettyPictureConfig'>`)
`rgbStyle`	The rgb mapping style, must be one of lsstRGB or lupton (`str`, default `'lupton'`)
`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

setDefaults()

Subclass hook for computing defaults.

Attributes Documentation

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

blue_channel_band#: Band to use for blue channel of color pngs in lupton color mapping. (str, default 'g')

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

green_channel_band#: Band to use for green channel of color pngs in lupton color mapping. (str, default 'r')

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_color_asinh_minimum#: AsinhMapping intensity to be mapped to black for color png scaling in lupton color mapping. (float, default 0.0)

png_color_asinh_softening#: AsinhMapping softening parameter (Q) for color png scaling in lupton color mapping. (float, default 8.0)

png_color_asinh_stretch#: AsinhMapping linear stretch for color png scaling in lupton color mapping. (float, default 5.0)

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'>)

red_channel_band#: Band to use for red channel of color pngs in lupton color mapping. (str, default 'i')

rgbGenerator#: The task to use to generate an RGB image (ConfigurableInstance, default <class 'lsst.pipe.tasks.prettyPictureMaker._task.PrettyPictureConfig'>)

rgbStyle#

The rgb mapping style, must be one of lsstRGB or lupton (str, default 'lupton')

Allowed values:

'lupton': Use the lupton algorithm for RGB images
'lsstRGB': Use new style lsstRGB color algorithm for RGB images
'None': Field is optional

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

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.

GenerateColorHipsConfig#

Notes#