Workspace
- class pyarts.workspace.Workspace(*args, **kwargs)[source]
The workspace object containing all ARTS variables and methods
Overview
Method
Ignore a workspace variable.
Method
Inversion by the so called optimal estimation method (OEM).
Method
Reads split catalog data from a folder structure similar to
arts-cat-data
Method
Reads a workspace variable from an XML file.
Method
As
ReadXML()
, but reads indexed file names.Method
Sets an atmospheric target
Method
Set magnetic field derivative
Method
Set pressure derivative
Method
Set sensor frequency derivative to use polynomial fitting offset
Method
Set isotopologue ratio derivative
Method
Set volume mixing ratio derivative
Method
Sets a surface target
Method
Set temperature derivative
Method
Set wind field derivative
Method
Finalize the retrieval setup.
Method
Initialize the retrieval setup.
Method
Integrate Disort spectral radiance.
Method
As
Ignore()
but for agenda output.Method
Update state of the model in preparation for a forward model run
Method
Initialize the Wigner tables
Method
Unloads the Wigner tables from static data (see
WignerInit()
)Method
Writes all the builtin partition functions to file.
Method
Writes a workspace variable to an XML file.
Method
As
WriteXML()
, but creates indexed file names.Method
Reads old style catalog but only for
absorption_species
Method
Gets modern line catalog from old style
Method
Sets
absorption_bands
to the state of the model.Method
Keeps first band of ID
Method
Adapts select band to use ordered Line mixing coefficients.
Method
Reads HITRAN data from a file.
Method
Saves all bands fin
absorption_bands
to a directoryMethod
Saves all bands fin
absorption_bands
to a directoryMethod
Remove first band of with a matching ID
Method
Saves all bands fin
absorption_bands
to a directoryMethod
Remove all lines/bands that strictly falls outside a frequency range
Method
Set the Zeeman splitting for lines within the frequency range
Method
Takes CIARecord as input and appends the results in the appropriate place.
Method
Read data from a CIA data file for all CIA molecules defined
Method
Read data from a CIA XML file and check that all CIA tags defined
Method
Reads a species split CIA dataset.
Method
Get
absorption_lookup_table
from available data.Method
Compute the lookup table for all species in
absorption_bands
.Method
Initialize an empty lookup table.
Method
Precompute the lookup table for a single species, adding it to the map.
Method
Compute the lookup table for all species in
absorption_bands
.Method
Set up a simple wide lookup table for all species in
absorption_bands
.Method
Sets the data for MT CKD 4.0 Water model
Method
Initialize the predefined model data
Method
Reads
absorption_predefined_model_data
catalog but only forabsorption_species
Method
Sets
absorption_species
[i][0] to all species in ARTSMethod
Set up a list of absorption species tag groups.
Method
Reads HITRAN Crosssection coefficients
Method
Append data to the atmospheric field based all absorption data
Method
Append base data to the atmospheric field
Method
Append species data to the atmospheric field based on collision-induced data data
Method
Append isotopologue data to the atmospheric field based on line data
Method
Append NLTE data to the atmospheric field based on line data
Method
Append species data to the atmospheric field based on line data
Method
Append species data to the atmospheric field based on predefined model data
Method
Append species data to the atmospheric field based on species data
Method
Append species data to the atmospheric field based on cross-section data
Method
Sets
atmospheric_field
to the state of the model.Method
Add the hydrostatic pressure to the atmospheric field
Method
Use IGRF to compute the magnetic field at each point.
Method
Initialize the atmospheric field with some altitude and isotopologue ratios
Method
Reads absorption file from a directory
Method
Regrid the input atmospheric field parameter to a new grid.
Method
Regrid all parameters of the input atmospheric field to a new grid
Method
Initialize an atmospheric point with some isotopologue ratios
Method
Space radiation into Disort is isotropic cosmic background radiation.
Method
Perform Disort calculations for spectral flux.
Method
Use a source function that changes linearly in optical thickness.
Method
Turns off fractional scattering in Disort calculations.
Method
Turns off source radiation in Disort calculations.
Method
Turns off Legendre coefficients in Disort calculations.
Method
Turns off single albedo scattering in Disort calculations.
Method
Turns off boundary condition from space for Disort calculations.
Method
Turns off solar radiation in Disort calculations.
Method
Turns boundary condition from surface for Disort calculations.
Method
Turns off BDRF in Disort calculations.
Method
Get optical thickness from path.
Method
Uses Set the FOV to the sun input for Disort calculations.
Method
Surface radiation into Disort is isotropic from surface temperature.
Method
Turns off BDRF in Disort calculations.
Method
Executes
disort_settings_agenda
, see it for more detailsMethod
Method
Perform Disort calculations for spectral flux.
Method
Use Disort for clearsky calculations of spectral flux field
Method
Use Disort for clearsky calculations of spectral flux field
Method
Perform Disort calculations for spectral radiance.
Method
Use the disort settings agenda to calculate spectral radiance
Method
Use Disort for clearsky calculations of spectral flux field
Method
Sets the O2-66 microwave band data for ECS.
Method
Sets ECS data for air from other data if available.
Method
Sets the CO2-626, CO2-628, and CO2-636 band data for ECS.
Method
Sets the CO2-626, CO2-628, and CO2-636 band data for ECS.
Method
Resets/initializes the ECS data.
Method
Applies wind shift to the
frequency_grid
for the local frequency grid.Method
Gets the value of the variable with the given name.
Method
Sets a gravity operator from the gravitational constant and the mass of the planet
Method
Checks if the workspace contains the variable.
Method
Overloaded function.
Method
Executes
inversion_iterate_agenda
, see it for more detailsMethod
Sets an atmospheric target
Method
Set magnetic field derivative
Method
Set pressure derivative
Method
Set sensor frequency derivative to use polynomial fitting offset
Method
Set isotopologue ratio derivative
Method
Set volume mixing ratio derivative
Method
Sets a surface target
Method
Set temperature derivative
Method
Set wind field derivative
Method
Finalize
jacobian_targets
.Method
Initialize or reset the
jacobian_targets
Method
Calculate the averaging kernel matrix.
Method
Adds a sensor with a dirac channel opening around the frequency grid.
Method
Adds a sensor with a Gaussian channel opening around the frequency grid.
Method
Adds a sensor with a Gaussian channel opening around the frequency grid.
Method
Update
measurement_sensor
frommodel_state_vector
.Method
Initialize
measurement_sensor
to empty.Method
Wrapper for a single simple dirac-opening sensor
Method
Wrapper for a single simple Gaussian-opening sensor
Method
Wrapper for a single simple Gaussian-opening sensor
Method
Sets measurement vector by looping over all sensor elements
Method
Sets measurement vector by looping over all sensor elements
Method
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
Method
Sets the fitted measurement vector to the current measurement vector.
Method
Set a species model state covariance matrix element.
Method
Initialises the model state covariance matrix to the identity matrix.
Method
Calculates the covariance matrix describing the error due to smoothing.
Method
Sets
model_state_vector
’s atmospheric part.Method
Sets
model_state_vector
’s absorption line part.Method
Get
model_state_vector
from available dataMethod
Sets
model_state_vector
’s sensor part.Method
Sets
model_state_vector
’s surface part.Method
Sets
model_state_vector
to the sizejacobian_targets
demand.Method
Sets
model_state_vector
to 0.0Method
Get
model_state_vector_apriori
from available dataMethod
Sets the a priori state of the model state vector to the current state.
Method
Calculate absorption coefficients per tag group for HITRAN CIA continua.
Method
Calculates absorption matrix describing Faraday rotation.
Method
Line-by-line calculations.
Method
Lookup calculations
Method
Adds all of the predefined models in
absorption_species
to the propagation_matrixMethod
Calculate absorption cross sections per tag group for HITRAN xsec species.
Method
Initialize
propagation_matrix
,propagation_matrix_source_vector_nonlte
, and their derivatives to zeroes.Method
Sets the
propagation_matrix_agenda
automatically from absorption data and species tag meta information.Method
Executes
propagation_matrix_agenda
, see it for more detailsMethod
Sets
propagation_matrix_agenda
to a default valueMethod
Fix for the wind field derivative.
Method
Add simple air to
propagation_matrix_scattering
.Method
Initialize
propagation_matrix_scattering
to zeroes.Method
Executes
propagation_matrix_scattering_agenda
, see it for more detailsMethod
Sets
propagation_matrix_scattering_agenda
to a default valueMethod
Get a geometric radiation path
Method
Wraps
ray_pathGeometric()
for straight downlooking paths from the top-of-the-atmosphere altitudeMethod
Get a geometric radiation path that crosses the tangent altitude
Method
Wraps
ray_pathGeometric()
for straight uplooking paths from the surface altitude at the positionMethod
Gets the atmospheric points along the path.
Method
Gets the atmospheric points along the path.
Method
Gets the frequency grid along the path.
Method
Executes
ray_path_observer_agenda
, see it for more detailsMethod
Method
Sets
ray_path_point
to the expected background point ofray_path
Method
Sets
ray_path_point
to the expected foreground point ofray_path
Method
Sets
ray_path_point
to the lowest point ofray_path
.Method
Adds the scattering part of the propagation matrix to the rest along the path.
Method
Gets the propagation matrix and non-LTE source term along the path.
Method
Gets the propagation matrix for scattering along the path.
Method
ray_path_spectral_radiance_scatteringSunsFirstOrderRayleigh()
Method
Adds the scattering part of the propagation matrix to the rest along the path.
Method
Gets the source term along the path.
Method
Wraps
sun_pathFromObserverAgenda()
for all paths to all suns.Method
Gets the transmission matrix in layers along the path.
Method
Sets
ray_path_transmission_matrix_cumulative
by forward iteration ofray_path_transmission_matrix
Method
Sets A path of Zeeman effec magnetic field properties.
Method
Set the variable to the new value.
Method
Get the sorting of the bands by first quantum identifier then some
criteria
Method
Applies a unit to
spectral_radiance
, returning a new fieldMethod
Apply unit changes to spectral radiance and its Jacobian
Method
Computes clearsky transmission of spectral radiances
Method
Computes clearsky emission of spectral radiances
Method
Computes clearsky emission of spectral radiances
Method
Computes clearsky transmission of spectral radiances
Method
Gets the spectral radiance from the path emission.
Method
Gets the spectral radiance from the path transmission.
Method
Sets default
spectral_radiance
andspectral_radiance_jacobian
for transmission.Method
Integrate Disort spectral radiance.
Method
Gets the spectral radiance from the path.
Method
Get the spectral radiance of a sun or of the cosmic background if the sun is not hit.
Method
Get the spectral radiance of a sun or of the cosmic background if no sun is hit.
Method
Set surface spectral radiance from Planck function of the surface temperature
Method
Background spectral radiance is from a uniform cosmic background temperature.
Method
Computes the background radiation.
Method
Computes the spectral radiance field using
ray_path_observer_agenda
.Method
Computes the spectral radiance field assuming planar geometric paths
Method
Adds the propagation variables to
spectral_radiance_jacobian
Method
Adds sensor properties to the
spectral_radiance_jacobian
.Method
Applies a unit to
spectral_radiance
, returning a new fieldMethod
Set the cosmic background radiation derivative to empty.
Method
Sets
spectral_radiance_jacobian
from the background valuesMethod
Executes
spectral_radiance_observer_agenda
, see it for more detailsMethod
Method
Set up a 1D spectral radiance operator
Method
Executes
spectral_radiance_space_agenda
, see it for more detailsMethod
Method
Executes
spectral_radiance_surface_agenda
, see it for more detailsMethod
Method
Set
sun
to blackbody.Method
Extracts a sun spectrum from a field of such data.
Method
Find a path that hits the sun if possible
Method
Method
Earth reference ellipsoids.
Method
Europa reference ellipsoids.
Method
Sets
surface_field
to the state of the model.Method
Ganymede reference ellipsoids.
Method
Manual setting of the reference ellipsoid.
Method
Io reference ellipsoids.
Method
Jupiter reference ellipsoids.
Method
Mars reference ellipsoids.
Method
Moon reference ellipsoids.
Method
Sets the planet base surface field
Method
Venus reference ellipsoids.
Method
Swap the workspace for andother.
Method
Sets
transmission_matrix_background
to back ofray_path_transmission_matrix_cumulative
Method
Sets
transmission_matrix_background
to front ofray_path_transmission_matrix_cumulative
Method
Calculate equivalent water pressure according to Murphy and Koop, 2005
Attribute
AbsorptionBands
Bands of absorption lines for LBL calculations.Attribute
ArrayOfCIARecord
HITRAN Collision Induced Absorption (CIA) Data.Attribute
AbsorptionLookupTables
Absorption lookup table for scalar gas absorption coefficients.Attribute
PredefinedModelData
This contains predefined model data.Attribute
ArrayOfArrayOfSpeciesTag
Tag groups for gas absorption.Attribute
ArrayOfXsecRecord
Fitting model coefficients for cross section species.Attribute
AtmField
An atmospheric field in ARTS.Attribute
AtmPoint
An atmospheric point in ARTS.Attribute
JacobianTargetsDiagonalCovarianceMatrixMap
A helper map for setting the covariance matrix.Attribute
Index
The number of Fourier modes for Disort.Attribute
Index
The number of input Legendre polynimials for Disort.Attribute
Vector
The quadrature angles for Disort.Attribute
Index
The quadrature size for Disort.Attribute
Vector
The quadrature weights for Disort.Attribute
DisortSettings
Contains the full settings of spectral Disort calculations.Attribute
Agenda
An agenda for setting up Disort.Attribute
Tensor3
The spectral flux field from Disort.Attribute
Tensor4
The spectral radiance field from Disort.Attribute
LinemixingEcsData
Error corrected sudden dataAttribute
AscendingGrid
A single path point’s frequency grid.Attribute
Vector3
The frequency grid wind shift Jacobian.Attribute
NumericTernaryOperator
The gravity operator.Attribute
Agenda
Work in progress …Attribute
Index
A counter for the inversion iterate agenda.Attribute
Index
A boolean for if Jacobian calculations should be done.Attribute
JacobianTargets
A list of targets for the Jacobian Matrix calculations.Attribute
Matrix
Averaging kernel matrix.Attribute
Matrix
Contribution function (or gain) matrix.Attribute
Matrix
The partial derivatives of themeasurement_vector
.Attribute
ArrayOfSensorObsel
A list of sensor elements.Attribute
Vector
The measurment vector for, e.g., a sensor.Attribute
CovarianceMatrix
Covariance matrix for observation uncertainties.Attribute
Vector
Asmeasurement_vector
, but fitted to the model.Attribute
CovarianceMatrix
Covariance matrix of a priori distribution.Attribute
Vector
A state vector of the model.Attribute
Vector
An apriori state vector of the model.Attribute
PropmatVector
This contains the propagation matrix for the current path point.Attribute
Agenda
Compute the propagation matrix, the non-LTE source vector, and their derivativesAttribute
Attribute
PropmatVector
This contains the propagation matrix for scattering for the current path point.Attribute
Agenda
Compute the propagation matrix, the non-LTE source vector, and their derivativesAttribute
SpeciesEnum
A select species tag group fromabsorption_species
Attribute
StokvecVector
The part of the source vector that is due to non-LTE.Attribute
StokvecMatrix
Partial derivative of thepropagation_matrix_source_vector_nonlte
with regards tojacobian_targets
.Attribute
ArrayOfPropagationPathPoint
A list path points making up a propagation path.Attribute
ArrayOfAtmPoint
Atmospheric points along the propagation path.Attribute
ArrayOfAscendingGrid
Allfrequency_grid
along the propagation path.Attribute
ArrayOfVector3
A list offrequency_grid_wind_shift_jacobian
for a ray path.Attribute
Agenda
Get the propagation path as it is obeserved.Attribute
PropagationPathPoint
A single path point.Attribute
ArrayOfPropmatVector
Propagation matrices along the propagation pathAttribute
ArrayOfPropmatMatrix
Propagation derivative matrices along the propagation pathAttribute
ArrayOfPropmatVector
Propagation matrices along the propagation path for scatteringAttribute
ArrayOfStokvecVector
Additional non-LTE along the propagation pathAttribute
ArrayOfStokvecMatrix
Additional non-LTE derivative along the propagation pathAttribute
ArrayOfStokvecMatrix
Spectral radiance derivative along the propagation pathAttribute
ArrayOfStokvecVector
Spectral radiance scattered into the propagation pathAttribute
ArrayOfStokvecVector
Source vectors along the propagation pathAttribute
ArrayOfStokvecMatrix
Source derivative vectors along the propagation pathAttribute
ArrayOfArrayOfArrayOfPropagationPathPoint
A list of paths to the suns from the ray path.Attribute
ArrayOfMuelmatVector
Transmission matrices along the propagation path.Attribute
ArrayOfMuelmatVector
Cumulative transmission matrices along the propagation pathAttribute
ArrayOfMuelmatTensor3
Transmission derivative matrices along the propagation path.Attribute
StokvecVector
A spectral radiance vector.Attribute
StokvecVector
Spectral radiance from the backgroundAttribute
StokvecMatrix
Spectral radiance derivative from the backgroundAttribute
StokvecMatrix
Jacobian ofspectral_radiance
with respect tojacobian_targets
.Attribute
Agenda
Spectral radiance as seen from the input position and environmentAttribute
Vector2
The position of the observer of spectral radiance.Attribute
Vector3
The position of an observer of spectral radiance.Attribute
SpectralRadianceOperator
The spectral radiance operator.Attribute
Agenda
Spectral radiance as seen of space.Attribute
Agenda
Spectral radiance as seen of the surface.Attribute
SpectralRadianceUnitType
The spectral radiance unit after conversion.Attribute
Sun
A sun.Attribute
ArrayOfPropagationPathPoint
A path to a sun if it is visible.Attribute
ArrayOfSun
A list ofSun
.Attribute
SurfaceField
The surface field describes the surface properties.Attribute
MuelmatVector
Transmittance from the backgroundOperator
__eq__()
Return self==value.
Operator
__ge__()
Return self>=value.
Operator
__getstate__()
Operator
__gt__()
Return self>value.
Operator
__hash__()
Return hash(self).
Operator
Allows iter(self)
Operator
__le__()
Return self<=value.
Operator
__lt__()
Return self<value.
Operator
__ne__()
Return self!=value.
Operator
__setstate__()
Constructors