lsst.pipe.tasks.functors.HtmIndex20 Class Reference

Inheritance diagram for lsst.pipe.tasks.functors.HtmIndex20:

Public Member Functions
def	__init__ (self, ra, decl, **kwargs)
def	noDup (self)
def	columns (self)
def	multilevelColumns (self, data, columnIndex=None, returnTuple=False)
def	__call__ (self, data, dropna=False)
def	difference (self, data1, data2, **kwargs)
def	fail (self, df)
def	name (self)
def	shortname (self)

Public Attributes
	pixelator
	ra
	decl
	filt
	dataset

Static Public Attributes
string	name = "Htm20"
int	htmLevel = 20

Detailed Description

Compute the level 20 HtmIndex for the catalog.

Notes
-----
This functor was implemented to satisfy requirements of old APDB interface
which required ``pixelId`` column in DiaObject with HTM20 index. APDB
interface had migrated to not need that information, but we keep this
class in case it may be useful for something else.

Definition at line 721 of file functors.py.

Constructor & Destructor Documentation

__init__()

def lsst.pipe.tasks.functors.HtmIndex20.__init__	(		self,
			ra,
			decl,
		**	kwargs
	)

Definition at line 735 of file functors.py.

    def __init__(self, ra, decl, **kwargs):
        self.pixelator = sphgeom.HtmPixelization(self.htmLevel)
        self.ra = ra
        self.decl = decl
        self._columns = [self.ra, self.decl]
        super().__init__(**kwargs)
 

Member Function Documentation

__call__()

def lsst.pipe.tasks.functors.Functor.__call__ (   self,   data,   dropna = False  )

inherited

Definition at line 340 of file functors.py.

    def __call__(self, data, dropna=False):
        try:
            df = self._get_data(data)
            vals = self._func(df)
        except Exception:
            vals = self.fail(df)
        if dropna:
            vals = self._dropna(vals)
 
        return vals
 

columns()

def lsst.pipe.tasks.functors.Functor.columns (   self )

inherited

Columns required to perform calculation

Reimplemented in lsst.pipe.tasks.functors.Ratio, lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr, lsst.pipe.tasks.functors.LocalDipoleDiffFlux, lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr, lsst.pipe.tasks.functors.LocalDipoleMeanFlux, lsst.pipe.tasks.functors.LocalMagnitudeErr, lsst.pipe.tasks.functors.LocalMagnitude, lsst.pipe.tasks.functors.LocalNanojanskyErr, lsst.pipe.tasks.functors.LocalNanojansky, lsst.pipe.tasks.functors.MagnitudeErr, lsst.pipe.tasks.functors.NanoJanskyErr, lsst.pipe.tasks.functors.Photometry, lsst.pipe.tasks.functors.ReferenceBand, lsst.pipe.tasks.functors.ConvertPixelSqToArcsecondsSq, lsst.pipe.tasks.functors.ConvertPixelToArcseconds, lsst.pipe.tasks.functors.ComputePixelScale, lsst.pipe.tasks.functors.RadiusFromQuadrupole, lsst.pipe.tasks.functors.E2, lsst.pipe.tasks.functors.E1, lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.MagDiff, lsst.pipe.tasks.functors.MagErr, lsst.pipe.tasks.functors.Mag, lsst.pipe.tasks.functors.Column, lsst.pipe.tasks.functors.CustomFunctor, and lsst.pipe.tasks.functors.CompositeFunctor.

Definition at line 155 of file functors.py.

    def columns(self):
        """Columns required to perform calculation
        """
        if not hasattr(self, '_columns'):
            raise NotImplementedError('Must define columns property or _columns attribute')
        return self._columns
 

difference()

def lsst.pipe.tasks.functors.Functor.difference (   self,   data1,   data2, **  kwargs  )

inherited

Computes difference between functor called on two different ParquetTable objects

Definition at line 351 of file functors.py.

    def difference(self, data1, data2, **kwargs):
        """Computes difference between functor called on two different ParquetTable objects
        """
        return self(data1, **kwargs) - self(data2, **kwargs)
 

fail()

def lsst.pipe.tasks.functors.Functor.fail (   self,   df  )

inherited

Definition at line 356 of file functors.py.

    def fail(self, df):
        return pd.Series(np.full(len(df), np.nan), index=df.index)
 

multilevelColumns()

def lsst.pipe.tasks.functors.Functor.multilevelColumns (   self,   data,   columnIndex = None,   returnTuple = False  )

inherited

Returns columns needed by functor from multilevel dataset

To access tables with multilevel column structure, the `MultilevelParquetTable`
or `DeferredDatasetHandle` need to be passed either a list of tuples or a
dictionary.

Parameters
----------
data : `MultilevelParquetTable` or `DeferredDatasetHandle`

columnIndex (optional): pandas `Index` object
    either passed or read in from `DeferredDatasetHandle`.

`returnTuple` : bool
    If true, then return a list of tuples rather than the column dictionary
    specification.  This is set to `True` by `CompositeFunctor` in order to be able to
    combine columns from the various component functors.

