Skip to content

Filter

FilterSpecifier Schema (Abstract Base)

Description: Base class for filter specifiers used by OpticalImagingRequest, which can be either a single Filter or a FilterGroup, which is a set of Filters.

Properties

Name Type Description
id String(50) No description
filter_specifier_type Enum(filter, filter_group) No description

Subclasses

Name filter_specifier_type
Filter filter
FilterGroup filter_group

Filter Schema

Properties

Name Type Description
id String(50) No description
is_modifier Boolean True if the filter is a modifier (e.g., polarizer, etc.).
central_wavelength Float (Optional) Central wavelength of the filter in nanometers.
bandpass Float (Optional) Bandpass of the filter in nanometers.
flat_exposure_scaler Float (Optional) Scale factor applied to the base twilight flat exposure time for this filter.
filter_specifier_type Enum(filter, filter_group) No description

Relationships

Relationship Name Type
filter_groups FilterGroup
filter_wheel_positions FilterWheelPosition

FilterGroup Schema

Properties

Name Type Description
id String(50) No description
order Integer Display order of the filter group.
description String(200) (Optional) Description of the filter group.
filter_specifier_type Enum(filter, filter_group) No description

Relationships

Relationship Name Type
filters Filter