Package _global.tri.oxidationstates.webapi

Class PotentialMapper

java.lang.Object
_global.tri.oxidationstates.webapi.PotentialMapper
public class PotentialMapper extends Object
This class performs linear transformations between the electronic chemical potential and the mapped potential

  • Constructor Summary

    Constructors
    Constructor
    Description
    PotentialMapper()
    Create a Potential Mapper with the default slope and intercept
    PotentialMapper(double slope, double intercept)
    Create a PotentialMapper with the given slope and intercept

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    fromMappedPotential(double mappedPotential)
    Converts the mapped potential to the electronic chemical potential used internally by the oxidation analyzer.
    double[]
    fromMappedPotential(double[] mappedPotentials)
    Converts the mapped potential to the electronic chemical potential used internally by the oxidation analyzer.
    double
    getIntercept()
    Returns the "intercept" value in the equation mapped_potential = electronic_chemical_potential * slope + intercept, where the electronic chemical potential is the potential used internally by the oxidation analyzer.
    double
    getSlope()
    Returns the "slope" value in the equation mapped_potential = electronic_chemical_potential * slope + intercept, where the electronic chemical potential is the potential used internally by the oxidation analyzer.
    double
    toMappedPotential(double value)
    Converts the mapped potential to the electronic chemical potential used internally by the oxidation analyzer.
    double[]
    toMappedPotential(double[] values)
    Converts the mapped potential to the electronic chemical potential used internally by the oxidation analyzer.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PotentialMapper

      public PotentialMapper()
      Create a Potential Mapper with the default slope and intercept

    • PotentialMapper

      public PotentialMapper(double slope, double intercept)
      Create a PotentialMapper with the given slope and intercept
      Parameters:
      slope - The slope
      intercept - The intercept

  • Method Details

    • toMappedPotential

      public double toMappedPotential(double value)
      Converts the mapped potential to the electronic chemical potential used internally by the oxidation analyzer.
      Parameters:
      value - An electronic chemical potential value
      Returns:
      The corresponding mapped potential value

    • toMappedPotential

      public double[] toMappedPotential(double[] values)
      Converts the mapped potential to the electronic chemical potential used internally by the oxidation analyzer.
      Parameters:
      values - An array of electronic chemical potential values
      Returns:
      An array of the corresponding mapped potential value

    • fromMappedPotential

      public double[] fromMappedPotential(double[] mappedPotentials)
      Converts the mapped potential to the electronic chemical potential used internally by the oxidation analyzer.
      Parameters:
      mappedPotentials - An array of mapped potential values
      Returns:
      An array of the corresponding electronic chemical potential values

    • fromMappedPotential

      public double fromMappedPotential(double mappedPotential)
      Converts the mapped potential to the electronic chemical potential used internally by the oxidation analyzer.
      Parameters:
      mappedPotential - A mapped potential value
      Returns:
      The corresponding electronic chemical potential value

    • getSlope

      public double getSlope()
      Returns the "slope" value in the equation mapped_potential = electronic_chemical_potential * slope + intercept, where the electronic chemical potential is the potential used internally by the oxidation analyzer.
      Returns:
      the "slope" value in the equation mapped_potential = electronic_chemical_potential * slope + intercept, where the electronic chemical potential is the potential used internally by the oxidation analyzer.

    • getIntercept

      public double getIntercept()
      Returns the "intercept" value in the equation mapped_potential = electronic_chemical_potential * slope + intercept, where the electronic chemical potential is the potential used internally by the oxidation analyzer.
      Returns:
      the "intercept" value in the equation mapped_potential = electronic_chemical_potential * slope + intercept, where the electronic chemical potential is the potential used internally by the oxidation analyzer.