Module simpa.acc

Package simpa.acc.api

Class AccCli

java.lang.Object

simpa.acc.api.AccCli

public class AccCli
extends Object

Class that specifies all the commands that can be used in the CLI using the CLI library apart from some extra commands.

Constructor Summary

Constructors

Constructor	Description
AccCli()

Method Summary

Modifier and Type	Method	Description
Sequence	activeSequence()
void	addArbitrary(String elementName, Double scaling, Double longiPos, String group, String etn, Map<Double,Profile> profileMap, String pathFile, org.apache.commons.math3.geometry.euclidean.threed.Vector3D localY)
void	addBending(String elementName, Double scaling, double length, double deflection, Double tilt, Double longPos, String etn, String group, Map<Double,Profile> profileMap, org.apache.commons.math3.geometry.euclidean.threed.Rotation rot, BendingType bendingType)
void	addBPM(BpmPlane plane, String name, Double lpos, Map<Double,Profile> profileMap)
void	addMarker(String name, Double lpos, Map<Double,Profile> profileMap)
void	addStraight(String elementName, Double scaling, Double tilt, Double longPos, String group, String etn, Map<Double,Profile> profileMap, org.apache.commons.math3.geometry.euclidean.threed.Rotation rot)
Beam	beamFromFile(ParticleType type, Double mom, Double lPos, Double mass, Double charge, String name, String file)
TwissParameters	beamTwiss(String file)
Matcher	bobyqaMatcher(Integer ipn, Double initialRegion, Double stopFitness, Integer maxIter, MatchingTarget[] targets, MatchingVariable[] variables)
double[]	calculateChromaticity(String file1, String file2, Integer turns, double dpop)
void	calculateTunes(String file, Integer turns, Integer startTurn, String directory, String outFile)
void	checkField(TilingConfig tconfig)
Matcher	cmaesMatcher(MatchingTarget[] targets, MatchingVariable[] variables, Double stopFitness, Integer maxIter, Boolean isActiveCMA, Double[] sigmas, Integer checkFeasableCount, Integer populationSize)
void	convertTrajectory(String particleName, String beamName, double diskr, String outFile, Boolean backward)
void	createAccElement(TilingConfig tconfig, Double relativeError, SolverPreset solverPreset, Double bjar, Double bjpr, Integer sliceWidth, Integer sliceOverlap, Integer gmresRestart, Boolean debug)
Beam	createBeam(ParticleType type, Double mom, Double he, Double ve, Double lPos, Double dpOp, Double mass, Double charge, String name, BeamDistribution distribution, Integer nParticles, TwissParameters twiss)
String	createBeamRegion(Profile profile, double distance, Double ballRadius, Double extention)
void	createBendingPath(Double deflectionAngle, Double bendingRadius, Integer nSegments, Double extentionLength, String name, org.apache.commons.math3.geometry.euclidean.threed.Vector3D translation, org.apache.commons.math3.geometry.euclidean.threed.Rotation rot, BendingType bendingType)
void	createCheckpointFile(TilingConfig tconfig, org.apache.commons.math3.geometry.euclidean.threed.Vector3D translation, Double extension, Double stepSize)
Profile	createEllipseProfile(double xrad, double yrad, int steps, Double startAngle)
void	createFieldMaps(String file, String groupName, Boolean oneByOne, int lmax, Integer pass1Lmax, Double relativeError, Boolean stat)
Particle	createParticle(ParticleType type, Double mom, Double dx, Double ax, Double dy, Double ay, Double lPos, Double dpOp, Double mass, Double charge, String name)
Profile	createRectProfile(double xmin, double xmax, double ymin, double ymax, int xsteps, int ysteps)
org.apache.commons.math3.geometry.euclidean.threed.Rotation	createRotation(org.apache.commons.math3.geometry.euclidean.threed.Vector3D v1, org.apache.commons.math3.geometry.euclidean.threed.Vector3D v2, org.apache.commons.math3.geometry.euclidean.threed.Vector3D v3, org.apache.commons.math3.geometry.euclidean.threed.Vector3D v4, Double angle)
void	createSequence(String name, Double orbitStep, Boolean circular, LocalFrameStrategyOption strategyOption, org.apache.commons.math3.geometry.euclidean.threed.Vector3D vertical)
String	createSingleRowCover(double apertureRadius, double ballRadius)
void	createStraightPath(Double sx, Double sy, Double sz, Double ex, Double ey, Double ez, String elementName, Integer nSteps)
TilingConfig	createTilingConfig(String elementName, Profile profile, LengthUnit unit, double elevation, OutputFileFormatOption outputFileFormat, double fieldScalingFactor, TileTypeOption tileType, FieldTypeOption fieldType)
TwissParameters	createTwiss(Double x, Double xp, Double y, Double yp, Double ha, Double va, Double hb, Double vb, Double dispH, Double dispV, Double dispPrimeH, Double dispPrimeV, Double emH, Double emV, Double muH, Double muV, Double dpop, Double lPos)
Map<Double,Profile>	createVacuumChamber(HashMap<Object,Double[]> distances)
org.apache.commons.math3.geometry.euclidean.threed.Vector3D	createVector3D(double x, double y, double z)
void	elementFrom(String seqName, String name)
void	endSequence(String outputFile, String lfFile, Integer increment, String lcFileName)
void	fieldOnCurve(Map<String,Double> map, org.apache.commons.math3.geometry.euclidean.threed.Vector3D shift, String outputFile, Boolean localFrame)
static cli.api.CommandInterpreter	getCommandInterpreter()	Method to get the CommandInterpreter object.
static cli.api.CliState	getState()
Object	javaCall(String externalClassName, String internalClassName, String pathToClass, String methodName, Object[] methodParameters, Object[] constructorParameters)
Optics	lineOptics(Beam b0, Beam b1, Double stepsize, double diskRadius, String outFile, Boolean backward, Boolean writeTrajectory)
static void	main(String[] args)
Map<String,Double>	match(Beam b0, Beam b1, Particle p0, Particle p1, Double diskRadius, Double stepSize, Matcher matcher, Boolean backward, String file, Double lossPenalty, TwissParameters initialTwiss)
MatchingTarget	matchingTarget(Double longiPos, MatchingTargetType type, Double value, Double upperLimit, Double lowerLimit, Double weight)
MatchingVariable	matchingVariable(String fieldMapFile, MatchingVariableType type, Double min, Double max, Double guess)
void	mirrorPath(String inFile, String outFile, LengthUnit unit)
void	orbitAtBPMs(String hOutFile, String vOutFile)
void	plot(PlotTypeOption type, String name, Boolean vectorField, String fileName, Double vectorScale)
void	resamplePath(String inFile, String outFile, Integer steps, Double[] distances, String distFile, Boolean relDist, Double x, Double y, Double z)
void	ringOptics(Particle p1, Particle p2, Double stepsize, double diskRadius, String outFile, Integer turns, Boolean writeTrajectory)
void	sequenceSourcesToFile(String f)
void	setIntegrator(IntegratorTypeOption type, Double omega)
void	setScalings(Map<String,Double> map, Boolean enableExternal)
void	survey(Double x0, Double y0, Double z0, Double theta0, Double phi0, Double psi0, String file, String elementName)
int	systemCall(String command)
void	track(Particle particle, Beam beam, Integer turns, Double stepSize, Double[] phoLongiPosArray, Double diskRadius, Boolean trajectoryObserver, String sigmaFile, Boolean debug, Integer threads, Boolean backward)
void	transformAccElement(String name, org.apache.commons.math3.geometry.euclidean.threed.Rotation rot, org.apache.commons.math3.geometry.euclidean.threed.Vector3D translation, Boolean inverseRot, Boolean inverseTransl, String outName)
TwissParameters	twiss(String file)
void	updateScalings(Map<String,Double> map)
void	useSequence(String name)
void	writeSurfacePoints(TilingConfig tconfig)

