An official website of the United States government

Here’s how you know

Here’s how you know

Search Site

The AtomProbMask Class
 
Constructor:
 
    AtomProbMask(grid,
                 molOrientationSels,
                 molPlaneSel,
                 zDirSels,
                 mapCenter,
                 mapOrientation)
 
      grid               - a densityGrid.DensityGrid object containing 
                           the mask image.
      molOrientationSels - a sequence of two atomSel.AtomSel
                           objects which specify map direction (within the
                           map plane).
      zDirSels           - a sequence of two atomSel.AtomSel used to
                           disambiguate the sign of the plane normal vector.
      molPlaneSel        - an atomSel.AtomSel specifying atoms defining
                           the mask plane.
      mapCenter          - a vec3.Vec3 specifying the mask center.
      mapOrientation     - a mat3.Mat3 specifying the mask orientation.
      
 
Read-only Accessors:
 
  These methods return values specified in the constructor:
    grid()
    molOrientationSels()
    molPlaneSel()
    zDirSels()
    mapCenter()
    mapOrientation()
 
  One of these values can be modified after mask creation:
 
    setZDirSels( val )
 
 
  The following accessors return computed values:
    molPlaneCentroid() - centroid of molPlaneSel
    molPlanePos()      - molPlaneSel's coordinates after subtraction by
                         molPlaneCentroid
    planeVals()        - eigenvalues of matrix molPlanePos molPlanePos^T
    planeVecs()        - corresponding eigenvectors.
    zDir()             - direction of zDirSels[1] - zDirSels[0]
    normal()           - normal to plane (eigenvector corresponding to the
                         smallest eigenvalue) with sign corrected s.t.
                         dot(zDir, normal) > 1.
 
    maskRot() - the rotation matrix formed by
                    / u0^T \
           maskR = |  u1^T |
                    \ n^T  /
 
           where n is normal()
           u0 = unitVec(molOrientation - dot(molOrientation,u2) u2)
           u1 = unitVec( u2 X u0 )
    normal    - plane normal direction.
    zRef      - vector defining the positive z direction of the
                plane normal. i.e. the sign of normal is chosen
                s.t. dot(zRef, normal) > 0.
 
 
  Methods:
 
   swapZdir() - swap zDirSels selections, to reverse the sign of the plane
                normal.
 
   update()  - compute all derived quantities
 
   apply(data,
         R,t      ) - Mask data given orienataion R and translation t.
                      No return value. This involves interpolation of
                      the mask.
 
   applyInFrame(data) - apply massk to data in the mask frame. 
   
   placeInFrame(atomProb) - update the orientation and translation of
                            the passed atomProb.AtomProb object to be
                            in the mask frame.
 
 
 
 
# This file was automatically generated by SWIG (http://www.swig.org).
# Version 4.0.2
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.