Definition at line 229 of file functors.py.

    def multilevelColumns(self, data, columnIndex=None, returnTuple=False):
        """Returns columns needed by functor from multilevel dataset
 
        To access tables with multilevel column structure, the `MultilevelParquetTable`
        or `DeferredDatasetHandle` need to be passed either a list of tuples or a
        dictionary.
 
        Parameters
        ----------
        data : `MultilevelParquetTable` or `DeferredDatasetHandle`
 
        columnIndex (optional): pandas `Index` object
            either passed or read in from `DeferredDatasetHandle`.
 
        `returnTuple` : bool
            If true, then return a list of tuples rather than the column dictionary
            specification.  This is set to `True` by `CompositeFunctor` in order to be able to
            combine columns from the various component functors.
 
        """
        if isinstance(data, DeferredDatasetHandle) and columnIndex is None:
            columnIndex = data.get(component="columns")
 
        # Confirm that the dataset has the column levels the functor is expecting it to have.
        columnLevels = self._get_data_columnLevels(data, columnIndex)
 
        columnDict = {'column': self.columns,
                      'dataset': self.dataset}
        if self.filt is None:
            columnLevelNames = self._get_data_columnLevelNames(data, columnIndex)
            if "band" in columnLevels:
                if self.dataset == "ref":
                    columnDict["band"] = columnLevelNames["band"][0]
                else:
                    raise ValueError(f"'filt' not set for functor {self.name}"
                                     f"(dataset {self.dataset}) "
                                     "and ParquetTable "
                                     "contains multiple filters in column index. "
                                     "Set 'filt' or set 'dataset' to 'ref'.")
        else:
            columnDict['band'] = self.filt
 
        if isinstance(data, MultilevelParquetTable):
            return data._colsFromDict(columnDict)
        elif isinstance(data, DeferredDatasetHandle):
            if returnTuple:
                return self._colsFromDict(columnDict, columnIndex=columnIndex)
            else:
                return columnDict
 

name()

def lsst.pipe.tasks.functors.Functor.name (   self )

inherited

Full name of functor (suitable for figure labels)

Reimplemented in lsst.pipe.tasks.functors.Ratio, lsst.pipe.tasks.functors.LocalDipoleDiffFluxErr, lsst.pipe.tasks.functors.LocalDipoleDiffFlux, lsst.pipe.tasks.functors.LocalDipoleMeanFluxErr, lsst.pipe.tasks.functors.LocalDipoleMeanFlux, lsst.pipe.tasks.functors.LocalMagnitudeErr, lsst.pipe.tasks.functors.LocalMagnitude, lsst.pipe.tasks.functors.LocalNanojanskyErr, lsst.pipe.tasks.functors.LocalNanojansky, lsst.pipe.tasks.functors.Photometry, lsst.pipe.tasks.functors.ConvertPixelSqToArcsecondsSq, lsst.pipe.tasks.functors.ConvertPixelToArcseconds, lsst.pipe.tasks.functors.Color, lsst.pipe.tasks.functors.MagDiff, lsst.pipe.tasks.functors.MagErr, lsst.pipe.tasks.functors.Mag, lsst.pipe.tasks.functors.Column, and lsst.pipe.tasks.functors.CustomFunctor.

Definition at line 360 of file functors.py.

    def name(self):
        """Full name of functor (suitable for figure labels)
        """
        return NotImplementedError
 

noDup()

def lsst.pipe.tasks.functors.Functor.noDup (   self )

inherited

Definition at line 148 of file functors.py.

    def noDup(self):
        if self._noDup is not None:
            return self._noDup
        else:
            return self._defaultNoDup
 

shortname()

def lsst.pipe.tasks.functors.Functor.shortname (   self )

inherited

Short name of functor (suitable for column name/dict key)

Reimplemented in lsst.pipe.tasks.functors.Color, and lsst.pipe.tasks.functors.MagDiff.

Definition at line 366 of file functors.py.

    def shortname(self):
        """Short name of functor (suitable for column name/dict key)
        """
        return self.name
 
 

Member Data Documentation

dataset

lsst.pipe.tasks.functors.Functor.dataset

inherited

Definition at line 144 of file functors.py.

decl

lsst.pipe.tasks.functors.HtmIndex20.decl

Definition at line 738 of file functors.py.

filt

lsst.pipe.tasks.functors.Functor.filt

inherited

Definition at line 143 of file functors.py.

htmLevel

int lsst.pipe.tasks.functors.HtmIndex20.htmLevel = 20

static

Definition at line 732 of file functors.py.

name

string lsst.pipe.tasks.functors.HtmIndex20.name = "Htm20"

static

Definition at line 731 of file functors.py.

pixelator

lsst.pipe.tasks.functors.HtmIndex20.pixelator

Definition at line 736 of file functors.py.

ra

lsst.pipe.tasks.functors.HtmIndex20.ra

Definition at line 737 of file functors.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/functors.py