Methods inherited from class java.lang.Object

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

Constructor Details

AccCli

public AccCli()

Method Details

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException

getCommandInterpreter

public static cli.api.CommandInterpreter getCommandInterpreter()
                                                        throws IOException

Method to get the CommandInterpreter object. The command interpreter can be used to execute simpa commands.

Returns:

The command interpreter.

Throws:

IOException

getState

public static cli.api.CliState getState()
                                 throws IOException

Returns:

The current state of the command line interface.

Throws:

IOException - if the state cannot be created.

activeSequence

public Sequence activeSequence()

addArbitrary

public void addArbitrary(String elementName,
 Double scaling,
 Double longiPos,
 String group,
 String etn,
 Map<Double,Profile> profileMap,
 String pathFile,
 org.apache.commons.math3.geometry.euclidean.threed.Vector3D localY)
                  throws IllegalAccessException,
FileNotFoundException

Throws:

IllegalAccessException

FileNotFoundException

addBending

public void addBending(String elementName,
 Double scaling,
 double length,
 double deflection,
 Double tilt,
 Double longPos,
 String etn,
 String group,
 Map<Double,Profile> profileMap,
 org.apache.commons.math3.geometry.euclidean.threed.Rotation rot,
 BendingType bendingType)

addBPM

public void addBPM(BpmPlane plane,
 String name,
 Double lpos,
 Map<Double,Profile> profileMap)
            throws IllegalArgumentException

