Package 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
Author:
Christopher K. Allen

  • Method Details

    • 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.
      Parameters:
      angle - the projection angle of the data set
      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.
      Parameters:
      angle - the projection angle of the data set
      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 length of the smallest interval containing the projection data. Note that this value may be different than the "scan length" as it may depend upon the measurement plane. The value, L, is typically given by the formula

          L = α Nsteps ΔL

      where α is the correction factor, Nsteps is the number of scan steps, and ΔL is the step length. For example, if the scan actuator arm is physically at a 45 ° angle to the given measurement plane then α = 1/√2.
      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