Module: filters#

class kbmod.filters.Filter(*args, **kwargs)[source]#

The base class for derived filters on the ResultList.

Methods

get_filter_name

keep_row

class kbmod.filters.LHFilter(min_lh, max_lh, *args, **kwargs)[source]#

A filter for result’s likelihood.

Methods

get_filter_name()

Get the name of the filter.

keep_row(row)

Determine whether to keep an individual row based on the likelihood.

get_filter_name()[source]#

Get the name of the filter.

Returns:
str

The filter name.

keep_row(row: ResultRow)[source]#

Determine whether to keep an individual row based on the likelihood.

Parameters:
rowResultRow

The row to evaluate.

Returns:
bool

An indicator of whether to keep the row.

class kbmod.filters.NumObsFilter(min_obs, *args, **kwargs)[source]#

A filter for result’s number of valid observations.

Methods

get_filter_name()

Get the name of the filter.

keep_row(row)

Determine whether to keep an individual row based on the number of valid observations.

get_filter_name()[source]#

Get the name of the filter.

Returns:
str

The filter name.

keep_row(row: ResultRow)[source]#

Determine whether to keep an individual row based on the number of valid observations.

Parameters:
rowResultRow

The row to evaluate.

Returns:
bool

An indicator of whether to keep the row.