Package gda.device.currentamplifier

Class EpicsStanfordAmplifer

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.currentamplifier.CurrentAmplifierBase

gda.device.currentamplifier.EpicsStanfordAmplifer

All Implemented Interfaces:

AmplifierAutoGain, CurrentAmplifier, StanfordAmplifier, Device, Scannable, Configurable, Findable, gda.observable.IObservable, org.springframework.beans.factory.InitializingBean

public class EpicsStanfordAmplifer
extends CurrentAmplifierBase
implements AmplifierAutoGain, StanfordAmplifier, org.springframework.beans.factory.InitializingBean

this class is for controlling s Stanford current amplifier via EPICS.

The Stanford amplifies the input current usually in pA, nA, uA, or mA and outputs a voltage as determined by the sensitivity setting. i.e a 1x10^-6 A current with a 10^6 gain will output 1 V

The output of Stanford usually feeds into ADC which offers the ability to average the voltage over time to improve the signal to noise ratio.

The EPICS EDM for these devices are:
The Standford

Nested Class Summary

Nested classes/interfaces inherited from interface gda.device.CurrentAmplifier

CurrentAmplifier.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	currentOffsetUnits

Fields inherited from class gda.device.currentamplifier.CurrentAmplifierBase

gainPositions, gainUnits, modePositions

Fields inherited from class gda.device.scannable.ScannableBase

__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormat

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
EpicsStanfordAmplifer()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	check all essential bean properties have been set.
void	asynchronousMoveTo(Object position)	Trigger a move/operation and return immediately.
void	clear()	clear input filter overload
void	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
String[]	getAllowedPositions()
String	getBasePVName()
double	getBiasVoltage()	get Bias voltage
String	getCouplingMode()
double	getCurrent()	returns the current value
int	getFilterHighpassFrequency()	get filter high pass frequency 0 = 0.03 Hz 1 = 0.1 Hz 2 = 0.3 Hz 3 = 1 Hz 4 = 3 Hz 5 = 10 Hz 6 = 30 Hz 7 = 100 Hz 8 = 300 Hz 9 = 1 kHz 10 = 3 kHz 11 = 10 KHz
int	getFilterLowpassFrequency()	return the index of filter low pass frequency 0 = 0.03 Hz 1 = 0.1 Hz 2 = 0.3 Hz 3 = 1 Hz 4 = 3 Hz 5 = 10 Hz 6 = 30 Hz 7 = 100 Hz 8 = 300 Hz 9 = 1 kHz 10 = 3 kHz 11 = 10 KHz 12 = 30 kHz 13 = 100 kHz 14 = 300 kHz 15 = 1 MHz
int	getFilterType()	get the filter type value 0 = 6dB High Pass 1 = 12dB High Pass 2 = 6dB Band Pass 3 = 6dB Low Pass 4 = 12dB Low Pass 5 = None
String	getGain()	returns the current gain position
String	getGainFromEpics()
String	getGainUnit()	returns the current gain unit
String[]	getGainUnits()	Returns an array of all possible gain units which this device can be moved to.
String	getInstantaneousPV()
double	getInstantaneousVoltage()
double	getLowerVoltageBound()
String	getMode()	gets the amplifier's mode of operation
int	getOffset()
int	getOffsetUnit()
String[]	getOffsetUnits()
Object	getPosition()	Returns the current position of the Scannable.
int	getSensitivity()
int	getSensitivityUnit()
long	getSettleTime()
int	getSignalInvert()	return the index of the signal invert, 0 = Non-Inverted, 1 = Inverted
CurrentAmplifier.Status	getStatus()	Returns the overload status
double	getUpperVoltageBound()
boolean	hasMultipleModes()
boolean	increaseOrDecreaseGain(int i)
boolean	isAllowUnitsChange()
boolean	isBiasVoltageOn()	check if bias voltage switched on or not
boolean	isBusy()	Check if the Scannable is moving/operating.
boolean	isOffsetCurrentOn()
boolean	isSupportsCoupling()
void	listGains()	returns a parsed list of gains available for this amplifier.
void	restore()	restore default settings
void	setAllowUnitsChange(boolean allowUnitsChange)
void	setBasePVName(String basePVName)
void	setBiasVoltage(double bias)	set bias voltage
void	setBiasVoltageOn(boolean switchOn)	switch bias voltage on (true) or off (false)
void	setFilterHighpassFrequency(int index)	set the filter high pass frequency using index position 0 = 0.03 Hz 1 = 0.1 Hz 2 = 0.3 Hz 3 = 1 Hz 4 = 3 Hz 5 = 10 Hz 6 = 30 Hz 7 = 100 Hz 8 = 300 Hz 9 = 1 kHz 10 = 3 kHz 11 = 10 KHz
void	setFilterLowpassFrequency(int index)	set the filter low pass frequency using index position 0 = 0.03 Hz 1 = 0.1 Hz 2 = 0.3 Hz 3 = 1 Hz 4 = 3 Hz 5 = 10 Hz 6 = 30 Hz 7 = 100 Hz 8 = 300 Hz 9 = 1 kHz 10 = 3 kHz 11 = 10 KHz 12 = 30 kHz 13 = 100 kHz 14 = 300 kHz 15 = 1 MHz
void	setFilterType(int index)	set filter type using index position 0 = 6dB High Pass 1 = 12dB High Pass 2 = 6dB Band Pass 3 = 6dB Low Pass 4 = 12dB Low Pass 5 = None
void	setGain(String gain)	Moves amplifier's gain to the named position.
void	setGainUnit(String unit)	Moves amplifier's gain unit to the named unit.
void	setInstantaneousPV(String instantaneousPV)
void	setLowerVoltageBound(double lowerVoltageBound)
void	setMode(String mode)	sets the amplifier's mode of operation
void	setOffset(int offset)
void	setOffsetCurrentOn(boolean switchOn)
void	setOffsetUnit(int unit)
void	setSensitivity(int sensitivity)
void	setSensitivityUnit(int unit)
void	setSettleTime(long settleTime)
void	setSignalInvert(int index)	set the signal invert using index, 0 = Non-Inverted, 1 = Inverted
void	setUpperVoltageBound(double upperVoltageBound)

