lsst.pipe.tasks.healSparseMapping.HealSparseMapFormatter Class Reference

Inheritance diagram for lsst.pipe.tasks.healSparseMapping.HealSparseMapFormatter:

Public Member Functions
	read (self, component=None)
	write (self, inMemoryDataset)

Public Attributes
	extension

Static Public Attributes
	unsupportedParameters = frozenset()
	supportedExtensions = frozenset({".hsp", ".fit", ".fits"})
str	extension = '.hsp'

Detailed Description

Interface for reading and writing healsparse.HealSparseMap files.

Definition at line 47 of file healSparseMapping.py.

Member Function Documentation

read()

lsst.pipe.tasks.healSparseMapping.HealSparseMapFormatter.read	(		self,
			component = None )

Definition at line 53 of file healSparseMapping.py.

    def read(self, component=None):
        # Docstring inherited from Formatter.read.
        path = self.fileDescriptor.location.path
 
        if component == 'coverage':
            try:
                data = hsp.HealSparseCoverage.read(path)
            except (OSError, RuntimeError):
                raise ValueError(f"Unable to read healsparse map with URI {self.fileDescriptor.location.uri}")
 
            return data
 
        if self.fileDescriptor.parameters is None:
            pixels = None
            degrade_nside = None
        else:
            pixels = self.fileDescriptor.parameters.get('pixels', None)
            degrade_nside = self.fileDescriptor.parameters.get('degrade_nside', None)
        try:
            data = hsp.HealSparseMap.read(path, pixels=pixels, degrade_nside=degrade_nside)
        except (OSError, RuntimeError):
            raise ValueError(f"Unable to read healsparse map with URI {self.fileDescriptor.location.uri}")
 
        return data
 

write()

lsst.pipe.tasks.healSparseMapping.HealSparseMapFormatter.write	(		self,
			inMemoryDataset )

Definition at line 78 of file healSparseMapping.py.

    def write(self, inMemoryDataset):
        # Docstring inherited from Formatter.write.
        # Update the location with the formatter-preferred file extension
        self.fileDescriptor.location.updateExtension(self.extension)
        inMemoryDataset.write(self.fileDescriptor.location.path, clobber=True)
 
 

Member Data Documentation

extension [1/2]

str lsst.pipe.tasks.healSparseMapping.HealSparseMapFormatter.extension = '.hsp'

static

Definition at line 51 of file healSparseMapping.py.

extension [2/2]

lsst.pipe.tasks.healSparseMapping.HealSparseMapFormatter.extension

Definition at line 81 of file healSparseMapping.py.

supportedExtensions

lsst.pipe.tasks.healSparseMapping.HealSparseMapFormatter.supportedExtensions = frozenset({".hsp", ".fit", ".fits"})

static

Definition at line 50 of file healSparseMapping.py.

unsupportedParameters

lsst.pipe.tasks.healSparseMapping.HealSparseMapFormatter.unsupportedParameters = frozenset()

static

Definition at line 49 of file healSparseMapping.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/g14a832a312+311607e4ab/python/lsst/pipe/tasks/healSparseMapping.py