Uses of Interface
xal.model.IProbe

Packages that use IProbe
Package
Description
 
Combination of modeling elements from TraceWin documentation put into OpenXAL reference frame.
 
The Online Model
 
Modeling Elements Package Library
 
 
Contains classes for representing particle beams and various aspects and properties of particle beams.
 
  • Uses of IProbe in xal.extension.jels.model.alg

    Methods in xal.extension.jels.model.alg with parameters of type IProbe
    Modifier and Type
    Method
    Description
    protected void
    ElsTracker.advanceState(IProbe ifcProbe, IElement ifcElem, double dblLen)
    Advances the probe state through a subsection of the element with the specified length.
    void
    ElsTracker.doPropagation(IProbe probe, IElement elem)
    Propagates the probe through the element.
    Constructor parameters in xal.extension.jels.model.alg with type arguments of type IProbe
    Modifier
    Constructor
    Description
    protected
    ElsTracker(String strType, int intVersion, Class<? extends IProbe> clsProbeType)
    Creates a new, empty, instance of EnvelopeTracker.
  • Uses of IProbe in xal.extension.jels.model.elem

    Methods in xal.extension.jels.model.elem with parameters of type IProbe
    Modifier and Type
    Method
    Description
    double
    IdealMagSectorDipole.compProbeCurvature(IProbe probe)
    Compute the path curvature within the dipole for the given probe.
    void
    ThickRfFieldMap.computePhaseDriftAndEnergyGain(IProbe probe, double dblLen)
    Method calculates the phase drift and the energy gain on the current range (i.e from probe.getPosition, and for dblLength).
    void
     
    void
     
    void
     
    double
    IdealMagDipoleFace.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    IdealMagSectorDipole.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe to drift through part of the element.
    double
    IdealRfGap.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    RfqDummyModel.elapsedTime(IProbe probe, double dblLen)
     
    double
    ThickMagFieldMap.elapsedTime(IProbe probe, double dblLen)
     
    double
    ThickRfFieldMap.elapsedTime(IProbe probe, double dblLen)
     
    protected double
    ThinMagFieldMap.elapsedTime(IProbe probe)
     
    protected double
    ThinRfFieldMap.elapsedTime(IProbe probe)
     
    double
    IdealMagDipoleFace.energyGain(IProbe probe)
    Return the energy gain for this Element.
    double
    IdealMagSectorDipole.energyGain(IProbe probe, double dblLen)
    Return the energy gain imparted to a particular probe.
    double
    IdealRfGap.energyGain(IProbe probe)
    Compute the energy gain of the RF gap for a probe including the effects of calculating the phase advance.
    double
    RfqDummyModel.energyGain(IProbe probe, double dblLen)
     
    double
    ThickMagFieldMap.energyGain(IProbe probe, double dblLen)
     
    double
    ThickRfFieldMap.energyGain(IProbe probe, double dblLen)
     
    double
    ThinMagFieldMap.energyGain(IProbe probe)
     
    protected double
    ThinRfFieldMap.energyGain(IProbe probe)
    Calculate the energy gain for this element on the supplied probe.
    double
    TransferMapLoader.TransferMaps.energyGain(IProbe p, double l)
     
    protected double
    IdealRfGap.longitudinalPhaseAdvance(IProbe probe)
     
    double
    ThickRfFieldMap.longitudinalPhaseAdvance(IProbe probe, double dblLen)
     
    protected double
    ThinRfFieldMap.longitudinalPhaseAdvance(IProbe probe)
     
    void
    FieldMapIntegrator.timesKick(IProbe probe, double length, FieldMapPoint fieldMapPoint)
     
    void
    FieldMapIntegrator.timesKick(IProbe probe, double length, FieldMapPoint fieldMapPoint, double energyGain)
     
    protected PhaseMap
    IdealMagDipoleFace.transferMap(IProbe probe)
    Compute and return the transfer map for this dipole magnet pole face element.
    IdealMagSectorDipole.transferMap(IProbe probe, double dblLen)
    Compute the partial transfer map of an ideal sector magnet for the particular probe.
    protected PhaseMap
    IdealRfGap.transferMap(IProbe probe)
    Compute the transfer map for an ideal RF gap.
    RfqDummyModel.transferMap(IProbe probe, double dblLen)
     
    ThickMagFieldMap.transferMap(IProbe probe, double dblLen)
    Method calculates transfer matrix for the field map on the current range (i.e from probe.getPosition, and for dblLength).
    ThickRfFieldMap.transferMap(IProbe probe, double dblLen)
    Method calculates transfer matrix for the field map on the current range (i.e from probe.getPosition, and for dblLength).
    ThinMagFieldMap.transferMap(IProbe probe)
    Method calculates transfer matrix for the field map for a given data point in the field map.
    ThinRfFieldMap.transferMap(IProbe probe)
    Method calculates transfer matrix for the field map for a given data point in the field map.Drift spaces are calculated separately.
    TransferMapLoader.TransferMaps.transferMap(IProbe p, double l)
     
  • Uses of IProbe in xal.extension.jels.model.probe

    Classes in xal.extension.jels.model.probe that implement IProbe
    Modifier and Type
    Class
    Description
    class 
    This is a probe ported from ELS implementation.
  • Uses of IProbe in xal.model

    Methods in xal.model with parameters of type IProbe
    Modifier and Type
    Method
    Description
    void
    IComponent.backPropagate(IProbe probe)
    Propagates the Probe object through this component.
    void
    IComponent.backPropagate(IProbe probe, double d)
    Position dependent tracking within an IElement
    void
    Lattice.backPropagate(IProbe probe)
    Backward propagation of a probe through the lattice.
    void
    LineModel.backPropagate(IProbe probe)
    void
    RingModel.backPropagate(IProbe probe)
    Deprecated.
    Back propagation of a probe through the lattice.
    double
    IElement.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe probe to propagate through a subsection of the element with length dblLen.
    double
    IElement.energyGain(IProbe probe, double dblLen)
    Returns energy gain provided by a subsection of the element during the given length for the particular probe.
    double
    IElement.longitudinalPhaseAdvance(IProbe probe, double dblLen)
    Returns the longitudinal phase advance of the given probe with respect to the RF phase while propagation through this element section.
    void
    IAlgorithm.propagate(IProbe probe, IElement elem)
    Propagates the probe through the element.
    void
    IComponent.propagate(IProbe probe)
    Propagates the Probe object through this component.
    void
    IComponent.propagate(IProbe probe, double d)
    Position dependent tracking within an IElement
    void
    IComposite.propagate(IProbe probe)
    Propagates the Probe object through this composite element sequentially element by element.
    void
    LineModel.propagate(IProbe probe)
    Deprecated.
    void
    RingModel.propagate(IProbe probe)
    Deprecated.
    Propagate a probe through the lattice.
    IElement.transferMap(IProbe probe, double dblLen)
    Compute the transfer matrix for subsection of this element of length dblLen for the specified given probe.
    boolean
    IAlgorithm.validProbe(IProbe probe)
    Check if probe can be handled by this algorithm.
  • Uses of IProbe in xal.model.alg

    Methods in xal.model.alg that return types with arguments of type IProbe
    Modifier and Type
    Method
    Description
    Class<? extends IProbe>
    Tracker.getProbeType()
    The implementation must propagate the probe through the element according to the dynamics of the specific algorithm.
    Methods in xal.model.alg with parameters of type IProbe
    Modifier and Type
    Method
    Description
    protected void
    Tracker.advanceProbe(IProbe probe, IElement elem, double dblLen)
    Convenience method for common propagation dynamics for all probes.
    protected void
    DiagnosticTracker.advanceState(IProbe probe, IElement elem, double dblLen)
    Advance the supplied probe through a subsection of the specified length in the specified element.
    protected void
    EnsembleTracker.advanceState(IProbe probe, IElement elem, double dblLen)
     
    protected void
    EnvelopeTracker.advanceState(IProbe ifcProbe, IElement iElem, double dblLen)
    Advances the probe state through a subsection of the element with the specified length.
    protected void
    SynchronousTracker.advanceState(IProbe ifcProbe, IElement elem)
     
    protected void
    Trace3dTracker.advanceState(IProbe ifcProbe, IElement ifcElem, double dblLen)
    Advances the probe state through a subsection of the element with the specified length.
    protected void
    TwissTracker.advanceState(IProbe ifcProbe, IElement ifcElem, double dblLen)
    Advances the probe state through a subsection of the element with the specified length.
    void
    DiagnosticTracker.doPropagation(IProbe probe, IElement elem)
    Propagates the probe through the element.
    void
    EnsembleTracker.doPropagation(IProbe probe, IElement elem)
    Propagates the probe through the element.
    void
    EnvelopeBacktracker.doPropagation(IProbe probe, IElement elem)
    Implementation of Abstract Tracker#doPropagation(IProbe, IElement)
    void
    EnvelopeTracker.doPropagation(IProbe probe, IElement elem)
    Propagates the probe through the element.
    void
    EnvelopeTrackerPmq.doPropagation(IProbe probe, IElement elem)
    Propagates the probe through the element.
    void
    EnvelopeTrackerPmqDipole.doPropagation(IProbe probe, IElement elem)
    Propagates the probe through the element.
    void
    EnvTrackerAdapt.doPropagation(IProbe ifcProbe, IElement elem)
    Propagates the probe through the element using a second-order accurate adaptive step size algorithm for space charge calculations.
    void
    ParticleTracker.doPropagation(IProbe iProbe, IElement elem)
    Propagates the probe through the element.
    void
    SynchronousTracker.doPropagation(IProbe probe, IElement elem)
    Perform the actual probe propagation through the the modeling element.
    void
    Trace3dTracker.doPropagation(IProbe probe, IElement elem)
    Propagates the probe through the element.
    abstract void
    Tracker.doPropagation(IProbe probe, IElement elem)
    The implementation must propagate the probe through the element according to the dynamics of the specific algorithm.
    void
    TransferMapTracker.doPropagation(IProbe ifcProbe, IElement elem)
    Perform the actual probe propagation through the the modeling element.
    void
    TwissTracker.doPropagation(IProbe probe, IElement elem)
    Propagates the probe through the element.
    void
    TwissTrackerPmq.doPropagation(IProbe probe, IElement elem)
    Propagates the probe through the element.
    void
    SynchronousTracker.propagate(IProbe probe, IComponent elem)
    This method was included to deal with RfCavitie objects
    void
    Tracker.propagate(IProbe probe, IElement elem)
    Propagates the probe through the element
    protected void
    Tracker.retractProbe(IProbe probe, IElement elem, double dblLen)
    Override of xal.model.alg.Tracker#advanceProbe(xal.model.IProbe, xal.model.IElement, double)
    protected void
    EnvelopeBacktracker.retractState(IProbe ifcProbe, IElement ifcElem, double dblLen)
    Back-propagates the Defining State of the Probe Object
    boolean
    Tracker.validProbe(IProbe ifcProbe)
    Check if probe can be handled by this algorithm.
    Method parameters in xal.model.alg with type arguments of type IProbe
    Modifier and Type
    Method
    Description
    protected void
    Tracker.registerProbeType(Class<? extends IProbe> clsProbeType)
    Register the class of a probe recognized by this algorithm.
    Constructor parameters in xal.model.alg with type arguments of type IProbe
    Modifier
    Constructor
    Description
    protected
    EnvelopeBacktracker(String strType, int intVersion, Class<? extends IProbe> clsProbeType)
    This method is a protected constructor meant only for building child classes.
    protected
    EnvelopeTracker(String strType, int intVersion, Class<? extends IProbe> clsProbeType)
    Creates a new, empty, instance of EnvelopeTracker.
    protected
    EnvelopeTrackerBase(String strType, int intVersion, Class<? extends IProbe> clsProbeType)
    EnvelopeTrackerBase Constructor
    protected
    Tracker(String strType, int intVersion, Class<? extends IProbe> clsProbeType)
    Creates a new, empty, instance of Tracker.
    protected
    TrackerAdaptive(String strType, int intVersion, Class<? extends IProbe> clsProbeType)
    Deprecated.
     
    protected
    TwissTracker(String strType, int intVersion, Class<? extends IProbe> clsProbeType)
    Creates a new, empty, instance of EnvelopeTracker.
  • Uses of IProbe in xal.model.elem

    Methods in xal.model.elem with parameters of type IProbe
    Modifier and Type
    Method
    Description
    protected PhaseMatrix
    ThickElement.applyErrors(PhaseMatrix matPhi, IProbe probe, double length)
    Add Rotation and Displacement Error to Transfer Matrix
    void
    Element.backPropagate(IProbe probe)
    Back propagates the Probe object through this element based on the associated algorithm.
    void
    Element.backPropagate(IProbe probe, double pos)
    Back propagates the Probe object through this element based on the associated algorithm.
    void
    ElementSeq.backPropagate(IProbe probe)
    Backward propagation of probe through sequence.
    void
    ElementSeq.backPropagate(IProbe probe, double pos)
    void
    IdealRfCavity.backPropagate(IProbe probe)
    I am overriding this method even though a proper back propagation is impossible.
    double
    IdealRfGap.betaMidGap(IProbe probe)
    Compute and return the mid-gap normalized velocity for the given probe.
    double
    IdealPermMagQuad.calcK(IProbe probe, double dblLen)
    Removed - Jan 2019 Natalia Milas private static PhaseMatrix applyAlignErrorStatic(PhaseMatrix matPhi, double delx, double dely, double delz) { if ((delx==0)&&(dely==0)&&(delz==0)) { return matPhi; } PhaseMatrix T = new PhaseMatrix(); //T = Translation Matrix by Chris Allen // |1 0 0 0 0 0 dx| // |0 1 0 0 0 0 0| // |0 0 1 0 0 0 dy| // |0 0 0 1 0 0 0| // |0 0 0 0 1 0 dz| // |0 0 0 0 0 1 0| // |0 0 0 0 0 0 1| // T(d)r = r+dr // where // r = |x | // |x'| // |y | // |y'| // |z | // |z'| // |1 | // dr = |dx | // |0 | // |dy | // |0 | // |dz | // |0 | // |0 | for (int i=0;i<7;i++) { T.setElem(i,i,1); } T.setElem(0,6,-delx); T.setElem(2,6,-dely); T.setElem(4,6,-delz); PhaseMatrix Phidx = T.inverse().times(matPhi).times(T); return Phidx; }
    double
    IdealMagSectorDipole.compCurvature(IProbe probe)
    Deprecated.
    Compute the path curvature within the dipole for the given probe.
    double
    IdealMagWedgeDipole.compCurvature(IProbe probe)
    Deprecated.
    Compute the path curvature within the dipole for the given probe.
    double
    Element.compDriftingTime(IProbe probe, double dblLen)
    Compute the time the probe probe spends drifting a a distance dblLen.
    double
    IdealRfGapUpgraded.compEffectivePhaseAtGap(IProbe probe)
    Provided for legacy calculations.
    double
    SpectrumMapRfGap.compEffectivePhaseAtGap(IProbe probe)
    Provided for legacy calculations.
    double
    IdealRfGap.compLongFocusing(IProbe probe)
    Get the longitudinal focusing constant for a particular probe.
    double
    IdealRfGapUpgraded.compLongFocusing(IProbe probe)
    Get the longitudinal focusing constant for a particular probe.
    double
    SpectrumMapRfGap.compLongFocusing(IProbe probe)
    Get the longitudinal focusing constant for a particular probe.
    double
    IdealRfGapUpgraded.compMidGapBeta(IProbe probe)
    Compute and return the mid-gap normalized velocity for the given probe.
    double
    SpectrumMapRfGap.compMidGapBeta(IProbe probe)
    Compute and return the mid-gap normalized velocity for the given probe.
    double
    IdealMagSectorDipole2.compPathLengthVariationFactor(IProbe probe)
    Computes and returns the path length variation factor.
    double
    IdealMagSectorDipole2.compProbeCurvature(IProbe probe)
    Compute the path curvature within the dipole for the given probe.
    double
    IdealMagWedgeDipole2.compProbeCurvature(IProbe probe)
    Compute the path curvature within the dipole for the given probe.
    double
    Element.compProbeLocation(IProbe probe)
     
    double
    IdealMagSectorDipole2.compQuadrupoleConstant(IProbe probe)
    Compute and return the quadrupole focusing constant for the current dipole settings and the given probe.
    double
    IdealRfGap.compTransFocusing(IProbe probe)
    Get the transverse focusing constant for a particular probe.
    double
    IdealRfGapUpgraded.compTransFocusing(IProbe probe)
    Get the transverse focusing constant for a particular probe.
    double
    SpectrumMapRfGap.compTransFocusing(IProbe probe)
    Get the transverse focusing constant for a particular probe.
    void
     
    void
    IdealRfGapUpgraded.computeSynchronousPhaseAndEnergyGain(IProbe probe)
     
    void
     
    double
    ChargeExchangeFoil.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    Collimator.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    abstract double
    Element.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe probe to propagate through a subsection of the element with length dblLen.
    double
    IdealDrift.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe to drift through part of the element.
    double
    IdealEDipole.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe to drift through part of the element.
    double
    IdealEQuad.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe to drift through part of the element.
    double
    IdealMagDipoleFace.elapsedTime(IProbe probe)
    Deprecated.
    Returns the time taken for the probe to propagate through element.
    double
    IdealMagDipoleFace2.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    IdealMagFringeQuadFace.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    IdealMagOctupole.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    IdealMagQuad.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe to drift through part of the element.
    double
    IdealMagSectorDipole.elapsedTime(IProbe probe, double dblLen)
    Deprecated.
    Returns the time taken for the probe to drift through part of the element.
    double
    IdealMagSectorDipole2.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe to drift through part of the element.
    double
    IdealMagSextupole.elapsedTime(IProbe probe, double length)
    Determine the time taken for the probe to propagate through element.
    double
    IdealMagSkewQuad3.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe to drift through part of the element.
    double
    IdealMagSolenoid.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe to drift through part of the element.
    double
    IdealMagSteeringDipole.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    IdealPermMagQuad.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe to drift through part of the element.
    double
    IdealRfGap.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    IdealRfGapUpgraded.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    Marker.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    SpectrumMapRfGap.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    ThickDipole.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe to drift through part of the element.
    abstract double
    ThickElement.elapsedTime(IProbe probe, double dblLen)
     
    double
    ThickMatrix.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for any probe to drift through part of the element.
    protected abstract double
    ThinElement.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    ThinElement.elapsedTime(IProbe probe, double dblLen)
    Returns the time taken for the probe to drift through part of the element.
    double
    ThinLens.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    ThinMatrix.elapsedTime(IProbe probe)
    Returns the time taken for the probe to propagate through element.
    double
    ChargeExchangeFoil.energyGain(IProbe probe)
    Returns energy gain which is zero.
    double
    Collimator.energyGain(IProbe probe)
    Returns energy gain which is zero.
    abstract double
    Element.energyGain(IProbe probe, double dblLen)
    Returns energy gain for subsection of this element of length dblLen for the specified given probe.
    double
    IdealDrift.energyGain(IProbe probe, double dblLen)
    Return the energy gain imparted to a probe object.
    double
    IdealEDipole.energyGain(IProbe probe, double dblLen)
    Returns the energy gain imparted to a particular probe.
    double
    IdealEQuad.energyGain(IProbe probe, double dblLen)
    Return the energy gain imparted to a particular probe.
    double
    IdealMagDipoleFace.energyGain(IProbe probe)
    Deprecated.
    Return the energy gain for this Element.
    double
    IdealMagDipoleFace2.energyGain(IProbe probe)
    Return the energy gain for this Element.
    double
    IdealMagFringeQuadFace.energyGain(IProbe probe)
    Return the energy gain for this Element.
    double
    IdealMagOctupole.energyGain(IProbe probe)
    Returns energy gain which is zero.
    double
    IdealMagQuad.energyGain(IProbe probe, double dblLen)
    Return the energy gain imparted to a particular probe.
    double
    IdealMagSectorDipole.energyGain(IProbe probe, double dblLen)
    Deprecated.
    Return the energy gain imparted to a particular probe.
    double
    IdealMagSectorDipole2.energyGain(IProbe probe, double dblLen)
    Return the energy gain imparted to a particular probe.
    double
    IdealMagSextupole.energyGain(IProbe probe, double length)
    Determine energy gain which is zero.
    double
    IdealMagSkewQuad3.energyGain(IProbe probe, double dblLen)
    Return the energy gain imparted to a particular probe.
    double
    IdealMagSolenoid.energyGain(IProbe probe, double dblLen)
    Return the energy gain imparted to a particular probe.
    double
    IdealMagSteeringDipole.energyGain(IProbe probe)
    Return the energy gain for this Element.
    double
    IdealPermMagQuad.energyGain(IProbe probe, double dblLen)
    Return the energy ga in imparted to a particular probe.
    double
    IdealRfGap.energyGain(IProbe probe)
    Compute the energy gain of the RF gap for a probe including the effects of calculating the phase advance.
    double
    IdealRfGapUpgraded.energyGain(IProbe probe)
    Compute the energy gain of the RF gap for a probe including the effects of calculating the phase advance.
    double
    Marker.energyGain(IProbe probe)
    Returns energy gain which is zero.
    double
    SpectrumMapRfGap.energyGain(IProbe probe)
    Compute the energy gain of the RF gap for a probe including the effects of calculating the phase advance.
    double
    ThickDipole.energyGain(IProbe probe, double dblLen)
    Return the energy gain imparted to a particular probe.
    abstract double
    ThickElement.energyGain(IProbe probe, double dblLen)
    Return the energy gain of the beamline element over a subsection of the specified length.
    double
    ThickMatrix.energyGain(IProbe probe, double dblLen)
    Returns the energy gain imparted to any probe when going through part of the element.
    protected abstract double
    ThinElement.energyGain(IProbe probe)
    Calculate the energy gain for this element on the supplied probe.
    double
    ThinElement.energyGain(IProbe probe, double dblLen)
    Calculate the energy gain for this element.
    double
    ThinLens.energyGain(IProbe probe)
    Returns zero for the energy gain imparted to any probe by a thin lens.
    double
    ThinMatrix.energyGain(IProbe probe)
    Returns the energy gain of this element, which is independent of all probe parameters.
    double
    ThickDipole.getFieldIndex(IProbe probe)
    get field index nQ
    double
    IdealPermMagQuad.kFringe(IProbe probe, double dblLen)
     
    protected double
    IdealPermMagQuad.kFringeFromOthers(IProbe probe, double dblLen)
     
    abstract double
    Element.longitudinalPhaseAdvance(IProbe probe, double dblLen)
    This is a kluge to make RF gaps work, since frequency is not defined for most modeling elements.
    double
    IdealRfCavityDrift.longitudinalPhaseAdvance(IProbe probe, double dblLen)
    Computes and returns the phase advance of the probe while drifting through the given segment of this drift.
    double
    IdealRfGapUpgraded.longitudinalPhaseAdvance(IProbe probe)
    Compute and return the longitudinal phase advance (w.r.t. the RF) for the given probe while propagating through this element.
    double
    SpectrumMapRfGap.longitudinalPhaseAdvance(IProbe probe)
    Compute and return the longitudinal phase advance (w.r.t. the RF) for the given probe while propagating through this element.
    double
    ThickElement.longitudinalPhaseAdvance(IProbe probe, double dblLen)
    This is a kluge to make RF gaps work, since frequency is not defined for modeling elements outside RF cavities.
    protected double
    ThinElement.longitudinalPhaseAdvance(IProbe probe)
    Again, this is a kluge.
    double
    ThinElement.longitudinalPhaseAdvance(IProbe probe, double dblLen)
    Calculate the longitudinal phase advance through this element ignoring the length parameter (or lack thereof).
    void
    Element.propagate(IProbe probe)
    Override of IComponent.propagate(xal.model.IProbe, double) Propagates the Probe object through this element based on the associated algorithm.
    void
    Element.propagate(IProbe probe, double pos)
    Override of IComponent.propagate(xal.model.IProbe, double) Propagates the Probe object through this element based on the associated algorithm.
    void
    ElementSeq.propagate(IProbe probe)
    Propagate probe through sequence
    void
    ElementSeq.propagate(IProbe probe, double pos)
    void
    IdealRfCavity.propagate(IProbe probe)
    Sets the probes longitudinal phase to the phase of this cavity upon entrance.
    double
    IdealRfGap.simpleEnergyGain(IProbe probe)
    Compute the energy gain of the RF gap for a probe assuming a fixed default phase at the gap center.
    protected PhaseMap
    ChargeExchangeFoil.transferMap(IProbe probe)
    Returns the transfer map of this element which is the identity.
    protected PhaseMap
    Collimator.transferMap(IProbe probe)
    Returns the transfer map of this element which is the identity.
    abstract PhaseMap
    Element.transferMap(IProbe probe, double dblLen)
    Compute the transfer matrix for subsection of this element of length dblLen for the specified given probe.
    IdealDrift.transferMap(IProbe probe, double dblLen)
    Computes the partial transfer map for an ideal drift space.
    IdealEDipole.transferMap(IProbe probe, double dL)
    Computes the partial transfer map of an ideal dipole for the particular probe.
    IdealEQuad.transferMap(IProbe probe, double length)
    Compute the partial transfer map of an ideal Equadrupole for the particular probe.
    protected PhaseMap
    IdealMagDipoleFace.transferMap(IProbe probe)
    Deprecated.
     
    protected PhaseMap
    IdealMagDipoleFace2.transferMap(IProbe probe)
    Compute and return the transfer map for this dipole magnet pole face element.
    protected PhaseMap
    IdealMagFringeQuadFace.transferMap(IProbe probe)
    Compute and return the transfer map for this dipole magnet pole face element.
    protected PhaseMap
    IdealMagOctupole.transferMap(IProbe probe)
    Returns the transfer map of this element which is the identity.
    IdealMagQuad.transferMap(IProbe probe, double length)
    Compute the partial transfer map of an ideal quadrupole for the particular probe.
    IdealMagSectorDipole.transferMap(IProbe probe, double dL)
    Deprecated.
    Compute the partial transfer map of an ideal sector magnet for the particular probe.
    IdealMagSectorDipole2.transferMap(IProbe probe, double dblLen)
    Compute the partial transfer map of an ideal sector magnet for the particular probe.
    IdealMagSextupole.transferMap(IProbe probe, double length)
    Determine the transfer map of this element which is simply treated as a drift.
    IdealMagSkewQuad.transferMap(IProbe probe, double length)
    Deprecated.
    Compute the partial transfer map of an ideal skew quadrupole for the particular probe.
    IdealMagSkewQuad3.transferMap(IProbe probe, double length)
    Compute the partial transfer map of an ideal quadrupole for the particular probe.
    IdealMagSolenoid.transferMap(IProbe probe, double length)
    Compute the partial transfer map of an ideal solenoid for the particular probe.
    protected PhaseMap
    IdealMagSteeringDipole.transferMap(IProbe probe)
    Computes the transfer map for an ideal magnetic dipole.
    IdealPermMagQuad.transferMap(IProbe probe, double dblLen)
     
    IdealPermMagQuad.transferMap(IProbe probe, double dL, double k, int orientation)
    Compute the partial transfer map of an ideal permanent quadrupole for the particular probe.
    protected PhaseMap
    IdealRfGap.transferMap(IProbe probe)
    Compute the transfer map for an ideal RF gap.
    protected PhaseMap
    IdealRfGapUpgraded.transferMap(IProbe probe)
    Compute the transfer map for an ideal RF gap.
    protected PhaseMap
    Marker.transferMap(IProbe probe)
    Returns the transfer map of this element which is the identity.
    protected PhaseMap
    SpectrumMapRfGap.transferMap(IProbe probe)
    Compute the transfer map for an ideal RF gap.
    ThickDipole.transferMap(IProbe probe, double dL)
    Compute the partial transfer map of an ideal quadrupole for the particular probe.
    abstract PhaseMap
    ThickElement.transferMap(IProbe probe, double dblLen)
     
    ThickMatrix.transferMap(IProbe probe, double dblLen)
    Returns the transfer map produced by the generator matrix over the distance dblLen.
    protected abstract PhaseMap
    ThinElement.transferMap(IProbe probe)
    Compute the transfer matrix of this element.
    ThinElement.transferMap(IProbe probe, double dblLen)
    Compute the transfer matrix for subsection of this element of length dblLen for the specified given probe.
    protected PhaseMap
    ThinLens.transferMap(IProbe probe)
    Compute and return the block-diagonal transfer matrix representing a thin lens in each phase plane.
    protected PhaseMap
    ThinMatrix.transferMap(IProbe probe)
    Returns the transfer map of this element, which only has a linear component corresponding to the transfer matrix,
    IdealMagSectorDipole.transferMapThickDipole(IProbe probe, double dL)
    Deprecated.
    A version from ThickDipole.
  • Uses of IProbe in xal.model.elem.sync

    Methods in xal.model.elem.sync with parameters of type IProbe
    Modifier and Type
    Method
    Description
    void
    Compute the synchronous phase and the energy gain for a cavity gap.
  • Uses of IProbe in xal.model.probe

    Classes in xal.model.probe that implement IProbe
    Modifier and Type
    Class
    Description
    class 
    Abstract base class for all probes having beam properties.
    class 
    Simple diagnostic probe for testing the Lattice framework.
    class 
    Represents an ensemble of particles.
    class 
    EnvelopeProbe represents the RMS beam envelopes of a beam.
    class 
    ParticleProbe extends the base BeamProbe to manage a particle state which is a Vector of homogeneous phase space variables.
    class 
    Probe<S extends ProbeState<S>>
    Provides a base class implementation of the IProbe interface that is useful for most standard probe types.
    class 
    This class represents the behavior of the synchronous particle of a particle beam bunch.
    class 
    Probe that tracks all the transfer maps between modeling elements.
    class 
    EnvelopeProbe represents the RMS beam envelopes of a beam.
  • Uses of IProbe in xal.tools.beam

    Constructors in xal.tools.beam with parameters of type IProbe
    Modifier
    Constructor
    Description
     
    EnergyFinder(IProbe probe, double freq)
    constructor
  • Uses of IProbe in xal.tools.beam.optics

    Methods in xal.tools.beam.optics with parameters of type IProbe
    Modifier and Type
    Method
    Description
    static double
    BendingMagnet.compCurvature(IProbe probe, double dblFld)
    Compute the path curvature of a magnetic dipole for the given probe.