Package ffx.crystal

Class Resolution

java.lang.Object
ffx.crystal.Resolution
public class Resolution extends Object
The Resolution class encapsulates the sampling limits and resolution limits for a given crystal and/or data set.
Since:
1.0
Author:
Timothy D. Fenn

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final double
    resolution
    The resolution of the data set.
    final double
    sampling
    The sampling limit for the data set.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Resolution(double resolution)
    Constructor for Resolution.
    Resolution(double resolution, double sampling)
    Constructor for Resolution.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Resolution
    checkProperties(org.apache.commons.configuration2.CompositeConfiguration properties, boolean isNeutron, double defaultResolution)
    checkProperties
    boolean
    inInverseResSqRange(double res)
    inInverseResSqRange
    boolean
    inResolutionRange(double res)
    inResolutionRange
    double
    inverseResSqLimit()
    inverseResSqLimit
    double
    resolutionLimit()
    resolutionLimit
    double
    samplingLimit()
    samplingLimit
    String
    toString()
    Returns a string representation of the Resolution object, including the resolution and sampling values.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • sampling

      public final double sampling
      The sampling limit for the data set.

    • resolution

      public final double resolution
      The resolution of the data set.

  • Constructor Details

    • Resolution

      public Resolution(double resolution, double sampling)
      Constructor for Resolution.
      Parameters:
      resolution - a double.
      sampling - a double.

    • Resolution

      public Resolution(double resolution)
      Constructor for Resolution.
      Parameters:
      resolution - a double.

  • Method Details

    • toString

      public String toString()
      Returns a string representation of the Resolution object, including the resolution and sampling values.
      Overrides:
      toString in class Object
      Returns:
      A formatted string containing the resolution and sampling values of the object.

    • checkProperties

      public static Resolution checkProperties(org.apache.commons.configuration2.CompositeConfiguration properties, boolean isNeutron, double defaultResolution)
      checkProperties
      Parameters:
      properties - a CompositeConfiguration object.
      isNeutron - If true, this is a neutron diffraction data set.
      defaultResolution - The resolution from the reflection file.
      Returns:
      a Resolution object.

    • inInverseResSqRange

      public boolean inInverseResSqRange(double res)
      inInverseResSqRange
      Parameters:
      res - a double.
      Returns:
      a boolean.

    • inResolutionRange

      public boolean inResolutionRange(double res)
      inResolutionRange
      Parameters:
      res - a double.
      Returns:
      a boolean.

    • inverseResSqLimit

      public double inverseResSqLimit()
      inverseResSqLimit
      Returns:
      a double.

    • resolutionLimit

      public double resolutionLimit()
      resolutionLimit
      Returns:
      a double.

    • samplingLimit

      public double samplingLimit()
      samplingLimit
      Returns:
      a double.