Skip to content

Latest commit

 

History

History
124 lines (86 loc) · 7.02 KB

parameter_and_file_conventions.rst

File metadata and controls

124 lines (86 loc) · 7.02 KB

1. Telescope aperture

Design parameter input menu

With the exception of symmetry, all these parameter keys are nested under the 'Pupil' key category. See https://github.com/neilzim/SCDA/blob/master/scda_demo.ipynb for usage when initializing a design survey.

  • Symmetry (defined by coronagraph subclass): 'full', 'half', 'quart'
  • Primary mirror configuration (key 'pm'): 'hex1', 'hex2', 'hex3', 'hex4', 'key24', 'pie12', 'pie08'
  • Secondary mirror support strut configuration (key 'ss'): 'Y60d', 'Yoff60d', 'X', 'Cross', 'T', 'Y90d'
  • Secondary mirror support strut thickness, either 2.5 or 10 cm (key 'sst'): '025', '100'
  • Secondary mirror obscuration present? (key 'sm'): True, False

File name format

Format spec: 'TelAp_{0:s}_{1:s}{2:s}{3:s}sm{4:d}_N{5:04d}.dat'

  1. Symmetry string: one of 'full', 'half', 'quart'
  2. Primary mirror string: one of 'hex1', 'hex2', 'hex3', 'hex4', 'key24', 'pie12', 'pie08'
  3. Support strut config string: one of 'Y60d', 'Yoff60d', 'X', 'Cross', 'T', 'Y90d'
  4. Support strut thickness string: either '025' or '100'
  5. Secondary mirror obscuration flag: either 0 or 1
  6. Pupil array quadrant width: zero-padded 4-digit integer from 50 to 1000

Example: 'TelAp_half_pie12Y60d025sm1_N0500.dat'

2. Focal plane mask

Design parameter input menu

For now, only the occulting spot is supported. All these keys are nested under the 'FPM' category.

  • Spot radius (key 'rad'; float)
  • Mask array quadrant width (key 'M'; integer)

File name format

FPM files are agnostic to physical/optical design dimensions.

Format spec: 'FPM_{0:s}_occspot_M{1:03d}.dat'

  1. Symmetry string (from coronagraph subclass): one of 'full', 'half', 'quart'
  2. Mask array quadrant width; zero-padded 3-digit integer

Example: 'FPM_half_occspot_M050.dat'

3. Lyot stop

Design parameter input menu

The basic Lyot stop is a clear annulus. On top of this, the interface supports a wide range of options: a hexagonal outer edge, switching on and off both secondary obscurations and primary mirror gaps, as well as adjusting the padding level applied to each layer. These keys are nested under the 'LS' category.

  • Shape (key 'shape'; string; choice of 'ann' or 'hex'; default 'ann'). The default Lyot stop is an annular aperture. When the 'hex' option is set, the outer edge is a hexagon.
  • Inner diameter of the aperture, as a percentage of the re-imaged telescope pupil diameter (key 'id'; integer from 0 to 99; default 20)
  • Outer diameter of the aperture, as a percentage of the re-imaged telescope pupil diameter (key 'od'; integer from 0 to 99; default 90)
  • Obscuration switch (key 'obscure'; integer from 0 to 2; default 0). If 0, the stop is a clear annulus. If 1, the stop mimics the secondary obscuration (secondary mirror plus support struts) defined for the telescope. If 2, the stop mimics the complete re-imaged telescope pupil, including the secondary obscuration as well as the gaps and edges of the primary mirror.
  • Padding of secondary obscuration features, if present (key 'spad'; integer from 0 to 99; default 0). The padding parameter is specified as a percentage of telescope pupil diameter [1].
  • Padding of primary mirror features, if present (key 'ppad'; integer from 0 to 99; default 0). The padding parameter is specified as a percentage of telescope pupil diameter [1].
  • Alignment tolerance, in units of 1/1000th of re-imaged telescope pupil diameter (key 'altol'; integer from 0 to 99). Does not affect the Lyot stop file name, but modifies the AMPL optimization program. Not yet supported; for future implementation.

File name format

A. When telescope obscurations are omitted and the stop is a clear annulus ('obscure' = 0):

Format spec: 'LS_{0:s}_{1:s}{2:02d}D{3:02d}_clear_N{4:04d}.dat'

  1. Symmetry string: one of 'full', 'half', 'quart'
  2. Shape string: either 'ann' or 'hex'
  3. Inner diameter: zero-padded 2-digit integer from 0 to 99
  4. Outer diameter: zero-padded 2-digit integer from 0 to 99
  5. Pupil array quadrant width: zero-padded 4-digit integer from 50 to 1000

Example: 'LS_quart_ann20D85_clear_N0250.dat'

B. When secondary obscuration is mimicked by the stop ('obscure' = 1), the relevant design parameters from the telescope aperture and the padding value are included:

Format spec: 'LS_{0:s}_{1:s}{2:02d}D{3:02d}_{4:s}{5:s}sm{6:d}Pad{7:02d}_N{8:04d}.dat'

  1. Symmetry string: one of 'full', 'half', 'quart'
  2. Shape string: either 'ann' or 'hex'
  3. Inner diameter: zero-padded 2-digit integer from 0 to 99
  4. Outer diameter: zero-padded 2-digit integer from 0 to 99
  5. Support strut config string: one of 'Y60d', 'Yoff60d', 'X', 'Cross', 'T', 'Y90d'
  6. Support strut thickness string: either '025' or '100'
  7. Secondary mirror obscuration flag: either 0 or 1
  8. Secondary obscuration padding: zero-padded 2-digit integer from 0 to 99
  9. Pupil array quadrant width: zero-padded 4-digit integer from 50 to 1000

Examples: 'LS_quart_ann20D85_X100sm1Pad08_N0250.dat'

C. When primary mirror gaps and secondary obscuration are mimicked by the stop ('obscure' = 2), the relevant design parameters from the telescope aperture and the padding values are included:

Format spec: 'LS_{0:s}_{1:s}{2:02d}D{3:02d}_{4:s}Pad{5:02d}{6:s}{7:s}sm{8:d}Pad{9:02d}_N{10:04d}.dat'

  1. Symmetry string: one of 'full', 'half', 'quart'
  2. Shape string: either 'ann' or 'hex'
  3. Inner diameter: zero-padded 2-digit integer from 0 to 99
  4. Outer diameter: zero-padded 2-digit integer from 0 to 99
  5. Primary mirror string: one of 'hex1', 'hex2', 'hex3', 'hex4', 'key24', 'pie12', 'pie08'
  6. Primary mirror gap padding: zero-padded 2-digit integer from 0 to 99
  7. Support strut config string: one of 'Y60d', 'Yoff60d', 'X', 'Cross', 'T', 'Y90d'
  8. Support strut thickness string: either '025' or '100'
  9. Secondary mirror obscuration flag: either 0 or 1
  10. Secondary obscuration padding: zero-padded 2-digit integer from 0 to 99
  11. Pupil array quadrant width: zero-padded 4-digit integer from 50 to 1000

Example: 'LS_quart_ann20D85_hex2Pad05X100sm1Pad08_N0250.dat'

[1](1, 2) Padding is applied in an omindirectional sense by a shift-and-combine-and-mask routine, so it increases thickness on all sides of a given obscuration feature, and the thickness of all features in a given layer increases by the same number of pixels (in other words, this is not a scale factor). This parameter remains zero if pupil features are not mimicked by the Lyot stop, or if they are mimicked but not padded.