lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig:

Public Member Functions
	validate (self)
	setDefaults (self)

Static Public Attributes
	creator_did_template
	obs_collection
	obs_description_template
	prov_progenitor
	obs_title_template
	spectral_ranges
	initial_ra
	initial_dec
	initial_fov
	obs_ack
	t_min
	t_max

Detailed Description

Configuration parameters for writing a HiPS properties file.

Definition at line 39 of file _properties.py.

Member Function Documentation

setDefaults()

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.setDefaults

(

self

)

Definition at line 107 of file _properties.py.

validate()

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.validate

(

self

)

Definition at line 100 of file _properties.py.

Member Data Documentation

creator_did_template

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.creator_did_template

static

Initial value:

=  Field[str](
        doc=("Unique identifier of the HiPS - Format: IVOID. Use ``{band}`` to substitute the band name."),
        dtype=str,
        optional=False,
    )

Definition at line 42 of file _properties.py.

initial_dec

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.initial_dec

static

Initial value:

=  Field[float](
        doc="Initial Declination (deg) (default for HiPS viewer).  If not set will use a point in MOC.",
        optional=True,
    )

Definition at line 79 of file _properties.py.

initial_fov

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.initial_fov

static

Initial value:

=  Field[float](
        doc="Initial field-of-view (deg).  If not set will use ~1 healpix tile.",
        optional=True,
    )

Definition at line 83 of file _properties.py.

initial_ra

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.initial_ra

static

Initial value:

=  Field[float](
        doc="Initial RA (deg) (default for HiPS viewer).  If not set will use a point in MOC.",
        optional=True,
    )

Definition at line 75 of file _properties.py.

obs_ack

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.obs_ack

static

Initial value:

=  Field[str](
        doc="Observation acknowledgements (free text).",
        optional=True,
    )

Definition at line 87 of file _properties.py.

obs_collection

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.obs_collection

static

Initial value:

=  Field[str](
        doc="Short name of original data set - Format: one word",
        optional=True,
    )

Definition at line 47 of file _properties.py.

obs_description_template

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.obs_description_template

static

Initial value:

=  Field[str](
        doc=(
            "Data set description - Format: free text, longer free text "
            "description of the dataset.  Use ``{band}`` to substitute "
            "the band name."
        ),
    )

Definition at line 51 of file _properties.py.

obs_title_template

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.obs_title_template

static

Initial value:

=  Field[str](
        doc=(
            "Data set title format: free text, but should be short. "
            "Use ``{band}`` to substitute the band name."
        ),
        optional=False,
    )

Definition at line 62 of file _properties.py.

prov_progenitor

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.prov_progenitor

static

Initial value:

=  ListField[str](
        doc="Provenance of the original data - Format: free text",
        default=[],
    )

Definition at line 58 of file _properties.py.

spectral_ranges

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.spectral_ranges

static

Initial value:

=  ConfigDictField(
        doc=("Mapping from band to lambda_min, lamba_max (nm).  May be approximate."),
        keytype=str,
        itemtype=HipsPropertiesSpectralTerm,
        default={},
    )

Definition at line 69 of file _properties.py.

t_max

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.t_max

static

Initial value:

=  Field[float](
        doc="Time (MJD) of latest observation included in HiPS",
        optional=True,
    )

Definition at line 95 of file _properties.py.

t_min

lsst.pipe.tasks.rgb2hips._properties.HipsPropertiesConfig.t_min

static

Initial value:

=  Field[float](
        doc="Time (MJD) of earliest observation included in HiPS",
        optional=True,
    )

Definition at line 91 of file _properties.py.

---

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

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