Class RotatedCompositeProbe

All Implemented Interfaces:
IField

public class RotatedCompositeProbe extends CompositeProbe
  • Constructor Details

  • Method Details

    • field

      public void field(int sector, float xtilt, float ytilt, float ztilt, float[] result)
      Obtain the magnetic field at a given location expressed in Cartesian coordinates of the tilted sector system. The field is returned as a Cartesian vector in kiloGauss.
      Specified by:
      field in interface IField
      Overrides:
      field in class CompositeProbe
      Parameters:
      sector - the sector [1..6]
      xtilt - the tilted x coordinate in cm
      ytilt - the tilted y coordinate in cm
      ztilt - the tilted z coordinate in cm
      result - the result is a float array holding the retrieved field in kiloGauss. The 0,1 and 2 indices correspond to x, y, and z components.
    • field

      public void field(float xs, float ys, float zs, float[] result)
      Obtain the magnetic field at a given location expressed in Cartesian coordinates. The field is returned as a Cartesian vector in kiloGauss. THIS ASSUMES COORDINATES ARE IN A SECTOR 1 SECTOR SYSTEM
      Specified by:
      field in interface IField
      Overrides:
      field in class CompositeProbe
      Parameters:
      xs - the x coordinate in cm in sector 1 sector system
      ys - the y coordinate in cm in sector 1 sector system
      zs - the z coordinate in cm in sector 1 sector system
      result - the result is a float array holding the retrieved field in kiloGauss. The 0,1 and 2 indices correspond to x, y, and z components.
    • gradient

      public void gradient(float xs, float ys, float zs, float[] result)
      Obtain an approximation for the magnetic field gradient at a given location expressed in Cartesian coordinates. The field is returned as a Cartesian vector in kiloGauss/cm.
      Specified by:
      gradient in interface IField
      Overrides:
      gradient in class CompositeProbe
      Parameters:
      x - the x coordinate in cm
      y - the y coordinate in cm
      z - the z coordinate in cm
      result - a float array holding the retrieved field in kiloGauss. The 0,1 and 2 indices correspond to x, y, and z components.