Module simpa.acc

Package simpa.acc.api.utils

Class FrequencyAnalysis

java.lang.Object

simpa.acc.api.utils.FrequencyAnalysis

public class FrequencyAnalysis
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FrequencyAnalysis.FrequencyAnalysisBuilder

Method Summary

Modifier and Type	Method	Description
static FrequencyAnalysis.FrequencyAnalysisBuilder	builder()	Creates a FrequencyAnalysis.FrequencyAnalysisBuilder object to set up the parameters for the frequency analysis.
void	calculate(String resultFile)	Calculates the diffusion coefficients for each tracking file.
void	scanTunes2D(double stepSize)	Executes the tune scan by tracking particles for the given number of turns for each point in the tune diagram.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static FrequencyAnalysis.FrequencyAnalysisBuilder builder()

Creates a FrequencyAnalysis.FrequencyAnalysisBuilder object to set up the parameters for the frequency analysis.

Returns:

The builder object.

scanTunes2D

public void scanTunes2D(double stepSize)
                 throws IOException,
KnownFatalException,
OutOfApertureException

Executes the tune scan by tracking particles for the given number of turns for each point in the tune diagram. The output files containing the phase space coordinates for each particle will be written into the output directory.

Parameters:

stepSize - The step size for the tracking.

Throws:

IOException

OutOfApertureException

KnownFatalException

calculate

public void calculate(String resultFile)
               throws FileNotFoundException

Calculates the diffusion coefficients for each tracking file. This file is the main output of frequency analysis. It is usually plotted as a heat map plot.

Parameters:

resultFile - The output file with the estimated and precisely calculated fractional tunes and the diffusion coefficients calculated from them.

Throws:

FileNotFoundException