lsst.pipe.tasks.diff_matched_tract_catalog.Percentile Class Reference

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

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

Public Attributes
	percentile

Static Public Attributes
float	percentile

Detailed Description

An arbitrary percentile.

Parameters
----------
percentile : `float`
    A valid percentile (0 <= p <= 100).

Definition at line 373 of file diff_matched_tract_catalog.py.

Member Function Documentation

__post_init__()

lsst.pipe.tasks.diff_matched_tract_catalog.Percentile.__post_init__

(

self

)

Definition at line 392 of file diff_matched_tract_catalog.py.

    def __post_init__(self):
        if not ((self.percentile >= 0) and (self.percentile <= 100)):
            raise ValueError(f'percentile={self.percentile} not >=0 and <= 100')
 
 

doc()

str lsst.pipe.tasks.diff_matched_tract_catalog.Percentile.doc

(

self

)

A description of the statistic

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

Definition at line 383 of file diff_matched_tract_catalog.py.

    def doc(self) -> str:
        return "Median absolute deviation multiplied by ~1.4826 (sigma-equivalent)"
 

name_short()

str lsst.pipe.tasks.diff_matched_tract_catalog.Percentile.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 386 of file diff_matched_tract_catalog.py.

    def name_short(self) -> str:
        return f"pctl{f'{self.percentile/100:.5f}'[2:]}"
 

value()

lsst.pipe.tasks.diff_matched_tract_catalog.Percentile.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 389 of file diff_matched_tract_catalog.py.

    def value(self, values):
        return np.percentile(values, self.percentile)
 

Member Data Documentation

percentile [1/2]

float lsst.pipe.tasks.diff_matched_tract_catalog.Percentile.percentile

static

Definition at line 381 of file diff_matched_tract_catalog.py.

percentile [2/2]

lsst.pipe.tasks.diff_matched_tract_catalog.Percentile.percentile

Definition at line 390 of file diff_matched_tract_catalog.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/gc07e1c2157+a98bf949bb/python/lsst/pipe/tasks/diff_matched_tract_catalog.py