Instrument Class

`azcam.console.tools.instrument.InstrumentConsole`

Bases: ConsoleTools

Instrument tool for consoles. Usually implemented as the "instrument" tool.

`comps_off()`

Turn off active comparisons.

`comps_on()`

Turn on active comparisons.

`get_all_comps()`

Return all valid comparison names. Useful for clients to determine which type of comparison exposures are supported.

`get_comps()`

Return a list of the active comparison lamps.

`get_current(shutter_state=1, diode_id=0)`

Returns measured instrument diode current. Args: shutter_state: open (1), close (0), unchanged (2) shutter during diode read diode_id: diode ID flag (system dependent) Returns: current: measured curent in amps

`get_currents()`

Return a list of all instrument currents.

`get_filter(filter_id=0)`

Get instrument filter position.

:param filter_id: filter ID flag (use negative value for a list of all filters)

`get_filters(filter_id=0)`

Return a list of all available/loaded filters.

`get_focus(focus_id=0)`

Get the current focus position.

:param focus_id: focus sensor ID flag

`get_power(wavelength, power_id=0)`

Returns power meter reading. Args: wavelength: wavelength for power meter power_id: power ID flag Returns: mean_power: measured mean power in Watts/cm2

`get_pressures()`

Return a list of all instrument pressures.

`get_wavelength(wavelength_id=0)`

Get instrument wavelength.

:param wavelength_id: wavelength ID flag (use negative value for a list of all wavelengths)

`set_comps(comp_names=None)`

Set comparisons which are to be turned on and off with comps_on() and comps_off(). comp_names is a single string or a list of strings to be set as active.

`set_filter(filter_name, filter_id=0)`

Set instrument filter position.

:param filter_name: filter value to set :param filter_id: filter ID flag

`set_focus(focus_value, focus_id=0, focus_type='absolute')`

Set instrument focus position. The focus value may be an absolute position or a relative step if supported by hardware.

:param focus_value: focus position :param focus_id: focus sensor ID flag :param focus_type: focus type (absolute or step)

`set_shutter(state=0, shutter_id=0)`

Open or close a shutter. Args: state: shutter state, 0 for close and 1 for open shutter_id: Shutter ID flag

`set_wavelength(wavelength, wavelength_id=0, nd=-1)`

Set wavelength, optionally changing neutral density.

:param wavelength: wavelength value, may be a string such as 'clear' or 'dark' :param wavelength_id: wavelength ID flag :param nd: neutral density value to set