Filters

Contents

Filters#

class cabaret.Filters(*values)[source]#

Allowed Gaia and 2MASS flux filter_band strings.

Examples

>>> from cabaret.queries import Filters
>>> Filters.G
<Filters.G: 'phot_g_mean_mag'>
>>> Filters.from_string('RP')
<Filters.RP: 'phot_rp_mean_mag'>
>>> Filters.is_tmass('J')
True
>>> Filters.options()
('G', 'BP', 'RP', 'J', 'H', 'KS')

Methods

options()

Return all valid filter_band options.

from_string(value)

Return the Filters enum member for a given string.

is_tmass(value)

Check if the filter_band string is a 2MASS filter_band.

ensure_enum(value)

Convert a string or Filters to Filters enum.

all()

Return all filter bands in definition order.

is_valid(value)

Check if the filter_band string is valid.

Attributes

G

Gaia G band magnitude [Gaia Vega system]

BP

Gaia BP band magnitude [Gaia Vega system]

RP

Gaia RP band magnitude [Gaia Vega system]

J

2MASS J-band magnitude [2MASS Vega system]

H

2MASS H-band magnitude [2MASS Vega system]

KS

2MASS KS-band magnitude [2MASS Vega system]
Contents