xal.smf.impl

Class WireScanner.ScanConfig

java.lang.Object

xal.smf.scada.ScadaRecord

xal.smf.impl.profile.ParameterSet

xal.smf.impl.WireScanner.ScanConfig

All Implemented Interfaces:

java.lang.Cloneable, ProfileDevice.IProfileDomain, DataListener

Enclosing class:

WireScanner

public static class WireScanner.ScanConfig
extends ParameterSet
implements ProfileDevice.IProfileDomain

This class is a data structure for managing scan configuration parameters.

Since:

Nov 9, 2009

Nested Class Summary

Nested classes/interfaces inherited from class xal.smf.scada.ScadaRecord

ScadaRecord.IFieldDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
static double	DBL_INV_SQRT_2 the numeric value 1/2-1/2
int	errScanRng Error flag indicating that the scan parameters are inconsistent, that is, they do not describe a viable scan.
static ScadaFieldMap	FLD_MAP The map between structure field names and there corresponding descriptors
double	lngScan The maximum position of the scan considering the current values of posInit, stepLength, and stepCount
double	lngStroke The stroke length of the device actuator.
double	posInit The initial (actuator) position of the scan in mm.
int	pulseCount The number of beam pulses (traces) used to compute a profile sample value.
int	stepCount The total number of profile data samples in the scan data set.
double	stepLength The size of each scan step in mm.

Constructor Summary

Constructors

Constructor and Description
ScanConfig() Create a new, uninitialized ScanConfig object.
ScanConfig(DataAdaptor daptSrc) Create a new ScanConfig object initialized from the given data source.
ScanConfig(ProfileDevice ws) Create a new ScanConfig object initialize with values fetched from the given device.

Method Summary

Modifier and Type	Method and Description
static WireScanner.ScanConfig	acquire(ProfileDevice ws) Return the set of profile scan configuration parameters.
double	getInitialPosition(ProfileDevice.ANGLE angle) Return the left-most position of the projection interval, that is, the minimum valued endpoint.
double	getIntervalLength(ProfileDevice.ANGLE angle) Return the length of the real interval containing the projection data.
int	getSampleCount(ProfileDevice.ANGLE angle) Returns the number of signal samples in the profile data, that is, the number of data points in the domain.
double[]	getSamplePositions(ProfileDevice.ANGLE angle) Returns the locations within the domain interval where the profile data samples are taken.

Methods inherited from class xal.smf.impl.profile.ParameterSet

dataLabel

Methods inherited from class xal.smf.scada.ScadaRecord

clone, getFieldDescriptor, getFieldDescriptorMap, getFieldDescriptors, loadHardwareValues, setFieldFromPV, setHardwareValues, setPvFromField, toString, update, write

Methods inherited from class java.lang.Object

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

Field Detail

DBL_INV_SQRT_2

public static final double DBL_INV_SQRT_2

the numeric value 1/2^-1/2

FLD_MAP

public static final ScadaFieldMap FLD_MAP

The map between structure field names and there corresponding descriptors

posInit

@AScada.Field(type=double.class,
              ctrl=true,
              hndRb="ScanCfgInitPosRb",
              hndSet="ScanCfgInitPosSet")
public double posInit

The initial (actuator) position of the scan in mm. This is the actuator location where the data acquisition begins. The actuator initially moves to this location then begins the data scan at the specified scan rate. The data is taken between this value and that returned by compFinalPosition().

stepCount

@AScada.Field(type=int.class,
              ctrl=true,
              hndRb="ScanCfgStepCntRb",
              hndSet="ScanCfgStepCntSet")
public int stepCount

The total number of profile data samples in the scan data set. That is, the number of actuator steps during data acquisition.

stepLength

@AScada.Field(type=double.class,
              ctrl=true,
              hndRb="ScanCfgStepLngRb",
              hndSet="ScanCfgStepLngSet")
public double stepLength

The size of each scan step in mm. That is, the distance between actuator positions for each profile data sample.

pulseCount

@AScada.Field(type=int.class,
              ctrl=true,
              hndRb="ScanCfgStepPulsesRb",
              hndSet="ScanCfgStepPulsesSet")
public int pulseCount

The number of beam pulses (traces) used to compute a profile sample value. Note that a value greater than 1 indicates averaging. Attempting to set the value less than 1 does nothing.

