xal.smf.impl.profile

Interface ProfileDevice.IProfileDomain

All Known Implementing Classes:

WireHarp.DaqConfig, WireScanner.ScanConfig

Enclosing class:

ProfileDevice

public static interface ProfileDevice.IProfileDomain

Interface for the generic description of the domain of profile data. The domain of definition is an interval on the real line. This interval is described by its position (the left-most endpoint) and its length.

Since:

Apr 24, 2014

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getSampleCount

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.

Returns:

number of data samples of the given angle

Since:

Apr 24, 2014

getSamplePositions

double[] getSamplePositions(ProfileDevice.ANGLE angle)

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

Parameters:

angle - the projection angle of the data set

Returns:

sample axis positions of the projection data

Since:

Apr 24, 2014

getInitialPosition

double getInitialPosition(ProfileDevice.ANGLE angle)

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

Returns:

left endpoint of the projection interval

Since:

Apr 24, 2014

getIntervalLength

double getIntervalLength(ProfileDevice.ANGLE angle)

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.

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