Throws:

IllegalArgumentException

addMarker

public void addMarker(String name,
 Double lpos,
 Map<Double,Profile> profileMap)
               throws IllegalArgumentException

Throws:

IllegalArgumentException

addStraight

public void addStraight(String elementName,
 Double scaling,
 Double tilt,
 Double longPos,
 String group,
 String etn,
 Map<Double,Profile> profileMap,
 org.apache.commons.math3.geometry.euclidean.threed.Rotation rot)
                 throws IllegalAccessException

Throws:

IllegalAccessException

beamFromFile

public Beam beamFromFile(ParticleType type,
 Double mom,
 Double lPos,
 Double mass,
 Double charge,
 String name,
 String file)
                  throws OutOfApertureException,
KnownFatalException,
FileNotFoundException

Throws:

OutOfApertureException

KnownFatalException

FileNotFoundException

beamTwiss

public TwissParameters beamTwiss(String file)
                          throws IOException

Throws:

IOException

bobyqaMatcher

public Matcher bobyqaMatcher(Integer ipn,
 Double initialRegion,
 Double stopFitness,
 Integer maxIter,
 MatchingTarget[] targets,
 MatchingVariable[] variables)

calculateChromaticity

public double[] calculateChromaticity(String file1,
 String file2,
 Integer turns,
 double dpop)
                               throws FileNotFoundException

Throws:

FileNotFoundException

calculateTunes

public void calculateTunes(String file,
 Integer turns,
 Integer startTurn,
 String directory,
 String outFile)
                    throws FileNotFoundException

Throws:

FileNotFoundException

checkField

public void checkField(TilingConfig tconfig)
                throws FileNotFoundException,
NotSetException

Throws:

FileNotFoundException

NotSetException

cmaesMatcher

public Matcher cmaesMatcher(MatchingTarget[] targets,
 MatchingVariable[] variables,
 Double stopFitness,
 Integer maxIter,
 Boolean isActiveCMA,
 Double[] sigmas,
 Integer checkFeasableCount,
 Integer populationSize)

convertTrajectory

public void convertTrajectory(String particleName,
 String beamName,
 double diskr,
 String outFile,
 Boolean backward)
                       throws IOException

Throws:

IOException

createAccElement

public void createAccElement(TilingConfig tconfig,
 Double relativeError,
 SolverPreset solverPreset,
 Double bjar,
 Double bjpr,
 Integer sliceWidth,
 Integer sliceOverlap,
 Integer gmresRestart,
 Boolean debug)
                      throws NotSetException,
PositionMismatchException

Throws:

NotSetException

PositionMismatchException

createBeam

public Beam createBeam(ParticleType type,
 Double mom,
 Double he,
 Double ve,
 Double lPos,
 Double dpOp,
 Double mass,
 Double charge,
 String name,
 BeamDistribution distribution,
 Integer nParticles,
 TwissParameters twiss)
                throws OutOfApertureException,
KnownFatalException

Throws:

OutOfApertureException

