lsst.pipe.tasks.diff_matched_tract_catalog.SigmaIQR Class Reference

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

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

Detailed Description

The re-scaled interquartile range (sigma equivalent).

Definition at line 344 of file diff_matched_tract_catalog.py.

Member Function Documentation

doc()

str lsst.pipe.tasks.diff_matched_tract_catalog.SigmaIQR.doc

(

self

)

A description of the statistic

Reimplemented from lsst.pipe.tasks.diff_matched_tract_catalog.Statistic.

Definition at line 347 of file diff_matched_tract_catalog.py.

    def doc(cls) -> str:
        return "Interquartile range divided by ~1.349 (sigma-equivalent)"
 

name_short()

str lsst.pipe.tasks.diff_matched_tract_catalog.SigmaIQR.name_short

(

self

)

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

Reimplemented from lsst.pipe.tasks.diff_matched_tract_catalog.Statistic.

Definition at line 351 of file diff_matched_tract_catalog.py.

    def name_short(cls) -> str:
        return "sig_iqr"
 

value()

lsst.pipe.tasks.diff_matched_tract_catalog.SigmaIQR.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 from lsst.pipe.tasks.diff_matched_tract_catalog.Statistic.

Definition at line 354 of file diff_matched_tract_catalog.py.

    def value(self, values):
        return iqr(values, scale='normal')
 
 

---

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/diff_matched_tract_catalog.py