lsst.afw.fits._fitsContinued.QuantizationOptions Class Reference

Public Member Functions
QuantizationOptions	from_mapping (cls, Mapping[str, object] mapping)
dict[str, object]	to_dict (self)
	__repr__ (self)

Public Attributes
	mask_planes
	level
	seed

Detailed Description

Definition at line 47 of file _fitsContinued.py.

Member Function Documentation

__repr__()

lsst.afw.fits._fitsContinued.QuantizationOptions.__repr__

(

self

)

Definition at line 111 of file _fitsContinued.py.

from_mapping()

QuantizationOptions lsst.afw.fits._fitsContinued.QuantizationOptions.from_mapping	(		cls,
		Mapping[str, object]	mapping )

Construct from a dictionary with keys matching this struct's fields.

Parameters
----------
mapping : `~collections.abc.Mapping`
    Mapping from string to value.  Enumeration values may be passed as
    string value names.

Returns
-------
options : `QuantizationOptions`
    An instance of this options class.

Notes
-----
Allowed keys are:

- ``dither``: `str`, one of ``NO_DITHER``, ``SUBTRACTIVE_DITHER_1``, or
  ``SUBTRACTIVE_DITHER_2``.  Defaults to ``NO_DITHER``.
- ``scaling``: `str`, one of ``STDEV_CFITSIO``, ``STDEV_MASKED``,
  ``RANGE``, or ``MANUAL`` (see C++ docs for definitions).
- ``mask_planes`` : `list` of `str`, names of mask planes to reject in
  ``STDEV_MASKED`` and ``RANGE`` (but only when writing objects with
  mask planes)
- ``level``: `float`, target compression level (see C++ docs).
- ``seed``: random number seed for dithering.  Default is zero, which
  uses a timestamp-based seed when used directly, but a data ID-based
  seed when used via `lsst.obs.base.FitsExposureFormatter`.

Definition at line 49 of file _fitsContinued.py.

to_dict()

dict[str, object] lsst.afw.fits._fitsContinued.QuantizationOptions.to_dict

(

self

)

"Return the mapping representation of these options.

Returns
-------
mapping : `dict`
    See `from_mapping`.

Definition at line 95 of file _fitsContinued.py.

Member Data Documentation

level

lsst.afw.fits._fitsContinued.QuantizationOptions.level

Definition at line 107 of file _fitsContinued.py.

mask_planes

lsst.afw.fits._fitsContinued.QuantizationOptions.mask_planes

Definition at line 106 of file _fitsContinued.py.

seed

lsst.afw.fits._fitsContinued.QuantizationOptions.seed

Definition at line 108 of file _fitsContinued.py.

---

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

• python/lsst/afw/fits/_fitsContinued.py