atomsmltr.environment package

The atomsmltr.environment subpackage provides classes to define the atom environment (lasers, mag. fields, zones).

Content

atomsmltr.environment.fields : vector fields (magnetic fields & forces)

atomsmltr.environment.lasers : laser beams

atomsmltr.environment.zones : zones in position or speed space

Subpackages

• atomsmltr.environment.fields package
  • ConstantForce
    • ConstantForce.type
  • Force
    • Force.type
    • Force.unit
  • GradientForce
    • GradientForce.type
  • InterpMag1D1D
    • InterpMag1D1D.type
  • InterpMag3D3D
    • InterpMag3D3D.type
  • MagneticGradient
    • MagneticGradient.type
  • MagneticOffset
    • MagneticOffset.type
  • MagneticQuadrupole
    • MagneticQuadrupole.type
  • MagneticQuadrupoleX
    • MagneticQuadrupoleX.type
  • MagneticQuadrupoleY
    • MagneticQuadrupoleY.type
  • MagneticQuadrupoleZ
    • MagneticQuadrupoleZ.type
  • Subpackages
    • atomsmltr.environment.fields.force package
      • ConstantForce
      • Force
      • GradientForce
      • Submodules
    • atomsmltr.environment.fields.magnetic package
      • InterpMag1D1D
      • InterpMag3D3D
      • MagneticField
      • MagneticGradient
      • MagneticOffset
      • MagneticQuadrupole
      • MagneticQuadrupoleX
      • MagneticQuadrupoleY
      • MagneticQuadrupoleZ
      • Submodules
  • Submodules
    • generic fields
    • BaseQuadrupoleField
      • BaseQuadrupoleField.gen_infostring_obj()
      • BaseQuadrupoleField.origin
      • BaseQuadrupoleField.slope
      • BaseQuadrupoleField.strong_axis
    • ConstantField
      • ConstantField.gen_infostring_obj()
    • Field
      • Field.get_norm()
      • Field.get_value()
      • Field.plot1D()
      • Field.plot2D()
      • Field.plot3D()
      • Field.unit
      • Field.vector
    • GradientField
      • GradientField.field_direction
      • GradientField.gen_infostring_obj()
      • GradientField.gradient_direction
      • GradientField.offset
      • GradientField.origin
      • GradientField.slope
    • QuadrupoleField
    • QuadrupoleFieldX
    • QuadrupoleFieldY
    • QuadrupoleFieldZ
    • interpolated fields
    • InterpolatedField
      • InterpolatedField.interpolate()
      • InterpolatedField.origin
      • InterpolatedField.scale
    • InterpolatedField1D1D
      • InterpolatedField1D1D.data_field
      • InterpolatedField1D1D.data_position
      • InterpolatedField1D1D.field_direction
      • InterpolatedField1D1D.gen_infostring_obj()
      • InterpolatedField1D1D.interpolate()
      • InterpolatedField1D1D.position_direction
    • InterpolatedField3D3D
      • InterpolatedField3D3D.data_field
      • InterpolatedField3D3D.data_position
      • InterpolatedField3D3D.gen_infostring_obj()
      • InterpolatedField3D3D.interpolate()
• atomsmltr.environment.lasers package
  • CircularLeft
  • CircularRight
  • GaussianLaserBeam
    • GaussianLaserBeam.gen_infostring_obj()
    • GaussianLaserBeam.rayleigh_length
    • GaussianLaserBeam.set_power_from_I()
    • GaussianLaserBeam.set_waist_from_I()
    • GaussianLaserBeam.type
  • Horizontal
  • LaserBeam
    • LaserBeam.direction
    • LaserBeam.direction_type
    • LaserBeam.gen_infostring_obj()
    • LaserBeam.get_polarization_quant()
    • LaserBeam.get_polarization_quant_amplitude()
    • LaserBeam.get_polarization_quant_amplitude_dict()
    • LaserBeam.get_polarization_quant_dict()
    • LaserBeam.get_polarization_vector_in_lab_frame()
    • LaserBeam.get_polarization_vector_in_laser_frame()
    • LaserBeam.get_value()
    • LaserBeam.k
    • LaserBeam.kvec
    • LaserBeam.plot2D()
    • LaserBeam.plot3D()
    • LaserBeam.polarization
    • LaserBeam.power
    • LaserBeam.print_info()
    • LaserBeam.set_power_from_I()
    • LaserBeam.set_waist_from_I()
    • LaserBeam.unit_vector
    • LaserBeam.vector
    • LaserBeam.waist
    • LaserBeam.waist_position
    • LaserBeam.wavelength
  • Linear
    • Linear.angle
  • PlaneWaveLaserBeam
    • PlaneWaveLaserBeam.gen_infostring_obj()
    • PlaneWaveLaserBeam.set_power_from_I()
    • PlaneWaveLaserBeam.set_waist_from_I()
    • PlaneWaveLaserBeam.type
  • Polarization
    • Polarization.gen_infostring_obj()
    • Polarization.get_polarization_vector_angles()
    • Polarization.get_polarization_vector_projection()
    • Polarization.get_polarization_vector_projection_norm()
    • Polarization.refresh_polarization_vector_angles()
  • Vector
    • Vector.vector
  • Vertical
  • Submodules
    • Laser Beams
    • GaussianLaserBeam
      • GaussianLaserBeam.gen_infostring_obj()
      • GaussianLaserBeam.rayleigh_length
      • GaussianLaserBeam.set_power_from_I()
      • GaussianLaserBeam.set_waist_from_I()
      • GaussianLaserBeam.type
    • LaserBeam
      • LaserBeam.direction
      • LaserBeam.direction_type
      • LaserBeam.gen_infostring_obj()
      • LaserBeam.get_polarization_quant()
      • LaserBeam.get_polarization_quant_amplitude()
      • LaserBeam.get_polarization_quant_amplitude_dict()
      • LaserBeam.get_polarization_quant_dict()
      • LaserBeam.get_polarization_vector_in_lab_frame()
      • LaserBeam.get_polarization_vector_in_laser_frame()
      • LaserBeam.get_value()
      • LaserBeam.k
      • LaserBeam.kvec
      • LaserBeam.plot2D()
      • LaserBeam.plot3D()
      • LaserBeam.polarization
      • LaserBeam.power
      • LaserBeam.print_info()
      • LaserBeam.set_power_from_I()
      • LaserBeam.set_waist_from_I()
      • LaserBeam.unit_vector
      • LaserBeam.vector
      • LaserBeam.waist
      • LaserBeam.waist_position
      • LaserBeam.wavelength
    • PlaneWaveLaserBeam
      • PlaneWaveLaserBeam.gen_infostring_obj()
      • PlaneWaveLaserBeam.set_power_from_I()
      • PlaneWaveLaserBeam.set_waist_from_I()
      • PlaneWaveLaserBeam.type
    • Polarization
      • Remarks
    • CircularLeft
    • CircularRight
    • Horizontal
    • Linear
      • Linear.angle
    • Polarization
      • Polarization.gen_infostring_obj()
      • Polarization.get_polarization_vector_angles()
      • Polarization.get_polarization_vector_projection()
      • Polarization.get_polarization_vector_projection_norm()
      • Polarization.refresh_polarization_vector_angles()
    • Vector
      • Vector.vector
    • Vertical