Methods inherited from class gda.device.currentamplifier.CurrentAmplifierBase

checkPositionValid, getGainPositions, getModePositions

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toFormattedString, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gda.device.AmplifierAutoGain

decreaseGain, increaseGain, optimiseGain

Methods inherited from interface gda.factory.Configurable

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.CurrentAmplifier

getGainPositions, getModePositions

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.Scannable

atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString, waitWhileBusy

Field Details

currentOffsetUnits

protected List<String> currentOffsetUnits

Constructor Details

EpicsStanfordAmplifer

public EpicsStanfordAmplifer()

Method Details

afterPropertiesSet

public void afterPropertiesSet()

check all essential bean properties have been set. This must be used to specify a custom init-method in an XML bean definition.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class ConfigurableBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

asynchronousMoveTo

public void asynchronousMoveTo(Object position)
                        throws DeviceException

Description copied from class: ScannableBase

Trigger a move/operation and return immediately. Implementations of this method should be non-blocking to allow concurrent motion; the isBusy method will be used to determine when the move has completed. Converts the external (user) position to an internal position and passes this to rawAsynchronousMoveTo.

Specified by:

asynchronousMoveTo in interface Scannable

Overrides:

asynchronousMoveTo in class CurrentAmplifierBase

Parameters:

position - Position to move to should have an element for each input field.

Throws:

DeviceException

getPosition

public Object getPosition()
                   throws DeviceException

Description copied from class: ScannableBase

Returns the current position of the Scannable. Called by ConcurentScan at the end of the point. Reads an internal (hardware) position from rawGetPosition, converts this to an external (user) position and returns it.

Specified by:

getPosition in interface Scannable

Overrides:

getPosition in class CurrentAmplifierBase

Returns:

Current position with an element for each input and extra field. null if their are no fields.

Throws:

DeviceException

isBusy

public boolean isBusy()

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Specified by:

isBusy in interface Scannable

Overrides:

isBusy in class CurrentAmplifierBase

Returns:

true - if operation carried out by moveTo has not completed yet

increaseOrDecreaseGain

public boolean increaseOrDecreaseGain(int i)
                               throws DeviceException

Specified by:

increaseOrDecreaseGain in interface AmplifierAutoGain

Throws:

DeviceException

setGain

public void setGain(String gain)
             throws DeviceException

Description copied from interface: CurrentAmplifier

Moves amplifier's gain to the named position.

Specified by:

setGain in interface CurrentAmplifier

Parameters:

gain -

Throws:

DeviceException

getGain

public String getGain()
               throws DeviceException

Description copied from interface: CurrentAmplifier

returns the current gain position

Specified by:

getGain in interface CurrentAmplifier

Returns:

gain position

Throws:

DeviceException

getGainFromEpics

public String getGainFromEpics()
                        throws DeviceException

Throws:

DeviceException

setGainUnit

public void setGainUnit(String unit)
                 throws DeviceException

Description copied from interface: CurrentAmplifier

Moves amplifier's gain unit to the named unit.

Specified by:

setGainUnit in interface CurrentAmplifier

Parameters:

unit -

Throws:

DeviceException

getGainUnit

public String getGainUnit()
                   throws DeviceException

Description copied from interface: CurrentAmplifier

