ProfileDataStatistics

java.lang.Object
- xal.extension.wirescan.profile.ProfileDataStatistics

```
public class ProfileDataStatistics
extends java.lang.Object
```
Computes statistical properties of profile data.

Define the weighted, central summation S_n(μ) as

S_n(μ) = Σ_k(k - μ)ⁿf_k

where {f_k} is the set of discrete samples for a projection view (that is, the discrete function representing the projection). Then the quantities provided by this class are typically some ratio of the S_n(μ) for a combination of parameters (n,μ). For example, the n^th central moment moment, denoted <(x - μ)ⁿ>, is defined as

<(x - μ)ⁿ> = S_n(μ)/S₀(0)

Note that the units of the moments will be in terms of samples (see below). For example, the value returned by the method getCenter(ProfileData.Angle) is the index location of the center of mass. Note further that although the indices are integer valued, the statistic values in units of samples need not be.

NOTE:
- The quantities provided by this class are for discrete system. When considering these systems as approximations for continuous systems (sampled data systems) then we must "unnormalized" the results by the sampling interval h. For example, to convert <(x - μ)ⁿ> to the continuous approximation the value must be multiplied by hⁿ.
- The above conversions are not provided by methods in this class. There are, however, methods for computing the sampling length h for the various axes and actuator positions. The rationale for not providing this service at present is the profile data sets might not contain the axis positions, as these are version-sensitive data. Thus, such methods have the potential for returning erroneous results.
- Higher-order moments are highly sensitive to signal noise.
- Strongly peaked distributions create numerically unstable computations. In general, for accurate numerical results the distribution should have a standard deviation σ > 2. Standard deviations smaller than this value imply that the sampling interval is too large.

Constructor Summary

Constructors
Constructor and Description

ProfileDataStatistics(ProfileData pdoData)
Create a new ProfileDataStatistics object and attach it to the given profile data set.

Constructors
Constructor and Description
`ProfileDataStatistics(ProfileData pdoData)` Create a new `ProfileDataStatistics` object and attach it to the given profile data set.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`compAveActuatorStepSize()` Compute and return the average step size between actuator positions for the entire sample projection sample set.
`double`	`compAveAxisStepSize(ProfileData.Angle view)` Compute and return the average step size between axis sample positions for the given projection view.
`double`	`compStdDev(ProfileData.Angle view)` Return the (normalized) standard deviation σ of the given projection.
`double`	`computeCentralMoment(int intOrder, ProfileData.Angle view)` Compute and return the indicated central moment for the given projection data.
`double`	`computeMoment(int intOrder, ProfileData.Angle view)` Compute and return the indicated moment for the given projection data.
`double`	`computeWeightedSum(int intOrder, double dblCntr, ProfileData.Angle view)` Compute and return the weighted central summation S_n(μ) which is defined S_n(μ) = Σ_k(k - μ)ⁿf_k
`double`	`getActuatorOffset()` Return the initial actuator position, that is the actuator location x₀ of the first sample.
`double`	`getAxisOffset(ProfileData.Angle view)` Return the initial axis position for the given projection angle, that is the axis location x₀ of the first sample.
`double`	`getCenter(ProfileData.Angle view)` Return the (normalized) center of mass (i.e., the first moment) for the given projection.
`double`	`getMass(ProfileData.Angle view)` Return the total mass (i.e., the first integral, or zeroth moment) of the given projection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProfileDataStatistics
```
public ProfileDataStatistics(ProfileData pdoData)
```
    Create a new ProfileDataStatistics object and attach it to the given profile data set.
- Method Detail
  - getMass
```
public double getMass(ProfileData.Angle view)
```
    Return the total mass (i.e., the first integral, or zeroth moment) of the given projection.
    
    NOTE:
    - The returned value is for a discrete function and must be treated as a "normalized" quantity when considering sampled data from a continuous system. To convert to the continuous approximation the returned value must be multiplied by h where h is the sampling interval.
    
    Parameters:
    
    view - projection data
    
    Returns:
    
    the value S₀(0)
  - getCenter
```
public double getCenter(ProfileData.Angle view)
```
    Return the (normalized) center of mass (i.e., the first moment) for the given projection.
    
    NOTE:
    - The returned value is for a discrete function and must be treated as a "normalized" quantity when considering sampled data from a continuous system. To convert to the continuous approximation for <x> the returned value must be multiplied by h where h is the sampling interval.
    - To convert to the center of the projection axis indicated by view, the returned value must be multiply by h then offset by x₀, the left-hand axis end-point.
    
    Parameters:
    
    view - projection data
    
    Returns:
    
    the value S₁(0)/S₀(0) in
  - getActuatorOffset
