scifysim.combiner module

class scifysim.combiner.combiner(expr, thesubs, mask_bright=None, mask_dark=None, mask_photometric=None, lamb=None)

Bases: object

__dict__ = mappingproxy({'__module__': 'scifysim.combiner', '__init__': <function combiner.__init__>, 'chromatic_matrix': <function combiner.chromatic_matrix>, 'pseudo_chromatic_matrix': <function combiner.pseudo_chromatic_matrix>, 'refresh_array': <function combiner.refresh_array>, 'angel_woolf': <classmethod object>, 'from_config': <classmethod object>, '__dict__': <attribute '__dict__' of 'combiner' objects>, '__weakref__': <attribute '__weakref__' of 'combiner' objects>, '__doc__': None, '__annotations__': {}})

__init__(expr, thesubs, mask_bright=None, mask_dark=None, mask_photometric=None, lamb=None)

__module__ = 'scifysim.combiner'

__weakref__

list of weak references to the object (if defined)

classmethod angel_woolf(file, ph_shifters=(0, pi / 2))

chromatic_matrix(wl)

Work in progress. This helps define the chromatic behaviour of the combiner even when it is define achromatic.

Parameters:

• wl : An array of wavelengths for which to compute the matrix

Result: Several matrices are stored in combiner

• self.Mcs : a symbolic formula for the combiner matrix (2D sympy array) as a function of the wavenumber k

• self.Mcl : The matrix as a lambda-function of (k, 0) The extra 0 parameter passed helps to cast the correct shape

• self.Mcn : The numpy ndarray of the matrix of interest shape is (n_wl, n_out, n_in)

classmethod from_config(file, ph_shifters=(0, 0))

A

Parameters:

• file : The config file

• ph_shiftersPhase shifters between first and second stage default: (0,0)

  These correspond to the “internal modulation”

Config keywords:

• configuration.combiner Name of the combiner architecture

• configuration.photometric_tap Fraction of light (power) sent to the photometric channels

• configuration.input_phase_offset Additional phase offset as part of the design of the combiner

Accepted combiners:

Managed by configuration.combiner

• angel_woolf_ph,

• VIKiNG

• GLINT

• GRAVITY

• bracewell_ph

• bracewell

pseudo_chromatic_matrix(wl)

Work in progress. This helps define the chromatic behaviour of the combiner even when it is define achromatic

refresh_array(thearray)

This method recomputes a disposable encapsulated function for the give pointing.

scifysim.combiner.test_angel_woolf()

scifysim.combiner.test_combiner(combiner, nwl=10)