Skip to content

OpticalImagingRequest

OpticalImagingRequest Schema

Properties

Name Type Description
id Integer No description
allow_binning Boolean (Optional) Allow using non-default camera binning.
allow_subframe Boolean (Optional) Permit an instrument whose native FOV exceeds the configuration's max_fov_* to subframe (window) its readout down to that ceiling, trading field for readout time. Advisory: inert unless a max FOV is set, and the node may decline to subframe when it would not save time. Sibling of allow_binning. See docs/internal/design/observations/OPTICAL_IMAGING_SUBFRAME_DESIGN.md.
allow_fast_readout Boolean (Optional) Permit a fast-readout (higher read-noise) camera mode. Null/false restricts selection to low-noise modes, so the scheduler never trades read noise for speed unless the observer opts in — readout time can still be cut without added noise via allow_binning (fewer, larger pixels; also boosts SNR) and allow_subframe (smaller field). Sibling of allow_binning / allow_subframe; distinct from the optimize_for objective, which only ranks the modes already deemed acceptable. See docs/internal/design/observations/OPTICAL_READOUT_INTENT_DESIGN.md.
electronic_shutter Boolean (Optional) Require the camera to have electronic shutter (interline CCD or CMOS).
global_shutter Boolean (Optional) Require the camera to have global shutter sreadout (CMOS only).
min_bit_depth Integer (Optional) The minimum bit depth of the camera.
max_bit_depth Integer (Optional) The maximum bit depth of the camera.
optimize_for Enum(resolution, readout_speed) (Optional) Which outcome to optimize when selecting among the acceptable camera readout modes: resolution (finest effective pixel scale) or readout_speed (shortest readout_time_sec, for higher cadence / less dead time). An explicitly set value ranks ALL eligible modes — overriding an eligible default readout mode — bounded by allow_binning + the configuration's pixel-scale window and sampling floor; it never names a binning factor, so it stays telescope-agnostic. readout_speed also retargets subframing to the configuration's min_fov (the field the observer needs). Null = no stated objective: the camera's default readout mode is kept whenever eligible (default-preferring). See docs/internal/design/observations/OPTICAL_READOUT_INTENT_DESIGN.md.
rbi_flood Boolean (Optional) Prefer RBI flooding-enabled or RBI-less readout modes over those subject to RBI.
high_gain Boolean (Optional) Prefer high gain over low gain readout modes.
hdr Boolean (Optional) Prefer high dynamic range over low dynamic range readout modes.
exposure_time_sec Float (Optional) Fixed exposure-sizing mode: the total exposure time in seconds, used as-is on every instrument. One of three mutually-exclusive exposure-sizing modes (set exactly one of exposure_time_sec / target_snr / target_full_well_fraction). A fixed time may give inconsistent depth across instruments of different aperture / efficiency.
target_snr Float (Optional) SNR exposure-sizing mode: the target signal-to-noise ratio. When this is the selected mode, the total exposure time is computed per-instrument from the configuration's brightness model and this SNR. One of three mutually-exclusive exposure-sizing modes (set exactly one of exposure_time_sec / target_snr / target_full_well_fraction).
target_full_well_fraction Float (Optional) Well-depth exposure-sizing mode: the fraction of full-well capacity the target's brightness model should reach. When this is the selected mode, the total exposure time is computed per-instrument from the brightness model to reach that count level. One of three mutually-exclusive exposure-sizing modes (set exactly one of exposure_time_sec / target_snr / target_full_well_fraction). This is a sizing target, NOT a saturation guard — per-frame saturation is capped separately by the configuration's saturation_model + saturation_level_fraction.
allow_coadding Boolean Whether the result can consist of multiple exposures which are coadded to achieve the desired exposure time. If false, the observation will only be dispatched to telescopes with sufficient tracking performance if the expected target counts don't exceed the saturation limit.
allow_registration Boolean Reduce and align exposures before coadding.
uid UUID No description
status Enum(active, inactive, completed) Status of the request.
is_deleted Boolean Flag indicating if the request is deleted.
observation_id Integer No description
request_type Enum(optical_imaging, optical_imaging_bias_calibration, optical_imaging_dark_calibration, optical_imaging_flat_calibration, radio_tracking, radio_mapping) Type of the observation.
instrument_mode Enum(none, include, exclude) Access mode for the instruments. If none, all instruments from the observing accounts are available.
sample_count Integer Temporal samples of THIS request per epoch (was iterations). NOT depth — depth is target SNR / integration time on the imaging configuration, split into frames at dispatch by the instrument's max exposure.
current_sample Integer 1-based current sample derived from the most recent task update for this request.
order Integer No description
active Boolean No description
created_on DateTime No description
modified_on DateTime No description
current_task_id Integer (Optional) No description

Relationships

Relationship Name Type
filter_specifiers FilterSpecifier
tasks ObservationTask
current_task ObservationTask
instruments Instrument
observation Observation