lsst.afw.fits._fitsContinued.CompressionOptions Class Reference

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

Public Attributes
	tile_width
	tile_height

Detailed Description

Definition at line 119 of file _fitsContinued.py.

Member Function Documentation

__repr__()

lsst.afw.fits._fitsContinued.CompressionOptions.__repr__

(

self

)

Definition at line 177 of file _fitsContinued.py.

from_mapping()

CompressionOptions lsst.afw.fits._fitsContinued.CompressionOptions.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.  Missing keys are mapped to default values.

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

Notes
-----
Allowed keys are:

- ``algorithm``: `str`, one of ``GZIP_1``, ``GZIP_2``, or ``RICE_1``.
- ``tile_width``: `int`, zero to use entire rows.
- ``tile_height``: `int`, zero to use entire columns.
- ``quantization``: `dict` or `None` (see
   `QuantizationOptions.from_mapping`).

Missing keys are replaced by defaults that reflect lossless compression
(``GZIP_2``) with single rows as tiles.

Definition at line 121 of file _fitsContinued.py.

to_dict()

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

(

self

)

"Return the mapping representation of these options.

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

Definition at line 162 of file _fitsContinued.py.

Member Data Documentation

tile_height

lsst.afw.fits._fitsContinued.CompressionOptions.tile_height

Definition at line 173 of file _fitsContinued.py.

tile_width

lsst.afw.fits._fitsContinued.CompressionOptions.tile_width

Definition at line 172 of file _fitsContinued.py.

---

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

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