Workspace

class pyarts3.workspace.Workspace(*args, **kwargs)[source]

The workspace object containing all ARTS variables and methods

Overview

Method	`Ignore()`	Ignore a workspace variable.
Method	`OEM()`	Inversion by the so called optimal estimation method (OEM).
Method	`ReadCatalogData()`	Reads split catalog data from a folder structure similar to `arts-cat-data`
Method	`ReadXML()`	Reads a workspace variable from an XML file.
Method	`ReadXMLIndexed()`	As `ReadXML()`, but reads indexed file names.
Method	`RetrievalAddAtmosphere()`	Sets an atmospheric target.
Method	`RetrievalAddErrorPolyFit()`	Set a measurement error to polynomial fit.
Method	`RetrievalAddMagneticField()`	Set magnetic field derivative.
Method	`RetrievalAddOverlappingMagneticField()`	Set magnetic field derivative for overlapping fields.
Method	`RetrievalAddOverlappingWindField()`	Set wind field derivative for overlapping fields.
Method	`RetrievalAddPressure()`	Set pressure derivative.
Method	`RetrievalAddSensorFrequencyPolyOffset()`	Set sensor frequency derivative to use polynomial fitting offset
Method	`RetrievalAddSpeciesIsotopologueRatio()`	Set isotopologue ratio derivative
Method	`RetrievalAddSpeciesVMR()`	Set volume mixing ratio derivative.
Method	`RetrievalAddSubsurface()`	Sets a subsurface target
Method	`RetrievalAddSurface()`	Sets a surface target
Method	`RetrievalAddTemperature()`	Set temperature derivative.
Method	`RetrievalAddWindField()`	Set wind field derivative.
Method	`RetrievalFinalizeDiagonal()`	Finalize the retrieval setup.
Method	`RetrievalInit()`	Initialize the retrieval setup.
Method	`SpectralFluxDisort()`	Integrate Disort spectral radiance.
Method	`Touch()`	As `Ignore()` but for agenda output.
Method	`UpdateModelStates()`	Update state of the model in preparation for a forward model run
Method	`WignerInit()`	Initialize the Wigner tables
Method	`WignerUnload()`	Unloads the Wigner tables from static data (see `WignerInit()`)
Method	`WriteBuiltinPartitionFunctionsXML()`	Writes all the builtin partition functions to file.
Method	`WriteXML()`	Writes a workspace variable to an XML file.
Method	`WriteXMLIndexed()`	As `WriteXML()`, but creates indexed file names.
Method	`absorption_bandsFromModelState()`	Sets `absorption_bands` to the state of the model.
Method	`absorption_bandsKeepID()`	Keeps first band of ID
Method	`absorption_bandsLineMixingAdaptation()`	Adapts select band to use ordered Line mixing coefficients.
Method	`absorption_bandsReadHITRAN()`	Reads HITRAN data from a file.
Method	`absorption_bandsReadSpeciesSplitARTSCAT()`	Same as `absorption_bandsReadSpeciesSplitCatalog()` but for reading the old ARTSCAT format.
Method	`absorption_bandsReadSpeciesSplitCatalog()`	Reads all species in `absorption_species` from a basename
Method	`absorption_bandsReadSplit()`	Saves all bands in `absorption_bands` to a directory
Method	`absorption_bandsRemoveID()`	Remove first band of with a matching ID
Method	`absorption_bandsSaveSplit()`	Saves all bands fin `absorption_bands` to a directory
Method	`absorption_bandsSelectFrequencyByBand()`	Remove all bands whose lines all strictly falls outside a frequency range
Method	`absorption_bandsSelectFrequencyByLine()`	Remove all lines that strictly falls outside a frequency range
Method	`absorption_bandsSetNonLTE()`	Set all bands to use non-LTE calculations.
Method	`absorption_bandsSetZeeman()`	Set the Zeeman splitting for lines within the frequency range
Method	`absorption_cia_dataAddCIARecord()`	Takes CIARecord as input and appends the results in the appropriate place.
Method	`absorption_cia_dataReadFromCIA()`	Read data from a CIA data file for all CIA molecules defined
Method	`absorption_cia_dataReadFromXML()`	Read data from a CIA XML file and check that all CIA tags defined
Method	`absorption_cia_dataReadSpeciesSplitCatalog()`	Reads a species split CIA dataset.
Method	`absorption_lookup_tableCalc()`	Get `absorption_lookup_table` from available data.
Method	`absorption_lookup_tableFromProfiles()`	Compute the lookup table for all species in `absorption_bands`.
Method	`absorption_lookup_tableInit()`	Initialize an empty lookup table.
Method	`absorption_lookup_tablePrecompute()`	Precompute the lookup table for a single species, adding it to the map.
Method	`absorption_lookup_tablePrecomputeAll()`	Compute the lookup table for all species in `absorption_bands`.
Method	`absorption_lookup_tableSimpleWide()`	Set up a simple wide lookup table for all species in `absorption_bands`.
Method	`absorption_predefined_model_dataAddWaterMTCKD400()`	Sets the data for MT CKD 4.0 Water model
Method	`absorption_predefined_model_dataInit()`	Initialize the predefined model data
Method	`absorption_predefined_model_dataReadSpeciesSplitCatalog()`	Reads `absorption_predefined_model_data` catalog but only for `absorption_species`
Method	`absorption_speciesDefineAll()`	Sets `absorption_species` [i][0] to all species in ARTS
Method	`absorption_speciesSet()`	Set `absorption_species` to the named species.
Method	`absorption_xsec_fit_dataReadSpeciesSplitCatalog()`	Reads HITRAN Crosssection coefficients
Method	`atmospheric_fieldAbsoluteMagneticField()`	Set the magnetic field to use the magnitude field functional.
Method	`atmospheric_fieldAbsoluteWindField()`	Set the wind field to use the magnitude field functional.
Method	`atmospheric_fieldAppendAbsorptionData()`	Append data to the atmospheric field based all absorption data
Method	`atmospheric_fieldAppendBaseData()`	Append base data to the atmospheric field
Method	`atmospheric_fieldAppendCIASpeciesData()`	Append species data to the atmospheric field based on collision-induced data data
Method	`atmospheric_fieldAppendLineIsotopologueData()`	Append isotopologue data to the atmospheric field based on line data
Method	`atmospheric_fieldAppendLineLevelData()`	Append NLTE data to the atmospheric field based on line data
Method	`atmospheric_fieldAppendLineSpeciesData()`	Append species data to the atmospheric field based on line data
Method	`atmospheric_fieldAppendLookupTableSpeciesData()`	Append species data to the atmospheric field based on lookup data
Method	`atmospheric_fieldAppendPredefSpeciesData()`	Append species data to the atmospheric field based on predefined model data
Method	`atmospheric_fieldAppendTagsSpeciesData()`	Append species data to the atmospheric field based on species data
Method	`atmospheric_fieldAppendXsecSpeciesData()`	Append species data to the atmospheric field based on cross-section data
Method	`atmospheric_fieldFitNonLTE()`	Fits non-LTE atmospheric field values
Method	`atmospheric_fieldFromModelState()`	Sets `atmospheric_field` to the state of the model.
Method	`atmospheric_fieldFromProfile()`	Sets the atmospheric field to be the 1D atmospheric profile.
Method	`atmospheric_fieldHydrostaticPressure()`	Add the hydrostatic pressure to the atmospheric field
Method	`atmospheric_fieldIGRF()`	Use IGRF to compute the magnetic field at each point.
Method	`atmospheric_fieldInit()`	Initialize the atmospheric field with some altitude and isotopologue ratios
Method	`atmospheric_fieldInitializeNonLTE()`	Initialize the non-LTE atmospheric field from the LTE temperature field.
Method	`atmospheric_fieldRead()`	Read atmospheric data files from a directory
Method	`atmospheric_fieldRegrid()`	Regrid the input atmospheric field parameter to a new grid.
Method	`atmospheric_fieldRegridAll()`	Regrid all parameters of the input atmospheric field to a new grid
Method	`atmospheric_fieldSchmidthFieldFromIGRF()`	For forward calculations, this should be similar to `atmospheric_fieldIGRF()`.
Method	`atmospheric_pointInit()`	Initialize an atmospheric point with some isotopologue ratios
Method	`atmospheric_profileExtendInPressure()`	Extends the atmospheric profile in pressure.
Method	`atmospheric_profileExtract()`	Extract an atmospheric profile from the atmospheric field.
Method	`atmospheric_profileFitNonLTE()`	Fits non-LTE distributions to the level data.
Method	`atmospheric_profileFromGrid()`	Extract an atmospheric profile and its grids.
Method	`disort_settingsCosmicMicrowaveBackgroundRadiation()`	Space radiation into Disort is isotropic cosmic background radiation.
Method	`disort_settingsInit()`	Perform Disort calculations for spectral flux.
Method	`disort_settingsLayerNonThermalEmissionLinearInTau()`	Same as `disort_settingsLayerThermalEmissionLinearInTau()` but considers non-LTE
Method	`disort_settingsLayerThermalEmissionLinearInTau()`	Use a source function that changes linearly in optical thickness.
Method	`disort_settingsLegendreCoefficientsFromPath()`	Sets the legendre coefficients from the path-variable.
Method	`disort_settingsNoFractionalScattering()`	Turns off fractional scattering in Disort calculations.
Method	`disort_settingsNoLayerThermalEmission()`	Turns off source radiation in Disort calculations.
Method	`disort_settingsNoLegendre()`	Turns off Legendre coefficients in Disort calculations.
Method	`disort_settingsNoSingleScatteringAlbedo()`	Turns off single albedo scattering in Disort calculations.
Method	`disort_settingsNoSpaceEmission()`	Turns off boundary condition from space for Disort calculations.
Method	`disort_settingsNoSun()`	Turns off solar radiation in Disort calculations.
Method	`disort_settingsNoSurfaceEmission()`	Turns boundary condition from surface for Disort calculations.
Method	`disort_settingsNoSurfaceScattering()`	Turns off BDRF in Disort calculations.
Method	`disort_settingsOpticalThicknessFromPath()`	Get optical thickness from path.
Method	`disort_settingsSetSun()`	Uses Set the FOV to the sun input for Disort calculations.
Method	`disort_settingsSingleScatteringAlbedoFromPath()`	Sets the single scattering albedo from the path-variable.
Method	`disort_settingsSurfaceEmissionByTemperature()`	Surface radiation into Disort is isotropic from surface temperature.
Method	`disort_settingsSurfaceLambertian()`	Sets the surface to Lambertian.
Method	`disort_settings_agendaExecute()`	Executes `disort_settings_agenda`, see it for more details
Method	`disort_settings_agendaExecuteOperator()`	Executes an operator emulating `disort_settings_agenda`, see it, and also `disort_settings_agendaOperator`, for more details
Method	`disort_settings_agendaSetOperator()`	Set `disort_settings_agenda` to exclusively use provided external operator. See `disort_settings_agendaOperator` for more details.
Method	`disort_settings_agendaSetup()`	Setup for Disort standard calculations.
Method	`disort_spectral_flux_fieldCalc()`	Perform Disort calculations for spectral flux.
Method	`disort_spectral_flux_fieldFromAgenda()`	Use Disort for clearsky calculations of spectral flux field
Method	`disort_spectral_flux_fieldProfile()`	Extract a 1D path through the atmospheric field and calculate spectral flux using Disort
Method	`disort_spectral_radiance_fieldCalc()`	Perform Disort calculations for spectral radiance.
Method	`disort_spectral_radiance_fieldCalcCdisort()`	Perform CDisort calculations for spectral radiance.
Method	`disort_spectral_radiance_fieldFromAgenda()`	Use the disort settings agenda to calculate spectral radiance
Method	`disort_spectral_radiance_fieldFromAgendaCdisort()`	Use the disort settings agenda to calculate spectral radiance
Method	`disort_spectral_radiance_fieldProfile()`	Extract a 1D path through the atmospheric field and calculate spectral radiance using Disort
Method	`disort_spectral_radiance_fieldProfileCdisort()`	Extract a 1D path through the atmospheric field and calculate spectral radiance using Disort
Method	`ecs_dataAddMakarov2020()`	Sets the O2-66 microwave band data for ECS.
Method	`ecs_dataAddMeanAir()`	Sets ECS data for air from other data if available.
Method	`ecs_dataAddRodrigues1997()`	Sets the CO2-626, CO2-628, and CO2-636 band data for ECS.
Method	`ecs_dataAddTran2011()`	Sets the CO2-626, CO2-628, and CO2-636 band data for ECS.
Method	`ecs_dataInit()`	Resets/initializes the ECS data.
Method	`flux_profileIntegrate()`	Computes the spectral flux
Method	`frequency_gridFitNonLTE()`	Frequency grid useful for `atmospheric_profileFitNonLTE()`.
Method	`frequency_gridWindShift()`	Applies wind shift to the `frequency_grid` for the local frequency grid.
Method	`get()`	Gets the value of the variable with the given name.
Method	`gravity_operatorCentralMass()`	Sets a gravity operator from the gravitational constant and the mass of the planet
Method	`has()`	Checks if the workspace contains the variable.
Method	`init()`	Overloaded function.
Method	`inversion_iterate_agendaExecute()`	Executes `inversion_iterate_agenda`, see it for more details
Method	`inversion_iterate_agendaExecuteOperator()`	Executes an operator emulating `inversion_iterate_agenda`, see it, and also `inversion_iterate_agendaOperator`, for more details
Method	`inversion_iterate_agendaSet()`	Set `inversion_iterate_agenda` to a specific predefined option
Method	`inversion_iterate_agendaSetOperator()`	Set `inversion_iterate_agenda` to exclusively use provided external operator. See `inversion_iterate_agendaOperator` for more details.
Method	`jacobian_targetsAddAtmosphere()`	Sets an atmospheric target.
Method	`jacobian_targetsAddErrorPolyFit()`	Set a measurement error to polynomial fit.
Method	`jacobian_targetsAddMagneticField()`	Set magnetic field derivative.
Method	`jacobian_targetsAddOverlappingMagneticField()`	Set magnetic field derivative for overlapping fields.
Method	`jacobian_targetsAddOverlappingWindField()`	Set wind field derivative for overlapping fields.
Method	`jacobian_targetsAddPressure()`	Set pressure derivative.
Method	`jacobian_targetsAddSensorFrequencyPolyOffset()`	Set sensor frequency derivative to use polynomial fitting offset
Method	`jacobian_targetsAddSpeciesIsotopologueRatio()`	Set isotopologue ratio derivative
Method	`jacobian_targetsAddSpeciesVMR()`	Set volume mixing ratio derivative.
Method	`jacobian_targetsAddSubsurface()`	Sets a subsurface target
Method	`jacobian_targetsAddSurface()`	Sets a surface target
Method	`jacobian_targetsAddTemperature()`	Set temperature derivative.
Method	`jacobian_targetsAddWindField()`	Set wind field derivative.
Method	`jacobian_targetsConditionalClear()`	Clears `jacobian_targets` if `do_jacobian` evaluates false.
Method	`jacobian_targetsFinalize()`	Finalize `jacobian_targets`.
Method	`jacobian_targetsInit()`	Initialize or reset the `jacobian_targets`.
Method	`jacobian_targetsOff()`	Turns off `jacobian_targets`
Method	`jacobian_targetsToggleLogRelAtmTarget()`	Toggles logarithmic/relative or absolute retrievals.
Method	`jacobian_targetsToggleLogRelSubsurfaceTarget()`	Toggles logarithmic/relative or absolute retrievals.
Method	`jacobian_targetsToggleLogRelSurfaceTarget()`	Toggles logarithmic/relative or absolute retrievals.
Method	`jacobian_targetsToggleLogarithmicAtmTarget()`	Toggles logarithmic or absolute retrievals.
Method	`jacobian_targetsToggleLogarithmicSubsurfaceTarget()`	Toggles logarithmic or absolute retrievals.
Method	`jacobian_targetsToggleLogarithmicSurfaceTarget()`	Toggles logarithmic or absolute retrievals.
Method	`jacobian_targetsToggleRelativeAtmTarget()`	Toggles relative or absolute retrievals.
Method	`jacobian_targetsToggleRelativeHumidityAtmTarget()`	Toggles relative humidity or absolute retrievals.
Method	`jacobian_targetsToggleRelativeSubsurfaceTarget()`	Toggles relative or absolute retrievals.
Method	`jacobian_targetsToggleRelativeSurfaceTarget()`	Toggles relative or absolute retrievals.
Method	`legendre_degreeFromDisortSettings()`	Sets `legendre_degree` to `disort_settings` `legendre_polynomial_dimension`
Method	`measurement_averaging_kernelCalc()`	Calculate the averaging kernel matrix.
Method	`measurement_inversion_agendaExecute()`	Executes `measurement_inversion_agenda`, see it for more details
Method	`measurement_inversion_agendaExecuteOperator()`	Executes an operator emulating `measurement_inversion_agenda`, see it, and also `measurement_inversion_agendaOperator`, for more details
Method	`measurement_inversion_agendaSet()`	Set `measurement_inversion_agenda` to a specific predefined option
Method	`measurement_inversion_agendaSetOperator()`	Set `measurement_inversion_agenda` to exclusively use provided external operator. See `measurement_inversion_agendaOperator` for more details.
Method	`measurement_jacobianAtmosphereTransformation()`	Applies transformations to the atmospheric state Jacobian
Method	`measurement_jacobianBandTransformation()`	Applies transformations to the line-by-line state Jacobian
Method	`measurement_jacobianSensorTransformation()`	Applies transformations to the measurement sensor state Jacobian
Method	`measurement_jacobianSubsurfaceTransformation()`	Applies transformations to the subsurface state Jacobian
Method	`measurement_jacobianSurfaceTransformation()`	Applies transformations to the surface state Jacobian
Method	`measurement_jacobianTransformations()`	Apply all transformations to the Jacobian related to states in `model_state_vectorFromData()`
Method	`measurement_sensorAddRawSensor()`	Adds sensor elements from a raw perturbation of the sensor
Method	`measurement_sensorAddSimple()`	Adds a sensor with a dirac channel opening around the frequency grid.
Method	`measurement_sensorAddSimpleGaussian()`	Adds a sensor with a Gaussian channel opening around the frequency grid.
Method	`measurement_sensorAddVectorGaussian()`	Adds a sensor with a Gaussian channel opening around the frequency grid.
Method	`measurement_sensorFromModelState()`	Update `measurement_sensor` from `model_state_vector`.
Method	`measurement_sensorInit()`	Initialize `measurement_sensor` to empty.
Method	`measurement_sensorMakeExclusive()`	Make the `measurement_sensor` excluive.
Method	`measurement_sensorSimple()`	Creates a single simple dirac-opening sensor
Method	`measurement_sensorSimpleGaussian()`	Creates a single simple Gaussian-opening sensor
Method	`measurement_sensorVectorGaussian()`	Creates a single simple Gaussian-opening sensor
Method	`measurement_vectorConditionalAddError()`	Add the measurement error to the measurement. Conditionally, also to the Jacobian.
Method	`measurement_vectorFromOperatorPath()`	Sets measurement vector by looping over all sensor elements
Method	`measurement_vectorFromSensor()`	Sets measurement vector by looping over all sensor elements
Method	`measurement_vector_errorFromModelState()`	Set the error and its Jacobian from the state of the model.
Method	`measurement_vector_error_covariance_matrixConstant()`	Sets a constant measurement vector error covariance matrix.
Method	`measurement_vector_error_covariance_matrix_observation_systemCalc()`	Calculates the covariance matrix describing the error due to uncertainties in the observation system.
Method	`measurement_vector_fittedFromMeasurement()`	Sets the fitted measurement vector to the current measurement vector.
Method	`model_state_covariance_matrixAddSpeciesVMR()`	Set a species model state covariance matrix element.
Method	`model_state_covariance_matrixInit()`	Initialises the model state covariance matrix to the identity matrix.
Method	`model_state_covariance_matrix_smoothing_errorCalc()`	Calculates the covariance matrix describing the error due to smoothing.
Method	`model_state_vectorFromAtmosphere()`	Sets `model_state_vector`’s atmospheric part.
Method	`model_state_vectorFromBands()`	Sets `model_state_vector`’s absorption line part.
Method	`model_state_vectorFromData()`	Get `model_state_vector` from available data
Method	`model_state_vectorFromSensor()`	Sets `model_state_vector`’s sensor part.
Method	`model_state_vectorFromSubsurface()`	Sets `model_state_vector`’s subsurface part.
Method	`model_state_vectorFromSurface()`	Sets `model_state_vector`’s surface part.
Method	`model_state_vectorInit()`	Sets `model_state_vector` to the size `jacobian_targets` demand.
Method	`model_state_vector_aprioriFromData()`	Get `model_state_vector_apriori` from available data
Method	`model_state_vector_aprioriFromState()`	Sets the a priori state of the model state vector to the current state.
Method	`nlte_line_flux_profileIntegrate()`	Integrate the spectral flux profile to get the line non-LTE flux
Method	`propagation_matrixAddCIA()`	Add absorption coefficients for HITRAN collision induced absorption (CIA).
Method	`propagation_matrixAddFaraday()`	Calculates absorption matrix describing Faraday rotation.
Method	`propagation_matrixAddLines()`	Line-by-line calculations.
Method	`propagation_matrixAddLookup()`	Lookup calculations.
Method	`propagation_matrixAddPredefined()`	Adds all of the predefined models in `absorption_species` to the propagation_matrix
Method	`propagation_matrixAddXsecFit()`	Calculate absorption cross sections per tag group for HITRAN xsec species.
Method	`propagation_matrixInit()`	Initialize `propagation_matrix`, `propagation_matrix_source_vector_nonlte`, and their derivatives to zeroes.
Method	`propagation_matrix_agendaAuto()`	Sets the `propagation_matrix_agenda` automatically from absorption data and species tag meta information.
Method	`propagation_matrix_agendaExecute()`	Executes `propagation_matrix_agenda`, see it for more details
Method	`propagation_matrix_agendaExecuteOperator()`	Executes an operator emulating `propagation_matrix_agenda`, see it, and also `propagation_matrix_agendaOperator`, for more details
Method	`propagation_matrix_agendaSet()`	Set `propagation_matrix_agenda` to a specific predefined option
Method	`propagation_matrix_agendaSetOperator()`	Set `propagation_matrix_agenda` to exclusively use provided external operator. See `propagation_matrix_agendaOperator` for more details.
Method	`propagation_matrix_jacobianWindFix()`	Fix for the wind field derivative.
Method	`propagation_matrix_scatteringAddSpectralScatteringSpeciesTRO()`	Adds `scattering_species` results for totally random oriented spectral calculations to
Method	`propagation_matrix_scatteringAirSimple()`	Add simple air to `propagation_matrix_scattering`.
Method	`propagation_matrix_scatteringInit()`	Initialize `propagation_matrix_scattering` to zeroes.
Method	`propagation_matrix_scatteringSpectralInit()`	Initialize `propagation_matrix_scattering` and co to zeroes.
Method	`propagation_matrix_scattering_agendaExecute()`	Executes `propagation_matrix_scattering_agenda`, see it for more details
Method	`propagation_matrix_scattering_agendaExecuteOperator()`	Executes an operator emulating `propagation_matrix_scattering_agenda`, see it, and also `propagation_matrix_scattering_agendaOperator`, for more details
Method	`propagation_matrix_scattering_agendaSet()`	Set `propagation_matrix_scattering_agenda` to a specific predefined option
Method	`propagation_matrix_scattering_agendaSetOperator()`	Set `propagation_matrix_scattering_agenda` to exclusively use provided external operator. See `propagation_matrix_scattering_agendaOperator` for more details.
Method	`propagation_matrix_scattering_spectral_agendaExecute()`	Executes `propagation_matrix_scattering_spectral_agenda`, see it for more details
Method	`propagation_matrix_scattering_spectral_agendaExecuteOperator()`	Executes an operator emulating `propagation_matrix_scattering_spectral_agenda`, see it, and also `propagation_matrix_scattering_spectral_agendaOperator`, for more details
Method	`propagation_matrix_scattering_spectral_agendaSet()`	Set `propagation_matrix_scattering_spectral_agenda` to a specific predefined option
Method	`propagation_matrix_scattering_spectral_agendaSetOperator()`	Set `propagation_matrix_scattering_spectral_agenda` to exclusively use provided external operator. See `propagation_matrix_scattering_spectral_agendaOperator` for more details.
Method	`ray_pathAddGeometricGridCrossings()`	Fill the path with with points that crosses the grid of the atmspheric field.
Method	`ray_pathAddLimbPoint()`	Add the limb point to the ray path
Method	`ray_pathFillGeometricHalfStep()`	Fill the path with geometric step points.
Method	`ray_pathFillGeometricStepwise()`	Fill the path with geometric step points.
Method	`ray_pathFixUpdownAzimuth()`	Fix azimuth angle errors that can occur for 180 and 0 degrees zenith.
Method	`ray_pathGeometric()`	Get a geometric radiation path
Method	`ray_pathGeometricDownlooking()`	Wraps `ray_pathGeometric()` for straight downlooking paths from the top-of-the-atmosphere altitude
Method	`ray_pathGeometricUplooking()`	Wraps `ray_pathGeometric()` for straight uplooking paths from the surface altitude at the position
Method	`ray_pathInit()`	Initialize the ray path with a single point.
Method	`ray_pathRemoveNearby()`	Remove points that are too close to each other.
Method	`ray_pathRemoveNonAtm()`	Remove non-atmospheric points to the ray path
Method	`ray_pathRemoveNonGeometricGridCrossings()`	Remove all non-geometric grid crossings from the ray path.
Method	`ray_pathSetGeometricExtremes()`	Add the geometric extremes to the ray path.
Method	`ray_path_atmospheric_pointFromPath()`	Gets the atmospheric points along the path.
Method	`ray_path_atmospheric_pointFromProfile()`	Set `ray_path_atmospheric_point = atmospheric_profile`.
Method	`ray_path_fieldFluxProfile()`	Adds observers that covers all zenith angles for each altitude point.
Method	`ray_path_fieldFromObserverAgenda()`	Create a ray path field from a set of observers.
Method	`ray_path_frequency_gridFromPath()`	Gets the frequency grids along the path.
Method	`ray_path_observer_agendaExecute()`	Executes `ray_path_observer_agenda`, see it for more details
Method	`ray_path_observer_agendaExecuteOperator()`	Executes an operator emulating `ray_path_observer_agenda`, see it, and also `ray_path_observer_agendaOperator`, for more details
Method	`ray_path_observer_agendaSetGeometric()`	Set `ray_path_observer_agenda` from programmable geometric settings.
Method	`ray_path_observer_agendaSetOperator()`	Set `ray_path_observer_agenda` to exclusively use provided external operator. See `ray_path_observer_agendaOperator` for more details.
Method	`ray_path_observersFieldProfilePseudo2D()`	Get a list of observer positions and line of sights to represent observing all angles of a profile.
Method	`ray_path_observersFluxProfile()`	Add \(n\) observers per altitude point.
Method	`ray_path_pointBackground()`	Sets `ray_path_point` to the expected background point of `ray_path`
Method	`ray_path_pointForeground()`	Sets `ray_path_point` to the expected foreground point of `ray_path`
Method	`ray_path_pointHighestFromPath()`	Sets `ray_path_point` to the highest altitude point of `ray_path`.
Method	`ray_path_pointLowestFromPath()`	Sets `ray_path_point` to the lowest altitude point of `ray_path`.
Method	`ray_path_propagation_matrixAddScattering()`	Adds the scattering part of the propagation matrix to the rest along the path.
Method	`ray_path_propagation_matrixFromPath()`	Gets the propagation matrix and non-LTE source term along the path.
Method	`ray_path_propagation_matrix_scatteringFromPath()`	Gets the propagation matrix for scattering along the path.
Method	`ray_path_propagation_matrix_scatteringFromSpectralAgenda()`	Compute `ray_path_propagation_matrix_scattering` and co for a path.
Method	`ray_path_propagation_matrix_species_splitFromPath()`	As `ray_path_propagation_matrixFromPath()` but the output is split between the species in the
Method	`ray_path_spectral_radiance_scatteringSunsFirstOrderRayleigh()`	Add `suns` to `ray_path_spectral_radiance_source`.
Method	`ray_path_spectral_radiance_sourceAddScattering()`	Adds the scattering part of the propagation matrix to the rest along the path.
Method	`ray_path_spectral_radiance_sourceFromPropmat()`	Gets the source term along the path.
Method	`ray_path_suns_pathFromPathObserver()`	Wraps `sun_pathFromObserverAgenda()` for all paths to all suns.
Method	`ray_path_transmission_matrixFromPath()`	Gets the transmission matrix in layers along the path.
Method	`ray_path_transmission_matrix_cumulativeFromPath()`	Sets `ray_path_transmission_matrix_cumulative` by forward iteration of `ray_path_transmission_matrix`
Method	`ray_path_zeeman_magnetic_fieldFromPath()`	Sets a path of Zeeman effect magnetic field properties.
Method	`readxml()`	Read variable from file
Method	`savexml()`	Saves variable to file
Method	`scattering_speciesInit()`	Initialize scattering species.
Method	`select_species_listCollectAbsorption()`	Selects all main absorbers from the absorption data.
Method	`set()`	Set the variable to the new value.
Method	`sortedIndexOfBands()`	Get the sorting of the bands by first quantum identifier then some `criteria`
Method	`spectral_flux_profileFromPathField()`	Computes the spectral flux from a field of paths.
Method	`spectral_flux_profileFromSpectralRadianceField()`	Computes the spectral flux. The input field must be a profile.
Method	`spectral_flux_profilePseudo2D()`	Computes the spectral flux profile using pseudo-2D geometry
Method	`spectral_radianceApplyForwardUnit()`	Helper to call `spectral_radianceApplyUnit()` when you do not have `spectral_radiance_jacobian`.
Method	`spectral_radianceApplyUnit()`	Applies a unit to `spectral_radiance`, returning a new field
Method	`spectral_radianceApplyUnitFromSpectralRadiance()`	Helper method for calling `spectral_radianceApplyUnit()`.
Method	`spectral_radianceClearskyBackgroundTransmission()`	Computes clearsky transmission of spectral radiances
Method	`spectral_radianceClearskyEmission()`	Computes clearsky emission of spectral radiances
Method	`spectral_radianceClearskyRayleighScattering()`	Computes clearsky emission of spectral radiances with solar Rayleigh scattering
Method	`spectral_radianceClearskyTransmission()`	Computes clearsky transmission of spectral radiances
Method	`spectral_radianceCumulativeTransmission()`	Gets the spectral radiance from the path transmission.
Method	`spectral_radianceDefaultTransmission()`	Sets default `spectral_radiance` and `spectral_radiance_jacobian` for transmission.
Method	`spectral_radianceFlatScalarReflectance()`	Set surface spectral radiance from Planck function of the surface temperature and the reflectance of incoming radiation
Method	`spectral_radianceIntegrateDisort()`	Integrate Disort spectral radiance.
Method	`spectral_radianceStepByStepEmission()`	Gets the spectral radiance from the path.
Method	`spectral_radianceSunOrCosmicBackground()`	Get the spectral radiance of a sun or of the cosmic background if the sun is not hit.
Method	`spectral_radianceSunsOrCosmicBackground()`	Get the spectral radiance of a sun or of the cosmic background if no sun is hit.
Method	`spectral_radianceSurfaceBlackbody()`	Set surface spectral radiance from Planck function of the surface temperature
Method	`spectral_radianceUniformCosmicBackground()`	Background spectral radiance is from a uniform cosmic background temperature.
Method	`spectral_radiance_backgroundAgendasAtEndOfPath()`	Computes the background radiation.
Method	`spectral_radiance_fieldFromOperatorPath()`	Computes the spectral radiance field using `ray_path_observer_agenda`.
Method	`spectral_radiance_fieldFromOperatorPlanarGeometric()`	Computes the spectral radiance field assuming planar geometric paths
Method	`spectral_radiance_fieldProfilePseudo2D()`	Computes the spectral radiance field assuming a profile and a pseudo-2D path.
Method	`spectral_radiance_jacobianAddPathPropagation()`	Adds the propagation variables to `spectral_radiance_jacobian`
Method	`spectral_radiance_jacobianAddSensorJacobianPerturbations()`	Adds sensor properties to the `spectral_radiance_jacobian`.
Method	`spectral_radiance_jacobianEmpty()`	Set the cosmic background radiation derivative to empty.
Method	`spectral_radiance_jacobianFromBackground()`	Sets `spectral_radiance_jacobian` from the background values
Method	`spectral_radiance_observer_agendaExecute()`	Executes `spectral_radiance_observer_agenda`, see it for more details
Method	`spectral_radiance_observer_agendaExecuteOperator()`	Executes an operator emulating `spectral_radiance_observer_agenda`, see it, and also `spectral_radiance_observer_agendaOperator`, for more details
Method	`spectral_radiance_observer_agendaSet()`	Set `spectral_radiance_observer_agenda` to a specific predefined option
Method	`spectral_radiance_observer_agendaSetOperator()`	Set `spectral_radiance_observer_agenda` to exclusively use provided external operator. See `spectral_radiance_observer_agendaOperator` for more details.
Method	`spectral_radiance_operatorClearsky1D()`	Set up a 1D spectral radiance operator
Method	`spectral_radiance_space_agendaExecute()`	Executes `spectral_radiance_space_agenda`, see it for more details
Method	`spectral_radiance_space_agendaExecuteOperator()`	Executes an operator emulating `spectral_radiance_space_agenda`, see it, and also `spectral_radiance_space_agendaOperator`, for more details
Method	`spectral_radiance_space_agendaSet()`	Set `spectral_radiance_space_agenda` to a specific predefined option
Method	`spectral_radiance_space_agendaSetOperator()`	Set `spectral_radiance_space_agenda` to exclusively use provided external operator. See `spectral_radiance_space_agendaOperator` for more details.
Method	`spectral_radiance_surface_agendaExecute()`	Executes `spectral_radiance_surface_agenda`, see it for more details
Method	`spectral_radiance_surface_agendaExecuteOperator()`	Executes an operator emulating `spectral_radiance_surface_agenda`, see it, and also `spectral_radiance_surface_agendaOperator`, for more details
Method	`spectral_radiance_surface_agendaSet()`	Set `spectral_radiance_surface_agenda` to a specific predefined option
Method	`spectral_radiance_surface_agendaSetOperator()`	Set `spectral_radiance_surface_agenda` to exclusively use provided external operator. See `spectral_radiance_surface_agendaOperator` for more details.
Method	`spectral_radiance_transform_operatorSet()`	Creates a `SpectralRadianceTransformOperator` from a `SpectralRadianceUnitType`.
Method	`subsurface_fieldFromModelState()`	Sets `subsurface_field` to the state of the model.
Method	`sunBlackbody()`	Set `sun` to blackbody.
Method	`sunFromGrid()`	Extracts a sun spectrum from a field of such data.
Method	`sun_pathFromObserverAgenda()`	Find a path that hits the sun if possible
Method	`sunsAddSun()`	Add `sun` to `suns`, only exist for composability.
Method	`surface_fieldEarth()`	Earth reference ellipsoids.
Method	`surface_fieldEuropa()`	Europa reference ellipsoids.
Method	`surface_fieldFromModelState()`	Sets `surface_field` to the state of the model.
Method	`surface_fieldGanymede()`	Ganymede reference ellipsoids.
Method	`surface_fieldInit()`	Manual setting of the reference ellipsoid.
Method	`surface_fieldIo()`	Io reference ellipsoids.
Method	`surface_fieldJupiter()`	Jupiter reference ellipsoids.
Method	`surface_fieldMars()`	Mars reference ellipsoids.
Method	`surface_fieldMoon()`	Moon reference ellipsoids.
Method	`surface_fieldPlanet()`	Initialize the surface field with the ellipsoid of a planet.
Method	`surface_fieldVenus()`	Venus reference ellipsoids.
Method	`swap()`	Swap the workspace for andother.
Method	`transmission_matrix_backgroundFromPathPropagationBack()`	Sets `transmission_matrix_background` to back of `ray_path_transmission_matrix_cumulative`.
Method	`transmission_matrix_backgroundFromPathPropagationFront()`	Sets `transmission_matrix_background` to front of `ray_path_transmission_matrix_cumulative`.
Method	`water_equivalent_pressure_operatorMK05()`	Sets an operator to compute the water equivalent pressure according to Murphy and Koop, 2005.
Method	`zenith_gridProfilePseudo2D()`	A custom zenith grid for `spectral_radiance_fieldProfilePseudo2D()`
Attribute	`absorption_bands`	Bands of absorption lines for line-by-line (LBL) calculations.
Attribute	`absorption_cia_data`	HITRAN Collision-Induced Absorption (CIA) Data.
Attribute	`absorption_lookup_table`	Absorption lookup table for scalar gas absorption coefficients.
Attribute	`absorption_predefined_model_data`	This contains predefined model data.
Attribute	`absorption_species`	Tag groups for gas absorption.
Attribute	`absorption_vector_scattering`	The absorption vector of totally random orientation particles at a single point along a path using spectral representation
Attribute	`absorption_xsec_fit_data`	Fitting model coefficients for cross section species.
Attribute	`altitude`	A single altitude in the atmosphere.
Attribute	`altitude_grid`	An ascending list of `altitude`. Often related to a field or a profile.
Attribute	`atmospheric_field`	An atmospheric field in ARTS.
Attribute	`atmospheric_point`	An atmospheric point in ARTS.
Attribute	`atmospheric_profile`	An atmospheric profile in ARTS.
Attribute	`covariance_matrix_diagonal_blocks`	A helper map for setting the covariance matrix.
Attribute	`disort_fourier_mode_dimension`	The number of Fourier modes for Disort.
Attribute	`disort_legendre_polynomial_dimension`	The number of input Legendre polynimials for Disort.
Attribute	`disort_quadrature`	The quadrature angles for Disort with accompying weights.
Attribute	`disort_quadrature_dimension`	The quadrature size for Disort.
Attribute	`disort_settings`	Contains the full settings of spectral Disort calculations.
Attribute	`disort_settings_agenda`	An agenda for setting up Disort.
Attribute	`disort_spectral_flux_field`	The spectral flux field from Disort.
Attribute	`disort_spectral_radiance_field`	The spectral radiance field from Disort.
Attribute	`do_jacobian`	A boolean calculations related to the `measurement_jacobian` should be ignored.
Attribute	`ecs_data`	Error corrected sudden data
Attribute	`frequency_grid`	A single frequency grid.
Attribute	`frequency_grid_wind_shift_jacobian`	The frequency grid wind shift Jacobian.
Attribute	`gravity_operator`	The gravity operator.
Attribute	`inversion_iterate_agenda`	Work in progress …
Attribute	`inversion_iterate_agenda_counter`	A counter for the inversion iterate agenda.
Attribute	`jacobian_targets`	A list of targets for the Jacobian Matrix calculations.
Attribute	`latitude`	A single latitude.
Attribute	`latitude_grid`	An ascending list of `latitude`. Often related to a field or a profile.
Attribute	`legendre_degree`	The degree of a Legendre polynimial.
Attribute	`longitude`	A single longitude.
Attribute	`longitude_grid`	An ascending list of `longitude`. Often related to a field or a profile.
Attribute	`measurement_averaging_kernel`	Averaging kernel matrix.
Attribute	`measurement_gain_matrix`	Contribution function (or gain) matrix.
Attribute	`measurement_inversion_agenda`	This is a helper `Agenda` intended for use within `inversion_iterate_agenda`.
Attribute	`measurement_jacobian`	The first order partial derivatives of the `measurement_vector`.
Attribute	`measurement_jacobian_error`	The partial derivatives of the `measurement_vector_error`.
Attribute	`measurement_sensor`	A list of sensor elements.
Attribute	`measurement_vector`	The measurment vector for, e.g., a sensor.
Attribute	`measurement_vector_error`	The model measurment vector error for, e.g., a sensor.
Attribute	`measurement_vector_error_covariance_matrix`	Covariance matrix for observation uncertainties.
Attribute	`measurement_vector_fitted`	As `measurement_vector`, but fitted to the model.
Attribute	`model_state_covariance_matrix`	Covariance matrix of a priori distribution.
Attribute	`model_state_vector`	A state vector of the model.
Attribute	`model_state_vector_apriori`	An apriori state vector of the model.
Attribute	`nlte_line_flux_profile`	A per-line flux profile.
Attribute	`phase_matrix_scattering_spectral`	The spectral phase matrix of totally random orientation particles at a single point along a path using spectral representation
Attribute	`propagation_matrix`	This contains the fully polarized propagation matrix for the current path point.
Attribute	`propagation_matrix_agenda`	Compute the propagation matrix, the non-LTE source vector, and their derivatives.
Attribute	`propagation_matrix_jacobian`	Partial derivative of the `propagation_matrix` with regards to `jacobian_targets`.
Attribute	`propagation_matrix_scattering`	The propgation matrix of totally random orientation particles at a single point along a path using spectral representation
Attribute	`propagation_matrix_scattering_agenda`	Compute the part of the propagation matrix that relates to scattering.
Attribute	`propagation_matrix_scattering_spectral_agenda`	Get the scattering propagation matrix, the scattering absorption vector, and the scattering spectral phase matrix.
Attribute	`propagation_matrix_source_vector_nonlte`	The part of the source vector that is due to non-LTE.
Attribute	`propagation_matrix_source_vector_nonlte_jacobian`	Partial derivative of the `propagation_matrix_source_vector_nonlte` with regards to `jacobian_targets`.
Attribute	`ray_path`	A list path points making up a propagation path.
Attribute	`ray_path_absorption_vector_scattering`	The absorption vector of totally random orientation particles along the propagation path using spectral representation
Attribute	`ray_path_atmospheric_point`	Atmospheric points along the propagation path.
Attribute	`ray_path_field`	A list of `ray_path` intended to build up a field of observations.
Attribute	`ray_path_frequency_grid`	All `frequency_grid` along the propagation path.
Attribute	`ray_path_frequency_grid_wind_shift_jacobian`	A list of `frequency_grid_wind_shift_jacobian` for a ray path.
Attribute	`ray_path_observer_agenda`	Get the propagation path as it is obeserved.
Attribute	`ray_path_observers`	A list path points making up the observers of a propagation path.
Attribute	`ray_path_phase_matrix_scattering_spectral`	The spectral phase matrix of totally random orientation particles along the propagation path using spectral representation
Attribute	`ray_path_point`	A single path point.
Attribute	`ray_path_propagation_matrix`	Propagation matrices along the propagation path
Attribute	`ray_path_propagation_matrix_jacobian`	Propagation derivative matrices along the propagation path
Attribute	`ray_path_propagation_matrix_scattering`	Propagation matrices along the propagation path for scattering
Attribute	`ray_path_propagation_matrix_source_vector_nonlte`	Additional non-LTE along the propagation path
Attribute	`ray_path_propagation_matrix_source_vector_nonlte_jacobian`	Additional non-LTE derivative along the propagation path
Attribute	`ray_path_spectral_radiance_jacobian`	Spectral radiance derivative along the propagation path
Attribute	`ray_path_spectral_radiance_scattering`	Spectral radiance scattered into the propagation path
Attribute	`ray_path_spectral_radiance_source`	Source vectors along the propagation path
Attribute	`ray_path_spectral_radiance_source_jacobian`	Source derivative vectors along the propagation path
Attribute	`ray_path_suns_path`	A list of paths to the suns from the ray path.
Attribute	`ray_path_transmission_matrix`	Transmission matrices along the propagation path.
Attribute	`ray_path_transmission_matrix_cumulative`	Cumulative transmission matrices along the propagation path
Attribute	`ray_path_transmission_matrix_jacobian`	Transmission derivative matrices along the propagation path.
Attribute	`scattering_species`	The scattering species
Attribute	`select_species`	Species selection.
Attribute	`select_species_list`	Species selection.
Attribute	`spectral_flux_profile`	An altitude profile of spectral flux.
Attribute	`spectral_radiance`	A spectral radiance vector.
Attribute	`spectral_radiance_background`	Spectral radiance from the background
Attribute	`spectral_radiance_background_jacobian`	Spectral radiance derivative from the background
Attribute	`spectral_radiance_field`	The spectral radiance field.
Attribute	`spectral_radiance_jacobian`	Jacobian of `spectral_radiance` with respect to `jacobian_targets`.
Attribute	`spectral_radiance_observer_agenda`	Spectral radiance as seen from the input position and environment
Attribute	`spectral_radiance_observer_line_of_sight`	The line-of-sight of the observer of spectral radiance.
Attribute	`spectral_radiance_observer_position`	The position of an observer of spectral radiance.
Attribute	`spectral_radiance_operator`	The spectral radiance operator.
Attribute	`spectral_radiance_space_agenda`	Spectral radiance as seen of space.
Attribute	`spectral_radiance_surface_agenda`	Spectral radiance as seen of the surface.
Attribute	`spectral_radiance_transform_operator`	The spectral radiance transform operator
Attribute	`subsurface_field`	The sub0surface field describes the sub-surface properties.
Attribute	`sun`	A sun.
Attribute	`sun_path`	A path to a sun if it is visible.
Attribute	`suns`	A list of `Sun`.
Attribute	`surface_field`	The surface field describes the surface properties.
Attribute	`transmission_matrix_background`	Transmittance from the background
Attribute	`water_equivalent_pressure_operator`	The water equivalent pressure operator.
Attribute	`zenith_grid`	A single zenith angle grid.
Static Data	`pyarts3.workspace.Workspace.fromxml`	<function Workspace.fromxml at 0x7f80ce6fb560> (`function`)
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__getstate__()`
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	__init__(self, with_defaults: bool = True) -> None
Operator	`__iter__()`	Allows iter(self)
Operator	`__le__()`	Return self<=value.
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__setstate__()`
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self, with_defaults: bool = True) → None