lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConfig:

Public Member Functions
	setDefaults (self)

Static Public Attributes
int	hips_order = 8
	warp
	hips_base_uri
	color_ordering
	file_extension
	array_type
	input_images
	skymap
	output_hpx

Detailed Description

Configuration class for the HighOrderHipsTask pipeline task.

Definition at line 89 of file _high_order_hips.py.

Member Function Documentation

setDefaults()

lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConfig.setDefaults

(

self

)

Definition at line 124 of file _high_order_hips.py.

Member Data Documentation

array_type

lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConfig.array_type

static

Initial value:

=  ChoiceField[str](
        doc="The dataset type for the output image array",
        default="uint8",
        allowed={
            "uint8": "Use 8 bit arrays, 255 max",
            "uint16": "Use 16 bit arrays, 65535 max",
            "half": "Use 16 bit float arrays, 1 max",
            "float": "Use 32 bit float arrays, 1 max",
        },
    )

Definition at line 113 of file _high_order_hips.py.

color_ordering

lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConfig.color_ordering

static

Initial value:

=  Field[str](
        doc=(
            "A string of the astrophysical bands that correspond to the RGB channels in the color image "
            "inputs to high_order_hips task. This is in making the hips metadata"
        ),
        optional=False,
    )

Definition at line 101 of file _high_order_hips.py.

file_extension

lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConfig.file_extension

static

Initial value:

=  ChoiceField[str](
        doc="Extension for the presisted image.",
        allowed={"png": "Use the png image extension", "webp": "Use the webp image extension"},
        default="png",
    )

Definition at line 108 of file _high_order_hips.py.

hips_base_uri

lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConfig.hips_base_uri

static

Initial value:

=  Field[str](
        doc="URI to HiPS base for output.",
        optional=False,
    )

Definition at line 97 of file _high_order_hips.py.

hips_order

int lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConfig.hips_order = 8

static

Definition at line 92 of file _high_order_hips.py.

input_images

lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConnections.input_images

staticinherited

Initial value:

=  Input(
        doc="Color images which are to be turned into hips tiles",
        name="rgb_picture",
        storageClass="ColorImage",
        dimensions=("tract", "patch", "skymap"),
        multiple=True,
        deferLoad=True,
    )

Definition at line 67 of file _high_order_hips.py.

output_hpx

lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConnections.output_hpx

staticinherited

Initial value:

=  Output(
        doc="Healpix tiles at order 8, but binned to 256x256",
        name="rgb_picture_hips8",
        storageClass="NumpyArray",
        dimensions=("healpix8",),
    )

Definition at line 81 of file _high_order_hips.py.

skymap

lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConnections.skymap

staticinherited

Initial value:

=  Input(
        doc="The skymap which the data has been mapped onto",
        storageClass="SkyMap",
        name=BaseSkyMap.SKYMAP_DATASET_TYPE_NAME,
        dimensions=("skymap",),
    )

Definition at line 75 of file _high_order_hips.py.

warp

lsst.pipe.tasks.rgb2hips._high_order_hips.HighOrderHipsTaskConfig.warp

static

Initial value:

=  ConfigField[Warper.ConfigClass](
        doc="Warper configuration",
    )

Definition at line 94 of file _high_order_hips.py.

---

The documentation for this class was generated from the following file:

• python/lsst/pipe/tasks/rgb2hips/_high_order_hips.py