Instrument Class

`azcam.server.tools.instrument.Instrument`

Bases: Tools, ObjectHeaderMethods

The base instrument tool. Usually implemented as the "instrument" tool.

`comps_delay(delay_time=0)`

Delays for delay_time for comparison lamp warmup. May internally set delay based on comp selection. Args: delay_time: delay in seconds

`comps_off()`

Turn off active comparisons.

`comps_on()`

Turn on active comparisons.

`exposure_finish()`

Optional tempcon.call after exposure finishes.

`exposure_start()`

Optional call before exposure starts.

`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, current_id=0)`

Read instrument current, usually from an electrometer. Args: current_id: current source ID shutter_state: shutter state during read Returns: current: measured current in amps

`get_currents()`

Return a list of all instrument currents.

`get_filter(filter_id=0)`

Return the current/loaded filter, typically the filter in the beam. Args: filter_id: filter mechanism ID

`get_filters(filter_id=0)`

Return a list of all available/loaded filters. Args: filter_id: filter mechanism ID

`get_focus(focus_id=0)`

Return the current instrument focus position. focus_id is the focus mechanism ID.

`get_power(wavelength, power_id=0)`

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

`get_pressure(pressure_id=0)`

Read an instrument pressure.

`get_pressures()`

Return a list of all instrument pressures.

`get_wavelength(wavelength_id=0)`

Returns the current wavelength. Args: wavelength_id: wavelength mechanism ID

`get_wavelengths(wavelength_id=0)`

Returns a list of valid wavelengths. Used for filter and LED based systems. Args: wavelength_id: wavelength mechanism ID

`set_comps(comp_names=None)`

Set comparisons to be turned on and off with comps_on() and comps_off(). Args: comp_names: list of string (or a single string) of comparison names

`set_filter(filter_name, filter_id=0)`

Set the current/loaded filter, typically the filter in the beam. Args: filter_name: filter name to set. Could be a number or filter name. filter_id: filter mechanism ID

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

Move (or step) the instrument focus. focus_position is the focus position or step size. focus_id is the focus mechanism ID. focus_type is "absolute" or "step".

`set_pressure(pressure, pressure_id=0)`

Sets an instrument pressure.

`set_shutter(state, shutter_id=0)`

Open or close the instrument shutter. state is 1 for open and 0 for close. shutter_id is the shutter mechanism ID.

`set_wavelength(wavelength, wavelength_id=0)`

Set the current wavelength, typically for a filter or grating. Args: wavelength: wavelength value to set. Could be a number or filter name. wavelength_id: wavelength mechanism ID