API Reference

tiptop.overallSimulation(path2param, parametersFile, outputDir, outputFile, doConvolve=True, doPlot=False, returnRes=False, returnMetrics=False, addSrAndFwhm=True, verbose=False, getHoErrorBreakDown=False, ensquaredEnergy=False, eeRadiusInMas=50, savePSDs=False, saveJson=False, gpuIndex=0)

function to run the entire tiptop simulation based on the input file

Parameters:

  • path2param (str) – required, path to the parameter file.

  • paramFileName (str) – required, name of the parameter file to be used without the extention.

  • outpuDir – required, path to the folder in which to write the output.

  • doConvolve (bool) – optional default: False, if you want to use the natural convolution operation set to True.

  • doPlot (bool) – optional default: False, if you want to see the result in python set this to True.

  • verbose (bool) – optional default: False, If you want all messages set this to True

  • returnRes (bool) – optional default: False, The function will return the result in the environment if set to True, else it saves the result only in a .fits file.

  • returnMetrics (bool) – optional default: False, The function will return Strehl Ratio, fwhm and encircled energy within eeRadiusInMas if set to True

  • addSrAndFwhm (bool) – optional default: False, The function will add in the header of the fits file SR anf FWHM for each PSF.

  • verbose – optional default: False, If you want all messages set this to True.

  • getHoErrorBreakDown (bool) – optional default: False, If you want HO error breakdown set this to True.

  • ensquaredEnergy (bool) – optional default: False, If you want ensquared energy instead of encircled energy set this to True.

  • eeRadiusInMas (float) – optional default: 50, used together with returnMetrics, radius used for the computation of the encirlced energy (if ensquaredEnergy is selected, this is half the side of the square)

  • savePSDs (bool) – optional default: False, If you want to save PSD in the output fits file set this to True.

  • saveJson (bool) – optional default: False, If you want to save the PSF profile in a json file

  • gpuIndex (int) – optional default: 0, Target GPU index where the simulation will be run

Returns:

TBD

Return type:

TBD

tiptop.tiptopUtils.plot_directions(parser, ticks_interval=5, labels=None, LO_labels=None, science=True, low_order=True, max_pos=None, add_legend=True)

Polar plot with science and GS (sources_HO and sources_LO) directions

Parameters:

  • parser (configparser object) – required, parameters object

  • ticks_interval (int) – optional default=5, size of interval for ticks in the figure

  • labels (list) – optional default=None, list of strings to be plotted next to the science sources

  • LO_labels (list) – optional default=None, list of strings to be plotted next to the LO sources

  • science (bool) – optional default=True, activate plot of science sources

  • low_order (bool) – optional default=True, activate plot of LO sources

  • max_pos (float) – optional default=None, maximum distance from axis

  • add_legend (bool) – optional default=True, activate legend

Returns:

fig, ax

Return type:

objects