lsst.pipe.tasks.diff_matched_tract_catalog.Statistic Class Reference

Inheritance diagram for lsst.pipe.tasks.diff_matched_tract_catalog.Statistic:

Public Member Functions
str	doc (self)
str	name_short (self)
	value (self, values)

Detailed Description

A statistic that can be applied to a set of values.

Definition at line 300 of file diff_matched_tract_catalog.py.

Member Function Documentation

doc()

str lsst.pipe.tasks.diff_matched_tract_catalog.Statistic.doc

(

self

)

A description of the statistic

Reimplemented in lsst.pipe.tasks.diff_matched_tract_catalog.Median, lsst.pipe.tasks.diff_matched_tract_catalog.SigmaIQR, lsst.pipe.tasks.diff_matched_tract_catalog.SigmaMAD, and lsst.pipe.tasks.diff_matched_tract_catalog.Percentile.

Definition at line 304 of file diff_matched_tract_catalog.py.

    def doc(self) -> str:
        """A description of the statistic"""
        raise NotImplementedError('Subclasses must implement this method')
 

name_short()

str lsst.pipe.tasks.diff_matched_tract_catalog.Statistic.name_short

(

self

)

A short name for the statistic, e.g. for a table column name

Reimplemented in lsst.pipe.tasks.diff_matched_tract_catalog.Median, lsst.pipe.tasks.diff_matched_tract_catalog.SigmaIQR, lsst.pipe.tasks.diff_matched_tract_catalog.SigmaMAD, and lsst.pipe.tasks.diff_matched_tract_catalog.Percentile.

Definition at line 309 of file diff_matched_tract_catalog.py.

    def name_short(self) -> str:
        """A short name for the statistic, e.g. for a table column name"""
        raise NotImplementedError('Subclasses must implement this method')
 

value()

lsst.pipe.tasks.diff_matched_tract_catalog.Statistic.value	(		self,
			values )

The value of the statistic for a set of input values.

Parameters
----------
values : `Collection` [`float`]
    A set of values to compute the statistic for.

Returns
-------
statistic : `float`
    The value of the statistic.

Reimplemented in lsst.pipe.tasks.diff_matched_tract_catalog.Median, lsst.pipe.tasks.diff_matched_tract_catalog.SigmaIQR, lsst.pipe.tasks.diff_matched_tract_catalog.SigmaMAD, and lsst.pipe.tasks.diff_matched_tract_catalog.Percentile.

Definition at line 314 of file diff_matched_tract_catalog.py.

    def value(self, values):
        """The value of the statistic for a set of input values.
 
        Parameters
        ----------
        values : `Collection` [`float`]
            A set of values to compute the statistic for.
 
        Returns
        -------
        statistic : `float`
            The value of the statistic.
        """
        raise NotImplementedError('Subclasses must implement this method')
 
 

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gc07e1c2157+a98bf949bb/python/lsst/pipe/tasks/diff_matched_tract_catalog.py