returns the current gain unit

Specified by:

getGainUnit in interface CurrentAmplifier

Returns:

gain unit

Throws:

DeviceException

getCurrent

public double getCurrent()
                  throws DeviceException

Description copied from interface: CurrentAmplifier

returns the current value

Specified by:

getCurrent in interface CurrentAmplifier

Returns:

current

Throws:

DeviceException

setMode

public void setMode(String mode)
             throws DeviceException

Description copied from interface: CurrentAmplifier

sets the amplifier's mode of operation

Specified by:

setMode in interface CurrentAmplifier

Parameters:

mode -

Throws:

DeviceException

getMode

public String getMode()
               throws DeviceException

Description copied from interface: CurrentAmplifier

gets the amplifier's mode of operation

Specified by:

getMode in interface CurrentAmplifier

Returns:

mode

Throws:

DeviceException

getStatus

public CurrentAmplifier.Status getStatus()
                                  throws DeviceException

Description copied from interface: CurrentAmplifier

Returns the overload status

Specified by:

getStatus in interface CurrentAmplifier

Returns:

the status

Throws:

DeviceException

listGains

public void listGains()
               throws DeviceException

Description copied from interface: CurrentAmplifier

returns a parsed list of gains available for this amplifier.

Specified by:

listGains in interface CurrentAmplifier

Throws:

DeviceException

getCouplingMode

public String getCouplingMode()
                       throws DeviceException

Specified by:

getCouplingMode in interface AmplifierAutoGain

Throws:

DeviceException

isSupportsCoupling

public boolean isSupportsCoupling()

Specified by:

isSupportsCoupling in interface AmplifierAutoGain

hasMultipleModes

public boolean hasMultipleModes()

Specified by:

hasMultipleModes in interface AmplifierAutoGain

getInstantaneousVoltage

public double getInstantaneousVoltage()
                               throws DeviceException

Specified by:

getInstantaneousVoltage in interface AmplifierAutoGain

Throws:

DeviceException

getSensitivity

public int getSensitivity()
                   throws DeviceException

Specified by:

getSensitivity in interface StanfordAmplifier

Throws:

DeviceException

getSensitivityUnit

public int getSensitivityUnit()
                       throws DeviceException

Specified by:

getSensitivityUnit in interface StanfordAmplifier

Throws:

DeviceException

isOffsetCurrentOn

public boolean isOffsetCurrentOn()
                          throws DeviceException

Specified by:

isOffsetCurrentOn in interface StanfordAmplifier

Throws:

DeviceException

setOffsetCurrentOn

public void setOffsetCurrentOn(boolean switchOn)
                        throws DeviceException

Specified by:

setOffsetCurrentOn in interface StanfordAmplifier

Throws:

DeviceException

getOffset

public int getOffset()
              throws DeviceException

Specified by:

getOffset in interface StanfordAmplifier

Throws:

DeviceException

getOffsetUnit

public int getOffsetUnit()
                  throws DeviceException

Specified by:

getOffsetUnit in interface StanfordAmplifier

Throws:

DeviceException

setSensitivity

public void setSensitivity(int sensitivity)
                    throws DeviceException

Specified by:

setSensitivity in interface StanfordAmplifier

Throws:

DeviceException

setSensitivityUnit

public void setSensitivityUnit(int unit)
                        throws DeviceException

Specified by:

setSensitivityUnit in interface StanfordAmplifier

Throws:

DeviceException

setOffset

public void setOffset(int offset)
               throws DeviceException

Specified by:

setOffset in interface StanfordAmplifier

Throws:

DeviceException

setOffsetUnit

public void setOffsetUnit(int unit)
                   throws DeviceException

Specified by:

setOffsetUnit in interface StanfordAmplifier

Throws:

DeviceException

isBiasVoltageOn

public boolean isBiasVoltageOn()
                        throws DeviceException

check if bias voltage switched on or not

Returns:

true when on, false when off

Throws:

DeviceException

setBiasVoltageOn

public void setBiasVoltageOn(boolean switchOn)
                      throws DeviceException

switch bias voltage on (true) or off (false)

Throws:

DeviceException

setBiasVoltage

public void setBiasVoltage(double bias)
                    throws DeviceException

set bias voltage

Parameters:

bias -

Throws:

DeviceException

getBiasVoltage

public double getBiasVoltage()
                      throws DeviceException

get Bias voltage

Returns:

the bias voltage

Throws:

DeviceException

setFilterType

public void setFilterType(int index)
                   throws DeviceException

set filter type using index position 0 = 6dB High Pass 1 = 12dB High Pass 2 = 6dB Band Pass 3 = 6dB Low Pass 4 = 12dB Low Pass 5 = None

Parameters:

index -

Throws:

