HealSparseMapFormatter

class lsst.pipe.tasks.healSparseMapping.HealSparseMapFormatter(fileDescriptor: FileDescriptor, *, dataId: DataCoordinate | None = None, writeParameters: Mapping[str, Any] | None = None, writeRecipes: Mapping[str, Any] | None = None, **kwargs: Any)

Bases: Formatter

Interface for reading and writing healsparse.HealSparseMap files.

Attributes Summary

extension	Default file extension to use for writing files.
supportedExtensions	Set of all extensions supported by this formatter.
unsupportedParameters	Set of read parameters not understood by this Formatter.

Methods Summary

read([component])	Read a Dataset.
write(inMemoryDataset)	Write a Dataset.

Attributes Documentation

extension: str | None = '.hsp'

Default file extension to use for writing files. None means that no modifications will be made to the supplied file extension. (str)

supportedExtensions: ClassVar[Set[str]] = frozenset({'.fit', '.fits', '.hsp'})

Set of all extensions supported by this formatter.

Only expected to be populated by Formatters that write files. Any extension assigned to the extension property will be automatically included in the list of supported extensions.

unsupportedParameters: ClassVar[Set[str] | None] = frozenset({})

Set of read parameters not understood by this Formatter. An empty set means all parameters are supported. None indicates that no parameters are supported. These parameters should match those defined in the storage class definition. (frozenset).

Methods Documentation

read(component=None)

Read a Dataset.

Parameters

componentstr, optional

Component to read from the file. Only used if the StorageClass for reading differed from the StorageClass used to write the file.

Returns

inMemoryDatasetobject

The requested Dataset.

write(inMemoryDataset)

Write a Dataset.

Parameters

inMemoryDatasetobject

The Dataset to store.