Package ffx.crystal
Class Resolution
java.lang.Object
ffx.crystal.Resolution
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
Modifier and TypeFieldDescriptionfinal double
The resolution of the data set.final double
The sampling limit for the data set. -
Constructor Summary
ConstructorDescriptionResolution
(double resolution) Constructor for Resolution.Resolution
(double resolution, double sampling) Constructor for Resolution. -
Method Summary
Modifier and TypeMethodDescriptionstatic Resolution
checkProperties
(org.apache.commons.configuration2.CompositeConfiguration properties) checkPropertiesboolean
inInverseResSqRange
(double res) inInverseResSqRangeboolean
inResolutionRange
(double res) inResolutionRangedouble
inverseResSqLimitdouble
resolutionLimitdouble
samplingLimit
-
Field Details
-
sampling
public final double samplingThe sampling limit for the data set. -
resolution
public final double resolutionThe 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
-
checkProperties
public static Resolution checkProperties(org.apache.commons.configuration2.CompositeConfiguration properties) checkProperties- Parameters:
properties
- aCompositeConfiguration
object.- 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.
-