KnownFatalException

createBeamRegion

public String createBeamRegion(Profile profile,
 double distance,
 Double ballRadius,
 Double extention)
                        throws FileNotFoundException,
KnownFatalException

Throws:

FileNotFoundException

KnownFatalException

createBendingPath

public void createBendingPath(Double deflectionAngle,
 Double bendingRadius,
 Integer nSegments,
 Double extentionLength,
 String name,
 org.apache.commons.math3.geometry.euclidean.threed.Vector3D translation,
 org.apache.commons.math3.geometry.euclidean.threed.Rotation rot,
 BendingType bendingType)

createCheckpointFile

public void createCheckpointFile(TilingConfig tconfig,
 org.apache.commons.math3.geometry.euclidean.threed.Vector3D translation,
 Double extension,
 Double stepSize)
                          throws FileNotFoundException,
NotSetException

Throws:

FileNotFoundException

NotSetException

createEllipseProfile

public Profile createEllipseProfile(double xrad,
 double yrad,
 int steps,
 Double startAngle)

createParticle

public Particle createParticle(ParticleType type,
 Double mom,
 Double dx,
 Double ax,
 Double dy,
 Double ay,
 Double lPos,
 Double dpOp,
 Double mass,
 Double charge,
 String name)
                        throws OutOfApertureException,
KnownFatalException

Throws:

OutOfApertureException

KnownFatalException

createRectProfile

public Profile createRectProfile(double xmin,
 double xmax,
 double ymin,
 double ymax,
 int xsteps,
 int ysteps)

createRotation

public org.apache.commons.math3.geometry.euclidean.threed.Rotation createRotation(org.apache.commons.math3.geometry.euclidean.threed.Vector3D v1,
 org.apache.commons.math3.geometry.euclidean.threed.Vector3D v2,
 org.apache.commons.math3.geometry.euclidean.threed.Vector3D v3,
 org.apache.commons.math3.geometry.euclidean.threed.Vector3D v4,
 Double angle)

createSequence

public void createSequence(String name,
 Double orbitStep,
 Boolean circular,
 LocalFrameStrategyOption strategyOption,
 org.apache.commons.math3.geometry.euclidean.threed.Vector3D vertical)

createSingleRowCover

public String createSingleRowCover(double apertureRadius,
 double ballRadius)

plot

public void plot(PlotTypeOption type,
 String name,
 Boolean vectorField,
 String fileName,
 Double vectorScale)
          throws IOException

Throws:

IOException

createTilingConfig

public TilingConfig createTilingConfig(String elementName,
 Profile profile,
 LengthUnit unit,
 double elevation,
 OutputFileFormatOption outputFileFormat,
 double fieldScalingFactor,
 TileTypeOption tileType,
 FieldTypeOption fieldType)
                                throws FileNotFoundException

Throws:

FileNotFoundException

createStraightPath

public void createStraightPath(Double sx,
 Double sy,
 Double sz,
 Double ex,
 Double ey,
 Double ez,
 String elementName,
 Integer nSteps)
                        throws IOException

Throws:

IOException

createTwiss

public TwissParameters createTwiss(Double x,
 Double xp,
 Double y,
 Double yp,
 Double ha,
 Double va,
 Double hb,
 Double vb,
 Double dispH,
 Double dispV,
 Double dispPrimeH,
 Double dispPrimeV,
 Double emH,
 Double emV,
 Double muH,
 Double muV,
 Double dpop,
 Double lPos)
                            throws OutOfApertureException,
KnownFatalException

Throws:

OutOfApertureException

KnownFatalException

createVector3D

public org.apache.commons.math3.geometry.euclidean.threed.Vector3D createVector3D(double x,
 double y,
 double z)

endSequence

public void endSequence(String outputFile,
 String lfFile,
 Integer increment,
 String lcFileName)

javaCall

public Object javaCall(String externalClassName,
 String internalClassName,
 String pathToClass,
 String methodName,
 Object[] methodParameters,
 Object[] constructorParameters)

createFieldMaps

public void createFieldMaps(String file,
 String groupName,
 Boolean oneByOne,
 int lmax,
 Integer pass1Lmax,
 Double relativeError,
 Boolean stat)
                     throws IOException

