src.Libs package

Subpackages

• src.Libs.FileIO package
  • Submodules
  • src.Libs.FileIO.FileDataClass module
    • FileData
      • FileData.createEmptyResult()
      • FileData.parseHeader()
      • FileData.parseLine()
      • FileData.printOut()
      • FileData.readData()
      • FileData.writeData()
      • FileData.writeHeader()
    • FileNameData
      • FileNameData.printOut()
  • src.Libs.FileIO.constants module
  • Module contents
• src.Libs.Simulation package
  • Subpackages
    • src.Libs.Simulation.Plots package
      • Submodules
      • src.Libs.Simulation.Plots.ArrayPlotClass module
      • Module contents
    • src.Libs.Simulation.Telescope package
      • Subpackages
      • Submodules
      • src.Libs.Simulation.Telescope.TelescopeDataClass module
      • Module contents
    • src.Libs.Simulation.UFO package
      • Submodules
      • src.Libs.Simulation.UFO.OpticsDataClass module
      • src.Libs.Simulation.UFO.UFODataClass module
      • src.Libs.Simulation.UFO.UFOGaussCalc module
      • src.Libs.Simulation.UFO.UFOTrace module
      • src.Libs.Simulation.UFO.UFO_CCode module
      • src.Libs.Simulation.UFO.constants module
      • Module contents
  • Submodules
  • src.Libs.Simulation.ArrayDataClass module
  • src.Libs.Simulation.AtmosphereDataClass module
    • Atmosphere
      • Atmosphere.SkyTransmission()
      • Atmosphere.plotData()
      • Atmosphere.printOut()
      • Atmosphere.readFile()
  • src.Libs.Simulation.BeamWeightDataClass module
    • BeamWeights
      • BeamWeights.normalize()
      • BeamWeights.plot()
      • BeamWeights.printOut()
      • BeamWeights.readFile()
      • BeamWeights.writeFile()
    • EfficiencyData
      • EfficiencyData.setEff()
    • NoiseData
      • NoiseData.setTemp()
  • src.Libs.Simulation.CSTDataClass module
    • CST
      • CST.getItemData()
      • CST.plotItem()
      • CST.printOut()
      • CST.readFarFieldSources()
  • src.Libs.Simulation.DistributionDataClass module
    • DistributionData
      • DistributionData.createDistribution()
      • DistributionData.getDisorder()
      • DistributionData.getSpacing()
      • DistributionData.plotDist()
      • DistributionData.printOut()
      • DistributionData.setGeometry()
      • DistributionData.setMinimumSpacing()
      • DistributionData.setPoints()
      • DistributionData.setSpacing()
      • DistributionData.setType()
      • DistributionData.shuffle()
  • src.Libs.Simulation.FarFieldDataClass module
    • FarFieldData
      • FarFieldData.adjustFarfield()
      • FarFieldData.calculateCurrent()
      • FarFieldData.calculateDipoleFarfieldPoint()
      • FarFieldData.calculateGaussianFarfieldPoint()
      • FarFieldData.combineFarField()
      • FarFieldData.createFarfield()
      • FarFieldData.createWaist()
      • FarFieldData.estimatePhaseCenter()
      • FarFieldData.getField()
      • FarFieldData.getFieldPoint()
      • FarFieldData.getPower()
      • FarFieldData.importFarfieldFile()
      • FarFieldData.makeMovie()
      • FarFieldData.moveCenter()
      • FarFieldData.movePhaseCenter()
      • FarFieldData.plotFarField()
      • FarFieldData.plotFarField2d()
      • FarFieldData.plotFarFieldCut()
      • FarFieldData.plotOpeningAngle()
      • FarFieldData.plotSParam()
      • FarFieldData.printOut()
      • FarFieldData.readCSTFarfieldFile()
      • FarFieldData.readUFOFarfieldFile()
      • FarFieldData.resetRotation()
      • FarFieldData.rotate()
      • FarFieldData.scaleI0()
      • FarFieldData.setCST()
      • FarFieldData.setFolder()
      • FarFieldData.setFrequency()
      • FarFieldData.setGain()
      • FarFieldData.setLog()
      • FarFieldData.setPhase()
      • FarFieldData.writeFile()
      • FarFieldData.writeSphere()
  • src.Libs.Simulation.FoVDataClass module
  • src.Libs.Simulation.ImpedanceMatrixDataClass module
    • ImpedanceMatrix
      • ImpedanceMatrix.correlate()
      • ImpedanceMatrix.correlateFields()
      • ImpedanceMatrix.getMutualPower()
      • ImpedanceMatrix.plotMatrix()
      • ImpedanceMatrix.printOut()
      • ImpedanceMatrix.readFile()
      • ImpedanceMatrix.writeFile()
  • src.Libs.Simulation.NoiseDataClass module
  • src.Libs.Simulation.SignalChainDataClass module
    • SignalChain
      • SignalChain.getData()
      • SignalChain.makeDataset()
      • SignalChain.plot()
      • SignalChain.plotSParam()
      • SignalChain.printOut()
      • SignalChain.readFile()
      • SignalChain.selectFreq()
      • SignalChain.writeFile()
  • src.Libs.Simulation.SnPDataClass module
    • SnPData
      • SnPData.export2ImpedanceMatrix()
      • SnPData.printOut()
      • SnPData.readSnP()
  • src.Libs.Simulation.constants module
  • Module contents
    • getColors()
    • makeMovie()

Submodules

src.Libs.LogClass module

This file is part of the PAFFrontendSim.

The PAFFrontendSim is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License v3 as published by the Free Software Foundation.

The PAFFrontendSim is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the PAFFrontendSim. If not, see https://www.gnu.org/licenses/.

class src.Libs.LogClass.LogClass(label='', logPath=None)

Bases: object

Module to replace Pythons built-in print function with a more complex alternative.

Since the simulator consists of multiple modules, it is important to discern the origin of printed messages. For this reason, messages printed by LogClass are preceeded by a header. This header contains the name of the module producing the message as well as the object hierarchy. Optionally all messages can be stored in .log-files. There is a .log-file for each module as well as a global file with all messages. Additionally each message has a type of importance. The importance affects the color of the text (for example red for errors). It is also relevant for the verbosity. A low verbosity setting will only cause the most important messages to be printed.

addLabel(cls='')

Add additional label to the label list.

Parameters:

cls (object) – Object of a class whose label should be added to the label

printOut(Message, message_type='user', noSpace=True, lineFeed=True)

Class console output function.

Parameters :

Message (string): Message-text message_type (string): What type of message “Message” is. User, Error, etc. noSpace (boolean): print Class-name, otherwise only spces of the same length lineFeed (boolean): print line-feed at the end of the line

setScenario(Type='')

Set predefined output scenarios.

Parameters:

Type (string) – id-string of the output scenario (so far defined, see constant-definitions above)

writelog(message, message_type)

Write the message to the log files.

Parameters:

• message (string) – The content of the message

• message_type (string) – What kind of message it is, info, warning, error, etc.

Module contents