lngScan

@AScada.Field(type=double.class,
              ctrl=false,
              hndRb="ScanCfgScanLngRb")
public double lngScan

The maximum position of the scan considering the current values of posInit, stepLength, and stepCount

lngStroke

@AScada.Field(type=double.class,
              ctrl=false,
              hndRb="ScanCfgStrokeLngRb")
public double lngStroke

The stroke length of the device actuator. Thus, this is the maximum possible distance the wire can travel while taking data. It is a mechanical limitation.

The product of stepLength × stepCount must be less than this value. This is a read-only quantity.

errScanRng

@AScada.Field(type=int.class,
              ctrl=false,
              hndRb="ScanCfgScanOutOfRngRb")
public int errScanRng

Error flag indicating that the scan parameters are inconsistent, that is, they do not describe a viable scan.

Constructor Detail

ScanConfig

public ScanConfig()

Create a new, uninitialized ScanConfig object.

Since:

Nov 13, 2009

ScanConfig

public ScanConfig(DataAdaptor daptSrc)

Create a new ScanConfig object initialized from the given data source.

Parameters:

daptSrc - data source containing data structure fields

Since:

Mar 17, 2010

ScanConfig

public ScanConfig(ProfileDevice ws)
           throws ConnectionException,
                  GetException

Create a new ScanConfig object initialize with values fetched from the given device.

Parameters:

ws - data acquisition device

Throws:

ConnectionException - unable to connect to a parameter read back channel

GetException - general field initialization exception

Since:

Dec 16, 2009

Method Detail

acquire

public static WireScanner.ScanConfig acquire(ProfileDevice ws)
                                      throws ConnectionException,
                                             GetException

Return the set of profile scan configuration parameters. The parameters are obtained from a call to channel access and returned the the scan parameter data structure.

Parameters:

ws - profile device under request

Returns:

scan configuration for given profile device

Throws:

ConnectionException - unable to connect parameter read back channel

GetException - general channel access get exception

Since:

Nov 9, 2009

getSampleCount

public int getSampleCount(ProfileDevice.ANGLE angle)

Description copied from interface: ProfileDevice.IProfileDomain

Returns the number of signal samples in the profile data, that is, the number of data points in the domain.

Specified by:

getSampleCount in interface ProfileDevice.IProfileDomain

Returns:

number of data samples of the given angle

Since:

Apr 24, 2014

See Also:

ProfileDevice.IProfileDomain.getSampleCount(xal.smf.impl.profile.ProfileDevice.ANGLE)

getSamplePositions

public double[] getSamplePositions(ProfileDevice.ANGLE angle)

Description copied from interface: ProfileDevice.IProfileDomain

Returns the locations within the domain interval where the profile data samples are taken.

Specified by:

getSamplePositions in interface ProfileDevice.IProfileDomain

Parameters:

angle - the projection angle of the data set

Returns:

sample axis positions of the projection data

Since:

Apr 24, 2014

See Also:

ProfileDevice.IProfileDomain.getSamplePositions(xal.smf.impl.profile.ProfileDevice.ANGLE)

getInitialPosition

public double getInitialPosition(ProfileDevice.ANGLE angle)

Description copied from interface: ProfileDevice.IProfileDomain

Return the left-most position of the projection interval, that is, the minimum valued endpoint.

Specified by:

getInitialPosition in interface ProfileDevice.IProfileDomain

Returns:

left endpoint of the projection interval

Since:

Apr 24, 2014

See Also:

ProfileDevice.IProfileDomain.getInitialPosition(xal.smf.impl.profile.ProfileDevice.ANGLE)

getIntervalLength

public double getIntervalLength(ProfileDevice.ANGLE angle)

Description copied from interface: ProfileDevice.IProfileDomain

Return the length of the real interval containing the projection data. That is, return the measure of the smallest real interval containing the projection data.

Specified by:

getIntervalLength in interface ProfileDevice.IProfileDomain

Parameters:

angle - the projection angle of the data set

Returns:

length of the interval of definition for the given data set

Since:

Apr 24, 2014

See Also:

ProfileDevice.IProfileDomain.getIntervalLength(xal.smf.impl.profile.ProfileDevice.ANGLE)