DeviceException

getFilterType

public int getFilterType()
                  throws DeviceException

get the filter type value 0 = 6dB High Pass 1 = 12dB High Pass 2 = 6dB Band Pass 3 = 6dB Low Pass 4 = 12dB Low Pass 5 = None

Returns:

filter type index

Throws:

DeviceException

setFilterHighpassFrequency

public void setFilterHighpassFrequency(int index)
                                throws DeviceException

set the filter high pass frequency using index position 0 = 0.03 Hz 1 = 0.1 Hz 2 = 0.3 Hz 3 = 1 Hz 4 = 3 Hz 5 = 10 Hz 6 = 30 Hz 7 = 100 Hz 8 = 300 Hz 9 = 1 kHz 10 = 3 kHz 11 = 10 KHz

Parameters:

index -

Throws:

DeviceException

getFilterHighpassFrequency

public int getFilterHighpassFrequency()
                               throws DeviceException

get filter high pass frequency 0 = 0.03 Hz 1 = 0.1 Hz 2 = 0.3 Hz 3 = 1 Hz 4 = 3 Hz 5 = 10 Hz 6 = 30 Hz 7 = 100 Hz 8 = 300 Hz 9 = 1 kHz 10 = 3 kHz 11 = 10 KHz

Returns:

the index position of the filter high pass frequency

Throws:

DeviceException

setFilterLowpassFrequency

public void setFilterLowpassFrequency(int index)
                               throws DeviceException

set the filter low pass frequency using index position 0 = 0.03 Hz 1 = 0.1 Hz 2 = 0.3 Hz 3 = 1 Hz 4 = 3 Hz 5 = 10 Hz 6 = 30 Hz 7 = 100 Hz 8 = 300 Hz 9 = 1 kHz 10 = 3 kHz 11 = 10 KHz 12 = 30 kHz 13 = 100 kHz 14 = 300 kHz 15 = 1 MHz

Parameters:

index -

Throws:

DeviceException

getFilterLowpassFrequency

public int getFilterLowpassFrequency()
                              throws DeviceException

return the index of filter low pass frequency 0 = 0.03 Hz 1 = 0.1 Hz 2 = 0.3 Hz 3 = 1 Hz 4 = 3 Hz 5 = 10 Hz 6 = 30 Hz 7 = 100 Hz 8 = 300 Hz 9 = 1 kHz 10 = 3 kHz 11 = 10 KHz 12 = 30 kHz 13 = 100 kHz 14 = 300 kHz 15 = 1 MHz

Returns:

the index position

Throws:

DeviceException

setSignalInvert

public void setSignalInvert(int index)
                     throws DeviceException

set the signal invert using index, 0 = Non-Inverted, 1 = Inverted

Parameters:

index -

Throws:

DeviceException

getSignalInvert

public int getSignalInvert()
                    throws DeviceException

return the index of the signal invert, 0 = Non-Inverted, 1 = Inverted

Returns:

the index of signal invert

Throws:

DeviceException

restore

public void restore()
             throws DeviceException

restore default settings

Throws:

DeviceException

clear

public void clear()
           throws DeviceException

clear input filter overload

Throws:

DeviceException

getOffsetUnits

public String[] getOffsetUnits()

Specified by:

getOffsetUnits in interface StanfordAmplifier

getAllowedPositions

public String[] getAllowedPositions()

Specified by:

getAllowedPositions in interface StanfordAmplifier

getGainUnits

public String[] getGainUnits()

Description copied from interface: CurrentAmplifier

Returns an array of all possible gain units which this device can be moved to.

Specified by:

getGainUnits in interface CurrentAmplifier

Specified by:

getGainUnits in interface StanfordAmplifier

Overrides:

getGainUnits in class CurrentAmplifierBase

Returns:

an array of gain units

getBasePVName

public String getBasePVName()

setBasePVName

public void setBasePVName(String basePVName)

getSettleTime

public long getSettleTime()

setSettleTime

public void setSettleTime(long settleTime)

getInstantaneousPV

public String getInstantaneousPV()

setInstantaneousPV

public void setInstantaneousPV(String instantaneousPV)

getLowerVoltageBound

public double getLowerVoltageBound()

Specified by:

getLowerVoltageBound in interface AmplifierAutoGain

setLowerVoltageBound

public void setLowerVoltageBound(double lowerVoltageBound)

getUpperVoltageBound

public double getUpperVoltageBound()

Specified by:

getUpperVoltageBound in interface AmplifierAutoGain

setUpperVoltageBound

public void setUpperVoltageBound(double upperVoltageBound)

isAllowUnitsChange

public boolean isAllowUnitsChange()

setAllowUnitsChange

public void setAllowUnitsChange(boolean allowUnitsChange)