lsst.sims.ocs.configuration.proposal.sub_sequence module

class lsst.sims.ocs.configuration.proposal.sub_sequence.SubSequence

Bases: lsst.sims.ocs.configuration.proposal.base_sequence.BaseSequence

Configuration for sub-sequences.

!Allocate a new Config object.

In order to ensure that all Config object are always in a proper state when handed to users or to derived Config classes, some attributes are handled at allocation time rather than at initialization

This ensures that even if a derived Config class implements __init__, the author does not need to be concerned about when or even if he should call the base Config.__init__

get_filter_string()

A string representation of the filter list parameter.

Returns:str

setDefaults()

Default specification for SubSequence information.

filters

The list of filters required for the sub-sequence.

name

The identifier for the sub-sequence.

num_events

The number of required events for the sub-sequence.

num_max_missed

The maximum number of events the sub-sequence is allowed to miss.

time_interval

Time (units=seconds) between subsequent visits for a field/filter combination. Must be non-zero if number of grouped visits is greater than one.

time_weight

Weighting factor for scaling the shape of the time window.

time_window_end

Relative time when the window ends for subsequent grouped visits.

time_window_max

Relative time when the window reaches maximum rank for subsequent grouped visits.

time_window_start

Relative time when the window opens for subsequent grouped visits.

visits_per_filter

The number of visits required for each filter in the sub-sequence.