The SKIRT project
advanced radiative transfer for astrophysics
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1234]
 NptsPython toolkit for working with SKIRT (PTS)
 NbandFacilities for representing broadband filters, including transmission curve data
 NbroadbandClass for representing broadband filters
 CBroadBandAn instance of the BroadBand class represents either a built-in standard broadband filter (including transmission curve data), a uniform filter over a specified wavelength range (with a constant transmission curve in that range), or a custom filter based on a given wavelength grid and transmission curve
 NdoExposing PTS functionality to the command line
 NcommandExecute one of the PTS command scripts from the command line
 CArgumentParserErrorAn instance of this class is raised as an exception when the argument parser wants to "exit" because of a user request for help or because of an error in the command line
 CCommandScriptThe CommandScript class encapsulates a particular PTS command script
 CLoggingArgumentParserThis class overrides the output functions in the argument parser to send all output to the logger instead of directly to stdin or stderr
 NsimulationFacilities interfacing with the SKIRT executable and simulation input and output files
 NhealpixHandling of HEALPix grids
 CHEALPixGridThis class represents a HEALPix grid
 NsimulationRepresenting the files related to a SKIRT simulation
 C_SimulationEntityThis class serves as an abstract base class for the Instrument and Probe classes
 CInstrumentAn instance of the Instrument class can be spawned from a Simulation object to represent an instrument in the simulation, allowing to retrieve its attributes
 CProbeAn instance of the Probe class can be spawned from a Simulation object to represent a probe in the simulation, allowing to retrieve its attributes
 CSimulationAn instance of the Simulation class represents all input and output files related to a single performed SKIRT simulation
 NskifileReading from and adjusting a SKIRT parameter file
 CSkiFileAn instance of the SkiFile class represents a particular existing SKIRT parameter file (ski file)
 NskirtExecuting the SKIRT command line application
 CSkirtAn instance of the Skirt class represents a particular SKIRT executable, and allows invoking it with given command line arguments for execution on the local host
 NstoredtableSupport for handling SKIRT stored table and stored columns formats
 NconversionspecFacilities for representing SKIRT resource conversion specifications
 CConversionSpecAn instance of this class represents a particular specification for converting some original data (in some given format) to the SKIRT stored table format, and it provides facilities to actually perform the specified conversion by calling upon the appropriate functionality outside this module
 CConversionSpecsAn instance of this class aggregates a set of ConversionSpec instances with facilities to perform them as a group
 NtokenizedfileRead a text file token by token
 CTokenizedFileThis class allows reading a text file token by token (where tokens are separated by whitespace), while still allowing to skip complete lines where needed
 NtestFacilities for testing SKIRT
 NfunctionalContains the SkirtTestSuite class for performing a suite of SKIRT test cases
 CSkirtTestSuiteAn instance of the SkirtTestSuite class represents a suite of SKIRT test cases, stored as a nested structure of files and directories according to a specific layout, and provides facilities to perform the tests, verify the results, and prepare a summary test report
 NutilsGeneral utilities
 NerrorCustom exceptions for use in PTS
 CUserErrorAn instance of this class should be raised by PTS scripts when a fatal problem is most likely caused by a user error as opposed to a programming error
 NvisualFacilities for visualizing SKIRT-related data through plots and images
 NmoviefileCreating a movie file from a sequence of still images
 CMovieFileAn instance of the MovieFile class allows creating a movie file from a sequence of still images
 NrgbimageManaging a color image in various representations
 C_CubicSplineAn instance of the CubicSpline class implements a function \(y=f(x)\) composed of three cubic spline segments of the form \(y=ax^3+bx^2+cx+d\)
 CRGBImageAn instance of the RGBImage class represents a single RGB color image, i.e