Throws:

IOException

fieldOnCurve

public void fieldOnCurve(Map<String,Double> map,
 org.apache.commons.math3.geometry.euclidean.threed.Vector3D shift,
 String outputFile,
 Boolean localFrame)
                  throws OutOfApertureException,
KnownFatalException,
IOException

Throws:

OutOfApertureException

KnownFatalException

IOException

createVacuumChamber

public Map<Double,Profile> createVacuumChamber(HashMap<Object,Double[]> distances)

lineOptics

public Optics lineOptics(Beam b0,
 Beam b1,
 Double stepsize,
 double diskRadius,
 String outFile,
 Boolean backward,
 Boolean writeTrajectory)
                  throws IOException

Throws:

IOException

match

public Map<String,Double> match(Beam b0,
 Beam b1,
 Particle p0,
 Particle p1,
 Double diskRadius,
 Double stepSize,
 Matcher matcher,
 Boolean backward,
 String file,
 Double lossPenalty,
 TwissParameters initialTwiss)
                         throws IllegalArgumentException

Throws:

IllegalArgumentException

matchingTarget

public MatchingTarget matchingTarget(Double longiPos,
 MatchingTargetType type,
 Double value,
 Double upperLimit,
 Double lowerLimit,
 Double weight)
                              throws IllegalArgumentException

Throws:

IllegalArgumentException

matchingVariable

public MatchingVariable matchingVariable(String fieldMapFile,
 MatchingVariableType type,
 Double min,
 Double max,
 Double guess)
                                  throws IllegalArgumentException

Throws:

IllegalArgumentException

mirrorPath

public void mirrorPath(String inFile,
 String outFile,
 LengthUnit unit)
                throws FileNotFoundException

Throws:

FileNotFoundException

orbitAtBPMs

public void orbitAtBPMs(String hOutFile,
 String vOutFile)
                 throws IOException

Throws:

IOException

resamplePath

public void resamplePath(String inFile,
 String outFile,
 Integer steps,
 Double[] distances,
 String distFile,
 Boolean relDist,
 Double x,
 Double y,
 Double z)
                  throws IOException

Throws:

IOException

ringOptics

public void ringOptics(Particle p1,
 Particle p2,
 Double stepsize,
 double diskRadius,
 String outFile,
 Integer turns,
 Boolean writeTrajectory)
                throws IOException

Throws:

IOException

sequenceSourcesToFile

public void sequenceSourcesToFile(String f)

setIntegrator

public void setIntegrator(IntegratorTypeOption type,
 Double omega)

setScalings

public void setScalings(Map<String,Double> map,
 Boolean enableExternal)
                 throws Exception

Throws:

Exception

survey

public void survey(Double x0,
 Double y0,
 Double z0,
 Double theta0,
 Double phi0,
 Double psi0,
 String file,
 String elementName)

systemCall

public int systemCall(String command)
               throws Exception

Throws:

Exception

track

public void track(Particle particle,
 Beam beam,
 Integer turns,
 Double stepSize,
 Double[] phoLongiPosArray,
 Double diskRadius,
 Boolean trajectoryObserver,
 String sigmaFile,
 Boolean debug,
 Integer threads,
 Boolean backward)
           throws KnownFatalException,
IOException

Throws:

KnownFatalException

IOException

transformAccElement

public void transformAccElement(String name,
 org.apache.commons.math3.geometry.euclidean.threed.Rotation rot,
 org.apache.commons.math3.geometry.euclidean.threed.Vector3D translation,
 Boolean inverseRot,
 Boolean inverseTransl,
 String outName)
                         throws IOException

Throws:

IOException

twiss

public TwissParameters twiss(String file)
                      throws IOException

Throws:

IOException

updateScalings

public void updateScalings(Map<String,Double> map)
                    throws Exception

Throws:

Exception

useSequence

public void useSequence(String name)

elementFrom

public void elementFrom(String seqName,
 String name)

writeSurfacePoints

public void writeSurfacePoints(TilingConfig tconfig)
                        throws NotSetException

Throws:

NotSetException