• atomsmltr.environment.zones package
  • Create a zone
  • Combining Zones
    • ANDCollection
    • ORCollection
    • XORCollection
    • Adding zones to a collection
  • Box
    • Box.gen_infostring_obj()
    • Box.type
    • Box.xmax
    • Box.xmin
    • Box.ymax
    • Box.ymin
    • Box.zmax
    • Box.zmin
  • Cylinder
    • Cylinder.direction
    • Cylinder.gen_infostring_obj()
    • Cylinder.origin
    • Cylinder.power
    • Cylinder.type
  • Limits
    • Limits.axis
    • Limits.gen_infostring_obj()
    • Limits.max
    • Limits.min
    • Limits.type
  • LowerLimit
    • LowerLimit.type
  • SuperZone
    • SuperZone.gen_infostring_obj()
    • SuperZone.get_value()
    • SuperZone.logic
    • SuperZone.target
    • SuperZone.type
  • UpperLimit
    • UpperLimit.type
  • Zone
    • Zone.action
    • Zone.get_value()
    • Zone.in_tag
    • Zone.invert()
    • Zone.inverted
    • Zone.inverted_copy()
    • Zone.out_tag
    • Zone.target
    • Zone.vector
  • Submodules
    • zones
    • ANDCollection
      • ANDCollection.type
    • ORCollection
      • ORCollection.type
    • SuperZone
      • SuperZone.gen_infostring_obj()
      • SuperZone.get_value()
      • SuperZone.logic
      • SuperZone.target
      • SuperZone.type
    • XORCollection
      • XORCollection.type
    • Zone
      • Zone.action
      • Zone.get_value()
      • Zone.in_tag
      • Zone.invert()
      • Zone.inverted
      • Zone.inverted_copy()
      • Zone.out_tag
      • Zone.target
      • Zone.vector
    • ZoneCollection
      • ZoneCollection.add_zone()
      • ZoneCollection.gen_infostring_obj()
      • ZoneCollection.reset()
      • ZoneCollection.type
      • ZoneCollection.zones
    • limits - 1D zones
    • Limits
      • Limits.axis
      • Limits.gen_infostring_obj()
      • Limits.max
      • Limits.min
      • Limits.type
    • LowerLimit
      • LowerLimit.type
    • SingleLimit
      • SingleLimit.axis
      • SingleLimit.gen_infostring_obj()
      • SingleLimit.value
    • UpperLimit
      • UpperLimit.type
    • volumes - 1D zones
    • Box
      • Box.gen_infostring_obj()
      • Box.type
      • Box.xmax
      • Box.xmin
      • Box.ymax
      • Box.ymin
      • Box.zmax
      • Box.zmin
    • Cylinder
      • Cylinder.direction
      • Cylinder.gen_infostring_obj()
      • Cylinder.origin
      • Cylinder.power
      • Cylinder.type

Submodules

• environment objects
• EnvObject
  • EnvObject.copy()
  • EnvObject.gen_info_string()
  • EnvObject.gen_infostring_obj()
  • EnvObject.get_value()
  • EnvObject.print_info()
  • EnvObject.tag
  • EnvObject.type
  • EnvObject.vector
• modifiers for environment objects
• rotate()
• rotate_position_vector()
• rotate_position_vector_alt()
• rotation_matrix()
• shift()