producer.design.fobosfocalplane module

Hard-coded method to construct the FOBOS focal plane design files.

producer.design.fobosfocalplane._special_module_mode_config1(active_bits, sky_bits, module_id)[source]
producer.design.fobosfocalplane._special_module_mode_config2(active_bits, sky_bits, module_id)[source]
producer.design.fobosfocalplane.baseline_module_type()[source]

Define the type of each module.

Module types are:
  1. single starbugs only

  2. mini-IFU module

  3. location of Big IFU

  4. imaging bundle module

  5. flux-calibration module

producer.design.fobosfocalplane.fobos_module_layout(module_file, starbug_file, version='0.1')[source]
producer.design.fobosfocalplane.module_mode(mod_type)[source]

Provide the default mode and designated sky bits of the starbugs in each module type.

There are 5 module types:

  1. single starbugs only

  2. mini-IFU module

  3. monolithic IFU

  4. imaging bundle module

  5. flux-calibration module

The active starbugs depend on the spectrograph mode. The modes are tracked using a bit value, where bits can be either:

  1. Single fiber mode.

  2. multi-IFU mode.

  3. Monolithic IFU mode.

So, e.g., a starbug with a mode value of 7 is deployed for all 3 modes. Starbug ID (or array index + 1) per module is expected to be.

03
02 07
01 06 12
05 11
04 10 16
09 15
08 14 19
13 18
17

Only IFU modules have designated sky apertures, which are starbug IDs 3, 4, 16, and 17.

Parameters

mod_type (int) – The module type. Must be 0, 1, 2, 3, or 4, as listed above.

Returns

Two integer numpy.ndarray objects providing (1) bits used to determine if the starbug is active during the spectrograph mode and (2) bits used to determine if the starbug houses a designated sky fiber during the spectrograph mode.

Return type

tuple

producer.design.fobosfocalplane.module_spectrograph()[source]

Define two possible module-to-spectrograph allocations.

The first distributes the modules (roughly) evenly between the 3 spectrographs across the full field of view. The second divides the focal plane into three regions, one per spectrograph.

The returned index gives the spectrograph number.

producer.design.fobosfocalplane.special_module_mode(active_bits, sky_bits, module_id, spec_map)[source]

Apply adjustments to active and sky bits for some modules:

  • Spectrograph 1 always deploys a single IFU for quick ToO follow-up. This means that module 44 always deploys an IFU and 4 sky fibers, and the other starbugs never do anything…

  • When using the monolithic IFU, the 12 starbugs in the outer hexagonal ring are activated for 2 modules in each spectrograph for sky-only observations. The modules are 38, 49, 58, 59, 70, and 80 in spectrograph-to-module-mapping design 1, and 14, 15, 54, 65, 70, 80 for design 2.