```
public double getActuatorOffset()
```
    Return the initial actuator position, that is the actuator location x₀ of the first sample.
    
    Returns:
    
    initial position of the actuator
  - getAxisOffset
```
public double getAxisOffset(ProfileData.Angle view)
```
    Return the initial axis position for the given projection angle, that is the axis location x₀ of the first sample.
    
    Returns:
    
    initial axis position for the given viewing angle
  - compAveActuatorStepSize
```
public double compAveActuatorStepSize()
```
    Compute and return the average step size between actuator positions for the entire sample projection sample set. This value is given by
    
    (x_N-1 - x₀)/(N - 1)
    
    where N is the number of sample points and {x_k} are the actuator positions.
    
    NOTE:
    - The above result is the same as computing the steps size h_k = x_k - x_k-1 between each sample then averaging the set.
    
    Returns:
    
    average step length between actuator positions
  - compAveAxisStepSize
```
public double compAveAxisStepSize(ProfileData.Angle view)
```
    Compute and return the average step size between axis sample positions for the given projection view. This value is given by
    
    (x_N-1 - x₀)/(N - 1)
    
    where N is the number of sample points and {x_k} are the axis positions.
    
    NOTE:
    - The above result is the same as computing the steps size h_k = x_k - x_k-1 between each sample then averaging the set.
    
    Returns:
    
    average step length between axis sample positions
  - compStdDev
```
public double compStdDev(ProfileData.Angle view)
```
    Return the (normalized) standard deviation σ of the given projection. The standard deviation is defined as
    
    σ = <(x - μ)²>^½
    
    NOTE:
    - The returned value is for a discrete function and must be treated as a "normalized" quantity when considering sampled data from a continuous system. To convert to the continuous approximation for σ the returned value must be multiplied by h where h is the sampling interval.
    - Because of signal noise and numerical rounding it is possible to compute a value for <(x - μ)²> which is less than zero. Such an occurrence indicates either that sampling interval h is too large, or that the signal-to-noise ratio is too small to permit meaningful results. A zero value is returned in this situation.
    
    Parameters:
    
    view - project data to analyze
    
    Returns:
    
    standard deviation of given view, or zero if undefined
  - computeMoment
```
public double computeMoment(int intOrder,
                            ProfileData.Angle view)
```
    Compute and return the indicated moment for the given projection data. The value of the returned moment <xⁿ> is defined as
    
    <xⁿ> = S_n(0)/S₀(0)
    
    NOTE:
    - The returned value is for a discrete function and must be treated as a "normalized" quantity when considering sampled data from a continuous system. To convert to the continuous approximation for <xⁿ> the returned value must be multiplied by hⁿ where h is the sampling interval.
    
    Parameters:
    
    intOrder - moment order
    
    view - project data to analyze
    
    Returns:
    
    moment of given view
  - computeCentralMoment
```
public double computeCentralMoment(int intOrder,
                                   ProfileData.Angle view)
```
    Compute and return the indicated central moment for the given projection data. The value of the returned moment <(x - μ)ⁿ> is defined as
    
    <(x - μ)ⁿ> = S_n(μ)/S₀(0)
    
    NOTE:
    - The returned value is for a discrete function and must be treated as a "normalized" quantity when considering sampled data from a continuous system. To convert to the continuous approximation for <(x - μ)ⁿ> the returned value must be multiplied by hⁿ where h is the sampling interval.
    
    Parameters:
    
    intOrder - moment order
    
    view - project data to analyze
    
    Returns:
    
    moment of given view
  - computeWeightedSum
```
public double computeWeightedSum(int intOrder,
                                 double dblCntr,
                                 ProfileData.Angle view)
```
    Compute and return the weighted central summation S_n(μ) which is defined
    
    S_n(μ) = Σ_k(k - μ)ⁿf_k
    
    Parameters:
    
    intOrder - order of the summation weight (i.e., n)
    
    dblCntr - center of the summation weight (i.e., μ)
    
    view - projection view angle (i.e., the set {f_k})
    
    Returns:
    
    the value S_n(μ) as defined above

Class ProfileDataStatistics

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProfileDataStatistics

Method Detail

getMass

getCenter

getActuatorOffset

getAxisOffset

compAveActuatorStepSize

compAveAxisStepSize

compStdDev

computeMoment

computeCentralMoment

computeWeightedSum