ARTS  2.4.0(git:4fb77825)
ARTS::AgendaMethod Namespace Reference

Functions

MRecord AbsInputFromAtmFields ([[maybe_unused]] Workspace &ws)
 
MRecord AbsInputFromRteScalars ([[maybe_unused]] Workspace &ws)
 
MRecord abs_cia_dataAddCIARecord ([[maybe_unused]] Workspace &ws, const Var::CIARecord cia_record, const Var::Index &clobber={})
 
MRecord abs_cia_dataReadFromCIA ([[maybe_unused]] Workspace &ws, const Var::String catalogpath)
 
MRecord abs_cia_dataReadFromXML ([[maybe_unused]] Workspace &ws, const Var::String &filename={})
 
MRecord abs_coefCalcFromXsec ([[maybe_unused]] Workspace &ws)
 
MRecord abs_cont_descriptionAppend ([[maybe_unused]] Workspace &ws, const Var::String tagname, const Var::String model, const Var::Vector &userparam={})
 
MRecord abs_cont_descriptionInit ([[maybe_unused]] Workspace &ws)
 
MRecord abs_hitran_relmat_dataReadHitranRelmatDataAndLines ([[maybe_unused]] Workspace &ws, const Var::String basedir, const Var::Numeric &linemixinglimit={}, const Var::Numeric &fmin={}, const Var::Numeric &fmax={}, const Var::Numeric &stot={}, const Var::String &mode={})
 
MRecord abs_linesCleanupEmpty ([[maybe_unused]] Workspace &ws)
 
MRecord abs_linesKeepBands ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier qid, const Var::Index &ignore_spec={}, const Var::Index &ignore_isot={})
 
MRecord abs_linesRemoveBand ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier qid)
 
MRecord abs_linesRemoveUnusedLocalQuantumNumbers ([[maybe_unused]] Workspace &ws)
 
MRecord abs_linesReplaceWithLines ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAbsorptionLines replacing_lines)
 
MRecord abs_linesAppendWithLines ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAbsorptionLines appending_lines, const Var::Index &safe={})
 
MRecord abs_linesDeleteWithLines ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAbsorptionLines deleting_lines)
 
MRecord abs_linesDeleteBadF0 ([[maybe_unused]] Workspace &ws, const Var::Numeric f0, const Var::Index &lower={})
 
MRecord abs_linesDeleteLinesWithUndefinedLocalQuanta ([[maybe_unused]] Workspace &ws)
 
MRecord abs_linesDeleteLinesWithBadOrHighChangingJs ([[maybe_unused]] Workspace &ws)
 
MRecord abs_linesDeleteLinesWithQuantumNumberAbove ([[maybe_unused]] Workspace &ws, const Var::String quantumnumber, const Var::Index quantumnumber_value)
 
MRecord abs_linesPrintDefinedQuantumNumbers ([[maybe_unused]] Workspace &ws)
 
MRecord abs_lines_per_speciesReadSplitCatalog ([[maybe_unused]] Workspace &ws, const Var::String basename)
 
MRecord abs_linesReadSpeciesSplitCatalog ([[maybe_unused]] Workspace &ws, const Var::String basename, const Var::Index &robust={})
 
MRecord abs_lines_per_speciesReadSpeciesSplitCatalog ([[maybe_unused]] Workspace &ws, const Var::String basename, const Var::Index &robust={})
 
MRecord abs_lines_per_speciesSetEmpty ([[maybe_unused]] Workspace &ws)
 
MRecord abs_linesSetEmptyBroadeningParametersToEmpty ([[maybe_unused]] Workspace &ws)
 
MRecord abs_linesSetNormalization ([[maybe_unused]] Workspace &ws, const Var::String option)
 
MRecord abs_lines_per_speciesSetNormalization ([[maybe_unused]] Workspace &ws, const Var::String option)
 
MRecord abs_linesSetNormalizationForMatch ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetNormalizationForMatch ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetNormalizationForSpecies ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::String species_tag)
 
MRecord abs_linesSetMirroring ([[maybe_unused]] Workspace &ws, const Var::String option)
 
MRecord abs_lines_per_speciesSetMirroring ([[maybe_unused]] Workspace &ws, const Var::String option)
 
MRecord abs_linesSetMirroringForMatch ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetMirroringForMatch ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetMirroringForSpecies ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::String species_tag)
 
MRecord abs_linesSetPopulation ([[maybe_unused]] Workspace &ws, const Var::String option)
 
MRecord abs_lines_per_speciesSetPopulation ([[maybe_unused]] Workspace &ws, const Var::String option)
 
MRecord abs_linesSetPopulationForMatch ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetPopulationForMatch ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetPopulationForSpecies ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::String species_tag)
 
MRecord abs_linesSetLineShapeType ([[maybe_unused]] Workspace &ws, const Var::String option)
 
MRecord abs_lines_per_speciesSetLineShapeType ([[maybe_unused]] Workspace &ws, const Var::String option)
 
MRecord abs_linesSetLineShapeTypeForMatch ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetLineShapeTypeForMatch ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetLineShapeTypeForSpecies ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::String species_tag)
 
MRecord abs_linesSetCutoff ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::Numeric value)
 
MRecord abs_lines_per_speciesSetCutoff ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::Numeric value)
 
MRecord abs_linesSetCutoffForMatch ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::Numeric value, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetCutoffForMatch ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::Numeric value, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetCutoffForSpecies ([[maybe_unused]] Workspace &ws, const Var::String option, const Var::Numeric value, const Var::String species_tag)
 
MRecord abs_linesSetLinemixingLimit ([[maybe_unused]] Workspace &ws, const Var::Numeric value)
 
MRecord abs_lines_per_speciesSetLinemixingLimit ([[maybe_unused]] Workspace &ws, const Var::Numeric value)
 
MRecord abs_linesSetLinemixingLimitForMatch ([[maybe_unused]] Workspace &ws, const Var::Numeric value, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetLinemixingLimitForMatch ([[maybe_unused]] Workspace &ws, const Var::Numeric value, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetLinemixingLimitForSpecies ([[maybe_unused]] Workspace &ws, const Var::Numeric value, const Var::String species_tag)
 
MRecord abs_linesSetT0 ([[maybe_unused]] Workspace &ws, const Var::Numeric value)
 
MRecord abs_lines_per_speciesSetT0 ([[maybe_unused]] Workspace &ws, const Var::Numeric value)
 
MRecord abs_linesSetT0ForMatch ([[maybe_unused]] Workspace &ws, const Var::Numeric value, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetT0ForMatch ([[maybe_unused]] Workspace &ws, const Var::Numeric value, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetT0ForSpecies ([[maybe_unused]] Workspace &ws, const Var::Numeric value, const Var::String species_tag)
 
MRecord abs_linesSetQuantumNumberForMatch ([[maybe_unused]] Workspace &ws, const Var::String quantum_number, const Var::Rational value, const Var::QuantumIdentifier ID)
 
MRecord abs_lines_per_speciesSetQuantumNumberForMatch ([[maybe_unused]] Workspace &ws, const Var::String quantum_number, const Var::Rational value, const Var::QuantumIdentifier ID)
 
MRecord abs_linesChangeBaseParameterForMatchingLevel ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter_name, const Var::Numeric change, const Var::Index &relative={})
 
MRecord abs_linesChangeBaseParameterForMatchingLevels ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier QI, const Var::String parameter_name, const Var::Vector change, const Var::Index &relative={})
 
MRecord abs_lines_per_speciesChangeBaseParameterForMatchingLevel ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter_name, const Var::Numeric change, const Var::Index &relative={})
 
MRecord abs_lines_per_speciesChangeBaseParameterForMatchingLevels ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier QI, const Var::String parameter_name, const Var::Vector change, const Var::Index &relative={})
 
MRecord abs_linesSetBaseParameterForMatchingLevel ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter_name, const Var::Numeric change)
 
MRecord abs_linesSetBaseParameterForMatchingLevels ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier QI, const Var::String parameter_name, const Var::Vector change)
 
MRecord abs_lines_per_speciesSetBaseParameterForMatchingLevel ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter_name, const Var::Numeric change)
 
MRecord abs_lines_per_speciesSetBaseParameterForMatchingLevels ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier QI, const Var::String parameter_name, const Var::Vector change)
 
MRecord abs_linesChangeBaseParameterForMatchingLines ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter_name, const Var::Numeric change, const Var::Index &relative={}, const Var::Index &loose_matching={})
 
MRecord abs_lines_per_speciesChangeBaseParameterForMatchingLines ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter_name, const Var::Numeric change, const Var::Index &relative={}, const Var::Index &loose_matching={})
 
MRecord abs_lines_per_speciesChangeBaseParameterForSpecies ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter_name, const Var::Numeric change, const Var::String species_tag, const Var::Index &relative={}, const Var::Index &loose_matching={})
 
MRecord abs_linesSetBaseParameterForMatchingLines ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter_name, const Var::Numeric change, const Var::Index &loose_matching={})
 
MRecord abs_lines_per_speciesSetBaseParameterForMatchingLines ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter_name, const Var::Numeric change, const Var::Index &loose_matching={})
 
MRecord abs_lines_per_speciesSetBaseParameterForSpecies ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter_name, const Var::Numeric change, const Var::String species_tag, const Var::Index &loose_matching={})
 
MRecord abs_linesSetLineShapeModelParameterForMatchingLines ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter, const Var::String coefficient, const Var::String species, const Var::Numeric change)
 
MRecord abs_lines_per_speciesSetLineShapeModelParameterForMatchingLines ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter, const Var::String coefficient, const Var::String species, const Var::Numeric change)
 
MRecord abs_lines_per_speciesSetLineShapeModelParameterForSpecies ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter, const Var::String coefficient, const Var::String species, const Var::Numeric change, const Var::String species_tag)
 
MRecord abs_linesSetZeemanCoefficients ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier qid, const Var::Vector gs)
 
MRecord abs_lines_per_speciesSetZeemanCoefficients ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier qid, const Var::Vector gs)
 
MRecord abs_linesChangeLineShapeModelParameterForMatchingLines ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter, const Var::String coefficient, const Var::String species, const Var::Numeric change, const Var::Index &relative={})
 
MRecord abs_lines_per_speciesChangeLineShapeModelParameterForMatchingLines ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter, const Var::String coefficient, const Var::String species, const Var::Numeric change, const Var::Index &relative={})
 
MRecord abs_lines_per_speciesChangeLineShapeModelParameterForSpecies ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier QI, const Var::String parameter, const Var::String coefficient, const Var::String species, const Var::Numeric change, const Var::String species_tag, const Var::Index &relative={})
 
MRecord abs_linesCompact ([[maybe_unused]] Workspace &ws)
 
MRecord abs_lines_per_speciesCompact ([[maybe_unused]] Workspace &ws)
 
MRecord abs_lines_per_speciesCreateFromLines ([[maybe_unused]] Workspace &ws)
 
MRecord abs_lookupAdapt ([[maybe_unused]] Workspace &ws)
 
MRecord abs_lookupCalc ([[maybe_unused]] Workspace &ws)
 
MRecord abs_lookupInit ([[maybe_unused]] Workspace &ws)
 
MRecord abs_lookupSetup ([[maybe_unused]] Workspace &ws, const Var::Numeric &p_step={}, const Var::Numeric &t_step={}, const Var::Numeric &h2o_step={})
 
MRecord abs_lookupSetupBatch ([[maybe_unused]] Workspace &ws, const Var::Numeric &p_step={}, const Var::Numeric &t_step={}, const Var::Numeric &h2o_step={}, const Var::Vector &extremes={}, const Var::Index &robust={}, const Var::Index &check_gridnames={})
 
MRecord abs_lookupSetupWide ([[maybe_unused]] Workspace &ws, const Var::Numeric &p_min={}, const Var::Numeric &p_max={}, const Var::Numeric &p_step={}, const Var::Numeric &t_min={}, const Var::Numeric &t_max={}, const Var::Numeric &h2o_min={}, const Var::Numeric &h2o_max={})
 
MRecord abs_lookupTestAccuracy ([[maybe_unused]] Workspace &ws)
 
MRecord abs_lookupTestAccMC ([[maybe_unused]] Workspace &ws)
 
MRecord abs_nlteFromRaw ([[maybe_unused]] Workspace &ws, const Var::Matrix data)
 
MRecord abs_speciesAdd ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString species)
 
MRecord abs_speciesAdd2 ([[maybe_unused]] Workspace &ws, const Var::Vector gin1, const Var::Vector gin2, const Var::Vector gin3, const Var::String species, const Var::String &unit={})
 
MRecord abs_speciesDefineAllInScenario ([[maybe_unused]] Workspace &ws, const Var::String basename)
 
MRecord abs_speciesDefineAll ([[maybe_unused]] Workspace &ws)
 
MRecord abs_speciesInit ([[maybe_unused]] Workspace &ws)
 
MRecord abs_speciesSet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString species)
 
MRecord abs_vecAddGas ([[maybe_unused]] Workspace &ws)
 
MRecord abs_xsec_agenda_checkedCalc ([[maybe_unused]] Workspace &ws)
 
MRecord abs_xsec_per_speciesAddCIA ([[maybe_unused]] Workspace &ws, const Var::Numeric &T_extrapolfac={}, const Var::Index &robust={})
 
MRecord abs_xsec_per_speciesAddHitranXsec ([[maybe_unused]] Workspace &ws, const Var::Index &apply_tfit={}, const Var::Numeric &force_p={}, const Var::Numeric &force_t={})
 
MRecord abs_xsec_per_speciesAddConts ([[maybe_unused]] Workspace &ws)
 
MRecord abs_xsec_per_speciesAddLines ([[maybe_unused]] Workspace &ws)
 
MRecord abs_xsec_per_speciesAddPredefinedO2MPM2020 ([[maybe_unused]] Workspace &ws)
 
MRecord abs_xsec_per_speciesInit ([[maybe_unused]] Workspace &ws)
 
MRecord AddZaAa ([[maybe_unused]] Workspace &ws, Var::Matrix new_los, const Var::Vector ref_los, const Var::Matrix dlos)
 
MRecord AgendaExecute ([[maybe_unused]] Workspace &ws, const Var::Agenda a)
 
MRecord AgendaExecuteExclusive ([[maybe_unused]] Workspace &ws, const Var::Agenda a)
 
MRecord AngularGridsSetFluxCalc ([[maybe_unused]] Workspace &ws, const Var::Index &N_za_grid={}, const Var::Index &N_aa_grid={}, const Var::String &za_grid_type={})
 
MRecord ArrayOfAgendaExecute ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAgenda agendas)
 
MRecord AntennaConstantGaussian1D ([[maybe_unused]] Workspace &ws, const Var::Index n_za_grid, const Var::Numeric fwhm, const Var::Numeric &xwidth_si={}, const Var::Numeric &dx_si={})
 
MRecord AntennaMultiBeamsToPencilBeams ([[maybe_unused]] Workspace &ws)
 
MRecord AntennaOff ([[maybe_unused]] Workspace &ws)
 
MRecord antenna_responseGaussian ([[maybe_unused]] Workspace &ws, const Var::Numeric fwhm, const Var::Numeric &xwidth_si={}, const Var::Numeric &dx_si={}, const Var::Index &do_2d={})
 
MRecord antenna_responseVaryingGaussian ([[maybe_unused]] Workspace &ws, const Var::Numeric leff, const Var::Index nf, const Var::Numeric fstart, const Var::Numeric fstop, const Var::Numeric &xwidth_si={}, const Var::Numeric &dx_si={}, const Var::Index &do_2d={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Numeric in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Vector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Matrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::Matrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::Tensor3 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::Tensor3 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::Tensor4 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::String out, const Var::String in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfAbsorptionLines out, const Var::ArrayOfAbsorptionLines in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfAbsorptionLines out, const Var::ArrayOfArrayOfAbsorptionLines in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfAgenda out, const Var::ArrayOfAgenda in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField1 out, const Var::ArrayOfArrayOfGriddedField1 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField2 out, const Var::ArrayOfArrayOfGriddedField2 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField3 out, const Var::ArrayOfArrayOfGriddedField3 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfIndex out, const Var::ArrayOfArrayOfIndex in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfMatrix out, const Var::ArrayOfArrayOfMatrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfPpath out, const Var::ArrayOfPpath in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfPropagationMatrix out, const Var::ArrayOfArrayOfPropagationMatrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfRadiationVector out, const Var::ArrayOfArrayOfRadiationVector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfScatteringMetaData out, const Var::ArrayOfArrayOfScatteringMetaData in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSingleScatteringData out, const Var::ArrayOfArrayOfSingleScatteringData in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSpeciesTag out, const Var::ArrayOfArrayOfSpeciesTag in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfStokesVector out, const Var::ArrayOfArrayOfStokesVector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfString out, const Var::ArrayOfArrayOfString in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor3 out, const Var::ArrayOfArrayOfTensor3 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor6 out, const Var::ArrayOfArrayOfTensor6 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTime out, const Var::ArrayOfArrayOfTime in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTransmissionMatrix out, const Var::ArrayOfArrayOfTransmissionMatrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfVector out, const Var::ArrayOfArrayOfVector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfCIARecord out, const Var::ArrayOfCIARecord in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField1 out, const Var::ArrayOfGriddedField1 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField2 out, const Var::ArrayOfGriddedField2 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField3 out, const Var::ArrayOfGriddedField3 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField4 out, const Var::ArrayOfGriddedField4 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfIndex out, const Var::ArrayOfIndex in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfMatrix out, const Var::ArrayOfMatrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfPropagationMatrix out, const Var::ArrayOfPropagationMatrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfQuantumIdentifier out, const Var::ArrayOfQuantumIdentifier in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfRadiationVector out, const Var::ArrayOfRadiationVector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfRetrievalQuantity out, const Var::ArrayOfRetrievalQuantity in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfScatteringMetaData out, const Var::ArrayOfScatteringMetaData in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfSingleScatteringData out, const Var::ArrayOfSingleScatteringData in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfSparse out, const Var::ArrayOfSparse in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfStokesVector out, const Var::ArrayOfStokesVector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfString out, const Var::ArrayOfString in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTelsemAtlas out, const Var::ArrayOfTelsemAtlas in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor3 out, const Var::ArrayOfTensor3 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor4 out, const Var::ArrayOfTensor4 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor5 out, const Var::ArrayOfTensor5 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor6 out, const Var::ArrayOfTensor6 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor7 out, const Var::ArrayOfTensor7 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTime out, const Var::ArrayOfTime in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTransmissionMatrix out, const Var::ArrayOfTransmissionMatrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfVector out, const Var::ArrayOfVector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfXsecRecord out, const Var::ArrayOfXsecRecord in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfAbsorptionLines out, const Var::AbsorptionLines in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfAbsorptionLines out, const Var::ArrayOfAbsorptionLines in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfAgenda out, const Var::Agenda in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField1 out, const Var::ArrayOfGriddedField1 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField2 out, const Var::ArrayOfGriddedField2 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField3 out, const Var::ArrayOfGriddedField3 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfIndex out, const Var::ArrayOfIndex in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfMatrix out, const Var::ArrayOfMatrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfPpath out, const Var::Ppath in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfPropagationMatrix out, const Var::ArrayOfPropagationMatrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfRadiationVector out, const Var::ArrayOfRadiationVector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfScatteringMetaData out, const Var::ArrayOfScatteringMetaData in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSingleScatteringData out, const Var::ArrayOfSingleScatteringData in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfStokesVector out, const Var::ArrayOfStokesVector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfString out, const Var::ArrayOfString in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor3 out, const Var::ArrayOfTensor3 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor6 out, const Var::ArrayOfTensor6 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTime out, const Var::ArrayOfTime in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTransmissionMatrix out, const Var::ArrayOfTransmissionMatrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfVector out, const Var::ArrayOfVector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfCIARecord out, const Var::CIARecord in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField1 out, const Var::GriddedField1 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField2 out, const Var::GriddedField2 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField3 out, const Var::GriddedField3 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField4 out, const Var::GriddedField4 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfIndex out, const Var::Index in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfMatrix out, const Var::Matrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfPropagationMatrix out, const Var::PropagationMatrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfQuantumIdentifier out, const Var::QuantumIdentifier in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfRadiationVector out, const Var::RadiationVector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfScatteringMetaData out, const Var::ScatteringMetaData in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfSingleScatteringData out, const Var::SingleScatteringData in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfSparse out, const Var::Sparse in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfStokesVector out, const Var::StokesVector in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfString out, const Var::String in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTelsemAtlas out, const Var::TelsemAtlas in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor3 out, const Var::Tensor3 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor4 out, const Var::Tensor4 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor5 out, const Var::Tensor5 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor6 out, const Var::Tensor6 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor7 out, const Var::Tensor7 in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTime out, const Var::Time in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfTransmissionMatrix out, const Var::TransmissionMatrix in, const Var::String &dimension={})
 
MRecord Append ([[maybe_unused]] Workspace &ws, Var::ArrayOfVector out, const Var::Vector in, const Var::String &dimension={})
 
MRecord ArrayOfGriddedFieldGetNames ([[maybe_unused]] Workspace &ws, Var::ArrayOfString names, const Var::ArrayOfGriddedField1 griddedfields)
 
MRecord ArrayOfGriddedFieldGetNames ([[maybe_unused]] Workspace &ws, Var::ArrayOfString names, const Var::ArrayOfGriddedField2 griddedfields)
 
MRecord ArrayOfGriddedFieldGetNames ([[maybe_unused]] Workspace &ws, Var::ArrayOfString names, const Var::ArrayOfGriddedField3 griddedfields)
 
MRecord ArrayOfGriddedFieldGetNames ([[maybe_unused]] Workspace &ws, Var::ArrayOfString names, const Var::ArrayOfGriddedField4 griddedfields)
 
MRecord ArrayOfIndexLinSpace ([[maybe_unused]] Workspace &ws, Var::ArrayOfIndex out, const Var::Index start, const Var::Index stop, const Var::Index step)
 
MRecord ArrayOfIndexSet ([[maybe_unused]] Workspace &ws, Var::ArrayOfIndex out, const Var::ArrayOfIndex value)
 
MRecord ArrayOfIndexSetConstant ([[maybe_unused]] Workspace &ws, Var::ArrayOfIndex out, const Var::Index value)
 
MRecord ArrayOfStringSet ([[maybe_unused]] Workspace &ws, Var::ArrayOfString out, const Var::ArrayOfString value)
 
MRecord AtmFieldPerturb ([[maybe_unused]] Workspace &ws, Var::Tensor3 perturbed_field, const Var::Tensor3 original_field, const Var::Vector p_ret_grid, const Var::Vector lat_ret_grid, const Var::Vector lon_ret_grid, const Var::Index pert_index, const Var::Numeric pert_size, const Var::String &pert_mode={})
 
MRecord AtmFieldPerturbAtmGrids ([[maybe_unused]] Workspace &ws, Var::Tensor3 perturbed_field, const Var::Tensor3 original_field, const Var::Index pert_index, const Var::Numeric pert_size, const Var::String &pert_mode={})
 
MRecord AtmFieldPRegrid ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::Tensor3 in, const Var::Vector p_grid_new, const Var::Vector p_grid_old, const Var::Index &interp_order={})
 
MRecord AtmFieldPRegrid ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::Tensor4 in, const Var::Vector p_grid_new, const Var::Vector p_grid_old, const Var::Index &interp_order={})
 
MRecord AtmFieldsCalc ([[maybe_unused]] Workspace &ws, const Var::Index &interp_order={}, const Var::Index &vmr_zeropadding={}, const Var::Index &vmr_nonegative={}, const Var::Index &nlte_when_negative={})
 
MRecord AtmFieldsCalcExpand1D ([[maybe_unused]] Workspace &ws, const Var::Index &interp_order={}, const Var::Index &vmr_zeropadding={}, const Var::Index &vmr_nonegative={}, const Var::Index &nlte_when_negative={})
 
MRecord AtmFieldsExpand1D ([[maybe_unused]] Workspace &ws, const Var::Index &chk_vmr_nan={})
 
MRecord AtmFieldsExtract1D ([[maybe_unused]] Workspace &ws, const Var::Index &ilat={}, const Var::Index &ilon={})
 
MRecord AtmFieldsRefinePgrid ([[maybe_unused]] Workspace &ws, const Var::Numeric p_step, const Var::Index &interp_order={})
 
MRecord AtmFieldsAndParticleBulkPropFieldFromCompact ([[maybe_unused]] Workspace &ws, const Var::String &delim={}, const Var::Numeric &p_min={}, const Var::Index &check_gridnames={})
 
MRecord atmfields_checkedCalc ([[maybe_unused]] Workspace &ws, const Var::Index &negative_vmr_ok={}, const Var::Index &bad_partition_functions_ok={})
 
MRecord atmgeom_checkedCalc ([[maybe_unused]] Workspace &ws)
 
MRecord AtmosphereSet1D ([[maybe_unused]] Workspace &ws)
 
MRecord AtmosphereSet2D ([[maybe_unused]] Workspace &ws)
 
MRecord AtmosphereSet3D ([[maybe_unused]] Workspace &ws)
 
MRecord AtmRawRead ([[maybe_unused]] Workspace &ws, const Var::String basename)
 
MRecord AtmWithNLTERawRead ([[maybe_unused]] Workspace &ws, const Var::String basename, const Var::Index &expect_vibrational_energies={})
 
MRecord atm_fields_compactAddConstant ([[maybe_unused]] Workspace &ws, const Var::String name, const Var::Numeric value, const Var::Index &prepend={}, const Var::ArrayOfString &condensibles={})
 
MRecord atm_fields_compactAddSpecies ([[maybe_unused]] Workspace &ws, const Var::String name, const Var::GriddedField3 value, const Var::Index &prepend={})
 
MRecord atm_fields_compactCleanup ([[maybe_unused]] Workspace &ws, const Var::Numeric threshold)
 
MRecord atm_fields_compactCreateFromField ([[maybe_unused]] Workspace &ws, const Var::String name, const Var::GriddedField3 field)
 
MRecord atm_fields_compactFromMatrix ([[maybe_unused]] Workspace &ws, const Var::Matrix gin1, const Var::ArrayOfString field_names)
 
MRecord backend_channel_responseFlat ([[maybe_unused]] Workspace &ws, const Var::Numeric resolution)
 
MRecord backend_channel_responseGaussian ([[maybe_unused]] Workspace &ws, const Var::Vector fwhm, const Var::Vector &xwidth_si={}, const Var::Vector &dx_si={})
 
MRecord batch_atm_fields_compactAddConstant ([[maybe_unused]] Workspace &ws, const Var::String name, const Var::Numeric value, const Var::Index &prepend={}, const Var::ArrayOfString &condensibles={})
 
MRecord batch_atm_fields_compactAddSpecies ([[maybe_unused]] Workspace &ws, const Var::String name, const Var::GriddedField3 value, const Var::Index &prepend={})
 
MRecord batch_atm_fields_compactCleanup ([[maybe_unused]] Workspace &ws, const Var::Numeric threshold)
 
MRecord batch_atm_fields_compactFromArrayOfMatrix ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix atmospheres_fields, const Var::ArrayOfString field_names)
 
MRecord CIAInfo ([[maybe_unused]] Workspace &ws, const Var::String catalogpath, const Var::ArrayOfString cia_tags)
 
MRecord CIARecordReadFromFile ([[maybe_unused]] Workspace &ws, Var::CIARecord cia_record, const Var::String species_tag, const Var::String filename)
 
MRecord cloudboxOff ([[maybe_unused]] Workspace &ws)
 
MRecord cloudboxSetAutomatically ([[maybe_unused]] Workspace &ws, const Var::Tensor4 particle_field, const Var::ArrayOfIndex &cloudbox_limits_old={}, const Var::Numeric &cloudbox_margin={})
 
MRecord cloudboxSetFullAtm ([[maybe_unused]] Workspace &ws)
 
MRecord cloudboxSetManually ([[maybe_unused]] Workspace &ws, const Var::Numeric p1, const Var::Numeric p2, const Var::Numeric lat1, const Var::Numeric lat2, const Var::Numeric lon1, const Var::Numeric lon2)
 
MRecord cloudboxSetManuallyAltitude ([[maybe_unused]] Workspace &ws, const Var::Numeric z1, const Var::Numeric z2, const Var::Numeric lat1, const Var::Numeric lat2, const Var::Numeric lon1, const Var::Numeric lon2)
 
MRecord cloudbox_checkedCalc ([[maybe_unused]] Workspace &ws, const Var::Index &negative_pnd_ok={})
 
MRecord cloudbox_field_monoIterate ([[maybe_unused]] Workspace &ws, const Var::Index &accelerated={})
 
MRecord cloudbox_fieldCrop ([[maybe_unused]] Workspace &ws, const Var::Index &new_limit0={}, const Var::Index &new_limit1={}, const Var::Index &new_limit2={}, const Var::Index &new_limit3={}, const Var::Index &new_limit4={}, const Var::Index &new_limit5={})
 
MRecord cloudbox_fieldSetFromPrecalc ([[maybe_unused]] Workspace &ws, const Var::Tensor7 cloudbox_field_precalc)
 
MRecord cloudbox_fieldSetClearsky ([[maybe_unused]] Workspace &ws, const Var::Index &all_frequencies={})
 
MRecord cloudbox_field_monoSetConst ([[maybe_unused]] Workspace &ws, const Var::Vector value)
 
MRecord cloudbox_fieldSetConst ([[maybe_unused]] Workspace &ws, const Var::Vector value)
 
MRecord cloudbox_fieldSetConstPerFreq ([[maybe_unused]] Workspace &ws, const Var::Matrix value)
 
MRecord cloudbox_fieldUpdate1D ([[maybe_unused]] Workspace &ws)
 
MRecord cloudbox_fieldUpdateSeq1D ([[maybe_unused]] Workspace &ws, const Var::Index &normalize={}, const Var::Numeric &norm_error_threshold={}, const Var::Index &norm_debug={})
 
MRecord cloudbox_fieldUpdateSeq1DPP ([[maybe_unused]] Workspace &ws)
 
MRecord cloudbox_fieldUpdateSeq3D ([[maybe_unused]] Workspace &ws)
 
MRecord cloudbox_field_monoOptimizeReverse ([[maybe_unused]] Workspace &ws)
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::Numeric var1, const Var::Numeric var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::Vector var1, const Var::Vector var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::Matrix var1, const Var::Matrix var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::Tensor3 var1, const Var::Tensor3 var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::Tensor4 var1, const Var::Tensor4 var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::Tensor5 var1, const Var::Tensor5 var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::Tensor7 var1, const Var::Tensor7 var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::ArrayOfVector var1, const Var::ArrayOfVector var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix var1, const Var::ArrayOfMatrix var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor7 var1, const Var::ArrayOfTensor7 var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::GriddedField3 var1, const Var::GriddedField3 var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::Sparse var1, const Var::Sparse var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord Compare ([[maybe_unused]] Workspace &ws, const Var::SingleScatteringData var1, const Var::SingleScatteringData var2, const Var::Numeric &maxabsdiff={}, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::Numeric var1, const Var::Numeric var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::Vector var1, const Var::Vector var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::Matrix var1, const Var::Matrix var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::Tensor3 var1, const Var::Tensor3 var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::Tensor4 var1, const Var::Tensor4 var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::Tensor5 var1, const Var::Tensor5 var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::Tensor6 var1, const Var::Tensor6 var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::Tensor7 var1, const Var::Tensor7 var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfVector var1, const Var::ArrayOfVector var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix var1, const Var::ArrayOfMatrix var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor3 var1, const Var::ArrayOfTensor3 var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor4 var1, const Var::ArrayOfTensor4 var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor6 var1, const Var::ArrayOfTensor6 var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor7 var1, const Var::ArrayOfTensor7 var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfVector var1, const Var::ArrayOfArrayOfVector var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfMatrix var1, const Var::ArrayOfArrayOfMatrix var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor3 var1, const Var::ArrayOfArrayOfTensor3 var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor6 var1, const Var::ArrayOfArrayOfTensor6 var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPropagationMatrix var1, const Var::ArrayOfPropagationMatrix var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfPropagationMatrix var1, const Var::ArrayOfArrayOfPropagationMatrix var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfStokesVector var1, const Var::ArrayOfStokesVector var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfStokesVector var1, const Var::ArrayOfArrayOfStokesVector var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord CompareRelative ([[maybe_unused]] Workspace &ws, const Var::EnergyLevelMap var1, const Var::EnergyLevelMap var2, const Var::Numeric maxabsreldiff, const Var::String &error_message={})
 
MRecord complex_refr_indexConstant ([[maybe_unused]] Workspace &ws, const Var::Numeric refr_index_real, const Var::Numeric refr_index_imag)
 
MRecord complex_refr_indexIceMatzler06 ([[maybe_unused]] Workspace &ws, const Var::Vector data_f_grid, const Var::Vector data_T_grid)
 
MRecord complex_refr_indexIceWarren84 ([[maybe_unused]] Workspace &ws, const Var::Vector data_f_grid, const Var::Vector data_T_grid)
 
MRecord complex_refr_indexWaterLiebe93 ([[maybe_unused]] Workspace &ws, const Var::Vector data_f_grid, const Var::Vector data_T_grid)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::AbsorptionLines out, const Var::AbsorptionLines in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Agenda out, const Var::Agenda in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfAbsorptionLines out, const Var::ArrayOfAbsorptionLines in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfAbsorptionLines out, const Var::ArrayOfArrayOfAbsorptionLines in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfAgenda out, const Var::ArrayOfAgenda in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField1 out, const Var::ArrayOfArrayOfGriddedField1 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField2 out, const Var::ArrayOfArrayOfGriddedField2 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField3 out, const Var::ArrayOfArrayOfGriddedField3 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfIndex out, const Var::ArrayOfArrayOfIndex in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfMatrix out, const Var::ArrayOfArrayOfMatrix in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfPpath out, const Var::ArrayOfPpath in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfPropagationMatrix out, const Var::ArrayOfArrayOfPropagationMatrix in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfRadiationVector out, const Var::ArrayOfArrayOfRadiationVector in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfScatteringMetaData out, const Var::ArrayOfArrayOfScatteringMetaData in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSingleScatteringData out, const Var::ArrayOfArrayOfSingleScatteringData in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSpeciesTag out, const Var::ArrayOfArrayOfSpeciesTag in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfStokesVector out, const Var::ArrayOfArrayOfStokesVector in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfString out, const Var::ArrayOfArrayOfString in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor3 out, const Var::ArrayOfArrayOfTensor3 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor6 out, const Var::ArrayOfArrayOfTensor6 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTime out, const Var::ArrayOfArrayOfTime in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTransmissionMatrix out, const Var::ArrayOfArrayOfTransmissionMatrix in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfVector out, const Var::ArrayOfArrayOfVector in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfCIARecord out, const Var::ArrayOfCIARecord in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField1 out, const Var::ArrayOfGriddedField1 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField2 out, const Var::ArrayOfGriddedField2 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField3 out, const Var::ArrayOfGriddedField3 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField4 out, const Var::ArrayOfGriddedField4 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfIndex out, const Var::ArrayOfIndex in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfMatrix out, const Var::ArrayOfMatrix in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfPropagationMatrix out, const Var::ArrayOfPropagationMatrix in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfQuantumIdentifier out, const Var::ArrayOfQuantumIdentifier in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfRadiationVector out, const Var::ArrayOfRadiationVector in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfRetrievalQuantity out, const Var::ArrayOfRetrievalQuantity in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfScatteringMetaData out, const Var::ArrayOfScatteringMetaData in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfSingleScatteringData out, const Var::ArrayOfSingleScatteringData in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfSparse out, const Var::ArrayOfSparse in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfStokesVector out, const Var::ArrayOfStokesVector in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfString out, const Var::ArrayOfString in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfTelsemAtlas out, const Var::ArrayOfTelsemAtlas in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor3 out, const Var::ArrayOfTensor3 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor4 out, const Var::ArrayOfTensor4 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor5 out, const Var::ArrayOfTensor5 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor6 out, const Var::ArrayOfTensor6 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor7 out, const Var::ArrayOfTensor7 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfTime out, const Var::ArrayOfTime in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfTransmissionMatrix out, const Var::ArrayOfTransmissionMatrix in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfVector out, const Var::ArrayOfVector in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ArrayOfXsecRecord out, const Var::ArrayOfXsecRecord in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::CIARecord out, const Var::CIARecord in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::CovarianceMatrix out, const Var::CovarianceMatrix in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::EnergyLevelMap out, const Var::EnergyLevelMap in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::GasAbsLookup out, const Var::GasAbsLookup in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::GridPos out, const Var::GridPos in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::GriddedField1 out, const Var::GriddedField1 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::GriddedField2 out, const Var::GriddedField2 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::GriddedField3 out, const Var::GriddedField3 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::GriddedField4 out, const Var::GriddedField4 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::GriddedField5 out, const Var::GriddedField5 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::GriddedField6 out, const Var::GriddedField6 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::HitranRelaxationMatrixData out, const Var::HitranRelaxationMatrixData in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Index out, const Var::Index in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::MCAntenna out, const Var::MCAntenna in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Matrix in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Numeric out, const Var::Numeric in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Ppath out, const Var::Ppath in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::PropagationMatrix out, const Var::PropagationMatrix in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::QuantumIdentifier out, const Var::QuantumIdentifier in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::RadiationVector out, const Var::RadiationVector in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Rational out, const Var::Rational in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::ScatteringMetaData out, const Var::ScatteringMetaData in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::SingleScatteringData out, const Var::SingleScatteringData in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Sparse out, const Var::Sparse in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::SpeciesAuxData out, const Var::SpeciesAuxData in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::StokesVector out, const Var::StokesVector in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::String out, const Var::String in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::TelsemAtlas out, const Var::TelsemAtlas in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::Tensor3 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::Tensor4 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Tensor5 out, const Var::Tensor5 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Tensor6 out, const Var::Tensor6 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Tensor7 out, const Var::Tensor7 in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Timer out, const Var::Timer in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Time out, const Var::Time in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::TessemNN out, const Var::TessemNN in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::TransmissionMatrix out, const Var::TransmissionMatrix in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Vector in)
 
MRecord Copy ([[maybe_unused]] Workspace &ws, Var::Verbosity out, const Var::Verbosity in)
 
MRecord covmat1D ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector grid_1, const Var::Vector sigma_1, const Var::Vector cls_1, const Var::String fname, const Var::Vector &grid_2={}, const Var::Vector &sigma_2={}, const Var::Vector &cls_2={}, const Var::Numeric &co={})
 
MRecord covmat1D ([[maybe_unused]] Workspace &ws, Var::Sparse out, const Var::Vector grid_1, const Var::Vector sigma_1, const Var::Vector cls_1, const Var::String fname, const Var::Vector &grid_2={}, const Var::Vector &sigma_2={}, const Var::Vector &cls_2={}, const Var::Numeric &co={})
 
MRecord covmat1DMarkov ([[maybe_unused]] Workspace &ws, Var::Matrix out, Var::Matrix out_inverse, const Var::Vector grid, const Var::Vector sigma, const Var::Numeric lc, const Var::Numeric &co={})
 
MRecord covmat1DMarkov ([[maybe_unused]] Workspace &ws, Var::Sparse out, Var::Sparse out_inverse, const Var::Vector grid, const Var::Vector sigma, const Var::Numeric lc, const Var::Numeric &co={})
 
MRecord covmatDiagonal ([[maybe_unused]] Workspace &ws, Var::Matrix out, Var::Matrix out_inverse, const Var::Vector vars)
 
MRecord covmatDiagonal ([[maybe_unused]] Workspace &ws, Var::Sparse out, Var::Sparse out_inverse, const Var::Vector vars)
 
MRecord covmat_seAddBlock ([[maybe_unused]] Workspace &ws, const Var::Matrix block, const Var::Index &i={}, const Var::Index &j={})
 
MRecord covmat_seAddBlock ([[maybe_unused]] Workspace &ws, const Var::Sparse block, const Var::Index &i={}, const Var::Index &j={})
 
MRecord covmat_seAddInverseBlock ([[maybe_unused]] Workspace &ws, const Var::Matrix block, const Var::Index &i={}, const Var::Index &j={})
 
MRecord covmat_seAddInverseBlock ([[maybe_unused]] Workspace &ws, const Var::Sparse block, const Var::Index &i={}, const Var::Index &j={})
 
MRecord covmat_seSet ([[maybe_unused]] Workspace &ws, const Var::CovarianceMatrix covmat)
 
MRecord covmat_seSet ([[maybe_unused]] Workspace &ws, const Var::Matrix covmat)
 
MRecord covmat_seSet ([[maybe_unused]] Workspace &ws, const Var::Sparse covmat)
 
MRecord covmat_sxSet ([[maybe_unused]] Workspace &ws, const Var::CovarianceMatrix covmat)
 
MRecord covmat_sxSet ([[maybe_unused]] Workspace &ws, const Var::Matrix covmat)
 
MRecord covmat_sxSet ([[maybe_unused]] Workspace &ws, const Var::Sparse covmat)
 
MRecord covmat_sxAddBlock ([[maybe_unused]] Workspace &ws, const Var::Matrix block, const Var::Index &i={}, const Var::Index &j={})
 
MRecord covmat_sxAddBlock ([[maybe_unused]] Workspace &ws, const Var::Sparse block, const Var::Index &i={}, const Var::Index &j={})
 
MRecord covmat_sxAddInverseBlock ([[maybe_unused]] Workspace &ws, const Var::Matrix block, const Var::Index &i={}, const Var::Index &j={})
 
MRecord covmat_sxAddInverseBlock ([[maybe_unused]] Workspace &ws, const Var::Sparse block, const Var::Index &i={}, const Var::Index &j={})
 
MRecord covmat_sxExtractSqrtDiagonal ([[maybe_unused]] Workspace &ws, Var::Vector x_norm)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::AbsorptionLines v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Agenda v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAbsorptionLines v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfAbsorptionLines v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAgenda v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField1 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField2 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField3 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfIndex v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfMatrix v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPpath v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfPropagationMatrix v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfRadiationVector v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfScatteringMetaData v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSingleScatteringData v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSpeciesTag v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfStokesVector v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfString v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor3 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor6 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTime v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTransmissionMatrix v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfVector v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfCIARecord v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField1 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField2 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField3 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField4 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfIndex v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPropagationMatrix v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRadiationVector v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRetrievalQuantity v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfScatteringMetaData v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSingleScatteringData v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSparse v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfStokesVector v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTelsemAtlas v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor3 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor4 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor5 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor6 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor7 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTime v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTransmissionMatrix v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfVector v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ArrayOfXsecRecord v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::CIARecord v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::CovarianceMatrix v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::EnergyLevelMap v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::GasAbsLookup v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::GridPos v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::GriddedField1 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::GriddedField2 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::GriddedField3 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::GriddedField4 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::GriddedField5 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::GriddedField6 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::HitranRelaxationMatrixData v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Index v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::MCAntenna v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Matrix v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Numeric v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Ppath v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::PropagationMatrix v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::RadiationVector v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Rational v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::ScatteringMetaData v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::SingleScatteringData v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Sparse v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::SpeciesAuxData v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::StokesVector v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::String v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::TelsemAtlas v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Tensor3 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Tensor4 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Tensor5 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Tensor6 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Tensor7 v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Timer v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Time v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::TessemNN v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::TransmissionMatrix v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Vector v)
 
MRecord Delete ([[maybe_unused]] Workspace &ws, const Var::Verbosity v)
 
MRecord diameter_maxFromDiameter_volume_equ ([[maybe_unused]] Workspace &ws, Var::Numeric diameter_max, Var::Numeric diameter_area_equ, const Var::String shape, const Var::Numeric diameter_volume_equ, const Var::Numeric aspect_ratio)
 
MRecord diameter_volume_equFromDiameter_max ([[maybe_unused]] Workspace &ws, Var::Numeric diameter_volume_equ, Var::Numeric volume, const Var::String shape, const Var::Numeric diameter_max, const Var::Numeric aspect_ratio)
 
MRecord DiagonalMatrix ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector v)
 
MRecord DiagonalMatrix ([[maybe_unused]] Workspace &ws, Var::Sparse out, const Var::Vector v)
 
MRecord DiffZaAa ([[maybe_unused]] Workspace &ws, Var::Matrix dlos, const Var::Vector ref_los, const Var::Matrix other_los)
 
MRecord DisortCalc ([[maybe_unused]] Workspace &ws, const Var::Index &nstreams={}, const Var::String &pfct_method={}, const Var::Index &Npfct={}, const Var::Index &quiet={})
 
MRecord DisortCalcWithARTSSurface ([[maybe_unused]] Workspace &ws, const Var::Index &nstreams={}, const Var::String &pfct_method={}, const Var::Index &Npfct={}, const Var::Index &quiet={})
 
MRecord DisortCalcClearsky ([[maybe_unused]] Workspace &ws, const Var::Index &nstreams={}, const Var::Index &quiet={})
 
MRecord DOBatchCalc ([[maybe_unused]] Workspace &ws, const Var::Index &robust={})
 
MRecord DOAngularGridsSet ([[maybe_unused]] Workspace &ws, const Var::Index N_za_grid, const Var::Index &N_aa_grid={}, const Var::String &za_grid_opt_file={})
 
MRecord DoitCalc ([[maybe_unused]] Workspace &ws)
 
MRecord DoitGetIncoming ([[maybe_unused]] Workspace &ws, const Var::Index &rigorous={}, const Var::Numeric &maxratio={})
 
MRecord DoitGetIncoming1DAtm ([[maybe_unused]] Workspace &ws)
 
MRecord DoitInit ([[maybe_unused]] Workspace &ws)
 
MRecord DoitScatteringDataPrepare ([[maybe_unused]] Workspace &ws)
 
MRecord DoitWriteIterationFields ([[maybe_unused]] Workspace &ws, const Var::ArrayOfIndex &iterations={}, const Var::ArrayOfIndex &frequencies={})
 
MRecord doit_conv_flagAbs ([[maybe_unused]] Workspace &ws, const Var::Vector epsilon, const Var::Index &max_iterations={}, const Var::Index &nonconv_return_nan={})
 
MRecord doit_conv_flagAbsBT ([[maybe_unused]] Workspace &ws, const Var::Vector epsilon, const Var::Index &max_iterations={}, const Var::Index &nonconv_return_nan={})
 
MRecord doit_conv_flagLsq ([[maybe_unused]] Workspace &ws, const Var::Vector epsilon, const Var::Index &max_iterations={}, const Var::Index &nonconv_return_nan={})
 
MRecord OptimizeDoitPressureGrid ([[maybe_unused]] Workspace &ws, const Var::Numeric &tau_scat_max={}, const Var::Numeric &sgl_alb_max={}, const Var::Index &cloudbox_size_max={})
 
MRecord doit_scat_fieldCalc ([[maybe_unused]] Workspace &ws)
 
MRecord doit_scat_fieldCalcLimb ([[maybe_unused]] Workspace &ws)
 
MRecord doit_za_grid_optCalc ([[maybe_unused]] Workspace &ws, const Var::Numeric acc)
 
MRecord doit_za_interpSet ([[maybe_unused]] Workspace &ws, const Var::String &interp_method={})
 
MRecord Duration ([[maybe_unused]] Workspace &ws, Var::Numeric duration, const Var::Time start, const Var::Time end)
 
MRecord EnergyLevelMapSet ([[maybe_unused]] Workspace &ws, Var::EnergyLevelMap x, const Var::EnergyLevelMap y)
 
MRecord Error ([[maybe_unused]] Workspace &ws, const Var::String msg)
 
MRecord Exit ([[maybe_unused]] Workspace &ws)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::Index needle, const Var::ArrayOfIndex haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::ArrayOfIndex needle, const Var::ArrayOfArrayOfIndex haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::Numeric needle, const Var::Vector haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::Vector needle, const Var::ArrayOfVector haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::Matrix needle, const Var::ArrayOfMatrix haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::Matrix needle, const Var::Tensor3 haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::Tensor3 needle, const Var::Tensor4 haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::Tensor4 needle, const Var::ArrayOfTensor4 haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::Tensor4 needle, const Var::Tensor5 haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::GriddedField3 needle, const Var::ArrayOfGriddedField3 haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField3 needle, const Var::ArrayOfArrayOfGriddedField3 haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::GriddedField4 needle, const Var::ArrayOfGriddedField4 haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::String needle, const Var::ArrayOfString haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::SingleScatteringData needle, const Var::ArrayOfSingleScatteringData haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::ArrayOfSingleScatteringData needle, const Var::ArrayOfArrayOfSingleScatteringData haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::TelsemAtlas needle, const Var::ArrayOfTelsemAtlas haystack, const Var::Index index)
 
MRecord Extract ([[maybe_unused]] Workspace &ws, Var::QuantumIdentifier needle, const Var::ArrayOfQuantumIdentifier haystack, const Var::Index index)
 
MRecord ExtractFromMetaSingleScatSpecies ([[maybe_unused]] Workspace &ws, Var::Vector meta_param, const Var::String meta_name, const Var::Index scat_species_index)
 
MRecord ext_matAddGas ([[maybe_unused]] Workspace &ws)
 
MRecord FastemStandAlone ([[maybe_unused]] Workspace &ws, Var::Matrix emissivity, Var::Matrix reflectivity, const Var::Numeric za, const Var::Numeric wind_speed, const Var::Numeric rel_aa, const Var::Vector transmittance, const Var::Numeric &salinity={}, const Var::Index &fastem_version={})
 
MRecord FieldFromGriddedField ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::GriddedField2 in)
 
MRecord FieldFromGriddedField ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::GriddedField3 in)
 
MRecord FieldFromGriddedField ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::GriddedField4 in)
 
MRecord FieldFromGriddedField ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::ArrayOfGriddedField3 in)
 
MRecord FlagOff ([[maybe_unused]] Workspace &ws, Var::Index flag)
 
MRecord FlagOn ([[maybe_unused]] Workspace &ws, Var::Index flag)
 
MRecord Flatten ([[maybe_unused]] Workspace &ws, Var::ArrayOfTime out, const Var::ArrayOfArrayOfTime in)
 
MRecord Flatten ([[maybe_unused]] Workspace &ws, Var::ArrayOfVector out, const Var::ArrayOfArrayOfVector in)
 
MRecord Flatten ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::ArrayOfVector in)
 
MRecord Flatten ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::ArrayOfMatrix in)
 
MRecord Flatten ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::ArrayOfTensor3 in)
 
MRecord Flatten ([[maybe_unused]] Workspace &ws, Var::Tensor5 out, const Var::ArrayOfTensor4 in)
 
MRecord Flatten ([[maybe_unused]] Workspace &ws, Var::Tensor6 out, const Var::ArrayOfTensor5 in)
 
MRecord Flatten ([[maybe_unused]] Workspace &ws, Var::Tensor7 out, const Var::ArrayOfTensor6 in)
 
MRecord ForLoop ([[maybe_unused]] Workspace &ws, const Var::Index start, const Var::Index stop, const Var::Index step)
 
MRecord FrequencyFromWavelength ([[maybe_unused]] Workspace &ws, Var::Numeric frequency, const Var::Numeric wavelength)
 
MRecord FrequencyFromWavelength ([[maybe_unused]] Workspace &ws, Var::Vector frequency, const Var::Vector wavelength)
 
MRecord FrequencyFromCGSAngularWavenumber ([[maybe_unused]] Workspace &ws, Var::Numeric frequency, const Var::Numeric angular_wavenumber)
 
MRecord FrequencyFromCGSAngularWavenumber ([[maybe_unused]] Workspace &ws, Var::Vector frequency, const Var::Vector angular_wavenumber)
 
MRecord FrequencyFromCGSKayserWavenumber ([[maybe_unused]] Workspace &ws, Var::Numeric frequency, const Var::Numeric kayser_wavenumber)
 
MRecord FrequencyFromCGSKayserWavenumber ([[maybe_unused]] Workspace &ws, Var::Vector frequency, const Var::Vector kayser_wavenumber)
 
MRecord f_gridFromAbsorptionLines ([[maybe_unused]] Workspace &ws, const Var::Index num_freqs, const Var::Numeric &delta_f_low={}, const Var::Numeric &delta_f_upp={})
 
MRecord f_gridFromGasAbsLookup ([[maybe_unused]] Workspace &ws)
 
MRecord f_gridFromSensorAMSU ([[maybe_unused]] Workspace &ws, const Var::Numeric &spacing={})
 
MRecord f_gridFromSensorAMSUgeneric ([[maybe_unused]] Workspace &ws, const Var::Numeric &spacing={}, const Var::Vector &verbosityVect={})
 
MRecord f_gridFromSensorHIRS ([[maybe_unused]] Workspace &ws, const Var::Numeric &spacing={})
 
MRecord f_gridMetMM ([[maybe_unused]] Workspace &ws, const Var::Vector &freq_spacing={}, const Var::ArrayOfIndex &freq_number={}, const Var::Numeric &freq_merge_threshold={})
 
MRecord g0Earth ([[maybe_unused]] Workspace &ws)
 
MRecord g0Io ([[maybe_unused]] Workspace &ws)
 
MRecord g0Jupiter ([[maybe_unused]] Workspace &ws)
 
MRecord g0Mars ([[maybe_unused]] Workspace &ws)
 
MRecord g0Venus ([[maybe_unused]] Workspace &ws)
 
MRecord geo_posEndOfPpath ([[maybe_unused]] Workspace &ws)
 
MRecord geo_posLowestAltitudeOfPpath ([[maybe_unused]] Workspace &ws)
 
MRecord geo_posWherePpathPassesZref ([[maybe_unused]] Workspace &ws, const Var::Numeric z_ref)
 
MRecord GetEnvironmentVariable ([[maybe_unused]] Workspace &ws, Var::String out, const Var::String in)
 
MRecord GetEnvironmentVariable ([[maybe_unused]] Workspace &ws, Var::Index out, const Var::String in)
 
MRecord GetNumberOfThreads ([[maybe_unused]] Workspace &ws, Var::Index nthreads)
 
MRecord GriddedFieldGetName ([[maybe_unused]] Workspace &ws, Var::String name, const Var::GriddedField1 griddedfield)
 
MRecord GriddedFieldGetName ([[maybe_unused]] Workspace &ws, Var::String name, const Var::GriddedField2 griddedfield)
 
MRecord GriddedFieldGetName ([[maybe_unused]] Workspace &ws, Var::String name, const Var::GriddedField3 griddedfield)
 
MRecord GriddedFieldGetName ([[maybe_unused]] Workspace &ws, Var::String name, const Var::GriddedField4 griddedfield)
 
MRecord GriddedFieldGetName ([[maybe_unused]] Workspace &ws, Var::String name, const Var::GriddedField5 griddedfield)
 
MRecord GriddedFieldGetName ([[maybe_unused]] Workspace &ws, Var::String name, const Var::GriddedField6 griddedfield)
 
MRecord GriddedFieldLatLonExpand ([[maybe_unused]] Workspace &ws, Var::GriddedField2 out, const Var::GriddedField2 in)
 
MRecord GriddedFieldLatLonExpand ([[maybe_unused]] Workspace &ws, Var::GriddedField3 out, const Var::GriddedField3 in)
 
MRecord GriddedFieldLatLonExpand ([[maybe_unused]] Workspace &ws, Var::GriddedField4 out, const Var::GriddedField4 in)
 
MRecord GriddedFieldLatLonExpand ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField3 out, const Var::ArrayOfGriddedField3 in)
 
MRecord GriddedFieldLatLonRegrid ([[maybe_unused]] Workspace &ws, Var::GriddedField2 out, const Var::GriddedField2 in, const Var::Index &interp_order={})
 
MRecord GriddedFieldLatLonRegrid ([[maybe_unused]] Workspace &ws, Var::GriddedField3 out, const Var::GriddedField3 in, const Var::Index &interp_order={})
 
MRecord GriddedFieldLatLonRegrid ([[maybe_unused]] Workspace &ws, Var::GriddedField4 out, const Var::GriddedField4 in, const Var::Index &interp_order={})
 
MRecord GriddedFieldLatLonRegrid ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField3 out, const Var::ArrayOfGriddedField3 in, const Var::Index &interp_order={})
 
MRecord GriddedFieldPRegrid ([[maybe_unused]] Workspace &ws, Var::GriddedField3 out, const Var::GriddedField3 in, const Var::Index &interp_order={}, const Var::Index &zeropadding={})
 
MRecord GriddedFieldPRegrid ([[maybe_unused]] Workspace &ws, Var::GriddedField4 out, const Var::GriddedField4 in, const Var::Index &interp_order={}, const Var::Index &zeropadding={})
 
MRecord GriddedFieldPRegrid ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField3 out, const Var::ArrayOfGriddedField3 in, const Var::Index &interp_order={}, const Var::Index &zeropadding={})
 
MRecord GriddedFieldZToPRegrid ([[maybe_unused]] Workspace &ws, Var::GriddedField3 out, const Var::GriddedField3 in, const Var::Index &interp_order={}, const Var::Index &zeropadding={})
 
MRecord heating_ratesFromIrradiance ([[maybe_unused]] Workspace &ws)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::AbsorptionLines in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Agenda in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAbsorptionLines in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfAbsorptionLines in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAgenda in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField1 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField2 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField3 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfIndex in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfMatrix in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPpath in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfPropagationMatrix in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfRadiationVector in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfScatteringMetaData in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSingleScatteringData in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSpeciesTag in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfStokesVector in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfString in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor3 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor6 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTime in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTransmissionMatrix in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfVector in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfCIARecord in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField1 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField2 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField3 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField4 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfIndex in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPropagationMatrix in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRadiationVector in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRetrievalQuantity in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfScatteringMetaData in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSingleScatteringData in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSparse in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfStokesVector in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTelsemAtlas in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor3 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor4 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor5 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor6 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor7 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTime in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTransmissionMatrix in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfVector in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ArrayOfXsecRecord in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::CIARecord in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::CovarianceMatrix in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::EnergyLevelMap in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::GasAbsLookup in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::GridPos in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::GriddedField1 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::GriddedField2 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::GriddedField3 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::GriddedField4 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::GriddedField5 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::GriddedField6 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::HitranRelaxationMatrixData in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Index in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::MCAntenna in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Matrix in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Numeric in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Ppath in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::PropagationMatrix in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::RadiationVector in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Rational in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::ScatteringMetaData in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::SingleScatteringData in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Sparse in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::SpeciesAuxData in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::StokesVector in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::String in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::TelsemAtlas in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Tensor3 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Tensor4 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Tensor5 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Tensor6 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Tensor7 in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Timer in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Time in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::TessemNN in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::TransmissionMatrix in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Vector in)
 
MRecord Ignore ([[maybe_unused]] Workspace &ws, const Var::Verbosity in)
 
MRecord INCLUDE ([[maybe_unused]] Workspace &ws)
 
MRecord IndexAdd ([[maybe_unused]] Workspace &ws, Var::Index out, const Var::Index in, const Var::Index value)
 
MRecord IndexNumberOfAtmosphericPoints ([[maybe_unused]] Workspace &ws, Var::Index n)
 
MRecord IndexSet ([[maybe_unused]] Workspace &ws, Var::Index out, const Var::Index value)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAbsorptionLines v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfAbsorptionLines v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAgenda v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField1 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField2 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField3 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfIndex v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfMatrix v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPpath v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfPropagationMatrix v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfRadiationVector v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfScatteringMetaData v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSingleScatteringData v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSpeciesTag v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfStokesVector v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfString v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor3 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor6 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTime v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTransmissionMatrix v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfVector v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfCIARecord v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField1 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField2 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField3 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField4 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfIndex v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPropagationMatrix v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRadiationVector v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRetrievalQuantity v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfScatteringMetaData v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSingleScatteringData v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSparse v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfStokesVector v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTelsemAtlas v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor3 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor4 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor5 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor6 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor7 v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTime v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTransmissionMatrix v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfVector v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::ArrayOfXsecRecord v)
 
MRecord IndexSetToLast ([[maybe_unused]] Workspace &ws, const Var::Vector v)
 
MRecord IndexStepDown ([[maybe_unused]] Workspace &ws, Var::Index out, const Var::Index in)
 
MRecord IndexStepUp ([[maybe_unused]] Workspace &ws, Var::Index out, const Var::Index in)
 
MRecord InterpAtmFieldToPosition ([[maybe_unused]] Workspace &ws, Var::Numeric out, const Var::Tensor3 field)
 
MRecord InterpGriddedField2ToPosition ([[maybe_unused]] Workspace &ws, Var::Numeric out, const Var::GriddedField2 gfield2)
 
MRecord InterpSurfaceFieldToPosition ([[maybe_unused]] Workspace &ws, Var::Numeric out, const Var::Matrix field)
 
MRecord irradiance_fieldFromRadiance ([[maybe_unused]] Workspace &ws)
 
MRecord isotopologue_ratiosInitFromBuiltin ([[maybe_unused]] Workspace &ws)
 
MRecord iyActiveSingleScat ([[maybe_unused]] Workspace &ws, const Var::Index &trans_in_jacobian={}, const Var::Numeric &pext_scaling={}, const Var::Index &t_interp_order={})
 
MRecord iyActiveSingleScat2 ([[maybe_unused]] Workspace &ws, const Var::Index &trans_in_jacobian={}, const Var::Numeric &pext_scaling={}, const Var::Index &t_interp_order={})
 
MRecord iyApplyUnit ([[maybe_unused]] Workspace &ws)
 
MRecord iyCalc ([[maybe_unused]] Workspace &ws)
 
MRecord iyEmissionStandard ([[maybe_unused]] Workspace &ws)
 
MRecord iyEmissionStandardSequential ([[maybe_unused]] Workspace &ws)
 
MRecord iyHybrid ([[maybe_unused]] Workspace &ws, const Var::Index &Naa_grid={}, const Var::Index &t_interp_order={})
 
MRecord iyHybrid2 ([[maybe_unused]] Workspace &ws, const Var::Index &Naa_grid={}, const Var::Index &t_interp_order={})
 
MRecord iyIndependentBeamApproximation ([[maybe_unused]] Workspace &ws, const Var::Index &return_atm1d={}, const Var::Index &skip_vmr={}, const Var::Index &skip_pnd={}, const Var::Index &return_masses={})
 
MRecord iyInterpCloudboxField ([[maybe_unused]] Workspace &ws, const Var::Index &za_interp_order={}, const Var::Index &za_restrict={}, const Var::Index &cos_za_interp={}, const Var::Numeric &za_extpolfac={}, const Var::Index &aa_interp_order={})
 
MRecord iyLoopFrequencies ([[maybe_unused]] Workspace &ws)
 
MRecord iyMC ([[maybe_unused]] Workspace &ws, const Var::Index &t_interp_order={})
 
MRecord iyReplaceFromAux ([[maybe_unused]] Workspace &ws, const Var::String aux_var)
 
MRecord iySurfaceCallAgendaX ([[maybe_unused]] Workspace &ws)
 
MRecord iySurfaceFastem ([[maybe_unused]] Workspace &ws, const Var::Numeric wind_speed, const Var::Numeric &salinity={}, const Var::Numeric &wind_direction={}, const Var::Index &fastem_version={})
 
MRecord iySurfaceRtpropAgenda ([[maybe_unused]] Workspace &ws)
 
MRecord iySurfaceRtpropCalc ([[maybe_unused]] Workspace &ws)
 
MRecord iyTransmissionStandard ([[maybe_unused]] Workspace &ws)
 
MRecord iy_transmitterMultiplePol ([[maybe_unused]] Workspace &ws)
 
MRecord iy_transmitterSinglePol ([[maybe_unused]] Workspace &ws)
 
MRecord jacobianAddAbsSpecies ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String species, const Var::String &unit={}, const Var::Index &for_species_tag={})
 
MRecord jacobianAddBasicCatalogParameter ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier catalog_identity, const Var::String catalog_parameter)
 
MRecord jacobianAddBasicCatalogParameters ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier catalog_identities, const Var::ArrayOfString catalog_parameters)
 
MRecord jacobianAddFreqShift ([[maybe_unused]] Workspace &ws, const Var::Numeric &df={})
 
MRecord jacobianAddFreqStretch ([[maybe_unused]] Workspace &ws, const Var::Numeric &df={})
 
MRecord jacobianAddShapeCatalogParameter ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier line_identity, const Var::String species, const Var::String variable, const Var::String coefficient)
 
MRecord jacobianAddShapeCatalogParameters ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier line_identities, const Var::ArrayOfString species, const Var::ArrayOfString variables, const Var::ArrayOfString coefficients)
 
MRecord jacobianAddMagField ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String &component={}, const Var::Numeric &dB={})
 
MRecord jacobianAddNLTE ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::QuantumIdentifier energy_level_identity, const Var::Numeric &dx={})
 
MRecord jacobianAddNLTEs ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::ArrayOfQuantumIdentifier energy_level_identities, const Var::Numeric &dx={})
 
MRecord jacobianAddPointingZa ([[maybe_unused]] Workspace &ws, const Var::Index &poly_order={}, const Var::String &calcmode={}, const Var::Numeric &dza={})
 
MRecord jacobianAddPolyfit ([[maybe_unused]] Workspace &ws, const Var::Index poly_order, const Var::Index &no_pol_variation={}, const Var::Index &no_los_variation={}, const Var::Index &no_mblock_variation={})
 
MRecord jacobianAddScatSpecies ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String species, const Var::String quantity)
 
MRecord jacobianAddSinefit ([[maybe_unused]] Workspace &ws, const Var::Vector period_lengths, const Var::Index &no_pol_variation={}, const Var::Index &no_los_variation={}, const Var::Index &no_mblock_variation={})
 
MRecord jacobianAddSpecialSpecies ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String species)
 
MRecord jacobianAddSurfaceQuantity ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::String quantity)
 
MRecord jacobianAddTemperature ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String &hse={})
 
MRecord jacobianAddWind ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String &component={}, const Var::Numeric &dfrequency={})
 
MRecord jacobianAdjustAndTransform ([[maybe_unused]] Workspace &ws)
 
MRecord jacobianCalcDoNothing ([[maybe_unused]] Workspace &ws)
 
MRecord jacobianCalcFreqShift ([[maybe_unused]] Workspace &ws)
 
MRecord jacobianCalcFreqStretch ([[maybe_unused]] Workspace &ws)
 
MRecord jacobianCalcPointingZaInterp ([[maybe_unused]] Workspace &ws)
 
MRecord jacobianCalcPointingZaRecalc ([[maybe_unused]] Workspace &ws)
 
MRecord jacobianCalcPolyfit ([[maybe_unused]] Workspace &ws, const Var::Index poly_coeff)
 
MRecord jacobianCalcSinefit ([[maybe_unused]] Workspace &ws, const Var::Index period_index)
 
MRecord jacobianClose ([[maybe_unused]] Workspace &ws)
 
MRecord jacobianFromTwoY ([[maybe_unused]] Workspace &ws, const Var::Vector y_pert, const Var::Numeric pert_size)
 
MRecord jacobianFromYbatch ([[maybe_unused]] Workspace &ws, const Var::Numeric pert_size)
 
MRecord jacobianInit ([[maybe_unused]] Workspace &ws)
 
MRecord jacobianOff ([[maybe_unused]] Workspace &ws)
 
MRecord jacobianSetAffineTransformation ([[maybe_unused]] Workspace &ws, const Var::Matrix transformation_matrix, const Var::Vector offset_vector)
 
MRecord jacobianSetFuncTransformation ([[maybe_unused]] Workspace &ws, const Var::String transformation_func, const Var::Numeric &z_min={}, const Var::Numeric &z_max={})
 
MRecord lat_gridFromRawField ([[maybe_unused]] Workspace &ws, const Var::GriddedField3 field_raw)
 
MRecord lbl_checkedCalc ([[maybe_unused]] Workspace &ws)
 
MRecord LocalTimeOffset ([[maybe_unused]] Workspace &ws, Var::Numeric dt)
 
MRecord lon_gridFromRawField ([[maybe_unused]] Workspace &ws, const Var::GriddedField3 field_raw)
 
MRecord MagFieldsCalc ([[maybe_unused]] Workspace &ws, const Var::Index &interp_order={})
 
MRecord MagFieldsCalcExpand1D ([[maybe_unused]] Workspace &ws, const Var::Index &interp_order={})
 
MRecord MagFieldsFromAltitudeRawCalc ([[maybe_unused]] Workspace &ws, const Var::Index &interp_order={}, const Var::Numeric &extrapolating={})
 
MRecord MagRawRead ([[maybe_unused]] Workspace &ws, const Var::String basename)
 
MRecord MatrixAddScalar ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Matrix in, const Var::Numeric value)
 
MRecord MatrixCBR ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector f)
 
MRecord MatrixCopySparse ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Sparse in)
 
MRecord MatrixExtractFromTensor3 ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Tensor3 in, const Var::Index i, const Var::String direction)
 
MRecord MatrixFromCovarianceMatrix ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::CovarianceMatrix in)
 
MRecord MatrixIdentity ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Index n, const Var::Numeric &value={})
 
MRecord MatrixMatrixMultiply ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Matrix m, const Var::Matrix x)
 
MRecord MatrixPlanck ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector f, const Var::Numeric t)
 
MRecord MatrixScale ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Matrix in, const Var::Numeric value)
 
MRecord MatrixSet ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Matrix value)
 
MRecord MatrixSetConstant ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Numeric value)
 
MRecord MatrixUnitIntensity ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector f)
 
MRecord MatrixVectorMultiply ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Matrix m, const Var::Vector v)
 
MRecord Matrix1ColFromVector ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector v)
 
MRecord Matrix2ColFromVectors ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector v1, const Var::Vector v2)
 
MRecord Matrix3ColFromVectors ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector v1, const Var::Vector v2, const Var::Vector v3)
 
MRecord Matrix1RowFromVector ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector v)
 
MRecord Matrix2RowFromVectors ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector v1, const Var::Vector v2)
 
MRecord Matrix3RowFromVectors ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::Vector v1, const Var::Vector v2, const Var::Vector v3)
 
MRecord mblock_dlos_gridUniformCircular ([[maybe_unused]] Workspace &ws, const Var::Numeric spacing, const Var::Numeric width, const Var::Index &centre={})
 
MRecord mblock_dlos_gridUniformRectangular ([[maybe_unused]] Workspace &ws, const Var::Numeric spacing, const Var::Numeric za_width, const Var::Numeric aa_width, const Var::Index &centre={})
 
MRecord mc_antennaSetGaussian ([[maybe_unused]] Workspace &ws, const Var::Numeric za_sigma, const Var::Numeric aa_sigma)
 
MRecord mc_antennaSetGaussianByFWHM ([[maybe_unused]] Workspace &ws, const Var::Numeric za_fwhm, const Var::Numeric aa_fwhm)
 
MRecord mc_antennaSetPencilBeam ([[maybe_unused]] Workspace &ws)
 
MRecord MCGeneral ([[maybe_unused]] Workspace &ws, const Var::Index &l_mc_scat_order={}, const Var::Index &t_interp_order={})
 
MRecord MCRadar ([[maybe_unused]] Workspace &ws, const Var::Numeric &ze_tref={}, const Var::Numeric &k2={}, const Var::Index &t_interp_order={})
 
MRecord MCSetSeedFromTime ([[maybe_unused]] Workspace &ws)
 
MRecord nlte_fieldRescalePopulationLevels ([[maybe_unused]] Workspace &ws, const Var::Numeric s)
 
MRecord nlte_fieldForSingleSpeciesNonOverlappingLines ([[maybe_unused]] Workspace &ws, const Var::Numeric df, const Var::Index nz, const Var::Index nf, const Var::Index dampened, const Var::Numeric &convergence_limit={}, const Var::Index &iteration_limit={})
 
MRecord collision_coefficientsFromSplitFiles ([[maybe_unused]] Workspace &ws, const Var::String &basename={})
 
MRecord NumericAdd ([[maybe_unused]] Workspace &ws, Var::Numeric out, const Var::Numeric in, const Var::Numeric value)
 
MRecord NumericFromVector ([[maybe_unused]] Workspace &ws, Var::Numeric out, const Var::Vector in, const Var::String op)
 
MRecord NumericInvScale ([[maybe_unused]] Workspace &ws, Var::Numeric out, const Var::Numeric in, const Var::Numeric value)
 
MRecord NumericScale ([[maybe_unused]] Workspace &ws, Var::Numeric out, const Var::Numeric in, const Var::Numeric value)
 
MRecord NumericSet ([[maybe_unused]] Workspace &ws, Var::Numeric out, const Var::Numeric value)
 
MRecord QuantumIdentifierSet ([[maybe_unused]] Workspace &ws, Var::QuantumIdentifier out, const Var::String string_initializer)
 
MRecord ArrayOfQuantumIdentifierSet ([[maybe_unused]] Workspace &ws, Var::ArrayOfQuantumIdentifier out, const Var::ArrayOfString string_initializers)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAbsorptionLines v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfAbsorptionLines v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAgenda v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField1 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField2 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField3 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfIndex v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfMatrix v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPpath v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfPropagationMatrix v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfRadiationVector v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfScatteringMetaData v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSingleScatteringData v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSpeciesTag v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfStokesVector v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfString v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor3 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor6 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTime v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTransmissionMatrix v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfVector v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfCIARecord v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField1 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField2 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField3 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField4 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfIndex v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPropagationMatrix v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRadiationVector v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRetrievalQuantity v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfScatteringMetaData v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSingleScatteringData v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSparse v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfStokesVector v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTelsemAtlas v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor3 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor4 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor5 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor6 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor7 v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTime v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTransmissionMatrix v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfVector v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::ArrayOfXsecRecord v)
 
MRecord nelemGet ([[maybe_unused]] Workspace &ws, const Var::Vector v)
 
MRecord ncolsGet ([[maybe_unused]] Workspace &ws, const Var::Matrix v)
 
MRecord ncolsGet ([[maybe_unused]] Workspace &ws, const Var::Sparse v)
 
MRecord ncolsGet ([[maybe_unused]] Workspace &ws, const Var::Tensor3 v)
 
MRecord ncolsGet ([[maybe_unused]] Workspace &ws, const Var::Tensor4 v)
 
MRecord ncolsGet ([[maybe_unused]] Workspace &ws, const Var::Tensor5 v)
 
MRecord ncolsGet ([[maybe_unused]] Workspace &ws, const Var::Tensor6 v)
 
MRecord ncolsGet ([[maybe_unused]] Workspace &ws, const Var::Tensor7 v)
 
MRecord nrowsGet ([[maybe_unused]] Workspace &ws, const Var::Matrix v)
 
MRecord nrowsGet ([[maybe_unused]] Workspace &ws, const Var::Sparse v)
 
MRecord nrowsGet ([[maybe_unused]] Workspace &ws, const Var::Tensor3 v)
 
MRecord nrowsGet ([[maybe_unused]] Workspace &ws, const Var::Tensor4 v)
 
MRecord nrowsGet ([[maybe_unused]] Workspace &ws, const Var::Tensor5 v)
 
MRecord nrowsGet ([[maybe_unused]] Workspace &ws, const Var::Tensor6 v)
 
MRecord nrowsGet ([[maybe_unused]] Workspace &ws, const Var::Tensor7 v)
 
MRecord npagesGet ([[maybe_unused]] Workspace &ws, const Var::Tensor3 v)
 
MRecord npagesGet ([[maybe_unused]] Workspace &ws, const Var::Tensor4 v)
 
MRecord npagesGet ([[maybe_unused]] Workspace &ws, const Var::Tensor5 v)
 
MRecord npagesGet ([[maybe_unused]] Workspace &ws, const Var::Tensor6 v)
 
MRecord npagesGet ([[maybe_unused]] Workspace &ws, const Var::Tensor7 v)
 
MRecord nbooksGet ([[maybe_unused]] Workspace &ws, const Var::Tensor4 v)
 
MRecord nbooksGet ([[maybe_unused]] Workspace &ws, const Var::Tensor5 v)
 
MRecord nbooksGet ([[maybe_unused]] Workspace &ws, const Var::Tensor6 v)
 
MRecord nbooksGet ([[maybe_unused]] Workspace &ws, const Var::Tensor7 v)
 
MRecord nshelvesGet ([[maybe_unused]] Workspace &ws, const Var::Tensor5 v)
 
MRecord nshelvesGet ([[maybe_unused]] Workspace &ws, const Var::Tensor6 v)
 
MRecord nshelvesGet ([[maybe_unused]] Workspace &ws, const Var::Tensor7 v)
 
MRecord nvitrinesGet ([[maybe_unused]] Workspace &ws, const Var::Tensor6 v)
 
MRecord nvitrinesGet ([[maybe_unused]] Workspace &ws, const Var::Tensor7 v)
 
MRecord nlibrariesGet ([[maybe_unused]] Workspace &ws, const Var::Tensor7 v)
 
MRecord nlte_sourceFromTemperatureAndSrcCoefPerSpecies ([[maybe_unused]] Workspace &ws)
 
MRecord nlteOff ([[maybe_unused]] Workspace &ws)
 
MRecord nlteSetByQuantumIdentifiers ([[maybe_unused]] Workspace &ws)
 
MRecord nlte_fieldFromRaw ([[maybe_unused]] Workspace &ws, const Var::Tensor4 data)
 
MRecord nlte_fieldSetLteExternalPartitionFunction ([[maybe_unused]] Workspace &ws)
 
MRecord ArrayOfQuantumIdentifierFromLines ([[maybe_unused]] Workspace &ws, Var::ArrayOfQuantumIdentifier out, const Var::Index &global={})
 
MRecord nlte_fieldSetLteInternalPartitionFunction ([[maybe_unused]] Workspace &ws)
 
MRecord timeNow ([[maybe_unused]] Workspace &ws)
 
MRecord timeOffset ([[maybe_unused]] Workspace &ws, const Var::Numeric offset)
 
MRecord OEM ([[maybe_unused]] Workspace &ws, const Var::String method, const Var::Numeric &max_start_cost={}, const Var::Vector &x_norm={}, const Var::Index &max_iter={}, const Var::Numeric &stop_dx={}, const Var::Vector &lm_ga_settings={}, const Var::Index &clear_matrices={}, const Var::Index &display_progress={})
 
MRecord avkCalc ([[maybe_unused]] Workspace &ws)
 
MRecord covmat_soCalc ([[maybe_unused]] Workspace &ws)
 
MRecord covmat_ssCalc ([[maybe_unused]] Workspace &ws)
 
MRecord opt_prop_bulkCalc ([[maybe_unused]] Workspace &ws)
 
MRecord opt_prop_sptFromData ([[maybe_unused]] Workspace &ws)
 
MRecord opt_prop_sptFromScat_data ([[maybe_unused]] Workspace &ws)
 
MRecord opt_prop_sptFromMonoData ([[maybe_unused]] Workspace &ws)
 
MRecord output_file_formatSetAscii ([[maybe_unused]] Workspace &ws)
 
MRecord output_file_formatSetBinary ([[maybe_unused]] Workspace &ws)
 
MRecord output_file_formatSetZippedAscii ([[maybe_unused]] Workspace &ws)
 
MRecord particle_bulkprop_fieldClip ([[maybe_unused]] Workspace &ws, const Var::String bulkprop_name, const Var::Numeric &limit_low={}, const Var::Numeric &limit_high={})
 
MRecord particle_bulkprop_fieldPerturb ([[maybe_unused]] Workspace &ws, const Var::String particle_type, const Var::Vector p_ret_grid, const Var::Vector lat_ret_grid, const Var::Vector lon_ret_grid, const Var::Index pert_index, const Var::Numeric pert_size, const Var::String &pert_mode={})
 
MRecord particle_bulkprop_fieldPerturbAtmGrids ([[maybe_unused]] Workspace &ws, const Var::String particle_type, const Var::Index pert_index, const Var::Numeric pert_size, const Var::String &pert_mode={})
 
MRecord particle_massesFromMetaDataSingleCategory ([[maybe_unused]] Workspace &ws)
 
MRecord particle_massesFromMetaData ([[maybe_unused]] Workspace &ws)
 
MRecord partition_functionsInitFromBuiltin ([[maybe_unused]] Workspace &ws)
 
MRecord pha_matCalc ([[maybe_unused]] Workspace &ws)
 
MRecord pha_mat_sptFromData ([[maybe_unused]] Workspace &ws)
 
MRecord pha_mat_sptFromDataDOITOpt ([[maybe_unused]] Workspace &ws)
 
MRecord pha_mat_sptFromMonoData ([[maybe_unused]] Workspace &ws)
 
MRecord pha_mat_sptFromScat_data ([[maybe_unused]] Workspace &ws)
 
MRecord pndFromPsd ([[maybe_unused]] Workspace &ws, const Var::Index scat_index, const Var::Index &quad_order={}, const Var::Numeric &threshold_se_ext={}, const Var::Numeric &threshold_ss_ext={}, const Var::Numeric &threshold_se_pnd={})
 
MRecord pndFromPsdBasic ([[maybe_unused]] Workspace &ws, const Var::Index &quad_order={})
 
MRecord pnd_fieldCalcFromParticleBulkProps ([[maybe_unused]] Workspace &ws)
 
MRecord pnd_fieldCalcFrompnd_field_raw ([[maybe_unused]] Workspace &ws, const Var::Index &zeropadding={})
 
MRecord pnd_fieldExpand1D ([[maybe_unused]] Workspace &ws, const Var::Index &nzero={})
 
MRecord pnd_fieldZero ([[maybe_unused]] Workspace &ws)
 
MRecord ppath_fieldFromDownUpLimbGeoms ([[maybe_unused]] Workspace &ws, const Var::Index &nz={})
 
MRecord ppathCalc ([[maybe_unused]] Workspace &ws)
 
MRecord ppath_fieldCalc ([[maybe_unused]] Workspace &ws)
 
MRecord ppathCalcFromAltitude ([[maybe_unused]] Workspace &ws, const Var::Numeric altitude, const Var::Numeric &accuracy={})
 
MRecord ppathFromRtePos2 ([[maybe_unused]] Workspace &ws, const Var::Numeric &za_accuracy={}, const Var::Numeric &pplrt_factor={}, const Var::Numeric &pplrt_lowest={})
 
MRecord ppathPlaneParallel ([[maybe_unused]] Workspace &ws)
 
MRecord ppathStepByStep ([[maybe_unused]] Workspace &ws)
 
MRecord ppathWriteXMLPartial ([[maybe_unused]] Workspace &ws, const Var::String &filename={}, const Var::Index &file_index={})
 
MRecord ppath_stepGeometric ([[maybe_unused]] Workspace &ws)
 
MRecord ppath_stepRefractionBasic ([[maybe_unused]] Workspace &ws)
 
MRecord ppvar_optical_depthFromPpvar_trans_cumulat ([[maybe_unused]] Workspace &ws)
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::AbsorptionLines in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Agenda in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAbsorptionLines in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfAbsorptionLines in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAgenda in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField1 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField2 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField3 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfIndex in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfMatrix in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPpath in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfPropagationMatrix in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfRadiationVector in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfScatteringMetaData in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSingleScatteringData in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSpeciesTag in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfStokesVector in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfString in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor3 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor6 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTime in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTransmissionMatrix in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfVector in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfCIARecord in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField1 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField2 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField3 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField4 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfIndex in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPropagationMatrix in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRadiationVector in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRetrievalQuantity in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfScatteringMetaData in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSingleScatteringData in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSparse in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfStokesVector in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTelsemAtlas in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor3 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor4 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor5 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor6 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor7 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTime in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTransmissionMatrix in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfVector in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ArrayOfXsecRecord in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::CIARecord in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::CovarianceMatrix in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::EnergyLevelMap in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::GasAbsLookup in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::GridPos in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::GriddedField1 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::GriddedField2 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::GriddedField3 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::GriddedField4 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::GriddedField5 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::GriddedField6 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::HitranRelaxationMatrixData in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Index in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::MCAntenna in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Matrix in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Numeric in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Ppath in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::PropagationMatrix in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::RadiationVector in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Rational in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::ScatteringMetaData in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::SingleScatteringData in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Sparse in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::SpeciesAuxData in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::StokesVector in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::String in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::TelsemAtlas in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Tensor3 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Tensor4 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Tensor5 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Tensor6 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Tensor7 in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Timer in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Time in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::TessemNN in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::TransmissionMatrix in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Vector in, const Var::Index &level={})
 
MRecord Print ([[maybe_unused]] Workspace &ws, const Var::Verbosity in, const Var::Index &level={})
 
MRecord PrintPhysicalConstants ([[maybe_unused]] Workspace &ws)
 
MRecord PrintWorkspace ([[maybe_unused]] Workspace &ws, const Var::Index &only_allocated={}, const Var::Index &level={})
 
MRecord ZFromPSimple ([[maybe_unused]] Workspace &ws, Var::Vector z_grid, const Var::Vector p_grid)
 
MRecord PFromZSimple ([[maybe_unused]] Workspace &ws, Var::Vector p_grid, const Var::Vector z_grid)
 
MRecord propmat_clearskyAddFaraday ([[maybe_unused]] Workspace &ws)
 
MRecord propmat_clearskyAddFromAbsCoefPerSpecies ([[maybe_unused]] Workspace &ws)
 
MRecord propmat_clearskyAddFromLookup ([[maybe_unused]] Workspace &ws, const Var::Numeric &extpolfac={})
 
MRecord propmat_clearskyAddHitranLineMixingLines ([[maybe_unused]] Workspace &ws)
 
MRecord propmat_clearskyAddOnTheFly ([[maybe_unused]] Workspace &ws)
 
MRecord propmat_clearskyAddParticles ([[maybe_unused]] Workspace &ws, const Var::Index &use_abs_as_ext={})
 
MRecord propmat_clearskyAddZeeman ([[maybe_unused]] Workspace &ws, const Var::Index &manual_zeeman_tag={}, const Var::Numeric &manual_zeeman_magnetic_field_strength={}, const Var::Numeric &manual_zeeman_theta={}, const Var::Numeric &manual_zeeman_eta={})
 
MRecord propmat_clearskyInit ([[maybe_unused]] Workspace &ws)
 
MRecord propmat_clearskyZero ([[maybe_unused]] Workspace &ws)
 
MRecord propmat_clearskyForceNegativeToZero ([[maybe_unused]] Workspace &ws)
 
MRecord propmat_clearsky_agenda_checkedCalc ([[maybe_unused]] Workspace &ws)
 
MRecord propmat_clearsky_fieldCalc ([[maybe_unused]] Workspace &ws, const Var::Vector &doppler={}, const Var::Vector &los={})
 
MRecord psdAbelBoutle12 ([[maybe_unused]] Workspace &ws, const Var::Numeric &t_min={}, const Var::Numeric &t_max={}, const Var::Index &picky={})
 
MRecord psdDelanoeEtAl14 ([[maybe_unused]] Workspace &ws, const Var::Numeric t_min, const Var::Numeric t_max, const Var::Numeric &iwc={}, const Var::Numeric &n0Star={}, const Var::Numeric &Dm={}, const Var::Numeric &rho={}, const Var::Numeric &alpha={}, const Var::Numeric &beta={}, const Var::Numeric &dm_min={}, const Var::Index &picky={})
 
MRecord psdFieldEtAl07 ([[maybe_unused]] Workspace &ws, const Var::String regime, const Var::Numeric &t_min={}, const Var::Numeric &t_max={}, const Var::Numeric &t_min_psd={}, const Var::Numeric &t_max_psd={}, const Var::Numeric &beta_min={}, const Var::Numeric &beta_max={}, const Var::Index &picky={})
 
MRecord psdFieldEtAl19 ([[maybe_unused]] Workspace &ws, const Var::Numeric t_min, const Var::Numeric t_max, const Var::Index &picky={})
 
MRecord psdMcFarquaharHeymsfield97 ([[maybe_unused]] Workspace &ws, const Var::Numeric &t_min={}, const Var::Numeric &t_max={}, const Var::Numeric &t_min_psd={}, const Var::Numeric &t_max_psd={}, const Var::Index &picky={}, const Var::Index &noisy={})
 
MRecord psdMilbrandtYau05 ([[maybe_unused]] Workspace &ws, const Var::String hydrometeor_type, const Var::Numeric &t_min={}, const Var::Numeric &t_max={}, const Var::Index &picky={})
 
MRecord psdModifiedGamma ([[maybe_unused]] Workspace &ws, const Var::Numeric t_min, const Var::Numeric t_max, const Var::Numeric &n0={}, const Var::Numeric &mu={}, const Var::Numeric &la={}, const Var::Numeric &ga={}, const Var::Index &picky={})
 
MRecord psdModifiedGammaMass ([[maybe_unused]] Workspace &ws, const Var::Numeric t_min, const Var::Numeric t_max, const Var::Numeric &n0={}, const Var::Numeric &mu={}, const Var::Numeric &la={}, const Var::Numeric &ga={}, const Var::Index &picky={})
 
MRecord psdModifiedGammaMassNtot ([[maybe_unused]] Workspace &ws, const Var::Numeric t_min, const Var::Numeric t_max, const Var::Numeric &n0={}, const Var::Numeric &mu={}, const Var::Numeric &la={}, const Var::Numeric &ga={}, const Var::Index &picky={})
 
MRecord psdModifiedGammaMassMeanParticleMass ([[maybe_unused]] Workspace &ws, const Var::Numeric t_min, const Var::Numeric t_max, const Var::Numeric &n0={}, const Var::Numeric &mu={}, const Var::Numeric &la={}, const Var::Numeric &ga={}, const Var::Index &picky={})
 
MRecord psdModifiedGammaMassSingleMoment ([[maybe_unused]] Workspace &ws, const Var::Numeric n_alpha, const Var::Numeric n_b, const Var::Numeric mu, const Var::Numeric gamma, const Var::Numeric t_min, const Var::Numeric t_max, const Var::Index &picky={})
 
MRecord psdModifiedGammaMassXmean ([[maybe_unused]] Workspace &ws, const Var::Numeric t_min, const Var::Numeric t_max, const Var::Numeric &n0={}, const Var::Numeric &mu={}, const Var::Numeric &la={}, const Var::Numeric &ga={}, const Var::Index &picky={})
 
MRecord psdModifiedGammaMassXmedian ([[maybe_unused]] Workspace &ws, const Var::Numeric t_min, const Var::Numeric t_max, const Var::Numeric &n0={}, const Var::Numeric &mu={}, const Var::Numeric &la={}, const Var::Numeric &ga={}, const Var::Index &picky={})
 
MRecord psdMonoDispersive ([[maybe_unused]] Workspace &ws, const Var::Index species_index, const Var::Numeric t_min, const Var::Numeric t_max, const Var::Index &picky={})
 
MRecord psdMonoMass ([[maybe_unused]] Workspace &ws, const Var::Index species_index, const Var::Numeric t_min, const Var::Numeric t_max, const Var::Index &picky={})
 
MRecord psdSeifertBeheng06 ([[maybe_unused]] Workspace &ws, const Var::String hydrometeor_type, const Var::Numeric &t_min={}, const Var::Numeric &t_max={}, const Var::Index &picky={})
 
MRecord psdWangEtAl16 ([[maybe_unused]] Workspace &ws, const Var::Numeric &t_min={}, const Var::Numeric &t_max={}, const Var::Index &picky={})
 
MRecord p_gridDensify ([[maybe_unused]] Workspace &ws, const Var::Vector p_grid_old, const Var::Index &nfill={})
 
MRecord p_gridFromZRaw ([[maybe_unused]] Workspace &ws, const Var::Index &no_negZ={})
 
MRecord lat_gridFromZRaw ([[maybe_unused]] Workspace &ws)
 
MRecord lon_gridFromZRaw ([[maybe_unused]] Workspace &ws)
 
MRecord atm_gridsFromZRaw ([[maybe_unused]] Workspace &ws, const Var::Index &no_negZ={})
 
MRecord p_gridFromGasAbsLookup ([[maybe_unused]] Workspace &ws)
 
MRecord p_gridRefine ([[maybe_unused]] Workspace &ws, const Var::Vector p_grid_old, const Var::Numeric p_step)
 
MRecord RadiationFieldSpectralIntegrate ([[maybe_unused]] Workspace &ws, Var::Tensor4 radiation_field, const Var::Tensor5 spectral_radiation_field)
 
MRecord RadiationFieldSpectralIntegrate ([[maybe_unused]] Workspace &ws, Var::Tensor5 radiation_field, const Var::Tensor7 spectral_radiation_field)
 
MRecord line_irradianceCalcForSingleSpeciesNonOverlappingLinesPseudo2D ([[maybe_unused]] Workspace &ws, const Var::Numeric df, const Var::Index nz, const Var::Index nf, const Var::Numeric &r={})
 
MRecord RationalAdd ([[maybe_unused]] Workspace &ws, Var::Rational out, const Var::Rational in, const Var::Rational value)
 
MRecord RationalInvScale ([[maybe_unused]] Workspace &ws, Var::Rational out, const Var::Rational in, const Var::Rational value)
 
MRecord RationalScale ([[maybe_unused]] Workspace &ws, Var::Rational out, const Var::Rational in, const Var::Rational value)
 
MRecord RationalSet ([[maybe_unused]] Workspace &ws, Var::Rational out, const Var::Index numerator, const Var::Index &denominator={})
 
MRecord ReadArrayOfARTSCAT ([[maybe_unused]] Workspace &ws, const Var::String filename, const Var::Numeric &fmin={}, const Var::Numeric &fmax={}, const Var::String &globalquantumnumbers={}, const Var::String &localquantumnumbers={}, const Var::String &normalization_option={}, const Var::String &mirroring_option={}, const Var::String &population_option={}, const Var::String &lineshapetype_option={}, const Var::String &cutoff_option={}, const Var::Numeric &cutoff_value={}, const Var::Numeric &linemixinglimit_value={})
 
MRecord ReadSplitARTSCAT ([[maybe_unused]] Workspace &ws, const Var::String basename, const Var::Numeric &fmin={}, const Var::Numeric &fmax={}, const Var::String &globalquantumnumbers={}, const Var::String &localquantumnumbers={}, const Var::Index &ignore_missing={}, const Var::String &normalization_option={}, const Var::String &mirroring_option={}, const Var::String &population_option={}, const Var::String &lineshapetype_option={}, const Var::String &cutoff_option={}, const Var::Numeric &cutoff_value={}, const Var::Numeric &linemixinglimit_value={})
 
MRecord ReadARTSCAT ([[maybe_unused]] Workspace &ws, const Var::String filename, const Var::Numeric &fmin={}, const Var::Numeric &fmax={}, const Var::String &globalquantumnumbers={}, const Var::String &localquantumnumbers={}, const Var::String &normalization_option={}, const Var::String &mirroring_option={}, const Var::String &population_option={}, const Var::String &lineshapetype_option={}, const Var::String &cutoff_option={}, const Var::Numeric &cutoff_value={}, const Var::Numeric &linemixinglimit_value={})
 
MRecord ReadHITRAN ([[maybe_unused]] Workspace &ws, const Var::String filename, const Var::Numeric &fmin={}, const Var::Numeric &fmax={}, const Var::String &globalquantumnumbers={}, const Var::String &localquantumnumbers={}, const Var::String &hitran_type={}, const Var::String &normalization_option={}, const Var::String &mirroring_option={}, const Var::String &population_option={}, const Var::String &lineshapetype_option={}, const Var::String &cutoff_option={}, const Var::Numeric &cutoff_value={}, const Var::Numeric &linemixinglimit_value={})
 
MRecord ReadLBLRTM ([[maybe_unused]] Workspace &ws, const Var::String filename, const Var::Numeric &fmin={}, const Var::Numeric &fmax={}, const Var::String &globalquantumnumbers={}, const Var::String &localquantumnumbers={}, const Var::String &normalization_option={}, const Var::String &mirroring_option={}, const Var::String &population_option={}, const Var::String &lineshapetype_option={}, const Var::String &cutoff_option={}, const Var::Numeric &cutoff_value={}, const Var::Numeric &linemixinglimit_value={})
 
MRecord ReadMytran2 ([[maybe_unused]] Workspace &ws, const Var::String filename, const Var::Numeric &fmin={}, const Var::Numeric &fmax={}, const Var::String &globalquantumnumbers={}, const Var::String &localquantumnumbers={}, const Var::String &normalization_option={}, const Var::String &mirroring_option={}, const Var::String &population_option={}, const Var::String &lineshapetype_option={}, const Var::String &cutoff_option={}, const Var::Numeric &cutoff_value={}, const Var::Numeric &linemixinglimit_value={})
 
MRecord ReadJPL ([[maybe_unused]] Workspace &ws, const Var::String filename, const Var::Numeric &fmin={}, const Var::Numeric &fmax={}, const Var::String &globalquantumnumbers={}, const Var::String &localquantumnumbers={}, const Var::String &normalization_option={}, const Var::String &mirroring_option={}, const Var::String &population_option={}, const Var::String &lineshapetype_option={}, const Var::String &cutoff_option={}, const Var::Numeric &cutoff_value={}, const Var::Numeric &linemixinglimit_value={})
 
MRecord abs_linesTruncateGlobalQuantumNumbers ([[maybe_unused]] Workspace &ws)
 
MRecord abs_linesWriteSplitXML ([[maybe_unused]] Workspace &ws, const Var::String basename)
 
MRecord abs_linesWriteSpeciesSplitXML ([[maybe_unused]] Workspace &ws, const Var::String basename)
 
MRecord abs_lines_per_speciesWriteSplitXML ([[maybe_unused]] Workspace &ws, const Var::String basename)
 
MRecord abs_lines_per_speciesWriteSpeciesSplitXML ([[maybe_unused]] Workspace &ws, const Var::String basename)
 
MRecord ReadNetCDF ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::String filename)
 
MRecord ReadNetCDF ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::String filename)
 
MRecord ReadNetCDF ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::String filename)
 
MRecord ReadNetCDF ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::String filename)
 
MRecord ReadNetCDF ([[maybe_unused]] Workspace &ws, Var::Tensor5 out, const Var::String filename)
 
MRecord ReadNetCDF ([[maybe_unused]] Workspace &ws, Var::ArrayOfVector out, const Var::String filename)
 
MRecord ReadNetCDF ([[maybe_unused]] Workspace &ws, Var::ArrayOfMatrix out, const Var::String filename)
 
MRecord ReadNetCDF ([[maybe_unused]] Workspace &ws, Var::GasAbsLookup out, const Var::String filename)
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::AbsorptionLines out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Agenda out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfAbsorptionLines out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfAbsorptionLines out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfAgenda out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField1 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField2 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField3 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfIndex out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfMatrix out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfPpath out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfPropagationMatrix out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfRadiationVector out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfScatteringMetaData out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSingleScatteringData out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSpeciesTag out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfStokesVector out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfString out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor3 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor6 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTime out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTransmissionMatrix out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfVector out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfCIARecord out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField1 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField2 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField3 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField4 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfIndex out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfMatrix out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfPropagationMatrix out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfQuantumIdentifier out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfRadiationVector out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfRetrievalQuantity out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfScatteringMetaData out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfSingleScatteringData out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfSparse out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfStokesVector out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfString out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfTelsemAtlas out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor3 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor4 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor5 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor6 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor7 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfTime out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfTransmissionMatrix out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfVector out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ArrayOfXsecRecord out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::CIARecord out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::CovarianceMatrix out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::EnergyLevelMap out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::GasAbsLookup out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::GridPos out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::GriddedField1 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::GriddedField2 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::GriddedField3 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::GriddedField4 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::GriddedField5 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::GriddedField6 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::HitranRelaxationMatrixData out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Index out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::MCAntenna out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Numeric out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Ppath out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::PropagationMatrix out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::QuantumIdentifier out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::RadiationVector out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Rational out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::ScatteringMetaData out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::SingleScatteringData out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Sparse out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::SpeciesAuxData out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::StokesVector out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::String out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::TelsemAtlas out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Tensor5 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Tensor6 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Tensor7 out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Timer out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Time out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::TessemNN out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::TransmissionMatrix out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::String &filename={})
 
MRecord ReadXML ([[maybe_unused]] Workspace &ws, Var::Verbosity out, const Var::String &filename={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::AbsorptionLines out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Agenda out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfAbsorptionLines out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfAbsorptionLines out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfAgenda out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField1 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField2 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField3 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfIndex out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfMatrix out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfPpath out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfPropagationMatrix out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfRadiationVector out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfScatteringMetaData out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSingleScatteringData out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSpeciesTag out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfStokesVector out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfString out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor3 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor6 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTime out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTransmissionMatrix out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfVector out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfCIARecord out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField1 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField2 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField3 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField4 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfIndex out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfMatrix out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfPropagationMatrix out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfQuantumIdentifier out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfRadiationVector out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfRetrievalQuantity out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfScatteringMetaData out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfSingleScatteringData out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfSparse out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfStokesVector out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfString out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfTelsemAtlas out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor3 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor4 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor5 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor6 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor7 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfTime out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfTransmissionMatrix out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfVector out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ArrayOfXsecRecord out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::CIARecord out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::CovarianceMatrix out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::EnergyLevelMap out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::GasAbsLookup out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::GridPos out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::GriddedField1 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::GriddedField2 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::GriddedField3 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::GriddedField4 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::GriddedField5 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::GriddedField6 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::HitranRelaxationMatrixData out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Index out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::MCAntenna out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Matrix out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Numeric out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Ppath out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::PropagationMatrix out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::QuantumIdentifier out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::RadiationVector out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Rational out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::ScatteringMetaData out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::SingleScatteringData out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Sparse out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::SpeciesAuxData out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::StokesVector out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::String out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::TelsemAtlas out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Tensor5 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Tensor6 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Tensor7 out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Timer out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Time out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::TessemNN out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::TransmissionMatrix out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord ReadXMLIndexed ([[maybe_unused]] Workspace &ws, Var::Verbosity out, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Numeric o, const Var::Vector i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Numeric o, const Var::Matrix i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Numeric o, const Var::Tensor3 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Numeric o, const Var::Tensor4 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Numeric o, const Var::Tensor5 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Numeric o, const Var::Tensor6 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Numeric o, const Var::Tensor7 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Vector o, const Var::Matrix i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Vector o, const Var::Tensor3 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Vector o, const Var::Tensor4 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Vector o, const Var::Tensor5 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Vector o, const Var::Tensor6 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Vector o, const Var::Tensor7 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Matrix o, const Var::Tensor3 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Matrix o, const Var::Tensor4 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Matrix o, const Var::Tensor5 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Matrix o, const Var::Tensor6 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Matrix o, const Var::Tensor7 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Tensor3 o, const Var::Tensor4 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Tensor3 o, const Var::Tensor5 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Tensor3 o, const Var::Tensor6 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Tensor3 o, const Var::Tensor7 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Tensor4 o, const Var::Tensor5 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Tensor4 o, const Var::Tensor6 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Tensor4 o, const Var::Tensor7 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Tensor5 o, const Var::Tensor6 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Tensor5 o, const Var::Tensor7 i)
 
MRecord Reduce ([[maybe_unused]] Workspace &ws, Var::Tensor6 o, const Var::Tensor7 i)
 
MRecord refellipsoidEarth ([[maybe_unused]] Workspace &ws, const Var::String &model={})
 
MRecord refellipsoidGanymede ([[maybe_unused]] Workspace &ws, const Var::String &model={})
 
MRecord refellipsoidForAzimuth ([[maybe_unused]] Workspace &ws, const Var::Numeric latitude, const Var::Numeric azimuth)
 
MRecord refellipsoidEuropa ([[maybe_unused]] Workspace &ws, const Var::String &model={})
 
MRecord refellipsoidIo ([[maybe_unused]] Workspace &ws, const Var::String &model={})
 
MRecord refellipsoidJupiter ([[maybe_unused]] Workspace &ws, const Var::String &model={})
 
MRecord refellipsoidMars ([[maybe_unused]] Workspace &ws, const Var::String &model={})
 
MRecord refellipsoidMoon ([[maybe_unused]] Workspace &ws, const Var::String &model={})
 
MRecord refellipsoidOrbitPlane ([[maybe_unused]] Workspace &ws, const Var::Numeric orbitinc)
 
MRecord refellipsoidSet ([[maybe_unused]] Workspace &ws, const Var::Numeric re, const Var::Numeric &e={})
 
MRecord refellipsoidVenus ([[maybe_unused]] Workspace &ws, const Var::String &model={})
 
MRecord refr_index_airFreeElectrons ([[maybe_unused]] Workspace &ws, const Var::Index &demand_vmr_value={})
 
MRecord refr_index_airInfraredEarth ([[maybe_unused]] Workspace &ws)
 
MRecord refr_index_airMicrowavesEarth ([[maybe_unused]] Workspace &ws, const Var::Numeric &k1={}, const Var::Numeric &k2={}, const Var::Numeric &k3={})
 
MRecord refr_index_airMicrowavesGeneral ([[maybe_unused]] Workspace &ws)
 
MRecord retrievalDefClose ([[maybe_unused]] Workspace &ws)
 
MRecord retrievalAddAbsSpecies ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String species, const Var::String &unit={}, const Var::Index &for_species_tag={})
 
MRecord retrievalAddFreqShift ([[maybe_unused]] Workspace &ws, const Var::Numeric &df={})
 
MRecord retrievalAddFreqStretch ([[maybe_unused]] Workspace &ws, const Var::Numeric &df={})
 
MRecord retrievalDefInit ([[maybe_unused]] Workspace &ws, const Var::Index &initialize_jacobian={})
 
MRecord retrievalAddCatalogParameter ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier catalog_identity, const Var::String catalog_parameter, const Var::Numeric var)
 
MRecord retrievalAddCatalogParameters ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier catalog_identities, const Var::ArrayOfString catalog_parameters)
 
MRecord retrievalAddMagField ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String &component={}, const Var::Numeric &dB={})
 
MRecord retrievalAddPointingZa ([[maybe_unused]] Workspace &ws, const Var::Index &poly_order={}, const Var::String &calcmode={}, const Var::Numeric &dza={})
 
MRecord retrievalAddPolyfit ([[maybe_unused]] Workspace &ws, const Var::Index poly_order, const Var::Index &no_pol_variation={}, const Var::Index &no_los_variation={}, const Var::Index &no_mblock_variation={})
 
MRecord retrievalAddScatSpecies ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String species, const Var::String quantity)
 
MRecord retrievalAddSinefit ([[maybe_unused]] Workspace &ws, const Var::Vector period_lengths, const Var::Index &no_pol_variation={}, const Var::Index &no_los_variation={}, const Var::Index &no_mblock_variation={})
 
MRecord retrievalAddSpecialSpecies ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String species)
 
MRecord retrievalAddSurfaceQuantity ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::String quantity)
 
MRecord retrievalAddTemperature ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String &hse={})
 
MRecord retrievalAddWind ([[maybe_unused]] Workspace &ws, const Var::Vector g1, const Var::Vector g2, const Var::Vector g3, const Var::String &component={}, const Var::Numeric &dfrequency={})
 
MRecord retrievalErrorsExtract ([[maybe_unused]] Workspace &ws)
 
MRecord RT4Calc ([[maybe_unused]] Workspace &ws, const Var::Index &nstreams={}, const Var::String &pfct_method={}, const Var::String &quad_type={}, const Var::Index &add_straight_angles={}, const Var::Index &pfct_aa_grid_size={}, const Var::Index &auto_inc_nstreams={}, const Var::Index &robust={}, const Var::Index &za_interp_order={}, const Var::Index &cos_za_interp={}, const Var::Numeric &max_delta_tau={})
 
MRecord RT4CalcWithRT4Surface ([[maybe_unused]] Workspace &ws, const Var::Index &nstreams={}, const Var::String &pfct_method={}, const Var::String &ground_type={}, const Var::String &quad_type={}, const Var::Index &add_straight_angles={}, const Var::Index &pfct_aa_grid_size={}, const Var::Index &auto_inc_nstreams={}, const Var::Index &robust={}, const Var::Index &za_interp_order={}, const Var::Index &cos_za_interp={}, const Var::Numeric &max_delta_tau={})
 
MRecord RT4Test ([[maybe_unused]] Workspace &ws, Var::Tensor4 out_rad, const Var::String &datapath={})
 
MRecord rte_losGeometricFromRtePosToRtePos2 ([[maybe_unused]] Workspace &ws)
 
MRecord rte_losSet ([[maybe_unused]] Workspace &ws, const Var::Numeric za, const Var::Numeric aa)
 
MRecord rte_posSet ([[maybe_unused]] Workspace &ws, const Var::Numeric z, const Var::Numeric lat, const Var::Numeric lon)
 
MRecord rte_pos_losMoveToStartOfPpath ([[maybe_unused]] Workspace &ws)
 
MRecord rtp_nlteFromRaw ([[maybe_unused]] Workspace &ws, const Var::Vector data)
 
MRecord ScatElementsPndAndScatAdd ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString scat_data_files, const Var::ArrayOfString pnd_field_files)
 
MRecord ScatElementsSelect ([[maybe_unused]] Workspace &ws, const Var::String species, const Var::String sizeparam, const Var::Numeric &sizemin={}, const Var::Numeric &sizemax={}, const Var::Numeric &tolerance={}, const Var::String &delim={})
 
MRecord ScatElementsToabs_speciesAdd ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString scat_data_files, const Var::ArrayOfString pnd_field_files)
 
MRecord ScatSpeciesExtendTemperature ([[maybe_unused]] Workspace &ws, const Var::String &species={}, const Var::String &scat_species_delim={}, const Var::Numeric &T_low={}, const Var::Numeric &T_high={})
 
MRecord ScatSpeciesInit ([[maybe_unused]] Workspace &ws)
 
MRecord ScatSpeciesMerge ([[maybe_unused]] Workspace &ws)
 
MRecord ScatSpeciesPndAndScatAdd ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString scat_data_files, const Var::String pnd_fieldarray_file)
 
MRecord ScatSpeciesScatAndMetaRead ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString scat_data_files)
 
MRecord scat_data_singleTmatrix ([[maybe_unused]] Workspace &ws, const Var::String shape, const Var::Numeric diameter_volume_equ, const Var::Numeric aspect_ratio, const Var::String ptype, const Var::Vector data_f_grid, const Var::Vector data_t_grid, const Var::Vector data_za_grid, const Var::Numeric &mass={}, const Var::Vector &data_aa_grid={}, const Var::Numeric &precision={}, const Var::String &cri_source={}, const Var::Index &ndgs={}, const Var::Index &robust={}, const Var::Index &quiet={})
 
MRecord scat_data_checkedCalc ([[maybe_unused]] Workspace &ws, const Var::Numeric &dfrel_threshold={}, const Var::String &check_level={}, const Var::Numeric &sca_mat_threshold={})
 
MRecord scat_data_monoCalc ([[maybe_unused]] Workspace &ws)
 
MRecord scat_data_monoExtract ([[maybe_unused]] Workspace &ws)
 
MRecord scat_dataCalc ([[maybe_unused]] Workspace &ws, const Var::Index &interp_order={})
 
MRecord scat_dataCheck ([[maybe_unused]] Workspace &ws, const Var::String &check_type={}, const Var::Numeric &sca_mat_threshold={})
 
MRecord scat_dataReduceT ([[maybe_unused]] Workspace &ws, const Var::Index scat_index, const Var::Numeric temperature, const Var::Index &interp_order={}, const Var::Index &phamat_only={}, const Var::Numeric &sca_mat_threshold={})
 
MRecord ScatSpeciesSizeMassInfo ([[maybe_unused]] Workspace &ws, const Var::Index species_index, const Var::String x_unit, const Var::Numeric &x_fit_start={}, const Var::Numeric &x_fit_end={}, const Var::Index &do_only_x={})
 
MRecord particle_fieldCleanup ([[maybe_unused]] Workspace &ws, Var::Tensor4 particle_field_out, const Var::Tensor4 particle_field_in, const Var::Numeric threshold)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfAbsorptionLines needles, const Var::ArrayOfAbsorptionLines haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfAbsorptionLines needles, const Var::ArrayOfArrayOfAbsorptionLines haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfAgenda needles, const Var::ArrayOfAgenda haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField1 needles, const Var::ArrayOfArrayOfGriddedField1 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField2 needles, const Var::ArrayOfArrayOfGriddedField2 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField3 needles, const Var::ArrayOfArrayOfGriddedField3 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfIndex needles, const Var::ArrayOfArrayOfIndex haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfMatrix needles, const Var::ArrayOfArrayOfMatrix haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfPpath needles, const Var::ArrayOfPpath haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfPropagationMatrix needles, const Var::ArrayOfArrayOfPropagationMatrix haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfRadiationVector needles, const Var::ArrayOfArrayOfRadiationVector haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfScatteringMetaData needles, const Var::ArrayOfArrayOfScatteringMetaData haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSingleScatteringData needles, const Var::ArrayOfArrayOfSingleScatteringData haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSpeciesTag needles, const Var::ArrayOfArrayOfSpeciesTag haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfStokesVector needles, const Var::ArrayOfArrayOfStokesVector haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfString needles, const Var::ArrayOfArrayOfString haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor3 needles, const Var::ArrayOfArrayOfTensor3 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor6 needles, const Var::ArrayOfArrayOfTensor6 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTime needles, const Var::ArrayOfArrayOfTime haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTransmissionMatrix needles, const Var::ArrayOfArrayOfTransmissionMatrix haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfVector needles, const Var::ArrayOfArrayOfVector haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfCIARecord needles, const Var::ArrayOfCIARecord haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField1 needles, const Var::ArrayOfGriddedField1 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField2 needles, const Var::ArrayOfGriddedField2 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField3 needles, const Var::ArrayOfGriddedField3 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField4 needles, const Var::ArrayOfGriddedField4 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfIndex needles, const Var::ArrayOfIndex haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfMatrix needles, const Var::ArrayOfMatrix haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfPropagationMatrix needles, const Var::ArrayOfPropagationMatrix haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfQuantumIdentifier needles, const Var::ArrayOfQuantumIdentifier haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfRadiationVector needles, const Var::ArrayOfRadiationVector haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfRetrievalQuantity needles, const Var::ArrayOfRetrievalQuantity haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfScatteringMetaData needles, const Var::ArrayOfScatteringMetaData haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfSingleScatteringData needles, const Var::ArrayOfSingleScatteringData haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfSparse needles, const Var::ArrayOfSparse haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfStokesVector needles, const Var::ArrayOfStokesVector haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfString needles, const Var::ArrayOfString haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfTelsemAtlas needles, const Var::ArrayOfTelsemAtlas haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor3 needles, const Var::ArrayOfTensor3 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor4 needles, const Var::ArrayOfTensor4 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor5 needles, const Var::ArrayOfTensor5 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor6 needles, const Var::ArrayOfTensor6 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor7 needles, const Var::ArrayOfTensor7 haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfTime needles, const Var::ArrayOfTime haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfTransmissionMatrix needles, const Var::ArrayOfTransmissionMatrix haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfVector needles, const Var::ArrayOfVector haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::ArrayOfXsecRecord needles, const Var::ArrayOfXsecRecord haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::Vector needles, const Var::Vector haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::Matrix needles, const Var::Matrix haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord Select ([[maybe_unused]] Workspace &ws, Var::Sparse needles, const Var::Sparse haystack, const Var::ArrayOfIndex needleindexes)
 
MRecord sensor_checkedCalc ([[maybe_unused]] Workspace &ws)
 
MRecord sensorOff ([[maybe_unused]] Workspace &ws)
 
MRecord sensor_losGeometricFromSensorPosToOtherPositions ([[maybe_unused]] Workspace &ws, const Var::Matrix target_pos)
 
MRecord sensor_responseAntenna ([[maybe_unused]] Workspace &ws, const Var::String &option_2d={})
 
MRecord sensor_responseBackend ([[maybe_unused]] Workspace &ws)
 
MRecord sensor_responseBackendFrequencySwitching ([[maybe_unused]] Workspace &ws, const Var::Numeric df1, const Var::Numeric df2)
 
MRecord sensor_responseBeamSwitching ([[maybe_unused]] Workspace &ws, const Var::Numeric &w1={}, const Var::Numeric &w2={})
 
MRecord sensor_responseFillFgrid ([[maybe_unused]] Workspace &ws, const Var::Index &polyorder={}, const Var::Index &nfill={})
 
MRecord sensor_responseFrequencySwitching ([[maybe_unused]] Workspace &ws)
 
MRecord sensor_responseIF2RF ([[maybe_unused]] Workspace &ws)
 
MRecord sensor_responseInit ([[maybe_unused]] Workspace &ws)
 
MRecord sensor_responseMetMM ([[maybe_unused]] Workspace &ws, const Var::Index &use_antenna={}, const Var::Index &mirror_dza={})
 
MRecord sensor_responseMixer ([[maybe_unused]] Workspace &ws)
 
MRecord sensor_responseMixerBackendPrecalcWeights ([[maybe_unused]] Workspace &ws)
 
MRecord sensor_responseMultiMixerBackend ([[maybe_unused]] Workspace &ws)
 
MRecord sensor_responsePolarisation ([[maybe_unused]] Workspace &ws)
 
MRecord sensor_responseStokesRotation ([[maybe_unused]] Workspace &ws)
 
MRecord sensor_responseSimpleAMSU ([[maybe_unused]] Workspace &ws, const Var::Numeric &spacing={})
 
MRecord sensor_responseGenericAMSU ([[maybe_unused]] Workspace &ws, const Var::Numeric &spacing={})
 
MRecord sensor_responseWMRF ([[maybe_unused]] Workspace &ws)
 
MRecord SetNumberOfThreads ([[maybe_unused]] Workspace &ws, const Var::Index nthreads)
 
MRecord Sleep ([[maybe_unused]] Workspace &ws, const Var::Numeric time)
 
MRecord timeSleep ([[maybe_unused]] Workspace &ws)
 
MRecord SparseSparseMultiply ([[maybe_unused]] Workspace &ws, Var::Sparse out, const Var::Sparse m1, const Var::Sparse m2)
 
MRecord SparseMatrixIdentity ([[maybe_unused]] Workspace &ws, Var::Sparse out, const Var::Index n, const Var::Numeric &value={})
 
MRecord spectral_irradiance_fieldFromSpectralRadianceField ([[maybe_unused]] Workspace &ws)
 
MRecord spectral_radiance_fieldClearskyPlaneParallel ([[maybe_unused]] Workspace &ws, Var::Tensor3 trans_field, const Var::Index &use_parallel_iy={})
 
MRecord spectral_radiance_fieldCopyCloudboxField ([[maybe_unused]] Workspace &ws)
 
MRecord spectral_radiance_fieldExpandCloudboxField ([[maybe_unused]] Workspace &ws, const Var::Index &use_parallel_iy={})
 
MRecord specular_losCalc ([[maybe_unused]] Workspace &ws, const Var::Index &ignore_surface_slope={})
 
MRecord specular_losCalcNoTopography ([[maybe_unused]] Workspace &ws)
 
MRecord StringJoin ([[maybe_unused]] Workspace &ws, Var::String out, const Var::String in1, const Var::String in2, const Var::String &in3={}, const Var::String &in4={}, const Var::String &in5={}, const Var::String &in6={}, const Var::String &in7={}, const Var::String &in8={}, const Var::String &in9={}, const Var::String &in10={})
 
MRecord StringSet ([[maybe_unused]] Workspace &ws, Var::String out, const Var::String text)
 
MRecord z_surfaceFromFileAndGrid ([[maybe_unused]] Workspace &ws, const Var::String filename, const Var::Index &interp_order={}, const Var::Index &set_lowest_altitude_to_zero={})
 
MRecord z_surfaceConstantAltitude ([[maybe_unused]] Workspace &ws, const Var::Numeric &altitude={})
 
MRecord surfaceBlackbody ([[maybe_unused]] Workspace &ws)
 
MRecord surfaceFastem ([[maybe_unused]] Workspace &ws, const Var::Numeric wind_speed, const Var::Vector transmittance, const Var::Numeric &salinity={}, const Var::Numeric &wind_direction={}, const Var::Index &fastem_version={})
 
MRecord surfaceTessem ([[maybe_unused]] Workspace &ws, const Var::Numeric wind_speed, const Var::Numeric &salinity={})
 
MRecord surfaceTelsem ([[maybe_unused]] Workspace &ws, const Var::TelsemAtlas atlas, const Var::Numeric &r_min={}, const Var::Numeric &r_max={}, const Var::Numeric &d_max={})
 
MRecord surfaceFlatRefractiveIndex ([[maybe_unused]] Workspace &ws)
 
MRecord surfaceFlatReflectivity ([[maybe_unused]] Workspace &ws)
 
MRecord surfaceFlatRvRh ([[maybe_unused]] Workspace &ws)
 
MRecord surfaceFlatScalarReflectivity ([[maybe_unused]] Workspace &ws)
 
MRecord surfaceLambertianSimple ([[maybe_unused]] Workspace &ws, const Var::Index &lambertian_nza={}, const Var::Numeric &za_pos={})
 
MRecord surfaceSemiSpecularBy3beams ([[maybe_unused]] Workspace &ws, const Var::Numeric specular_factor, const Var::Numeric dza)
 
MRecord surfaceSplitSpecularTo3beams ([[maybe_unused]] Workspace &ws, const Var::Numeric specular_factor, const Var::Numeric dza)
 
MRecord surface_complex_refr_indexFromGriddedField5 ([[maybe_unused]] Workspace &ws, const Var::GriddedField5 complex_refr_index_field)
 
MRecord surface_reflectivityFromGriddedField6 ([[maybe_unused]] Workspace &ws, const Var::GriddedField6 r_field)
 
MRecord surface_rtpropCallAgendaX ([[maybe_unused]] Workspace &ws)
 
MRecord surface_scalar_reflectivityFromGriddedField4 ([[maybe_unused]] Workspace &ws, const Var::GriddedField4 r_field)
 
MRecord surface_scalar_reflectivityFromSurface_rmatrix ([[maybe_unused]] Workspace &ws)
 
MRecord surface_typeInterpTypeMask ([[maybe_unused]] Workspace &ws)
 
MRecord SurfaceDummy ([[maybe_unused]] Workspace &ws)
 
MRecord SurfaceFastem ([[maybe_unused]] Workspace &ws, const Var::Vector transmittance, const Var::Index &fastem_version={})
 
MRecord SurfaceTessem ([[maybe_unused]] Workspace &ws)
 
MRecord TangentPointExtract ([[maybe_unused]] Workspace &ws, Var::Vector tan_pos)
 
MRecord TangentPointPrint ([[maybe_unused]] Workspace &ws, const Var::Index &level={})
 
MRecord telsemStandalone ([[maybe_unused]] Workspace &ws, Var::Matrix emissivities, const Var::Numeric lat, const Var::Numeric lon, const Var::Numeric theta, const Var::Vector f, const Var::TelsemAtlas ta, const Var::Numeric &d_max={})
 
MRecord telsemAtlasLookup ([[maybe_unused]] Workspace &ws, Var::Vector emissivities, const Var::Numeric lat, const Var::Numeric lon, const Var::TelsemAtlas atlas)
 
MRecord telsemSurfaceTypeLandSea ([[maybe_unused]] Workspace &ws, const Var::TelsemAtlas atlas)
 
MRecord telsem_atlasReadAscii ([[maybe_unused]] Workspace &ws, Var::TelsemAtlas atlas, const Var::String directory, const Var::Index month, const Var::String &filename_pattern={})
 
MRecord telsem_atlasesReadAscii ([[maybe_unused]] Workspace &ws, const Var::String directory, const Var::String &filename_pattern={})
 
MRecord Tensor3AddScalar ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::Tensor3 in, const Var::Numeric value)
 
MRecord Tensor3ExtractFromTensor4 ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::Tensor4 in, const Var::Index i, const Var::String direction)
 
MRecord Tensor3Scale ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::Tensor3 in, const Var::Numeric value)
 
MRecord Tensor3SetConstant ([[maybe_unused]] Workspace &ws, Var::Tensor3 out, const Var::Numeric value)
 
MRecord Tensor4AddScalar ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::Tensor4 in, const Var::Numeric value)
 
MRecord Tensor4Scale ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::Tensor4 in, const Var::Numeric value)
 
MRecord Tensor4SetConstant ([[maybe_unused]] Workspace &ws, Var::Tensor4 out, const Var::Numeric value)
 
MRecord Tensor5Scale ([[maybe_unused]] Workspace &ws, Var::Tensor5 out, const Var::Tensor5 in, const Var::Numeric value)
 
MRecord Tensor5SetConstant ([[maybe_unused]] Workspace &ws, Var::Tensor5 out, const Var::Numeric value)
 
MRecord Tensor6Scale ([[maybe_unused]] Workspace &ws, Var::Tensor6 out, const Var::Tensor6 in, const Var::Numeric value)
 
MRecord Tensor6SetConstant ([[maybe_unused]] Workspace &ws, Var::Tensor6 out, const Var::Numeric value)
 
MRecord Tensor7Scale ([[maybe_unused]] Workspace &ws, Var::Tensor7 out, const Var::Tensor7 in, const Var::Numeric value)
 
MRecord Tensor7SetConstant ([[maybe_unused]] Workspace &ws, Var::Tensor7 out, const Var::Numeric value)
 
MRecord TestArrayOfAgenda ([[maybe_unused]] Workspace &ws, const Var::Index &index={})
 
MRecord TessemNNReadAscii ([[maybe_unused]] Workspace &ws, Var::TessemNN tessem_nn, const Var::String filename)
 
MRecord TestTessem ([[maybe_unused]] Workspace &ws, Var::Vector outvalues, const Var::TessemNN net, const Var::Vector invalues)
 
MRecord Test ([[maybe_unused]] Workspace &ws)
 
MRecord time_gridOffset ([[maybe_unused]] Workspace &ws, const Var::Numeric dt)
 
MRecord timerStart ([[maybe_unused]] Workspace &ws)
 
MRecord timerStop ([[maybe_unused]] Workspace &ws)
 
MRecord time_stampsSort ([[maybe_unused]] Workspace &ws, Var::ArrayOfTime out, const Var::ArrayOfTime in)
 
MRecord time_stampsSort ([[maybe_unused]] Workspace &ws, Var::ArrayOfVector out, const Var::ArrayOfVector in)
 
MRecord TMatrixTest ([[maybe_unused]] Workspace &ws)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::AbsorptionLines in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Agenda in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfAbsorptionLines in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfAbsorptionLines in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfAgenda in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField1 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField2 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfGriddedField3 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfIndex in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfMatrix in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfPpath in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfPropagationMatrix in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfRadiationVector in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfScatteringMetaData in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSingleScatteringData in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfSpeciesTag in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfStokesVector in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfString in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor3 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTensor6 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTime in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfTransmissionMatrix in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfArrayOfVector in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfCIARecord in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField1 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField2 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField3 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfGriddedField4 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfIndex in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfMatrix in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfPropagationMatrix in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfQuantumIdentifier in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfRadiationVector in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfRetrievalQuantity in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfScatteringMetaData in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfSingleScatteringData in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfSparse in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfStokesVector in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfString in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfTelsemAtlas in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor3 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor4 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor5 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor6 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfTensor7 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfTime in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfTransmissionMatrix in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfVector in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ArrayOfXsecRecord in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::CIARecord in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::CovarianceMatrix in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::EnergyLevelMap in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::GasAbsLookup in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::GridPos in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::GriddedField1 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::GriddedField2 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::GriddedField3 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::GriddedField4 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::GriddedField5 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::GriddedField6 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::HitranRelaxationMatrixData in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Index in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::MCAntenna in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Matrix in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Numeric in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Ppath in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::PropagationMatrix in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::QuantumIdentifier in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::RadiationVector in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Rational in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::ScatteringMetaData in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::SingleScatteringData in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Sparse in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::SpeciesAuxData in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::StokesVector in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::String in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::TelsemAtlas in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Tensor3 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Tensor4 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Tensor5 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Tensor6 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Tensor7 in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Timer in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Time in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::TessemNN in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::TransmissionMatrix in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Vector in)
 
MRecord Touch ([[maybe_unused]] Workspace &ws, Var::Verbosity in)
 
MRecord transmittanceFromIy_aux ([[maybe_unused]] Workspace &ws, Var::Vector transmittance)
 
MRecord VectorAddScalar ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Vector in, const Var::Numeric value)
 
MRecord VectorAddVector ([[maybe_unused]] Workspace &ws, Var::Vector c, const Var::Vector a, const Var::Vector b)
 
MRecord VectorCrop ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Vector in, const Var::Numeric &min_value={}, const Var::Numeric &max_value={})
 
MRecord VectorExtractFromMatrix ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Matrix in, const Var::Index i, const Var::String direction)
 
MRecord VectorFlip ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Vector in)
 
MRecord VectorInsertGridPoints ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Vector in, const Var::Vector points)
 
MRecord VectorLinSpace ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Numeric start, const Var::Numeric stop, const Var::Numeric step)
 
MRecord VectorLogSpace ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Numeric start, const Var::Numeric stop, const Var::Numeric step)
 
MRecord VectorMatrixMultiply ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Matrix m, const Var::Vector v)
 
MRecord VectorNLinSpace ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Numeric start, const Var::Numeric stop)
 
MRecord VectorNLogSpace ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Numeric start, const Var::Numeric stop)
 
MRecord VectorReshapeMatrix ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Matrix in, const Var::String &direction={})
 
MRecord VectorScale ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Vector in, const Var::Numeric value)
 
MRecord VectorSetConstant ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Numeric value)
 
MRecord VectorSet ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Vector value)
 
MRecord VectorSubtractVector ([[maybe_unused]] Workspace &ws, Var::Vector c, const Var::Vector a, const Var::Vector b)
 
MRecord VectorVectorMultiply ([[maybe_unused]] Workspace &ws, Var::Vector out, const Var::Vector v1, const Var::Vector v2)
 
MRecord VectorZtanToZaRefr1D ([[maybe_unused]] Workspace &ws, Var::Vector v_za, const Var::Vector v_ztan)
 
MRecord VectorZtanToZa1D ([[maybe_unused]] Workspace &ws, Var::Vector v_za, const Var::Vector v_ztan)
 
MRecord verbosityInit ([[maybe_unused]] Workspace &ws)
 
MRecord verbositySet ([[maybe_unused]] Workspace &ws, const Var::Index agenda, const Var::Index screen, const Var::Index file)
 
MRecord verbositySetAgenda ([[maybe_unused]] Workspace &ws, const Var::Index level)
 
MRecord verbositySetFile ([[maybe_unused]] Workspace &ws, const Var::Index level)
 
MRecord verbositySetScreen ([[maybe_unused]] Workspace &ws, const Var::Index level)
 
MRecord vmr_fieldClip ([[maybe_unused]] Workspace &ws, const Var::String species, const Var::Numeric &limit_low={}, const Var::Numeric &limit_high={})
 
MRecord vmr_fieldPerturb ([[maybe_unused]] Workspace &ws, const Var::String species, const Var::Vector p_ret_grid, const Var::Vector lat_ret_grid, const Var::Vector lon_ret_grid, const Var::Index pert_index, const Var::Numeric pert_size, const Var::String &pert_mode={})
 
MRecord vmr_fieldPerturbAtmGrids ([[maybe_unused]] Workspace &ws, const Var::String species, const Var::Index pert_index, const Var::Numeric pert_size, const Var::String &pert_mode={})
 
MRecord vmr_fieldSetAllConstant ([[maybe_unused]] Workspace &ws, const Var::Vector vmr_values)
 
MRecord water_p_eq_fieldMK05 ([[maybe_unused]] Workspace &ws)
 
MRecord vmr_fieldSetConstant ([[maybe_unused]] Workspace &ws, const Var::String species, const Var::Numeric vmr_value)
 
MRecord Wigner6Init ([[maybe_unused]] Workspace &ws, const Var::Index &fast_wigner_stored_symbols={}, const Var::Index &largest_wigner_symbol_parameter={})
 
MRecord Wigner3Init ([[maybe_unused]] Workspace &ws, const Var::Index &fast_wigner_stored_symbols={}, const Var::Index &largest_wigner_symbol_parameter={})
 
MRecord Wigner6Unload ([[maybe_unused]] Workspace &ws)
 
MRecord Wigner3Unload ([[maybe_unused]] Workspace &ws)
 
MRecord WignerFastInfoPrint ([[maybe_unused]] Workspace &ws)
 
MRecord WindFieldsCalc ([[maybe_unused]] Workspace &ws, const Var::Index &interp_order={})
 
MRecord WindFieldsCalcExpand1D ([[maybe_unused]] Workspace &ws, const Var::Index &interp_order={})
 
MRecord WindRawRead ([[maybe_unused]] Workspace &ws, const Var::String basename)
 
MRecord wind_u_fieldIncludePlanetRotation ([[maybe_unused]] Workspace &ws)
 
MRecord WMRFSelectChannels ([[maybe_unused]] Workspace &ws)
 
MRecord WriteMolTau ([[maybe_unused]] Workspace &ws, const Var::String filename)
 
MRecord WriteNetCDF ([[maybe_unused]] Workspace &ws, const Var::Vector in, const Var::String &filename={})
 
MRecord WriteNetCDF ([[maybe_unused]] Workspace &ws, const Var::Matrix in, const Var::String &filename={})
 
MRecord WriteNetCDF ([[maybe_unused]] Workspace &ws, const Var::Tensor3 in, const Var::String &filename={})
 
MRecord WriteNetCDF ([[maybe_unused]] Workspace &ws, const Var::Tensor4 in, const Var::String &filename={})
 
MRecord WriteNetCDF ([[maybe_unused]] Workspace &ws, const Var::Tensor5 in, const Var::String &filename={})
 
MRecord WriteNetCDF ([[maybe_unused]] Workspace &ws, const Var::ArrayOfVector in, const Var::String &filename={})
 
MRecord WriteNetCDF ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix in, const Var::String &filename={})
 
MRecord WriteNetCDF ([[maybe_unused]] Workspace &ws, const Var::GasAbsLookup in, const Var::String &filename={})
 
MRecord WriteNetCDFIndexed ([[maybe_unused]] Workspace &ws, const Var::Vector in, const Var::String &filename={})
 
MRecord WriteNetCDFIndexed ([[maybe_unused]] Workspace &ws, const Var::Matrix in, const Var::String &filename={})
 
MRecord WriteNetCDFIndexed ([[maybe_unused]] Workspace &ws, const Var::Tensor3 in, const Var::String &filename={})
 
MRecord WriteNetCDFIndexed ([[maybe_unused]] Workspace &ws, const Var::Tensor4 in, const Var::String &filename={})
 
MRecord WriteNetCDFIndexed ([[maybe_unused]] Workspace &ws, const Var::Tensor5 in, const Var::String &filename={})
 
MRecord WriteNetCDFIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfVector in, const Var::String &filename={})
 
MRecord WriteNetCDFIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix in, const Var::String &filename={})
 
MRecord WriteNetCDFIndexed ([[maybe_unused]] Workspace &ws, const Var::GasAbsLookup in, const Var::String &filename={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::AbsorptionLines in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Agenda in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAbsorptionLines in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfAbsorptionLines in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAgenda in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField1 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField2 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField3 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfIndex in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfMatrix in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPpath in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfPropagationMatrix in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfRadiationVector in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfScatteringMetaData in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSingleScatteringData in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSpeciesTag in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfStokesVector in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfString in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor3 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor6 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTime in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTransmissionMatrix in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfVector in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfCIARecord in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField1 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField2 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField3 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField4 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfIndex in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPropagationMatrix in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRadiationVector in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRetrievalQuantity in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfScatteringMetaData in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSingleScatteringData in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSparse in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfStokesVector in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTelsemAtlas in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor3 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor4 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor5 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor6 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor7 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTime in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTransmissionMatrix in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfVector in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ArrayOfXsecRecord in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::CIARecord in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::CovarianceMatrix in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::EnergyLevelMap in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::GasAbsLookup in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::GridPos in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::GriddedField1 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::GriddedField2 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::GriddedField3 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::GriddedField4 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::GriddedField5 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::GriddedField6 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::HitranRelaxationMatrixData in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Index in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::MCAntenna in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Matrix in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Numeric in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Ppath in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::PropagationMatrix in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::RadiationVector in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Rational in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::ScatteringMetaData in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::SingleScatteringData in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Sparse in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::SpeciesAuxData in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::StokesVector in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::String in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::TelsemAtlas in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Tensor3 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Tensor4 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Tensor5 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Tensor6 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Tensor7 in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Timer in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Time in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::TessemNN in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::TransmissionMatrix in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Vector in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXML ([[maybe_unused]] Workspace &ws, const Var::Verbosity in, const Var::String &filename={}, const Var::Index &no_clobber={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::AbsorptionLines in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Agenda in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAbsorptionLines in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfAbsorptionLines in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfAgenda in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField1 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField2 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfGriddedField3 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfIndex in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfMatrix in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPpath in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfPropagationMatrix in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfRadiationVector in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfScatteringMetaData in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSingleScatteringData in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfSpeciesTag in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfStokesVector in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfString in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor3 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTensor6 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTime in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfTransmissionMatrix in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfArrayOfVector in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfCIARecord in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField1 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField2 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField3 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfGriddedField4 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfIndex in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfMatrix in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfPropagationMatrix in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfQuantumIdentifier in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRadiationVector in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRetrievalQuantity in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfScatteringMetaData in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSingleScatteringData in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfSparse in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfStokesVector in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfString in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTelsemAtlas in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor3 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor4 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor5 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor6 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTensor7 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTime in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfTransmissionMatrix in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfVector in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ArrayOfXsecRecord in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::CIARecord in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::CovarianceMatrix in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::EnergyLevelMap in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::GasAbsLookup in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::GridPos in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::GriddedField1 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::GriddedField2 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::GriddedField3 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::GriddedField4 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::GriddedField5 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::GriddedField6 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::HitranRelaxationMatrixData in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Index in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::MCAntenna in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Matrix in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Numeric in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Ppath in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::PropagationMatrix in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::QuantumIdentifier in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::RadiationVector in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Rational in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::ScatteringMetaData in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::SingleScatteringData in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Sparse in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::SpeciesAuxData in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::StokesVector in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::String in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::TelsemAtlas in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Tensor3 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Tensor4 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Tensor5 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Tensor6 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Tensor7 in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Timer in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Time in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::TessemNN in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::TransmissionMatrix in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Vector in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord WriteXMLIndexed ([[maybe_unused]] Workspace &ws, const Var::Verbosity in, const Var::String &filename={}, const Var::Index &digits={})
 
MRecord xaStandard ([[maybe_unused]] Workspace &ws)
 
MRecord xClip ([[maybe_unused]] Workspace &ws, const Var::Index ijq, const Var::Numeric &limit_low={}, const Var::Numeric &limit_high={})
 
MRecord x2artsAtmAndSurf ([[maybe_unused]] Workspace &ws)
 
MRecord x2artsSensor ([[maybe_unused]] Workspace &ws)
 
MRecord x2artsSpectroscopy ([[maybe_unused]] Workspace &ws)
 
MRecord yApplySensorPol ([[maybe_unused]] Workspace &ws)
 
MRecord yApplyUnit ([[maybe_unused]] Workspace &ws)
 
MRecord ybatchCalc ([[maybe_unused]] Workspace &ws, const Var::Index &robust={})
 
MRecord yColdAtmHot ([[maybe_unused]] Workspace &ws, const Var::Vector cold, const Var::Vector atm, const Var::Vector hot, const Var::Numeric cold_temp, const Var::Numeric hot_temp, const Var::Index &calib={})
 
MRecord ybatchMetProfiles ([[maybe_unused]] Workspace &ws, const Var::Index nelem_p_grid, const Var::String met_profile_path, const Var::String met_profile_pnd_path)
 
MRecord ybatchMetProfilesClear ([[maybe_unused]] Workspace &ws, const Var::Index nelem_p_grid, const Var::String met_profile_path)
 
MRecord ybatchTimeAveraging ([[maybe_unused]] Workspace &ws, const Var::String time_step, const Var::Index &disregard_first={}, const Var::Index &disregard_last={})
 
MRecord ybatchTroposphericCorrectionNaiveMedianForward ([[maybe_unused]] Workspace &ws, const Var::ArrayOfIndex range, const Var::Vector trop_temp, const Var::Numeric &targ_temp={})
 
MRecord ybatchTroposphericCorrectionNaiveMedianInverse ([[maybe_unused]] Workspace &ws)
 
MRecord yCalc ([[maybe_unused]] Workspace &ws)
 
MRecord yCalcAppend ([[maybe_unused]] Workspace &ws, const Var::ArrayOfRetrievalQuantity jacobian_quantities_copy, const Var::Index &append_instrument_wfs={})
 
MRecord yActive ([[maybe_unused]] Workspace &ws, const Var::Numeric &ze_tref={}, const Var::Numeric &k2={}, const Var::Numeric &dbze_min={})
 
MRecord ySimpleSpectrometer ([[maybe_unused]] Workspace &ws, const Var::Numeric df)
 
MRecord z_fieldFromHSE ([[maybe_unused]] Workspace &ws)
 

Function Documentation

◆ abs_cia_dataAddCIARecord()

MRecord ARTS::AgendaMethod::abs_cia_dataAddCIARecord ( [[maybe_unused] ] Workspace ws,
const Var::CIARecord  cia_record,
const Var::Index clobber = {} 
)
inline

Takes CIARecord as input and appends the results in the appropriate place.

If CIARecord has same species as species in abs_cia_data, then the array position is used to append all of the CIARecord into the array. If clobber evaluates as true, cia_record overwrites the appropriate abs_cia_data. If species in cia_record are not in abs_cia_data, the CIARecord is pushed back.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]cia_record- CIA record to append to abs_cia_data.
[in]clobber- If true, the new input clobbers the old cia data. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 64921 of file autoarts.h.

◆ abs_cia_dataReadFromCIA()

MRecord ARTS::AgendaMethod::abs_cia_dataReadFromCIA ( [[maybe_unused] ] Workspace ws,
const Var::String  catalogpath 
)
inline

Read data from a CIA data file for all CIA molecules defined in abs_species.

The units in the HITRAN file are: Frequency: cm^(-1) Binary absorption cross-section: cm^5 molec^(-2)

Upon reading we convert this to the ARTS internal SI units of Hz and m^5 molec^(-2).

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]catalogpath- Path to the CIA catalog directory.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 64962 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ abs_cia_dataReadFromXML()

MRecord ARTS::AgendaMethod::abs_cia_dataReadFromXML ( [[maybe_unused] ] Workspace ws,
const Var::String filename = {} 
)
inline

Read data from a CIA XML file and check that all CIA tags defined in abs_species are present in the file.

The units of the data are described in abs_cia_dataReadFromCIA.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 64992 of file autoarts.h.

◆ abs_coefCalcFromXsec()

MRecord ARTS::AgendaMethod::abs_coefCalcFromXsec ( [[maybe_unused] ] Workspace ws)
inline

Calculate absorption coefficients from cross sections.

This calculates both the total absorption and the absorption per species.

Cross sections are multiplied by n*VMR.

Author
Stefan Buehler
Axel von Engeln
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65027 of file autoarts.h.

◆ abs_cont_descriptionAppend()

MRecord ARTS::AgendaMethod::abs_cont_descriptionAppend ( [[maybe_unused] ] Workspace ws,
const Var::String  tagname,
const Var::String  model,
const Var::Vector userparam = {} 
)
inline

Appends the description of a continuum model or a complete absorption model to abs_cont_names and abs_cont_parameters.

See online documentation for abs_cont_names for a list of allowed models and for information what parameters they require. See file includes/continua.arts for default parameters for the various models.

Author
Thomas Kuhn
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]tagname- The name (species tag) of a continuum model. Must match one of the models implemented in ARTS.
[in]model- A string selecting a particular continuum/full model under this species tag.
[in]userparam- A Vector containing the required parameters for the selected model. The meaning of the parameters and how many parameters are required depends on the model. (default: {})

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65064 of file autoarts.h.

◆ abs_cont_descriptionInit()

MRecord ARTS::AgendaMethod::abs_cont_descriptionInit ( [[maybe_unused] ] Workspace ws)
inline

Initializes the two workspace variables for the continuum description, abs_cont_names* and abs_cont_parameters.

This method does not really do anything, except setting the two variables to empty Arrays. It is just necessary because the method abs_cont_descriptionAppend* wants to append to the variables.

Formally, the continuum description workspace variables are required by the absorption calculation methods (e.g., abs_coefCalcFromXsec). Therefore you always have to call at least abs_cont_descriptionInit, even if you do not want to use any continua.

Author
Thomas Kuhn
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65110 of file autoarts.h.

◆ abs_hitran_relmat_dataReadHitranRelmatDataAndLines()

MRecord ARTS::AgendaMethod::abs_hitran_relmat_dataReadHitranRelmatDataAndLines ( [[maybe_unused] ] Workspace ws,
const Var::String  basedir,
const Var::Numeric linemixinglimit = {},
const Var::Numeric fmin = {},
const Var::Numeric fmax = {},
const Var::Numeric stot = {},
const Var::String mode = {} 
)
inline

Reads HITRAN line mixing data from a basedir The basedir must point at line mixing data as provided by HITRAN. The lines will be changed such that ALL CO2 lines are truncated before adding the HITRAN line mixing lines.

The available modes are such that "VP*" uses Voigt profiles and "SDVP*" uses speed-dependent Voigt profiles, where the "_Y" signifies if Rosenkranz-style line mixing is considered or not, and the "W" at the end signifies that full calculations are used. At the line mixing limit, line mixing is simply turned off.

The "FullW" mode uses Lorentzian calculations with the full relaxation matrix until the line mixing limit is reached and it switches to Voigt.

The HITRAN LM data is available for download at: https://hitran.org/supplementary/

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basedir- Direcory where the linemixing data is to be found
[in]linemixinglimit- Line mixing limit as defined by AbsorptionLines (default: -1)
[in]fmin- Minimum frequency to read from (default: 0)
[in]fmax- Maximum frequency to read until (default: 1e99)
[in]stot- Minimum integrated band strength to consider (default: 0)
[in]mode- Mode of calculations. The options are: "VP", "VP_Y", "SDVP", "SDVP_Y", "FullW", and "VP_W" (default: "VP_W")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65152 of file autoarts.h.

◆ abs_lines_per_speciesChangeBaseParameterForMatchingLevel()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesChangeBaseParameterForMatchingLevel ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Numeric  change,
const Var::Index relative = {} 
)
inline

See abs_linesChangeBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the level.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to change matching level's value
[in]relative- Flag for relative change (0 is absolute change) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66997 of file autoarts.h.

◆ abs_lines_per_speciesChangeBaseParameterForMatchingLevels()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesChangeBaseParameterForMatchingLevels ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Vector  change,
const Var::Index relative = {} 
)
inline

See abs_linesChangeBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the level.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to change matching level's value
[in]relative- Flag for relative change (0 is absolute change) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67039 of file autoarts.h.

◆ abs_lines_per_speciesChangeBaseParameterForMatchingLines()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesChangeBaseParameterForMatchingLines ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Numeric  change,
const Var::Index relative = {},
const Var::Index loose_matching = {} 
)
inline

See abs_linesChangeBaseParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to change matching line's value
[in]relative- Flag for relative change (0 is absolute change) (default: 0)
[in]loose_matching- Flag for loose match (0 means only complete matches) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67286 of file autoarts.h.

◆ abs_lines_per_speciesChangeBaseParameterForSpecies()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesChangeBaseParameterForSpecies ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Numeric  change,
const Var::String  species_tag,
const Var::Index relative = {},
const Var::Index loose_matching = {} 
)
inline

See abs_linesChangeBaseParameterForMatchingLines but for single species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to change matching line's value
[in]relative- Flag for relative change (0 is absolute change) (default: 0)
[in]loose_matching- Flag for loose match (0 means only complete matches) (default: 0)
[in]species_tag- The species tag from abs_species to change

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67336 of file autoarts.h.

◆ abs_lines_per_speciesChangeLineShapeModelParameterForMatchingLines()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesChangeLineShapeModelParameterForMatchingLines ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter,
const Var::String  coefficient,
const Var::String  species,
const Var::Numeric  change,
const Var::Index relative = {} 
)
inline

See abs_linesChangeLineShapeModelParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter- Name of parameter to be replaced
[in]coefficient- Coefficient of the parameter to be changed
[in]species- Species of parameter to be changed
[in]change- Change in the value found
[in]relative- Flag for relative change (0 is absolute change) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67832 of file autoarts.h.

◆ abs_lines_per_speciesChangeLineShapeModelParameterForSpecies()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesChangeLineShapeModelParameterForSpecies ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter,
const Var::String  coefficient,
const Var::String  species,
const Var::Numeric  change,
const Var::String  species_tag,
const Var::Index relative = {} 
)
inline

See abs_linesChangeLineShapeModelParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter- Name of parameter to be replaced
[in]coefficient- Coefficient of the parameter to be changed
[in]species- Species of parameter to be changed
[in]change- Change in the value found
[in]relative- Flag for relative change (0 is absolute change) (default: 0)
[in]species_tag- The species tag from abs_species to change

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67883 of file autoarts.h.

◆ abs_lines_per_speciesCompact()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesCompact ( [[maybe_unused] ] Workspace ws)
inline

See abs_linesCompact

Author
Stefan Buehler
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67954 of file autoarts.h.

◆ abs_lines_per_speciesCreateFromLines()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesCreateFromLines ( [[maybe_unused] ] Workspace ws)
inline

Split lines up into the different species.

The order of the splitting will match the outer layer of abs_species There will be no respect for the internal layer of abs_species

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67978 of file autoarts.h.

◆ abs_lines_per_speciesReadSpeciesSplitCatalog()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesReadSpeciesSplitCatalog ( [[maybe_unused] ] Workspace ws,
const Var::String  basename,
const Var::Index robust = {} 
)
inline

See abs_lines_per_speciesReadSplitCatalog but expects a single file per species of ArrayOfAbsorptionLines

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- The path to the split catalog files
[in]robust- Flag to continue in case nothing is found [0 throws, 1 continues] (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65631 of file autoarts.h.

◆ abs_lines_per_speciesReadSplitCatalog()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesReadSplitCatalog ( [[maybe_unused] ] Workspace ws,
const Var::String  basename 
)
inline

Reads abs_lines_per_species split by abs_linesWriteSplitXML* or abs_lines_per_speciesWriteSplitXML

Note that this will sort the isotopologue

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- The path to the split catalog files

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65568 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetBaseParameterForMatchingLevel()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetBaseParameterForMatchingLevel ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Numeric  change 
)
inline

See abs_linesSetBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the level.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to set matching level's value

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67153 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::String::islast(), ARTS::Var::Numeric::pos(), ARTS::Var::QuantumIdentifier::pos(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetBaseParameterForMatchingLevels()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetBaseParameterForMatchingLevels ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Vector  change 
)
inline

See abs_linesSetBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the level.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to set matching level's value

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67188 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::ArrayOfQuantumIdentifier::pos(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ abs_lines_per_speciesSetBaseParameterForMatchingLines()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetBaseParameterForMatchingLines ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Numeric  change,
const Var::Index loose_matching = {} 
)
inline

See abs_linesSetBaseParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to change matching line's value
[in]loose_matching- Flag for loose match (0 means only complete matches) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67441 of file autoarts.h.

◆ abs_lines_per_speciesSetBaseParameterForSpecies()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetBaseParameterForSpecies ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Numeric  change,
const Var::String  species_tag,
const Var::Index loose_matching = {} 
)
inline

See abs_linesSetBaseParameterForMatchingLines but for single species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to change matching line's value
[in]loose_matching- Flag for loose match (0 means only complete matches) (default: 0)
[in]species_tag- The species tag from abs_species to change

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67484 of file autoarts.h.

◆ abs_lines_per_speciesSetCutoff()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetCutoff ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::Numeric  value 
)
inline

See abs_linesSetCutoff

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line shape calculations
[in]value- Value of cutoff

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66391 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ abs_lines_per_speciesSetCutoffForMatch()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetCutoffForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::Numeric  value,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetCutoff for more options.

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line shape calculations
[in]value- Value of cutoff
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66462 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_lines_per_speciesSetCutoffForSpecies()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetCutoffForSpecies ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::Numeric  value,
const Var::String  species_tag 
)
inline

See abs_linesSetCutoff but for single species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line shape calculations
[in]value- Value of cutoff
[in]species_tag- The species tag from abs_species to change

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66497 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::String::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetEmpty()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetEmpty ( [[maybe_unused] ] Workspace ws)
inline

Empties abs_lines_per_species at the correct size.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65663 of file autoarts.h.

◆ abs_lines_per_speciesSetLinemixingLimit()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetLinemixingLimit ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  value 
)
inline

See abs_linesSetLinemixingLimit

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- Value of limit

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66560 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ abs_lines_per_speciesSetLinemixingLimitForMatch()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetLinemixingLimitForMatch ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  value,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetLinemixingLimit for values

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- Value of limit
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66623 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_lines_per_speciesSetLinemixingLimitForSpecies()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetLinemixingLimitForSpecies ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  value,
const Var::String  species_tag 
)
inline

See abs_linesSetLinemixingLimit but for single species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- Value of limit
[in]species_tag- The species tag from abs_species to change

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66654 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::String::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetLineShapeModelParameterForMatchingLines()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetLineShapeModelParameterForMatchingLines ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter,
const Var::String  coefficient,
const Var::String  species,
const Var::Numeric  change 
)
inline

See abs_linesSetLineShapeModelParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter- Name of parameter to be replaced
[in]coefficient- Coefficient of the parameter to be changed
[in]species- Species of parameter to be changed
[in]change- Sets the value found

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67599 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::String::islast(), ARTS::Var::Numeric::pos(), ARTS::Var::QuantumIdentifier::pos(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetLineShapeModelParameterForSpecies()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetLineShapeModelParameterForSpecies ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter,
const Var::String  coefficient,
const Var::String  species,
const Var::Numeric  change,
const Var::String  species_tag 
)
inline

See abs_linesSetLineShapeModelParameterForMatchingLines

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter- Name of parameter to be replaced
[in]coefficient- Coefficient of the parameter to be changed
[in]species- Species of parameter to be changed
[in]change- Sets the value found
[in]species_tag- The species tag from abs_species to change

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67643 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::String::islast(), ARTS::Var::Numeric::pos(), ARTS::Var::QuantumIdentifier::pos(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetLineShapeType()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetLineShapeType ( [[maybe_unused] ] Workspace ws,
const Var::String  option 
)
inline

See abs_linesSetLineShapeType

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line shape calculations

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66224 of file autoarts.h.

◆ abs_lines_per_speciesSetLineShapeTypeForMatch()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetLineShapeTypeForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetLineShapeType for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line shape calculations
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66287 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_lines_per_speciesSetLineShapeTypeForSpecies()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetLineShapeTypeForSpecies ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::String  species_tag 
)
inline

See abs_linesSetLineShapeType but for single species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line shape calculations
[in]species_tag- The species tag from abs_species to change

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66318 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetMirroring()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetMirroring ( [[maybe_unused] ] Workspace ws,
const Var::String  option 
)
inline

See abs_linesSetMirroring

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line mirroring

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65906 of file autoarts.h.

◆ abs_lines_per_speciesSetMirroringForMatch()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetMirroringForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetMirroring for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line mirroring
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65969 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_lines_per_speciesSetMirroringForSpecies()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetMirroringForSpecies ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::String  species_tag 
)
inline

See abs_linesSetMirroring but for single species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line mirroring
[in]species_tag- The species tag from abs_species to change

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66000 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetNormalization()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetNormalization ( [[maybe_unused] ] Workspace ws,
const Var::String  option 
)
inline

See abs_linesSetNormalization

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line normalizations

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65744 of file autoarts.h.

◆ abs_lines_per_speciesSetNormalizationForMatch()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetNormalizationForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetNormalization for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line normalizations
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65807 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_lines_per_speciesSetNormalizationForSpecies()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetNormalizationForSpecies ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::String  species_tag 
)
inline

See abs_linesSetNormalization but for single species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line normalizations
[in]species_tag- The species tag from abs_species to change

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65838 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetPopulation()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetPopulation ( [[maybe_unused] ] Workspace ws,
const Var::String  option 
)
inline

See abs_linesSetPopulation

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line population

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66064 of file autoarts.h.

◆ abs_lines_per_speciesSetPopulationForMatch()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetPopulationForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetPopulation for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line population
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66127 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_lines_per_speciesSetPopulationForSpecies()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetPopulationForSpecies ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::String  species_tag 
)
inline

See abs_linesSetPopulation but for single species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line population
[in]species_tag- The species tag from abs_species to change

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66158 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetQuantumNumberForMatch()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetQuantumNumberForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  quantum_number,
const Var::Rational  value,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetQuantumNumberForMatch

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]quantum_number- Quantum number key
[in]value- Value of quantum number
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66874 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::Rational::islast(), ARTS::Var::String::islast(), ARTS::Var::QuantumIdentifier::pos(), ARTS::Var::Rational::pos(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetT0()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetT0 ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  value 
)
inline

See abs_linesSetT0

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- Value of T0

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66711 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ abs_lines_per_speciesSetT0ForMatch()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetT0ForMatch ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  value,
const Var::QuantumIdentifier  ID 
)
inline

Sets reference temperature

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- Value of T0
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66774 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_lines_per_speciesSetT0ForSpecies()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetT0ForSpecies ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  value,
const Var::String  species_tag 
)
inline

See abs_linesSetT0 but for single species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- Value of T0
[in]species_tag- The species tag from abs_species to change

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66805 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::String::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesSetZeemanCoefficients()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesSetZeemanCoefficients ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  qid,
const Var::Vector  gs 
)
inline

See abs_linesSetZeemanCoefficients

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]qid- Information to match an energy level of a/many lines.
[in]gs- Corresponding value to set as Zeeman coefficient

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67717 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), ARTS::Var::Vector::islast(), ARTS::Var::ArrayOfQuantumIdentifier::pos(), and ARTS::Var::Vector::pos().

◆ abs_lines_per_speciesWriteSpeciesSplitXML()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesWriteSpeciesSplitXML ( [[maybe_unused] ] Workspace ws,
const Var::String  basename 
)
inline

See abs_linesWriteSpeciesSplitXML

In addition, the structure of the files generated will not care about generating identifiers for the order in abs_species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- Path to store the files at

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111754 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ abs_lines_per_speciesWriteSplitXML()

MRecord ARTS::AgendaMethod::abs_lines_per_speciesWriteSplitXML ( [[maybe_unused] ] Workspace ws,
const Var::String  basename 
)
inline

See abs_linesWriteSplitXML

In addition, the structure of the files generated will not care about generating identifiers for the order in abs_species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- Path to store the files at

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111724 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ abs_linesAppendWithLines()

MRecord ARTS::AgendaMethod::abs_linesAppendWithLines ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAbsorptionLines  appending_lines,
const Var::Index safe = {} 
)
inline

Appends all lines in abs_lines that match with lines in replacement_lines if safe. If not safe, appends all lines.

No appended line is allowed to match any line in abs_lines if safe

Conditional behavior if safe: If the AbosorptionLines to be appended match no AbsorptionLines in abs_lines, then the entire AbsorptionLines is appended. Otherwise, only a single AbsorptionLines can be matched and is not allowed to have any internal matches

Note that lines are identified by their AbsorptionLines tags and by their quantum numbers in safe mode.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]appending_lines- Line-array that appends lines in abs_lines.
[in]safe- Flag whether to check quantum numbers or not (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65368 of file autoarts.h.

◆ abs_linesChangeBaseParameterForMatchingLevel()

MRecord ARTS::AgendaMethod::abs_linesChangeBaseParameterForMatchingLevel ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Numeric  change,
const Var::Index relative = {} 
)
inline

Change parameter of all levels in abs_lines that match with QuantumIdentifier. Only works for these parameters: parameter_name = "Statistical Weight" parameter_name = "Zeeman Coefficient"

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the level.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to change matching level's value
[in]relative- Flag for relative change (0 is absolute change) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66913 of file autoarts.h.

◆ abs_linesChangeBaseParameterForMatchingLevels()

MRecord ARTS::AgendaMethod::abs_linesChangeBaseParameterForMatchingLevels ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Vector  change,
const Var::Index relative = {} 
)
inline

See abs_linesChangeBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the level.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to change matching level's value
[in]relative- Flag for relative change (0 is absolute change) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66955 of file autoarts.h.

◆ abs_linesChangeBaseParameterForMatchingLines()

MRecord ARTS::AgendaMethod::abs_linesChangeBaseParameterForMatchingLines ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Numeric  change,
const Var::Index relative = {},
const Var::Index loose_matching = {} 
)
inline

Change parameter of all lines in abs_lines that match with QuantumIdentifier. Only works for these parameters: parameter_name = "Central Frequency" parameter_name = "Line Strength" parameter_name = "Lower State Energy" parameter_name = "Einstein Coefficient" parameter_name = "Lower Statistical Weight" parameter_name = "Upper Statistical Weight" parameter_name = "Lower Zeeman Coefficient" parameter_name = "Upper Zeeman Coefficient"

Note that loose_matching:=0 means only identical quantum identifiers are accepted, otherwise the numbers in QI must just be contained in the line identifier

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to change matching line's value
[in]relative- Flag for relative change (0 is absolute change) (default: 0)
[in]loose_matching- Flag for loose match (0 means only complete matches) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67237 of file autoarts.h.

◆ abs_linesChangeLineShapeModelParameterForMatchingLines()

MRecord ARTS::AgendaMethod::abs_linesChangeLineShapeModelParameterForMatchingLines ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter,
const Var::String  coefficient,
const Var::String  species,
const Var::Numeric  change,
const Var::Index relative = {} 
)
inline

Change line shape model data parameter in matching lines.

The matching is done so that QI must be in the line identifier

Acceptable parameter(s) are: "G0" "D0" "G2" "D2" "FVC" "ETA" "Y" "G" "DV"

Acceptable coefficient(s) are: "X0" "X1" "X2" "X3"

Acceptable species are: "AIR" (so long as it is the broadening species list) "SELF" (so long as it is the broadening species list) Any species in the line broadening species

The line parameter will have its old value plus the change if relative is false, else it will have its old value times (1+change).

Throws an error if it cannot find any targets to change

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter- Name of parameter to be replaced
[in]coefficient- Coefficient of the parameter to be changed
[in]species- Species of parameter to be changed
[in]change- Change in the value found
[in]relative- Flag for relative change (0 is absolute change) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67782 of file autoarts.h.

◆ abs_linesCleanupEmpty()

MRecord ARTS::AgendaMethod::abs_linesCleanupEmpty ( [[maybe_unused] ] Workspace ws)
inline

Removes empty bands from abs_lines.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65208 of file autoarts.h.

◆ abs_linesCompact()

MRecord ARTS::AgendaMethod::abs_linesCompact ( [[maybe_unused] ] Workspace ws)
inline

Removes lines that are unimportant because of their cutoff frequency range

Author
Stefan Buehler
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67932 of file autoarts.h.

◆ abs_linesDeleteBadF0()

MRecord ARTS::AgendaMethod::abs_linesDeleteBadF0 ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  f0,
const Var::Index lower = {} 
)
inline

Deletes all lines in abs_lines that have bad central frequencies

If lower evaluates as true, deletes all lines with a frequency below f0. Otherwise deletes all lines with a frequency above f0.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]f0- Target frequency
[in]lower- Lower or upper flag (eval as boolean) (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65437 of file autoarts.h.

◆ abs_linesDeleteLinesWithBadOrHighChangingJs()

MRecord ARTS::AgendaMethod::abs_linesDeleteLinesWithBadOrHighChangingJs ( [[maybe_unused] ] Workspace ws)
inline

Deletes all lines in abs_lines that have undefined Js or Js that change more than 1 between energy levels

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65491 of file autoarts.h.

◆ abs_linesDeleteLinesWithQuantumNumberAbove()

MRecord ARTS::AgendaMethod::abs_linesDeleteLinesWithQuantumNumberAbove ( [[maybe_unused] ] Workspace ws,
const Var::String  quantumnumber,
const Var::Index  quantumnumber_value 
)
inline

Deletes all lines in abs_lines that have too large quantum number

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]quantumnumber- Quantum number identified
[in]quantumnumber_value- Value

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65514 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::String::islast(), ARTS::Var::Index::pos(), and ARTS::Var::String::pos().

◆ abs_linesDeleteLinesWithUndefinedLocalQuanta()

MRecord ARTS::AgendaMethod::abs_linesDeleteLinesWithUndefinedLocalQuanta ( [[maybe_unused] ] Workspace ws)
inline

Deletes all lines in abs_lines that have undefined local quanta

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65469 of file autoarts.h.

◆ abs_linesDeleteWithLines()

MRecord ARTS::AgendaMethod::abs_linesDeleteWithLines ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAbsorptionLines  deleting_lines 
)
inline

Deletes all lines in abs_lines that match with lines in replacement_lines.

If a deleted line has no match, then nothing happens.

Note that lines are identified by their AbsorptionLines tags and by their quantum numbers. There is no need to have all values correct.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]deleting_lines- Line-array that removes lines from abs_lines.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65406 of file autoarts.h.

References ARTS::Var::ArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfAbsorptionLines::pos().

◆ abs_linesKeepBands()

MRecord ARTS::AgendaMethod::abs_linesKeepBands ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  qid,
const Var::Index ignore_spec = {},
const Var::Index ignore_isot = {} 
)
inline

Keep only qid-matches in abs_lines

The ignore values will ignore isotopologue and/or species. The latter means the isotopologue has to be ignores.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]qid- Band ID
[in]ignore_spec- If species is to be ignores (default: 1)
[in]ignore_isot- If isotopologue is to be ignored (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65235 of file autoarts.h.

◆ abs_linesPrintDefinedQuantumNumbers()

MRecord ARTS::AgendaMethod::abs_linesPrintDefinedQuantumNumbers ( [[maybe_unused] ] Workspace ws)
inline

Print the count of defined quantum numbers in the catalog

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65543 of file autoarts.h.

◆ abs_linesReadSpeciesSplitCatalog()

MRecord ARTS::AgendaMethod::abs_linesReadSpeciesSplitCatalog ( [[maybe_unused] ] Workspace ws,
const Var::String  basename,
const Var::Index robust = {} 
)
inline

Reads a catalog of absorption lines files in a directory

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- The path to the split catalog files
[in]robust- Flag to continue in case nothing is found [0 throws, 1 continues] (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65596 of file autoarts.h.

◆ abs_linesRemoveBand()

MRecord ARTS::AgendaMethod::abs_linesRemoveBand ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  qid 
)
inline

Removes qid band from abs_lines

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]qid- Band ID

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65274 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_linesRemoveUnusedLocalQuantumNumbers()

MRecord ARTS::AgendaMethod::abs_linesRemoveUnusedLocalQuantumNumbers ( [[maybe_unused] ] Workspace ws)
inline

Removes unused quantums from local values in the line lists

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65300 of file autoarts.h.

◆ abs_linesReplaceWithLines()

MRecord ARTS::AgendaMethod::abs_linesReplaceWithLines ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAbsorptionLines  replacing_lines 
)
inline

Replace all lines in abs_lines that match with lines in replacement_lines.

Each replacement_lines must match excatly a single line in abs_lines.

The matching required identical quantum number signatures to work

Note that lines are identified by their AbsorptionLines tags and by their quantum numbers.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]replacing_lines- Line-array that replace lines in abs_lines.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65328 of file autoarts.h.

References ARTS::Var::ArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfAbsorptionLines::pos().

◆ abs_linesSetBaseParameterForMatchingLevel()

MRecord ARTS::AgendaMethod::abs_linesSetBaseParameterForMatchingLevel ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Numeric  change 
)
inline

Set parameter of all levels in abs_lines that match with QuantumIdentifier. Only works for these parameters: parameter_name = "Statistical Weight" parameter_name = "Zeeman Coefficient"

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the level.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to set matching level's value

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67083 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::String::islast(), ARTS::Var::Numeric::pos(), ARTS::Var::QuantumIdentifier::pos(), and ARTS::Var::String::pos().

◆ abs_linesSetBaseParameterForMatchingLevels()

MRecord ARTS::AgendaMethod::abs_linesSetBaseParameterForMatchingLevels ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Vector  change 
)
inline

See abs_linesSetBaseParameterForMatchingLevel

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the level.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to set matching level's value

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67118 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::ArrayOfQuantumIdentifier::pos(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ abs_linesSetBaseParameterForMatchingLines()

MRecord ARTS::AgendaMethod::abs_linesSetBaseParameterForMatchingLines ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter_name,
const Var::Numeric  change,
const Var::Index loose_matching = {} 
)
inline

Set parameter of all lines in abs_lines that match with QuantumIdentifier. Only works for these parameters: parameter_name = "Central Frequency" parameter_name = "Line Strength" parameter_name = "Lower State Energy" parameter_name = "Einstein Coefficient" parameter_name = "Lower Statistical Weight" parameter_name = "Upper Statistical Weight" parameter_name = "Lower Zeeman Coefficient" parameter_name = "Upper Zeeman Coefficient"

Note that loose_matching:=0 means only identical quantum identifiers are accepted, otherwise the numbers in QI must just be contained in the line identifier

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter_name- Name of parameter to be replaced
[in]change- Value with which to change matching line's value
[in]loose_matching- Flag for loose match (0 means only complete matches) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67399 of file autoarts.h.

◆ abs_linesSetCutoff()

MRecord ARTS::AgendaMethod::abs_linesSetCutoff ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::Numeric  value 
)
inline

Sets cutoff type and magnitude for all lines.

The line is cut off when this is active at the given frequency. The only non-zero range is from this range to its negative equivalent

Available options: "None" - No cutoff "ByLine" - Cutoff relative line center, highest frequency: F0+cutoff "ByBand" - Absolute frequency, highest frequency: cutoff

For "ByLine", the negative frequency is at F0-cutoff For "ByBand", the negative frequency is at cutoff minus twice the average band frequency

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line shape calculations
[in]value- Value of cutoff

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66360 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ abs_linesSetCutoffForMatch()

MRecord ARTS::AgendaMethod::abs_linesSetCutoffForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::Numeric  value,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetCutoff for more options.

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line shape calculations
[in]value- Value of cutoff
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66425 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_linesSetEmptyBroadeningParametersToEmpty()

MRecord ARTS::AgendaMethod::abs_linesSetEmptyBroadeningParametersToEmpty ( [[maybe_unused] ] Workspace ws)
inline

Sets a broadening parameter to empty if it is efficiently empty

This will not save RAM but it will save disk space (reading time), and computational time by not doing unecessary calculations

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65687 of file autoarts.h.

◆ abs_linesSetLinemixingLimit()

MRecord ARTS::AgendaMethod::abs_linesSetLinemixingLimit ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  value 
)
inline

Sets line mixing limit for all lines.

If value is less than 0, no limit is applied and line mixing is active. Otherwise, line mixing is inactive if the pressure is below the limit.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- Value of limit

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66533 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ abs_linesSetLinemixingLimitForMatch()

MRecord ARTS::AgendaMethod::abs_linesSetLinemixingLimitForMatch ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  value,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetLinemixingLimit for values

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- Value of limit
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66590 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_linesSetLineShapeModelParameterForMatchingLines()

MRecord ARTS::AgendaMethod::abs_linesSetLineShapeModelParameterForMatchingLines ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  QI,
const Var::String  parameter,
const Var::String  coefficient,
const Var::String  species,
const Var::Numeric  change 
)
inline

Sets line shape model data parameter in matching lines.

The matching is done so that QI must be in the line identifier

Acceptable parameter(s) are: "G0" "D0" "G2" "D2" "FVC" "ETA" "Y" "G" "DV"

Acceptable coefficient(s) are: "X0" "X1" "X2" "X3"

Acceptable species are: "AIR" (so long as it is the broadening species list) "SELF" (so long as it is the broadening species list) Any species in the line broadening species

Throws an error if it cannot find any targets to change

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]QI- Information to match the line.
[in]parameter- Name of parameter to be replaced
[in]coefficient- Coefficient of the parameter to be changed
[in]species- Species of parameter to be changed
[in]change- Sets the value found

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67556 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::String::islast(), ARTS::Var::Numeric::pos(), ARTS::Var::QuantumIdentifier::pos(), and ARTS::Var::String::pos().

◆ abs_linesSetLineShapeType()

MRecord ARTS::AgendaMethod::abs_linesSetLineShapeType ( [[maybe_unused] ] Workspace ws,
const Var::String  option 
)
inline

Sets shape calculations type for all lines.

Available options: "DP" - Doppler profile "LP" - Lorentz profile "VP" - Voigt profile "SDVP" - Speed-dependent Voigt profile "HTP" - Hartman-Tran profile

See the theory guide for more details.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line shape calculations

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66197 of file autoarts.h.

◆ abs_linesSetLineShapeTypeForMatch()

MRecord ARTS::AgendaMethod::abs_linesSetLineShapeTypeForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetLineShapeType for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line shape calculations
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66254 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_linesSetMirroring()

MRecord ARTS::AgendaMethod::abs_linesSetMirroring ( [[maybe_unused] ] Workspace ws,
const Var::String  option 
)
inline

Sets mirroring type for all lines.

Available options: "None" - No mirrored line "Same" - Mirrored line broadened by line shape "Manual" - Manually mirrored line (be careful; allows all frequencies) "Lorentz" - Mirrored line broadened by Lorentz

Note that mirroring is never applied for DP line shape Also note that Lorentz profile is approached by most line shapes at high frequency offset. Also note that Manual settings are potentially dangerous as other frequency offsets might not work as hoped.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line mirroring

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65879 of file autoarts.h.

◆ abs_linesSetMirroringForMatch()

MRecord ARTS::AgendaMethod::abs_linesSetMirroringForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetMirroring for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line mirroring
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65936 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_linesSetNormalization()

MRecord ARTS::AgendaMethod::abs_linesSetNormalization ( [[maybe_unused] ] Workspace ws,
const Var::String  option 
)
inline

Sets normalization type for all lines.

Available options: "VVH" - Van Vleck and Huber "VVW" - Van Vleck and Weisskopf "RQ" - Rosenkranz quadratic "None" - No extra normalization

See the theory guide for more details.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line normalizations

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65717 of file autoarts.h.

◆ abs_linesSetNormalizationForMatch()

MRecord ARTS::AgendaMethod::abs_linesSetNormalizationForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetNormalization for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line normalizations
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 65774 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_linesSetPopulation()

MRecord ARTS::AgendaMethod::abs_linesSetPopulation ( [[maybe_unused] ] Workspace ws,
const Var::String  option 
)
inline

Sets population type for all lines.

Available options: "LTE" - Standard distribution by temperature "NLTE-VibrationalTemperatures" - LTE but with vibrational temperatures "NLTE" - Distribution is given as input

You must have set nlte_field and/or its ilk to use the NLTE methods.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line population

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66037 of file autoarts.h.

◆ abs_linesSetPopulationForMatch()

MRecord ARTS::AgendaMethod::abs_linesSetPopulationForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  option,
const Var::QuantumIdentifier  ID 
)
inline

See abs_linesSetPopulation for options

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option- Method of line population
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66094 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_linesSetQuantumNumberForMatch()

MRecord ARTS::AgendaMethod::abs_linesSetQuantumNumberForMatch ( [[maybe_unused] ] Workspace ws,
const Var::String  quantum_number,
const Var::Rational  value,
const Var::QuantumIdentifier  ID 
)
inline

Sets a quantum number to a new value

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]quantum_number- Quantum number key
[in]value- Value of quantum number
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66839 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::Rational::islast(), ARTS::Var::String::islast(), ARTS::Var::QuantumIdentifier::pos(), ARTS::Var::Rational::pos(), and ARTS::Var::String::pos().

◆ abs_linesSetT0()

MRecord ARTS::AgendaMethod::abs_linesSetT0 ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  value 
)
inline

Sets reference temperature for all lines.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- Value of T0

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66684 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ abs_linesSetT0ForMatch()

MRecord ARTS::AgendaMethod::abs_linesSetT0ForMatch ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  value,
const Var::QuantumIdentifier  ID 
)
inline

Sets reference temperature

This function only acts on matches between the bands and input ID

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- Value of T0
[in]ID- ID of one or more bands

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 66741 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::QuantumIdentifier::pos().

◆ abs_linesSetZeemanCoefficients()

MRecord ARTS::AgendaMethod::abs_linesSetZeemanCoefficients ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  qid,
const Var::Vector  gs 
)
inline

Sets the Zeeman coefficients of the lines by user input

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]qid- Information to match an energy level of a/many lines.
[in]gs- Corresponding value to set as Zeeman coefficient

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 67686 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), ARTS::Var::Vector::islast(), ARTS::Var::ArrayOfQuantumIdentifier::pos(), and ARTS::Var::Vector::pos().

◆ abs_linesTruncateGlobalQuantumNumbers()

MRecord ARTS::AgendaMethod::abs_linesTruncateGlobalQuantumNumbers ( [[maybe_unused] ] Workspace ws)
inline

Truncates all global quantum numbers and then recombine the line list.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111638 of file autoarts.h.

◆ abs_linesWriteSpeciesSplitXML()

MRecord ARTS::AgendaMethod::abs_linesWriteSpeciesSplitXML ( [[maybe_unused] ] Workspace ws,
const Var::String  basename 
)
inline

As abs_linesWriteSplitXML but writes an array per species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- Path to store the files at

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111694 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ abs_linesWriteSplitXML()

MRecord ARTS::AgendaMethod::abs_linesWriteSplitXML ( [[maybe_unused] ] Workspace ws,
const Var::String  basename 
)
inline

Writes a split catalog, AbsorptionLines by AbsorptionLines.

There will be one unique file generated per AbsorptionLines in abs_lines.

The names of these files will be: basename+"."+AbsorptionLines.SpeciesName()+"."+to_string(N)+".xml" where N>=0 and the species name is something line "H2O".

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- Path to store the files at

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111666 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ abs_lookupAdapt()

MRecord ARTS::AgendaMethod::abs_lookupAdapt ( [[maybe_unused] ] Workspace ws)
inline

Adapts a gas absorption lookup table to the current calculation.

The lookup table can contain more species and more frequencies than are needed for the current calculation. This method cuts down the table in memory, so that it contains just what is needed. Also, the species in the table are brought in the same order as the species in the current calculation.

Of course, the method also performs quite a lot of checks on the table. If something is not ok, a runtime error is thrown.

The method sets a flag abs_lookup_is_adapted to indicate that the table has been checked and that it is ok. Never set this by hand, always use this method to set it!

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68012 of file autoarts.h.

◆ abs_lookupCalc()

MRecord ARTS::AgendaMethod::abs_lookupCalc ( [[maybe_unused] ] Workspace ws)
inline

Creates a gas absorption lookup table.

The lookup table stores absorption cross-sections as a function of pressure. Additionally, absorption can be stored as a function of temperature for temperature perturbations from a reference profile.

Additionally, absorption can be stored as a function of water vapor VMR perturbations from a reference profile. The variable abs_nls specifies, for which species water vapor perturbations should be generated.

Note, that the absorbing gas can be any gas, but the perturbing gas is always H2O.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68046 of file autoarts.h.

◆ abs_lookupInit()

MRecord ARTS::AgendaMethod::abs_lookupInit ( [[maybe_unused] ] Workspace ws)
inline

Creates an empty gas absorption lookup table.

This is mainly there to help developers. For example, you can write the empty table to an XML file, to see the file format.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68070 of file autoarts.h.

◆ abs_lookupSetup()

MRecord ARTS::AgendaMethod::abs_lookupSetup ( [[maybe_unused] ] Workspace ws,
const Var::Numeric p_step = {},
const Var::Numeric t_step = {},
const Var::Numeric h2o_step = {} 
)
inline

Set up input parameters for abs_lookupCalc.

More information can be found in the documentation for method abs_lookupSetupBatch*

Max and min values of H2O and temperature are adjusted to allow for numerical perturbations in Jacobian calculation.

The input variables abs_nls_interp_order and abs_t_interp_order are used to make sure that there are enough points in abs_nls_pert and abs_t_pert for the chosen interpolation order.

Note: For homogeneous 1D cases, it can be advantageous to calculate abs_lookup* from the 1D atmosphere, and to expand the atmosphere to 3D only after that. This particularly if nonlinear species (i.e., H2O) are involved. See also: abs_lookupSetupBatch*

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]p_step- Maximum step in log10(p[Pa]). If the pressure grid is coarser than this, additional points are added until each log step is smaller than this. (default: 0.05)
[in]t_step- The temperature variation grid step in Kelvin, for a 2D or 3D atmosphere. For a 1D atmosphere this parameter is not used. (default: 100)
[in]h2o_step- The H2O variation grid step [fractional], if H2O variations are done (which is determined automatically, based on abs_species and the atmospheric dimension). For a 1D atmosphere this parameter is not used. (default: 100)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68111 of file autoarts.h.

◆ abs_lookupSetupBatch()

MRecord ARTS::AgendaMethod::abs_lookupSetupBatch ( [[maybe_unused] ] Workspace ws,
const Var::Numeric p_step = {},
const Var::Numeric t_step = {},
const Var::Numeric h2o_step = {},
const Var::Vector extremes = {},
const Var::Index robust = {},
const Var::Index check_gridnames = {} 
)
inline

Set up input parameters for abs_lookupCalc for batch calculations.

This method performs a similar task as abs_lookupSetup, with the difference that the lookup table setup is not for a single atmospheric state, but for a whole batch of them, stored in batch_atm_fields_compact*.

The method checks abs_species to decide which species require nonlinear treatment in the lookup table.

The method also checks which range of pressures, temperatures, and VMRs occurs, and sets abs_p, abs_t, abs_t_pert, and abs_vmrs accordingly.

If nonlinear species are present, abs_nls and abs_nls_pert are also generated.

Max and min values of H2O and temperature are adjusted to allow for numerical perturbations in Jacobian calculation.

The input variables abs_nls_interp_order and abs_t_interp_order are used to make sure that there are enough points in abs_nls_pert and abs_t_pert for the chosen interpolation order.

The method checks each given field using atmfields_checkedCalc. If a field does not pass the check, a run-time error is thrown. To prevent this, the parameter robust can be set to one: Invalid atmospheres are skipped, but the run continues. This matches the robust behaviour of ybatchCalc.

See also: abs_lookupSetup*

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]p_step- Grid step in log10(p[Pa]) (base 10 logarithm). (default: 0.05)
[in]t_step- The temperature variation grid step in Kelvin. The true step can become finer than this, if required by the interpolation order. (default: 20)
[in]h2o_step- The H2O variation grid step [fractional], if H2O variations are done (which is determined automatically, based on abs_species and the atmospheric dimension). As for T, the true step can turn out finer if required by the interpolation order. (default: 100)
[in]extremes- You can give here explicit extreme values to add to abs_t_pert and abs_nls_pert. The order is [t_pert_min, t_pert_max, nls_pert_min, nls_pert_max]. (default: {})
[in]robust- A flag with value 1 or 0. If set to one, the batch setup will continue, even if individual fields are invalid. This is consistent with the behaviour of ybatchCalc. (default: 0)
[in]check_gridnames- A flag with value 1 or 0. If set to one, the gridnames of every atm_fields_compact are checked. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68192 of file autoarts.h.

◆ abs_lookupSetupWide()

MRecord ARTS::AgendaMethod::abs_lookupSetupWide ( [[maybe_unused] ] Workspace ws,
const Var::Numeric p_min = {},
const Var::Numeric p_max = {},
const Var::Numeric p_step = {},
const Var::Numeric t_min = {},
const Var::Numeric t_max = {},
const Var::Numeric h2o_min = {},
const Var::Numeric h2o_max = {} 
)
inline

Set up input parameters for abs_lookupCalc for a wide range of atmospheric conditions.

This method can be used to set up parameters for a lookup table that really covers all reasonable atmospheric conditions.

Reference profiles of T and H2O will be constant, so that the different dimensions in the lookup table are actually "orthogonal", unlike the traditional case where we have pressure dependent reference profiles. This makes the table numerically somewhat more robust then the traditional ones, and it makes it straightforward to calculate the accuracy for the different interpolations with abs_lookupTestAccuracy.

You can give min an max values for the atmospheric conditions. The default values are chosen such that they cover the value range over the complete Chevallier91L data set, and a bit more. The statistics of the Chevallier91L data are:

min(p) / max(p) [Pa]: 1 / 104960 min(T) / max(T) [K]: 158.21 / 320.39 min(H2O) / max(H2O) [VMR]: -5.52e-07 / 0.049

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]p_min- Pressure grid minimum [Pa]. (default: 0.5)
[in]p_max- Pressure grid maximum [Pa]. (default: 110000)
[in]p_step- Pressure grid step in log10(p[Pa]) (base 10 logarithm). (default: 0.05)
[in]t_min- Temperature grid minimum [K]. (default: 100)
[in]t_max- Temperature grid maximum [K]. (default: 400)
[in]h2o_min- Humidity grid minimum [fractional]. (default: 0)
[in]h2o_max- Humidity grid maximum [fractional]. (default: 0.05)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68278 of file autoarts.h.

◆ abs_lookupTestAccMC()

MRecord ARTS::AgendaMethod::abs_lookupTestAccMC ( [[maybe_unused] ] Workspace ws)
inline

Test accuracy of absorption lookup table with Monte Carlo Algorithm.

Explicitly compare absorption from the lookup table with line-by-line calculations for random conditions.

The quantities returned are the mean value and standard deviation of the absolute value of the relative error in percent. The relative error itself is computed for a large number of cases (pressure, temperature, and H2O VMR combinations). In the frequency dimension the maximum value is taken for each case.

Produces no workspace output, only output to the output streams.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68383 of file autoarts.h.

◆ abs_lookupTestAccuracy()

MRecord ARTS::AgendaMethod::abs_lookupTestAccuracy ( [[maybe_unused] ] Workspace ws)
inline

Test accuracy of absorption lookup table.

Explicitly compare absorption from the lookup table with line-by-line calculations for strategically selected conditions (in-between the lookup table grid points).

For error units see abs_lookupTestAccMC

Produces no workspace output, only output to the output streams.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68351 of file autoarts.h.

◆ abs_nlteFromRaw()

MRecord ARTS::AgendaMethod::abs_nlteFromRaw ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  data 
)
inline

Sets NLTE values manually

Touch

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]data- Vibrational data [nlevels, np]

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68407 of file autoarts.h.

References data.

◆ abs_speciesAdd()

MRecord ARTS::AgendaMethod::abs_speciesAdd ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  species 
)
inline

Adds species tag groups to the list of absorption species.

This WSM is similar to abs_speciesSet, the only difference is that this method appends species to an existing list of absorption species instead of creating the whole list.

See abs_speciesSet for details on how tags are defined and examples of how to input them in the control file.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]species- Specify one String for each tag group that you want to add. Inside the String, separate the tags by commas (plus optional blanks).

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68444 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), and ARTS::Var::ArrayOfString::pos().

◆ abs_speciesAdd2()

MRecord ARTS::AgendaMethod::abs_speciesAdd2 ( [[maybe_unused] ] Workspace ws,
const Var::Vector  gin1,
const Var::Vector  gin2,
const Var::Vector  gin3,
const Var::String  species,
const Var::String unit = {} 
)
inline

Adds a species tag group to the list of absorption species and jacobian quantities.

The method is basically a combined call of abs_speciesAdd and jacobianAddAbsSpecies*. In this way it is not needed to specify a tag group in two different places.

Arguments exactly as for jacobianAddAbsSpecies. Note that this method only handles a single tag group, in contrast to abs_speciesAdd*.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]gin1- Pressure retrieval grid.
[in]gin2- Latitude retrieval grid.
[in]gin3- Longitude retreival grid.
[in]species- The species tag of the retrieval quantity.
[in]unit- Retrieval unit. See above. (default: "vmr")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68484 of file autoarts.h.

◆ abs_speciesDefineAll()

MRecord ARTS::AgendaMethod::abs_speciesDefineAll ( [[maybe_unused] ] Workspace ws)
inline

Sets abs_species[i][0] to all species in ARTS

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68559 of file autoarts.h.

◆ abs_speciesDefineAllInScenario()

MRecord ARTS::AgendaMethod::abs_speciesDefineAllInScenario ( [[maybe_unused] ] Workspace ws,
const Var::String  basename 
)
inline

Define one tag group for each species known to ARTS and included in an atmospheric scenario.

You can use this as an alternative to abs_speciesSet if you want to make an absorption calculation that is as complete as possible. The method goes through all defined species and tries to open the VMR file. If this works the tag is included, otherwise it is skipped.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- The name and path of a particular atmospheric scenario. For example: /pool/lookup2/arts-data/atmosphere/fascod/tropical

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68533 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ abs_speciesInit()

MRecord ARTS::AgendaMethod::abs_speciesInit ( [[maybe_unused] ] Workspace ws)
inline

Sets abs_species to be empty.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68580 of file autoarts.h.

◆ abs_speciesSet()

MRecord ARTS::AgendaMethod::abs_speciesSet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  species 
)
inline

Set up a list of absorption species tag groups.

Workspace variables like abs_species contain several tag groups. Each tag group contains one or more tags. This method converts descriptions of tag groups given in the keyword to the ARTS internal representation (an ArrayOfArrayOfSpeciesTag). A tag group selects spectral features which belong to the same species.

A tag is defined in terms of the name of the species, isotopologue, and a range of frequencies. Species are named after the standard chemical names, e.g., "O3". Isotopologues are given by the last digit of the atomic weight, i.g., "O3-668" for the asymmetric ozone molecule including an oxygen 18 atom. Groups of transitions are specified by giving a lower and upper limit of a frequency range, e.g., "O3-666-500e9-501e9".

To turn on Zeeman calculation for a species, "-Z" may be appended to its name: "O2-Z" or "O2-Z-66"

To turn on line mixing calculation for a species, "-LM" may be appended to its name (or after the Zeeman tag): "O2-LM" or "O2-Z-LM-66"

The symbol "*" acts as a wild card. Furthermore, frequency range or frequency range and isotopologue may be omitted.

Finally, instead of the isotopologue the special letter "nl" may be given, e.g., "H2O-nl". This means that no absorption at all is associated with this tag. (It is not quite clear if this feature is useful for anything right now.)

Example:

species = [ "O3-666-500e9-501e9, O3-686", "O3", "H2O-PWR98" ]

The first tag group selects all O3-666 lines between 500 and 501 GHz plus all O3-686 lines.

The second tag group selects all remaining O3 transitions.

The third tag group selects H2O, with one of the complete absorption models (Rosenkranz 98). No spectrocopic line catalogue data will be used for that third tag group.

Note that order of tag groups in the species list matters. In our example, changing the order of the first two tag group will give different results: as "O3" already selects all O3 transitions, no lines will remain to be selected by the "O3-666-500e9-501e9, O3-686" tag.

For CIA species the tag consists of the two involved species and a dataset index. CIA species can be defined for multiple regions The dataset index determines which region to use from the corresponding CIARecord in abs_cia_data.

Example

species = [ "N2-CIA-N2-0, N2-CIA-N2-1" ]

For Hitran cross section species the tag consists of the species and the tagtype HXSEC, e.g. CFC11-HXSEC. The data for the species must be available in the hitran_xsec_data variable. abs_xsec_agenda_checked* and propmat_clearsky_agenda_checked are set to be false.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]species- Specify one String for each tag group that you want to create. Inside the String, separate the tags by commas (plus optional blanks).

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68668 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), and ARTS::Var::ArrayOfString::pos().

◆ abs_vecAddGas()

MRecord ARTS::AgendaMethod::abs_vecAddGas ( [[maybe_unused] ] Workspace ws)
inline

Add gas absorption to first element of absorption vector.

The task of this method is to sum up the gas absorption of the different gas species and add the result to the first element of the absorption vector.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68698 of file autoarts.h.

◆ abs_xsec_agenda_checkedCalc()

MRecord ARTS::AgendaMethod::abs_xsec_agenda_checkedCalc ( [[maybe_unused] ] Workspace ws)
inline

Checks if the abs_xsec_agenda contains all necessary methods to calculate all the species in abs_species.

This method should be called just before the abs_xsec_agenda is used, e.g. abs_lookupCalc, ybatchCalc, yCalc

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68723 of file autoarts.h.

◆ abs_xsec_per_speciesAddCIA()

MRecord ARTS::AgendaMethod::abs_xsec_per_speciesAddCIA ( [[maybe_unused] ] Workspace ws,
const Var::Numeric T_extrapolfac = {},
const Var::Index robust = {} 
)
inline

Calculate absorption cross sections per tag group for HITRAN CIA continua.

This interpolates the cross sections from abs_cia_data.

The robust option is intended only for testing. Do not use for normal runs, since subsequent functions will not be able to deal with NAN values.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]T_extrapolfac- Temperature extrapolation factor (relative to grid spacing). (default: 0.5)
[in]robust- Set to 1 to suppress runtime errors (and return NAN values instead). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68751 of file autoarts.h.

◆ abs_xsec_per_speciesAddConts()

MRecord ARTS::AgendaMethod::abs_xsec_per_speciesAddConts ( [[maybe_unused] ] Workspace ws)
inline

Calculate absorption cross sections per tag group for continua.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68838 of file autoarts.h.

◆ abs_xsec_per_speciesAddHitranXsec()

MRecord ARTS::AgendaMethod::abs_xsec_per_speciesAddHitranXsec ( [[maybe_unused] ] Workspace ws,
const Var::Index apply_tfit = {},
const Var::Numeric force_p = {},
const Var::Numeric force_t = {} 
)
inline

Calculate absorption cross sections per tag group for HITRAN xsec species.

This broadens the cross section data from hitran_xsec_data and interpolates it onto the current f_grid.

apply_tfit turns of the temperature fit. It is only meant for testing and should alwasy be kept on for real calculations.

This method depends on the FFTW-3 library.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]apply_tfit- Apply temperature fit. (default: 1)
[in]force_p- Positive value forces constant pressure [Pa]. (default: -1)
[in]force_t- Positive value forces constant temperature [K]. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68797 of file autoarts.h.

◆ abs_xsec_per_speciesAddLines()

MRecord ARTS::AgendaMethod::abs_xsec_per_speciesAddLines ( [[maybe_unused] ] Workspace ws)
inline

Calculates the line spectrum for both attenuation and phase for each tag group and adds it to abs_xsec_per_species.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68860 of file autoarts.h.

◆ abs_xsec_per_speciesAddPredefinedO2MPM2020()

MRecord ARTS::AgendaMethod::abs_xsec_per_speciesAddPredefinedO2MPM2020 ( [[maybe_unused] ] Workspace ws)
inline

Reimplementation of published O2 absorption line cross-section algorithm

Based on: Dmitriy S. Makarov, Mikhail Yu. Tretyakov, Philip W. Rosenkranz, JQSRT 243, 2020, Revision of the 60-GHz atmospheric oxygen absorption band models for practical use, https://doi.org/10.1016/j.jqsrt.2019.106798

Note that this is only really applicable to Earth and at lower altitudes. The only two tested derivatives are for frequency and for temperature but other untested derivatives are available for all model parameters except a2

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68890 of file autoarts.h.

◆ abs_xsec_per_speciesInit()

MRecord ARTS::AgendaMethod::abs_xsec_per_speciesInit ( [[maybe_unused] ] Workspace ws)
inline

Initialize abs_xsec_per_species.

The initialization is necessary, because methods abs_xsec_per_speciesAddLines and abs_xsec_per_speciesAddConts just add to abs_xsec_per_species. The size is determined from abs_species.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68916 of file autoarts.h.

◆ AbsInputFromAtmFields()

MRecord ARTS::AgendaMethod::AbsInputFromAtmFields ( [[maybe_unused] ] Workspace ws)
inline

Initialises the WSVs abs_p, abs_t and abs_vmrs from p_grid, t_field and vmr_field.

This only works for a 1D atmosphere!

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 64866 of file autoarts.h.

◆ AbsInputFromRteScalars()

MRecord ARTS::AgendaMethod::AbsInputFromRteScalars ( [[maybe_unused] ] Workspace ws)
inline

Initialize absorption input WSVs from local atmospheric conditions.

The purpose of this method is to allow an explicit line-by-line calculation, e.g., by abs_coefCalcFromXsec, to be put inside the propmat_clearsky_agenda*. What the method does is to prepare absorption input parameters (pressure, temperature, VMRs), from the input parameters to propmat_clearsky_agenda.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 64893 of file autoarts.h.

◆ AddZaAa()

MRecord ARTS::AgendaMethod::AddZaAa ( [[maybe_unused] ] Workspace ws,
Var::Matrix  new_los,
const Var::Vector  ref_los,
const Var::Matrix  dlos 
)
inline

Adds zenith and azimuth angles.

Adds up line-of-sights (LOS). In short, dlos is added to ref_los, assuming that a unit changes in zenith and azimuth are equal where dlos=(0,0).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]new_los- End line-of-sights.
[in]ref_los- Reference line-of-sight (a single LOS).
[in]dlos- Change in line-of-sight (can be multiple LOS).

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68944 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ AgendaExecute()

MRecord ARTS::AgendaMethod::AgendaExecute ( [[maybe_unused] ] Workspace ws,
const Var::Agenda  a 
)
inline

Execute an agenda.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]a- Agenda to be executed.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 68977 of file autoarts.h.

References ARTS::Var::Agenda::islast(), and ARTS::Var::Agenda::pos().

◆ AgendaExecuteExclusive()

MRecord ARTS::AgendaMethod::AgendaExecuteExclusive ( [[maybe_unused] ] Workspace ws,
const Var::Agenda  a 
)
inline

Execute an agenda exclusively.

Only one call to AgendaExecuteExclusive is executed at a time. Other calls to this function are blocked until the current one finishes. WARNING: Can cause deadlocks! Use with care.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]a- Agenda to be executed.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69008 of file autoarts.h.

References ARTS::Var::Agenda::islast(), and ARTS::Var::Agenda::pos().

◆ AngularGridsSetFluxCalc()

MRecord ARTS::AgendaMethod::AngularGridsSetFluxCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index N_za_grid = {},
const Var::Index N_aa_grid = {},
const Var::String za_grid_type = {} 
)
inline

Sets the angular grids for the calculation of radiation fluxes (irradiance) per hemispheres and heating rates

This method sets the angular grids for the radiation fluxes type calculations and calculates the integration weights za_grid_weights for the zenith angle integration. For down- und up-looking geometries it suffices to define N_za_grid and N_aa_grid*. From N_aa_grid an equally spaced grid is created and stored in the WSV*aa_grid*. Depending on the desired za_grid_type za_grid will be equally spaced ('linear') or unequally ('linear_mu','double_gauss') Important, N_za_grid must be an even number because for the integration over each hemisphere N_za_grid / 2 zenith angles are needed.

Possible zenith angle grid types are: double_gauss: The zenith grid and the integration weights are set according to a gauss-legendre integration for each hemispheres. linear: Equally space grid between 0 deg and 180 deg including the poles linear_mu: Similar to 'linear' but equally spaced for cos(180 deg) to cos(0 deg), which results a unequally spaced angular grid

Author
Manfred Brath
Parameters
[in,out]Workspacews - An ARTS workspace
[in]N_za_grid- Number of zenith angles (default: 2)
[in]N_aa_grid- Number of azimuth angles (default: 1)
[in]za_grid_type- Zenith angle grid type (default: "linear_mu")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69056 of file autoarts.h.

◆ antenna_responseGaussian()

MRecord ARTS::AgendaMethod::antenna_responseGaussian ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  fwhm,
const Var::Numeric xwidth_si = {},
const Var::Numeric dx_si = {},
const Var::Index do_2d = {} 
)
inline

Sets up a gaussian antenna response.

The method assumes that the response is the same for all frequencies and polarisations, and that it can be modelled as gaussian.

The grid generated is approximately si * [-xwidth_si:dx_si:xwidth_si] where si is the standard deviation corresponding to the FWHM. That is, width and spacing of the grid is specified in terms of number of standard deviations. If xwidth_si is set to 2, the response will cover about 95% the complete response. For xwidth_si=3, about 99% is covered. If xwidth_si/dx_si is not an integer, the end points of the grid are kept and the spacing of the grid is reduced (ie. spacing is equal or smaller dx_si).

If the 2D option is selected (do_2d), a circular antenna is assumed and the response is any direction follows the 1D case.

The antenna repsonse is not normalised.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]fwhm- Full width at half-maximum
[in]xwidth_si- Half-width of response, in terms of std. dev. (default: 3)
[in]dx_si- Grid spacing, in terms of std. dev. (default: 0.1)
[in]do_2d- Set to 1 to create a 2D antenna pattern. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69266 of file autoarts.h.

◆ antenna_responseVaryingGaussian()

MRecord ARTS::AgendaMethod::antenna_responseVaryingGaussian ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  leff,
const Var::Index  nf,
const Var::Numeric  fstart,
const Var::Numeric  fstop,
const Var::Numeric xwidth_si = {},
const Var::Numeric dx_si = {},
const Var::Index do_2d = {} 
)
inline

Sets up gaussian antenna responses.

Similar to antenna_responseGaussian but allows to set up responses that varies with frequency. That is, the method assumes that the response is the same for all polarisations, and that it can be modelled as a gaussian function varying with frequency.

The full width at half maximum (FWHM in radians) is calculated as: fwhm = lambda / leff where lambda is the wavelength and leff is the effective size of the antenna. Normally, leff is smaller than the physical antenna size.

Antenna responses are created for nf frequencies spanning the range [fstart,fstop], with a logarithmic spacing. That is, the frequency grid of the responses is taken from VectorNLogSpace.

The responses have a common angular grid. The width, determined by xwidth_si*, is set for the lowest frequency, while the spacing (dx_si) is set for the highest frequency. This ensures that both the width and spacing are equal or better than xwidth_si and dx_si*, respectively, for all frequencies.

If the 2D option is selected (do_2d), a circular antenna is assumed and the response is any direction follows the 1D case.

The antenna repsonse is not normalised.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]leff- Effective size of the antenna
[in]xwidth_si- Half-width of response, in terms of std. dev. (default: 3)
[in]dx_si- Grid spacing, in terms of std. dev. (default: 0.1)
[in]nf- Number of points in frequency grid (must be >= 2)
[in]fstart- Start point of frequency grid
[in]fstop- End point of frequency grid
[in]do_2d- Set to 1 to create a 2D antenna pattern. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69343 of file autoarts.h.

◆ AntennaConstantGaussian1D()

MRecord ARTS::AgendaMethod::AntennaConstantGaussian1D ( [[maybe_unused] ] Workspace ws,
const Var::Index  n_za_grid,
const Var::Numeric  fwhm,
const Var::Numeric xwidth_si = {},
const Var::Numeric dx_si = {} 
)
inline

Sets up a 1D gaussian antenna response and a matching mblock_dlos_grid*.

As antenna_responseGaussian, but also creates mblock_dlos_grid. For returned antenna response, see antenna_responseGaussian.

The size of mblock_dlos_grid is determined by n_za_grid. The end points of the grid are set to be the same as for the antenna response. The spacing of the grid follows the magnitude of the response; the spacing is smaller where the response is high. More precisely, the grid points are determined by dividing the cumulative sum of the response in equal steps. This makes sense if the representation error of the radiance (as a function of zenith angle) increases linearly with the grid spacing.

The WSV antenna_dlos is set to [0].

The antenna repsonse is not normalised.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]n_za_grid- Number of points to include in mblock_dlos_grid.
[in]fwhm- Full width at half-maximum of antenna beam [deg].
[in]xwidth_si- Half-width of response, in terms of std. dev. (default: 3)
[in]dx_si- Grid spacing, in terms of std. dev. (default: 0.1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69145 of file autoarts.h.

◆ AntennaMultiBeamsToPencilBeams()

MRecord ARTS::AgendaMethod::AntennaMultiBeamsToPencilBeams ( [[maybe_unused] ] Workspace ws)
inline

Maps a multi-beam case to a matching pencil beam case.

Cases with overlapping beams are most efficiently handled by letting antenna_dlos have several rows. That is, there are multiple beams for each measurement block. The drawback is that many variables must be adjusted if the corresponding pencil beam spectra shall be calculated. This method makes this adjustment. That is, if you have a control file for a multiple beam case and for some reason want to avoid the antenna weighting, you add this method before sensor_responseInit, and remove the call of sensor_responseAntenna* and you will get the matching pencil beam spectra.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69197 of file autoarts.h.

◆ AntennaOff()

MRecord ARTS::AgendaMethod::AntennaOff ( [[maybe_unused] ] Workspace ws)
inline

Sets some antenna related variables

Use this method to set antenna_dim and mblock_dlos_grid to suitable values (1 and [0], respectively) for cases when a sensor is included, but the antenna pattern is neglected.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69222 of file autoarts.h.

◆ Append() [1/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAbsorptionLines  out,
const Var::AbsorptionLines  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72610 of file autoarts.h.

◆ Append() [2/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAbsorptionLines  out,
const Var::ArrayOfAbsorptionLines  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69931 of file autoarts.h.

◆ Append() [3/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAgenda  out,
const Var::Agenda  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72724 of file autoarts.h.

◆ Append() [4/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAgenda  out,
const Var::ArrayOfAgenda  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70045 of file autoarts.h.

◆ Append() [5/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfAbsorptionLines  out,
const Var::ArrayOfAbsorptionLines  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72667 of file autoarts.h.

◆ Append() [6/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfAbsorptionLines  out,
const Var::ArrayOfArrayOfAbsorptionLines  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69988 of file autoarts.h.

◆ Append() [7/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField1  out,
const Var::ArrayOfArrayOfGriddedField1  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70102 of file autoarts.h.

◆ Append() [8/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField1  out,
const Var::ArrayOfGriddedField1  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72781 of file autoarts.h.

◆ Append() [9/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField2  out,
const Var::ArrayOfArrayOfGriddedField2  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70159 of file autoarts.h.

◆ Append() [10/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField2  out,
const Var::ArrayOfGriddedField2  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72838 of file autoarts.h.

◆ Append() [11/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField3  out,
const Var::ArrayOfArrayOfGriddedField3  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70216 of file autoarts.h.

◆ Append() [12/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField3  out,
const Var::ArrayOfGriddedField3  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72895 of file autoarts.h.

◆ Append() [13/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfIndex  out,
const Var::ArrayOfArrayOfIndex  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70273 of file autoarts.h.

◆ Append() [14/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfIndex  out,
const Var::ArrayOfIndex  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72952 of file autoarts.h.

◆ Append() [15/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfMatrix  out,
const Var::ArrayOfArrayOfMatrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70330 of file autoarts.h.

◆ Append() [16/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfMatrix  out,
const Var::ArrayOfMatrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73009 of file autoarts.h.

◆ Append() [17/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfPropagationMatrix  out,
const Var::ArrayOfArrayOfPropagationMatrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70444 of file autoarts.h.

◆ Append() [18/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfPropagationMatrix  out,
const Var::ArrayOfPropagationMatrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73123 of file autoarts.h.

◆ Append() [19/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfRadiationVector  out,
const Var::ArrayOfArrayOfRadiationVector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70501 of file autoarts.h.

◆ Append() [20/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfRadiationVector  out,
const Var::ArrayOfRadiationVector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73180 of file autoarts.h.

◆ Append() [21/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfScatteringMetaData  out,
const Var::ArrayOfArrayOfScatteringMetaData  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70558 of file autoarts.h.

◆ Append() [22/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfScatteringMetaData  out,
const Var::ArrayOfScatteringMetaData  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73237 of file autoarts.h.

◆ Append() [23/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSingleScatteringData  out,
const Var::ArrayOfArrayOfSingleScatteringData  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70615 of file autoarts.h.

◆ Append() [24/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSingleScatteringData  out,
const Var::ArrayOfSingleScatteringData  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73294 of file autoarts.h.

◆ Append() [25/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSpeciesTag  out,
const Var::ArrayOfArrayOfSpeciesTag  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70672 of file autoarts.h.

◆ Append() [26/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfStokesVector  out,
const Var::ArrayOfArrayOfStokesVector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70729 of file autoarts.h.

◆ Append() [27/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfStokesVector  out,
const Var::ArrayOfStokesVector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73351 of file autoarts.h.

◆ Append() [28/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfString  out,
const Var::ArrayOfArrayOfString  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70786 of file autoarts.h.

◆ Append() [29/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfString  out,
const Var::ArrayOfString  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73408 of file autoarts.h.

◆ Append() [30/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor3  out,
const Var::ArrayOfArrayOfTensor3  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70843 of file autoarts.h.

◆ Append() [31/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor3  out,
const Var::ArrayOfTensor3  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73465 of file autoarts.h.

◆ Append() [32/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor6  out,
const Var::ArrayOfArrayOfTensor6  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70900 of file autoarts.h.

◆ Append() [33/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor6  out,
const Var::ArrayOfTensor6  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73522 of file autoarts.h.

◆ Append() [34/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTime  out,
const Var::ArrayOfArrayOfTime  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70957 of file autoarts.h.

◆ Append() [35/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTime  out,
const Var::ArrayOfTime  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73579 of file autoarts.h.

◆ Append() [36/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTransmissionMatrix  out,
const Var::ArrayOfArrayOfTransmissionMatrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71014 of file autoarts.h.

◆ Append() [37/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTransmissionMatrix  out,
const Var::ArrayOfTransmissionMatrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73636 of file autoarts.h.

◆ Append() [38/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfVector  out,
const Var::ArrayOfArrayOfVector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71071 of file autoarts.h.

◆ Append() [39/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfVector  out,
const Var::ArrayOfVector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73693 of file autoarts.h.

◆ Append() [40/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfCIARecord  out,
const Var::ArrayOfCIARecord  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71128 of file autoarts.h.

◆ Append() [41/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfCIARecord  out,
const Var::CIARecord  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73750 of file autoarts.h.

◆ Append() [42/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField1  out,
const Var::ArrayOfGriddedField1  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71185 of file autoarts.h.

◆ Append() [43/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField1  out,
const Var::GriddedField1  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73807 of file autoarts.h.

◆ Append() [44/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField2  out,
const Var::ArrayOfGriddedField2  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71242 of file autoarts.h.

◆ Append() [45/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField2  out,
const Var::GriddedField2  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73864 of file autoarts.h.

◆ Append() [46/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField3  out,
const Var::ArrayOfGriddedField3  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71299 of file autoarts.h.

◆ Append() [47/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField3  out,
const Var::GriddedField3  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73921 of file autoarts.h.

◆ Append() [48/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField4  out,
const Var::ArrayOfGriddedField4  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71356 of file autoarts.h.

◆ Append() [49/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField4  out,
const Var::GriddedField4  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73978 of file autoarts.h.

◆ Append() [50/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfIndex  out,
const Var::ArrayOfIndex  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71413 of file autoarts.h.

◆ Append() [51/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfIndex  out,
const Var::Index  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74035 of file autoarts.h.

◆ Append() [52/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfMatrix  out,
const Var::ArrayOfMatrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71470 of file autoarts.h.

◆ Append() [53/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfMatrix  out,
const Var::Matrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74092 of file autoarts.h.

◆ Append() [54/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPpath  out,
const Var::ArrayOfPpath  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 70387 of file autoarts.h.

◆ Append() [55/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPpath  out,
const Var::Ppath  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 73066 of file autoarts.h.

◆ Append() [56/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPropagationMatrix  out,
const Var::ArrayOfPropagationMatrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71527 of file autoarts.h.

◆ Append() [57/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPropagationMatrix  out,
const Var::PropagationMatrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74149 of file autoarts.h.

◆ Append() [58/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfQuantumIdentifier  out,
const Var::ArrayOfQuantumIdentifier  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71584 of file autoarts.h.

◆ Append() [59/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfQuantumIdentifier  out,
const Var::QuantumIdentifier  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74206 of file autoarts.h.

◆ Append() [60/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRadiationVector  out,
const Var::ArrayOfRadiationVector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71641 of file autoarts.h.

◆ Append() [61/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRadiationVector  out,
const Var::RadiationVector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74263 of file autoarts.h.

◆ Append() [62/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRetrievalQuantity  out,
const Var::ArrayOfRetrievalQuantity  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71698 of file autoarts.h.

◆ Append() [63/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfScatteringMetaData  out,
const Var::ArrayOfScatteringMetaData  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71755 of file autoarts.h.

◆ Append() [64/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfScatteringMetaData  out,
const Var::ScatteringMetaData  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74320 of file autoarts.h.

◆ Append() [65/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSingleScatteringData  out,
const Var::ArrayOfSingleScatteringData  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71812 of file autoarts.h.

◆ Append() [66/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSingleScatteringData  out,
const Var::SingleScatteringData  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74377 of file autoarts.h.

◆ Append() [67/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSparse  out,
const Var::ArrayOfSparse  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71869 of file autoarts.h.

◆ Append() [68/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSparse  out,
const Var::Sparse  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74434 of file autoarts.h.

◆ Append() [69/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfStokesVector  out,
const Var::ArrayOfStokesVector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71926 of file autoarts.h.

◆ Append() [70/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfStokesVector  out,
const Var::StokesVector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74491 of file autoarts.h.

◆ Append() [71/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  out,
const Var::ArrayOfString  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 71983 of file autoarts.h.

◆ Append() [72/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  out,
const Var::String  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74548 of file autoarts.h.

◆ Append() [73/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTelsemAtlas  out,
const Var::ArrayOfTelsemAtlas  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72040 of file autoarts.h.

◆ Append() [74/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTelsemAtlas  out,
const Var::TelsemAtlas  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74605 of file autoarts.h.

◆ Append() [75/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor3  out,
const Var::ArrayOfTensor3  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72097 of file autoarts.h.

◆ Append() [76/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor3  out,
const Var::Tensor3  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74662 of file autoarts.h.

◆ Append() [77/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor4  out,
const Var::ArrayOfTensor4  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72154 of file autoarts.h.

◆ Append() [78/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor4  out,
const Var::Tensor4  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74719 of file autoarts.h.

◆ Append() [79/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor5  out,
const Var::ArrayOfTensor5  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72211 of file autoarts.h.

◆ Append() [80/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor5  out,
const Var::Tensor5  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74776 of file autoarts.h.

◆ Append() [81/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor6  out,
const Var::ArrayOfTensor6  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72268 of file autoarts.h.

◆ Append() [82/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor6  out,
const Var::Tensor6  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74833 of file autoarts.h.

◆ Append() [83/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor7  out,
const Var::ArrayOfTensor7  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72325 of file autoarts.h.

◆ Append() [84/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor7  out,
const Var::Tensor7  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74890 of file autoarts.h.

◆ Append() [85/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTime  out,
const Var::ArrayOfTime  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72382 of file autoarts.h.

◆ Append() [86/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTime  out,
const Var::Time  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 74947 of file autoarts.h.

◆ Append() [87/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTransmissionMatrix  out,
const Var::ArrayOfTransmissionMatrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72439 of file autoarts.h.

◆ Append() [88/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTransmissionMatrix  out,
const Var::TransmissionMatrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75004 of file autoarts.h.

◆ Append() [89/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfVector  out,
const Var::ArrayOfVector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72496 of file autoarts.h.

◆ Append() [90/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfVector  out,
const Var::Vector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75061 of file autoarts.h.

◆ Append() [91/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfXsecRecord  out,
const Var::ArrayOfXsecRecord  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 72553 of file autoarts.h.

◆ Append() [92/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Matrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69532 of file autoarts.h.

◆ Append() [93/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69589 of file autoarts.h.

◆ Append() [94/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::String  out,
const Var::String  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69874 of file autoarts.h.

◆ Append() [95/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::Matrix  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69646 of file autoarts.h.

◆ Append() [96/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::Tensor3  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69703 of file autoarts.h.

◆ Append() [97/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::Tensor3  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69760 of file autoarts.h.

◆ Append() [98/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::Tensor4  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69817 of file autoarts.h.

◆ Append() [99/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Numeric  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69418 of file autoarts.h.

Referenced by ARTS::AgendaDefine::abs_xsec_agenda(), ARTS::AgendaDefine::dobatch_calc_agenda(), ARTS::AgendaDefine::doit_conv_test_agenda(), ARTS::AgendaDefine::doit_mono_agenda(), ARTS::AgendaDefine::doit_rte_agenda(), ARTS::AgendaDefine::doit_scat_field_agenda(), ARTS::AgendaDefine::forloop_agenda(), ARTS::AgendaDefine::g0_agenda(), ARTS::AgendaDefine::geo_pos_agenda(), ARTS::AgendaDefine::inversion_iterate_agenda(), ARTS::AgendaDefine::iy_cloudbox_agenda(), ARTS::AgendaDefine::iy_independent_beam_approx_agenda(), ARTS::AgendaDefine::iy_loop_freqs_agenda(), ARTS::AgendaDefine::iy_main_agenda(), ARTS::AgendaDefine::iy_space_agenda(), ARTS::AgendaDefine::iy_surface_agenda(), ARTS::AgendaDefine::iy_transmitter_agenda(), ARTS::AgendaDefine::jacobian_agenda(), ARTS::AgendaDefine::main_agenda(), ARTS::AgendaDefine::met_profile_calc_agenda(), ARTS::AgendaDefine::pha_mat_spt_agenda(), ARTS::AgendaDefine::ppath_agenda(), ARTS::AgendaDefine::ppath_step_agenda(), ARTS::AgendaDefine::propmat_clearsky_agenda(), ARTS::AgendaDefine::refr_index_air_agenda(), ARTS::AgendaDefine::sensor_response_agenda(), ARTS::AgendaDefine::spt_calc_agenda(), ARTS::AgendaDefine::surface_rtprop_agenda(), ARTS::AgendaDefine::surface_rtprop_sub_agenda(), ARTS::AgendaDefine::test_agenda(), ARTS::AgendaDefine::water_p_eq_agenda(), and ARTS::AgendaDefine::ybatch_calc_agenda().

◆ Append() [100/100]

MRecord ARTS::AgendaMethod::Append ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Vector  in,
const Var::String dimension = {} 
)
inline

Append one workspace variable to another.

This method can append an array to another array of the same type, e.g. ArrayOfIndex to ArrayOfIndex. Or a single element to an array such as a Tensor3 to an ArrayOfTensor3.

Appending two vectors or a numeric to a vector works as for array variables.

Both another matrix or a vector can be appended to a matrix. In addition, for matrices, the 'append dimension' can be selected. The third argument, dimension, indicates how to append, where "leading" means to append row-wise, and "trailing" means column-wise.

Other types (TensorX) are currently only implemented for appending to the leading dimension.

This method is not implemented for all types, just for those that were thought or found to be useful. (See variable list below.).

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The variable to append to.
[in]in- The variable to append.
[in]dimension- Where to append. Could be either the "leading" or "trailing" dimension. (default: "leading")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69475 of file autoarts.h.

◆ ArrayOfAgendaExecute()

MRecord ARTS::AgendaMethod::ArrayOfAgendaExecute ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAgenda  agendas 
)
inline

Execute an agenda from an ArrayOfAgenda.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]agendas- Array of agendas.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 69098 of file autoarts.h.

References agendas().

◆ ArrayOfGriddedFieldGetNames() [1/4]

MRecord ARTS::AgendaMethod::ArrayOfGriddedFieldGetNames ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  names,
const Var::ArrayOfGriddedField1  griddedfields 
)
inline

Get the names of all GriddedFields stored in an Array.

See GriddedFieldGetName.

Author
Lukas Kluft
Parameters
[in,out]Workspacews - An ARTS workspace
[out]names- Names of the GriddedFields in the ArrayOfGriddedField.
[in]griddedfields- Array of GriddedFields.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75100 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField1::islast(), ARTS::Var::ArrayOfString::islast(), ARTS::Var::ArrayOfGriddedField1::pos(), and ARTS::Var::ArrayOfString::pos().

◆ ArrayOfGriddedFieldGetNames() [2/4]

MRecord ARTS::AgendaMethod::ArrayOfGriddedFieldGetNames ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  names,
const Var::ArrayOfGriddedField2  griddedfields 
)
inline

Get the names of all GriddedFields stored in an Array.

See GriddedFieldGetName.

Author
Lukas Kluft
Parameters
[in,out]Workspacews - An ARTS workspace
[out]names- Names of the GriddedFields in the ArrayOfGriddedField.
[in]griddedfields- Array of GriddedFields.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75133 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField2::islast(), ARTS::Var::ArrayOfString::islast(), ARTS::Var::ArrayOfGriddedField2::pos(), and ARTS::Var::ArrayOfString::pos().

◆ ArrayOfGriddedFieldGetNames() [3/4]

MRecord ARTS::AgendaMethod::ArrayOfGriddedFieldGetNames ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  names,
const Var::ArrayOfGriddedField3  griddedfields 
)
inline

Get the names of all GriddedFields stored in an Array.

See GriddedFieldGetName.

Author
Lukas Kluft
Parameters
[in,out]Workspacews - An ARTS workspace
[out]names- Names of the GriddedFields in the ArrayOfGriddedField.
[in]griddedfields- Array of GriddedFields.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75166 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField3::islast(), ARTS::Var::ArrayOfString::islast(), ARTS::Var::ArrayOfGriddedField3::pos(), and ARTS::Var::ArrayOfString::pos().

◆ ArrayOfGriddedFieldGetNames() [4/4]

MRecord ARTS::AgendaMethod::ArrayOfGriddedFieldGetNames ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  names,
const Var::ArrayOfGriddedField4  griddedfields 
)
inline

Get the names of all GriddedFields stored in an Array.

See GriddedFieldGetName.

Author
Lukas Kluft
Parameters
[in,out]Workspacews - An ARTS workspace
[out]names- Names of the GriddedFields in the ArrayOfGriddedField.
[in]griddedfields- Array of GriddedFields.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75199 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField4::islast(), ARTS::Var::ArrayOfString::islast(), ARTS::Var::ArrayOfGriddedField4::pos(), and ARTS::Var::ArrayOfString::pos().

◆ ArrayOfIndexLinSpace()

MRecord ARTS::AgendaMethod::ArrayOfIndexLinSpace ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfIndex  out,
const Var::Index  start,
const Var::Index  stop,
const Var::Index  step 
)
inline

Initializes an ArrayOfIndex with linear spacing.

The first element equals always the start value, and the spacing equals always the step value, but the last value can deviate from the stop value. step can be both positive and negative.

The created array is [start, start+step, start+2*step, ...]

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output array.
[in]start- Start value.
[in]stop- Maximum/minimum value of the end value
[in]step- Spacing of the array.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75238 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::Index::islast(), ARTS::Var::ArrayOfIndex::pos(), ARTS::Var::Index::pos(), and Zeeman::start().

◆ ArrayOfIndexSet()

MRecord ARTS::AgendaMethod::ArrayOfIndexSet ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfIndex  out,
const Var::ArrayOfIndex  value 
)
inline

Creates an ArrayOfIndex from the given list of numbers.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- Indexes for initializiation.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75275 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfIndex::value().

◆ ArrayOfIndexSetConstant()

MRecord ARTS::AgendaMethod::ArrayOfIndexSetConstant ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfIndex  out,
const Var::Index  value 
)
inline

Creates an ArrayOfIndex of length nelem, with all values identical.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- Array value..

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75307 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::Index::islast(), ARTS::Var::ArrayOfIndex::pos(), ARTS::Var::Index::pos(), and ARTS::Var::Index::value().

◆ ArrayOfQuantumIdentifierFromLines()

MRecord ARTS::AgendaMethod::ArrayOfQuantumIdentifierFromLines ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfQuantumIdentifier  out,
const Var::Index global = {} 
)
inline

Sets an ArrayOfQuantumIdentifier to all levels in abs_lines_per_species with defined quantum numbers

Lines without defined quantum numbers are ignored

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Identifiers to all levels in abs_lines_per_species
[in]global- Only look at global quantum numbers (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103834 of file autoarts.h.

◆ ArrayOfQuantumIdentifierSet()

MRecord ARTS::AgendaMethod::ArrayOfQuantumIdentifierSet ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfQuantumIdentifier  out,
const Var::ArrayOfString  string_initializers 
)
inline

Sets an ArrayOfQuantumIdentifier workspace variable to the given value by converting the input ArrayOfString

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variables to initialize.
[in]string_initializers- The array of string representing the values of the array.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101496 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), ARTS::Var::ArrayOfString::islast(), ARTS::Var::ArrayOfQuantumIdentifier::pos(), and ARTS::Var::ArrayOfString::pos().

◆ ArrayOfStringSet()

MRecord ARTS::AgendaMethod::ArrayOfStringSet ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  out,
const Var::ArrayOfString  value 
)
inline

Sets a String array according the given text. The format is text = ["String1","String2",...]

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- Strings for initialization.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75339 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), ARTS::Var::ArrayOfString::pos(), and ARTS::Var::ArrayOfString::value().

◆ atm_fields_compactAddConstant()

MRecord ARTS::AgendaMethod::atm_fields_compactAddConstant ( [[maybe_unused] ] Workspace ws,
const Var::String  name,
const Var::Numeric  value,
const Var::Index prepend = {},
const Var::ArrayOfString condensibles = {} 
)
inline

Adds a constant field to atm_fields_compact.

This is handy, e.g., for nitrogen or oxygen. The constant value can be appended or prepended as an additional field to the already existing collection of fields. All dimensions (pressure, latitude, longitude) are filled up, so this works for 1D, 2D, or 3D atmospheres.

The passed name of the field has to be in accordance with the tagging structure described for atm_fields_compact.

A list of condensibles can be optionally specified if the VMR of the added species is assuming dry air. The VMR of the added species is then scaled down by the sum of the condensibles' VMR: VMR * (1 - VMR_sum_of_condensibles). For Earth this should be set to ["abs_species-H2O"]

Author
Stefan Buehler, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]name- Name of additional atmospheric field, with constant value.
[in]value- Constant value of additional field.
[in]prepend- 0 = Append to the end, 1 = insert at the beginning. (default: 0)
[in]condensibles- List of condensibles used to scale down the VMR of the added species. (default: {})

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76241 of file autoarts.h.

◆ atm_fields_compactAddSpecies()

MRecord ARTS::AgendaMethod::atm_fields_compactAddSpecies ( [[maybe_unused] ] Workspace ws,
const Var::String  name,
const Var::GriddedField3  value,
const Var::Index prepend = {} 
)
inline

Adds a field to atm_fields_compact, with interpolation.

This method appends or prepends a GriddedField3 to atm_fields_compact. The GriddedField3 is interpolated upon the grid of atm_fields_compact*. A typical use case for this method may be to add a climatology of some gas when this gas is needed for radiative transfer calculations, but not yet present in atm_fields_compact. One case where this happens is when using the Chevalier91L dataset for infrared simulations.

The grids in atm_fields_compact must fully encompass the grids in the GriddedField3 to be added, for interpolation to succeed. If this is not the case, a RuntimeError is thrown.

The passed name of the field has to be in accordance with the tagging structure described for atm_fields_compact.

Author
Gerrit Holl
Parameters
[in,out]Workspacews - An ARTS workspace
[in]name- Name of additional atmospheric field.
[in]value- Value of additional atmospheric field.
[in]prepend- 0 = Append to the end, 1 = insert at the beginning. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76300 of file autoarts.h.

◆ atm_fields_compactCleanup()

MRecord ARTS::AgendaMethod::atm_fields_compactCleanup ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  threshold 
)
inline

Removes unrealistically small or erroneous data from atm_fields_compact* (or other GriddedField4 data)

This WSM checks if the data in atm_fields_compact contains values smaller than the given threshold. In this case, these values will be set to zero.

The method should be applied if atm_fields_compact contains unrealistically small or erroneous data (NWP/GCM model data occassionally contains negative values, which are numerical artefacts rather than physical values.)

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]threshold- Threshold below which atm_fields_compact values are set to zero.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76346 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ atm_fields_compactCreateFromField()

MRecord ARTS::AgendaMethod::atm_fields_compactCreateFromField ( [[maybe_unused] ] Workspace ws,
const Var::String  name,
const Var::GriddedField3  field 
)
inline

Initiates atm_fields_compact from a field.

atm_fields_compact* will have the same size and grids as the GriddedField3, but with one dimension as length 1.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]name- Name atmospheric field.
[in]field- The atmospheric field.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76377 of file autoarts.h.

References ARTS::Var::GriddedField3::islast(), ARTS::Var::String::islast(), ARTS::Var::GriddedField3::pos(), and ARTS::Var::String::pos().

◆ atm_fields_compactFromMatrix()

MRecord ARTS::AgendaMethod::atm_fields_compactFromMatrix ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  gin1,
const Var::ArrayOfString  field_names 
)
inline

Sets atm_fields_compact from 1D fields given in form of a matrix.

For batch calculations it is handy to store atmospheric profiles in an array of matrix. We take such a matrix, and create atm_fields_compact* from it.

The matrix must contain one row for each pressure level.

Not all fields contained in the matrix must be selected into atm_fields_compact*, but the selection must at least contain fields of pressure, temperature, altitude and one absorption species. The matrix can contain some additional fields which are not directly used by ARTS for calculations but can be required for further processing, e.g. wind speed and direction. These fields do not need to be transfered into the atm_fields_compact variable.

Selection of fields into atm_fields_compact works by providing a field name tag in field_names for the selected fields, while unselected fields are tagged by 'ignore'. Order of tags in field_names* is strictly taken as corresponding to column order in the matrix. The pressure fields are by convention the first column of the matrix, hence must not be tagged. That is, there must be given one field name tag less than matrix columns.

For detailed tagging conventions see atm_fields_compact.

Works only for atmosphere_dim==1.

Author
Stefan Buehler
Daniel Kreyling
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]gin1- One atmosphere matrix from batch input ArrayOfMatrix.
[in]field_names- Order/names of atmospheric fields.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76438 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), ARTS::Var::Matrix::islast(), ARTS::Var::ArrayOfString::pos(), and ARTS::Var::Matrix::pos().

◆ atm_gridsFromZRaw()

MRecord ARTS::AgendaMethod::atm_gridsFromZRaw ( [[maybe_unused] ] Workspace ws,
const Var::Index no_negZ = {} 
)
inline

Calls p_gridFromZRaw, lat_gridFromZRaw and lon_gridFromZRaw

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]no_negZ- Exclude negative altitudes. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110507 of file autoarts.h.

◆ AtmFieldPerturb()

MRecord ARTS::AgendaMethod::AtmFieldPerturb ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  perturbed_field,
const Var::Tensor3  original_field,
const Var::Vector  p_ret_grid,
const Var::Vector  lat_ret_grid,
const Var::Vector  lon_ret_grid,
const Var::Index  pert_index,
const Var::Numeric  pert_size,
const Var::String pert_mode = {} 
)
inline

Adds a perturbation to an atmospheric field.

The shape and position of the perturbation follow the retrieval grids. That is, the shape of the perturbation has a traingular shape, with breake points at the retrieval grid points. The position is given as an index. This index matches the column in the Jacobian for the selected grid position.

If the retrieval grids fully match the atmospheric grids, you can use AtmFieldPerturbAtmGrids, that is faster. The description of that method can help to understand this method.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]perturbed_field- Perturbed/modified field.
[in]original_field- Original field, e.g. t_field.
[in]p_ret_grid- Pressure retrieval grid.
[in]lat_ret_grid- Latitude retrieval grid.
[in]lon_ret_grid- Longitude retrieval grid.
[in]pert_index- Index of position where the perturbation shall be performed.
[in]pert_size- Size of perturbation.
[in]pert_mode- Type of perturbation, absolute or relative. (default: "absolute")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75386 of file autoarts.h.

◆ AtmFieldPerturbAtmGrids()

MRecord ARTS::AgendaMethod::AtmFieldPerturbAtmGrids ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  perturbed_field,
const Var::Tensor3  original_field,
const Var::Index  pert_index,
const Var::Numeric  pert_size,
const Var::String pert_mode = {} 
)
inline

As AtmFieldPerturb, but perturbation follows the atmospheric grids.

The method effectively performs this perturbed_field = original_field perturbed_field(p_index,lat_index,lon_index) += pert_size if not pert_mode is set to relative when this is done perturbed_field = original_field perturbed_field(p_index,lat_index,lon_index) *= 1*pert_size where p_index etc. are derived from pert_index.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]perturbed_field- Perturbed/modified field.
[in]original_field- Original field, e.g. t_field.
[in]pert_index- Index of position where the perturbation shall be performed.
[in]pert_size- Size of perturbation.
[in]pert_mode- Type of perturbation, ansolute or relative. (default: "absolute")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75449 of file autoarts.h.

◆ AtmFieldPRegrid() [1/2]

MRecord ARTS::AgendaMethod::AtmFieldPRegrid ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::Tensor3  in,
const Var::Vector  p_grid_new,
const Var::Vector  p_grid_old,
const Var::Index interp_order = {} 
)
inline

Interpolates the input field along the pressure dimension from p_grid_old* to to p_grid_new.

Extrapolation is allowed within the common 0.5grid-step margin. in and out fields can be the same variable.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Regridded atmospheric field.
[in]in- Input atmospheric field.
[in]p_grid_new- Pressure grid to regrid to
[in]p_grid_old- Pressure grid of input field
[in]interp_order- Interpolation order. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75499 of file autoarts.h.

◆ AtmFieldPRegrid() [2/2]

MRecord ARTS::AgendaMethod::AtmFieldPRegrid ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::Tensor4  in,
const Var::Vector  p_grid_new,
const Var::Vector  p_grid_old,
const Var::Index interp_order = {} 
)
inline

Interpolates the input field along the pressure dimension from p_grid_old* to to p_grid_new.

Extrapolation is allowed within the common 0.5grid-step margin. in and out fields can be the same variable.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Regridded atmospheric field.
[in]in- Input atmospheric field.
[in]p_grid_new- Pressure grid to regrid to
[in]p_grid_old- Pressure grid of input field
[in]interp_order- Interpolation order. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75549 of file autoarts.h.

◆ atmfields_checkedCalc()

MRecord ARTS::AgendaMethod::atmfields_checkedCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index negative_vmr_ok = {},
const Var::Index bad_partition_functions_ok = {} 
)
inline

Checks consistency of (clear sky) atmospheric fields.

The following WSVs are treated: p_grid, lat_grid, lon_grid, t_field*, vmr_field, wind_u/v/w_field and mag_u/v/w_field.

If any of the variables above is changed, then this method shall be called again (no automatic check that this is fulfilled!).

The tests include that:

  1. Atmospheric grids (p/lat/lon_grid) are OK with respect to atmosphere_dim* (and vmr_field also regarding abs_species).
  2. Atmospheric fields have sizes consistent with the atmospheric grids.
  3. abs_f_interp_order is not zero if any wind is nonzero.
  4. All values in t_field are > 0.

Default is that values in vmr_field are demanded to be >= 0 (ie. zero allowed, in contrast to t_field), but this requirement can be removed by the negative_vmr_ok argument.

If any test fails, there is an error. Otherwise, atmfields_checked* is set to 1.

The cloudbox is covered by cloudbox_checked, z_field is part of the checks done around atmgeom_checked.

If you choose to use bad_partition_functions_ok please note that this is done on your own risk and that it could introduce hard-to- track errors into your calculations. Do not use this for anything important.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]negative_vmr_ok- Flag whether to accept vmr_field < 0. (default: 0)
[in]bad_partition_functions_ok- Flag whether to accept partition functions not covering t_field range. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75971 of file autoarts.h.

◆ AtmFieldsAndParticleBulkPropFieldFromCompact()

MRecord ARTS::AgendaMethod::AtmFieldsAndParticleBulkPropFieldFromCompact ( [[maybe_unused] ] Workspace ws,
const Var::String delim = {},
const Var::Numeric p_min = {},
const Var::Index check_gridnames = {} 
)
inline

Extract pressure grid and atmospheric fields from atm_fields_compact*.

An atmospheric scenario includes the following data for each position (pressure, latitude, longitude) in the atmosphere:

  1. temperature field
  2. the corresponding altitude field
  3. vmr fields for the gaseous species
  4. scattering species fields

This method splits up the data found in atm_fields_compact to p_grid, lat_grid, lon_grid, vmr_field, particle_bulkprop_field, and particle_bulkprop_names. See documentation of atm_fields_compact for a definition of the data.

Compact states are characterized by having all atmospheric fields already given on identical grids. That is, no interpolation needs to be and is performed. Keyword p_min allows to remove atmospheric levels with pressures lower than the given value (default: no removal). This reduces computational burden and is useful when upper atmospheric contributions are negligible.

Possible future extensions: Add a keyword parameter to refine the pressure grid if it is too coarse. Or a version that interpolates onto given grids, instead of using and returning the original grids.

Author
Jana Mendrok, Manfred Brath
Parameters
[in,out]Workspacews - An ARTS workspace
[in]delim- Delimiter string of scat_species elements. (default: "-")
[in]p_min- Minimum-pressure level to consider (for TOA). (default: 0)
[in]check_gridnames- A flag with value 1 or 0. If set to one, the gridnames of the atm_fields_compact are checked. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75899 of file autoarts.h.

◆ AtmFieldsCalc()

MRecord ARTS::AgendaMethod::AtmFieldsCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index interp_order = {},
const Var::Index vmr_zeropadding = {},
const Var::Index vmr_nonegative = {},
const Var::Index nlte_when_negative = {} 
)
inline

Interpolation of raw atmospheric T, z, VMR, and NLTE T/r fields to calculation grids.

An atmospheric scenario includes the following data for each position (pressure, latitude, longitude) in the atmosphere:

  1. temperature field
  2. the corresponding altitude field
  3. vmr fields for the gaseous species This method interpolates the fields of raw data (t_field_raw, z_field_raw*, vmr_field_raw) which can be stored on arbitrary grids to the calculation grids (p_grid, lat_grid, lon_grid). If nlte_field_raw is empty, it is assumed to be so because LTE is assumed by the user and nlte_field will be empty.

Internally, AtmFieldsCalc applies GriddedFieldPRegrid and GriddedFieldLatLonRegrid*. Generally, 'half-grid-step' extrapolation is allowed and applied. However, if vmr_zeropadding=1 then VMRs at p_grid* levels exceeding the raw VMRs' pressure grid are set to 0 (applying the vmr_zeropadding option of GriddedFieldPRegrid).

Default is to just accept obtained VMRs. If you want to enforce that all VMR created are >= 0, set vmr_nonegative to 1. Negative values are then set 0. Beside being present in input data, negative VMR can be generated from the interpolation if interp_order is above 1.

Author
Claudia Emde
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]interp_order- Interpolation order (1=linear interpolation). (default: 1)
[in]vmr_zeropadding- Pad VMRs with zeroes to fit the pressure grid if necessary. (default: 0)
[in]vmr_nonegative- If set to 1, negative VMRs are set to 0. (default: 0)
[in]nlte_when_negative- -1: Skip step. 0: Negative is 0. Else: Negative is t. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75619 of file autoarts.h.

◆ AtmFieldsCalcExpand1D()

MRecord ARTS::AgendaMethod::AtmFieldsCalcExpand1D ( [[maybe_unused] ] Workspace ws,
const Var::Index interp_order = {},
const Var::Index vmr_zeropadding = {},
const Var::Index vmr_nonegative = {},
const Var::Index nlte_when_negative = {} 
)
inline

Interpolation of 1D raw atmospheric fields to create 2D or 3D homogeneous atmospheric fields.

The method works as AtmFieldsCalc, but accepts only raw 1D atmospheres. The raw atmosphere is interpolated to p_grid and the obtained values are applied for all latitudes, and also longitudes for 3D, to create a homogeneous atmosphere.

The method deals only with the atmospheric fields, and to create a true 2D or 3D version of a 1D case, a demand is also that the ellipsoid is set to be a sphere.

Author
Patrick Eriksson
Claudia Emde
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]interp_order- Interpolation order (1=linear interpolation). (default: 1)
[in]vmr_zeropadding- Pad VMRs with zeroes to fit the pressure grid if necessary. (default: 0)
[in]vmr_nonegative- If set to 1, negative VMRs are set to 0. (default: 0)
[in]nlte_when_negative- -1: Skip step. 0: Negative is 0. Else: Negative is t. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75682 of file autoarts.h.

◆ AtmFieldsExpand1D()

MRecord ARTS::AgendaMethod::AtmFieldsExpand1D ( [[maybe_unused] ] Workspace ws,
const Var::Index chk_vmr_nan = {} 
)
inline

Maps a 1D case to 2D or 3D homogeneous atmospheric fields.

This method takes a 1D atmospheric case and converts it to the corresponding case for 2D or 3D. The atmospheric fields (t_field, z_field and vmr_field) must be 1D and match p_grid. The size of the new data is determined by atmosphere_dim, lat_grid and lon_grid*. That is, these later variables have been changed since the original fields were created.

The method deals only with the atmospheric fields, and to create a true 2D or 3D version of a 1D case, a demand is also that the ellipsoid is set to be a sphere.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]chk_vmr_nan- Flag to determine if a search for NaN shall be performed or not. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75741 of file autoarts.h.

◆ AtmFieldsExtract1D()

MRecord ARTS::AgendaMethod::AtmFieldsExtract1D ( [[maybe_unused] ] Workspace ws,
const Var::Index ilat = {},
const Var::Index ilon = {} 
)
inline

Converts 2D or 3D homogeneous atmospheric fields to a 1D case.

The method extracts data for given latitude and longitude index to create a 1D atmosphere. AtmosphereSet1D is called to set output values of atmosphere_dim, lat_grid and lon_grid. Nothing is done if atmosphere_dim alöready is 1.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]ilat- Pick data having this latitude index (0-based). (default: 0)
[in]ilon- Pick data having this longitude index (0-based). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75777 of file autoarts.h.

◆ AtmFieldsRefinePgrid()

MRecord ARTS::AgendaMethod::AtmFieldsRefinePgrid ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  p_step,
const Var::Index interp_order = {} 
)
inline

Refines the pressure grid and regrids the clearsky atmospheric fields accordingly.

This method is, e.g., used for absorption lookup table testing. It can also be used to refine the p_grid and atmospheric fields from compact state atmospheres.

It adds additional vertical grid points to the atmospheric fields, by interpolating them in the usual ARTS way (linear in log pressure).

How fine the new grid will be is determined by the keyword parameter p_step. The definition of p_step, and the default interpolation behavior, is consistent with abs_lookupSetup and abs_lookupSetupBatch* (new points are added between the original ones, so that the spacing is always below p_step.)

Internally, AtmFieldsRefinePgrid applies p_gridRefine and AtmFieldPRegrid* to the clearsky atmospheric fields (T, z, vmr).

Atmospheric field related check WSV are reset to 0 (unchecked), i.e., the corresponding checkedCalc methods have to be performed (again) before yCalc or similar methods can be executed.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]p_step- Maximum step in log(p[Pa]) (natural logarithm, as always). If the pressure grid is coarser than this, additional points are added until each log step is smaller than this.
[in]interp_order- Interpolation order. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 75838 of file autoarts.h.

◆ atmgeom_checkedCalc()

MRecord ARTS::AgendaMethod::atmgeom_checkedCalc ( [[maybe_unused] ] Workspace ws)
inline

Checks consistency of geometric considerations of the atmosphere.

The following WSVs are checked: z_field, refellipsoid, z_surface, lat_true* and lon_true. If any of the variables above is changed, then this method shall be called again (no automatic check that this is fulfilled!).

The tests include that:

  1. refellipsoid has correct size, and that eccentricity is set to zero if 1D atmosphere.
  2. z_field and z_surface have sizes consistent with the atmospheric grids.
  3. There is no gap between z_surface and z_field.

lat_true* and lon_true are allowed to be empty.

If any test fails, there is an error. Otherwise, atmgeom_checked is set to 1.

See further atmgeom_checkedCalc.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76025 of file autoarts.h.

◆ AtmosphereSet1D()

MRecord ARTS::AgendaMethod::AtmosphereSet1D ( [[maybe_unused] ] Workspace ws)
inline

Sets the atmospheric dimension to 1D.

Sets atmosphere_dim to 1, and the latitude and longitude grids are set to be empty.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76049 of file autoarts.h.

◆ AtmosphereSet2D()

MRecord ARTS::AgendaMethod::AtmosphereSet2D ( [[maybe_unused] ] Workspace ws)
inline

Sets the atmospheric dimension to be 2D.

Sets atmosphere_dim to 2 and the longitude grid to be empty.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76072 of file autoarts.h.

◆ AtmosphereSet3D()

MRecord ARTS::AgendaMethod::AtmosphereSet3D ( [[maybe_unused] ] Workspace ws)
inline

Sets the atmospheric dimension to 3D.

Sets atmosphere_dim to 3, and lat_true and lon_true are set to be empty.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76096 of file autoarts.h.

◆ AtmRawRead()

MRecord ARTS::AgendaMethod::AtmRawRead ( [[maybe_unused] ] Workspace ws,
const Var::String  basename 
)
inline

Reads atmospheric data from a scenario.

An atmospheric scenario includes the following data for each position (pressure, latitude, longitude) in the atmosphere:

  1. temperature field
  2. the corresponding altitude field
  3. vmr fields for the absorption species The vmr fields read are governed by the species given in abs_species*. Beside gaseous species, these can also contain purely absorbing particulate matter. In the latter case the profiles are supposed to provide the mass content (unit kg/m3) for clouds and precipitation rate (unit kg/m2/s) for precipitation instead of the vmr.

The data is stored in different files. This methods reads all files and creates the variables t_field_raw, z_field_raw and vmr_field_raw*. nlte_field_raw is set to empty.

Files in a scenarios should be named matching the pattern of: basename.speciesname.xml (for temperature and altitude the expected 'speciesname' are 't' and'z', respectivly). The files can be anywhere, but they must all be in the same directory, selected by 'basename'. The files are chosen by the species name. If you have more than one tag group for the same species, the same profile will be used.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- Name of scenario, probably including the full path. For example: "/smiles_local/arts-data/atmosphere/fascod/tropical"

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76143 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ AtmWithNLTERawRead()

MRecord ARTS::AgendaMethod::AtmWithNLTERawRead ( [[maybe_unused] ] Workspace ws,
const Var::String  basename,
const Var::Index expect_vibrational_energies = {} 
)
inline

Reads atmospheric data from a scenario.

An atmospheric scenario includes the following data for each position (pressure, latitude, longitude) in the atmosphere:

  1. temperature field
  2. the corresponding altitude field
  3. vmr fields for the gaseous species
  4. Non-LTE temperature fields and matching identifiers The data is stored in different files. This method reads all files and creates the variables t_field_raw, z_field_raw, vmr_field_raw*, nlte_field_raw, and nlte_level_identifiers.

Files in a scenarios should be named matching the pattern of: tropical.H2O.xml

The files can be anywhere, but they must be all in the same directory, selected by 'basename'. The files are chosen by the species name. If you have more than one tag group for the same species, the same profile will be used.

Author
Claudia Emde
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- Name of scenario, probably including the full path. For example: "/smiles_local/arts-data/atmosphere/fascod/tropical"
[in]expect_vibrational_energies- Should ev.xml be read? (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76190 of file autoarts.h.

◆ avkCalc()

MRecord ARTS::AgendaMethod::avkCalc ( [[maybe_unused] ] Workspace ws)
inline

Calculates the averaging kernel matrix describing the sensitivity of the OEM retrieval with respect to the true state of the system. A prerequisite for the calculation of the averaging kernel matrix is a successful OEM calculation in which the jacobian and the gain matrix dxdy have been calculated.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104091 of file autoarts.h.

◆ backend_channel_responseFlat()

MRecord ARTS::AgendaMethod::backend_channel_responseFlat ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  resolution 
)
inline

Sets up a rectangular channel response.

The response of the backend channels is hee assumed to be constant inside the resolution width, and zero outside.

The method assumes that all channels have the same response.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]resolution- The spectrometer resolution.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76473 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ backend_channel_responseGaussian()

MRecord ARTS::AgendaMethod::backend_channel_responseGaussian ( [[maybe_unused] ] Workspace ws,
const Var::Vector  fwhm,
const Var::Vector xwidth_si = {},
const Var::Vector dx_si = {} 
)
inline

Sets up a gaussian backend channel response.

The method assumes that all channels can be modelled as gaussian.

If fwhm has only one element, all channels are assumed to be equal. If fwhm has multiple elements, xwidth_si and dx_si must have one element or the same number of elements as fwhm. If one element is given, this value will be used for all channels.

The grid generated can be written as si * [-xwidth_si:dx_si:xwidth_si] where si is the standard deviation corresponding to the FWHM. That is, width and spacing of the grid is specified in terms of number of standard deviations. If xwidth_si is set to 2, the response will cover about 95% the complete response. For xwidth_si=3, about 99% is covered. If xwidth_si/dx_si is not an integer, the end points of the grid are kept and the spacing if the grid is adjusted in the downward direction (ie. spacing is. is max dx_si).

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]fwhm- Full width at half-maximum
[in]xwidth_si- Half-width of response, in terms of std. dev. (default: {3})
[in]dx_si- Grid spacing, in terms of std. dev. (default: {0.1})

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76520 of file autoarts.h.

◆ batch_atm_fields_compactAddConstant()

MRecord ARTS::AgendaMethod::batch_atm_fields_compactAddConstant ( [[maybe_unused] ] Workspace ws,
const Var::String  name,
const Var::Numeric  value,
const Var::Index prepend = {},
const Var::ArrayOfString condensibles = {} 
)
inline

Adds a constant field to batch_atm_fields_compact.

Applies atm_fields_compactAddConstant to each batch. The format is equal to that WSM.

Author
Gerrit Holl
Parameters
[in,out]Workspacews - An ARTS workspace
[in]name- Name of additional atmospheric field, with constant value.
[in]value- Constant value of additional field.
[in]prepend- 0 = Append to the end, 1 = insert at the beginning. (default: 0)
[in]condensibles- List of condensibles used to scale down the VMR of the added species. (default: {})

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76565 of file autoarts.h.

◆ batch_atm_fields_compactAddSpecies()

MRecord ARTS::AgendaMethod::batch_atm_fields_compactAddSpecies ( [[maybe_unused] ] Workspace ws,
const Var::String  name,
const Var::GriddedField3  value,
const Var::Index prepend = {} 
)
inline

Adds a field to batch_atm_fields_compact, with interpolation.

This method appends or prepends a GriddedField3 to each atm_fields_compact. in batch_atm_fields_compact. For details, see atm_fields_compactAddSpecies.

Author
Gerrit Holl
Parameters
[in,out]Workspacews - An ARTS workspace
[in]name- Name of additional atmospheric field. Use, e.g., vmr_ch4 for methane VMR
[in]value- Value of additional atmospheric field.
[in]prepend- 0 = Append to the end, 1 = insert at the beginning. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76612 of file autoarts.h.

◆ batch_atm_fields_compactCleanup()

MRecord ARTS::AgendaMethod::batch_atm_fields_compactCleanup ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  threshold 
)
inline

Removes unrealistically small or erroneous data from each data field of batch_atm_fields_compact (or other AerrayOfGriddedField4 data)

This WSM checks if the data in batch_atm_fields_compact contains values smaller than the given threshold. In this case, these values will be set to zero.

The method should be applied if batch_atm_fields_compact contains unrealistically small or erroneous data (NWP/GCM model data occassionally contains negative values, which are numerical artefacts rather than physical values.)

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]threshold- Threshold below which atm_fields_compact values are set to zero.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76658 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ batch_atm_fields_compactFromArrayOfMatrix()

MRecord ARTS::AgendaMethod::batch_atm_fields_compactFromArrayOfMatrix ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  atmospheres_fields,
const Var::ArrayOfString  field_names 
)
inline

Expand batch of 1D atmospheric state matrices to batch_atm_fields_compact.

This is used to handle 1D batch cases, e.g. from NWP/GCM model like the Chevallier91L data set, stored in a matrix (it is preferred, though, to immediatedly store the model fields as ArrayOfGriddedField4* and use ReadXML to load them directly into batch_atm_fields_compact*).

Works only for atmosphere_dim==1.

See atm_fields_compactFromMatrix for basic documentation.

See batch_atm_fields_compactAddConstant and batch_atm_fields_compactAddSpecies* for adding additional fields.

Author
Stefan Buehler
Daniel Kreyling
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]atmospheres_fields- Batch of atmospheres stored in one array of matrix
[in]field_names- Order/names of atmospheric fields.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76701 of file autoarts.h.

References ARTS::Var::ArrayOfMatrix::islast(), ARTS::Var::ArrayOfString::islast(), ARTS::Var::ArrayOfMatrix::pos(), and ARTS::Var::ArrayOfString::pos().

◆ CIAInfo()

MRecord ARTS::AgendaMethod::CIAInfo ( [[maybe_unused] ] Workspace ws,
const Var::String  catalogpath,
const Var::ArrayOfString  cia_tags 
)
inline

Display information about the given CIA tags. The CIA tags shown are in the same format as needed by abs_speciesSet.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]catalogpath- Path to the CIA catalog directory.
[in]cia_tags- Array of CIA tags to view, e.g. [ "N2-N2", "H2-H2" ]

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76733 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), ARTS::Var::String::islast(), ARTS::Var::ArrayOfString::pos(), and ARTS::Var::String::pos().

◆ CIARecordReadFromFile()

MRecord ARTS::AgendaMethod::CIARecordReadFromFile ( [[maybe_unused] ] Workspace ws,
Var::CIARecord  cia_record,
const Var::String  species_tag,
const Var::String  filename 
)
inline

Reads CIARecord from Hitran-style file.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]cia_record- CIARecord type variable for input and output.
[in]species_tag- SpeciesTag string to associate with this CIARecord. See abs_speciesSet for correct format.
[in]filename- Filename of HITRAN CIA data file.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76765 of file autoarts.h.

References ARTS::Var::CIARecord::islast(), ARTS::Var::String::islast(), ARTS::Var::CIARecord::pos(), and ARTS::Var::String::pos().

◆ cloudbox_checkedCalc()

MRecord ARTS::AgendaMethod::cloudbox_checkedCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index negative_pnd_ok = {} 
)
inline

Checks consistency and validity of the cloudbox governing variables.

The following WSVs are treated: cloudbox_on, cloudbox_limits, pnd_field*, scat_data, scat_species, abs_species, particle_masses particle_bulkprop_field*, particle_bulkprop_names and wind_u/v/w_field.

If any of these variables is changed, then this method shall be called again (no automatic check that this is fulfilled!).

The main checks are if the cloudbox limits are OK with respect to the atmospheric dimensionality and the limits of the atmosphere, and that the scattering element variables pnd_field and scat_data* match in size.

Further checks on scat_data are performed in scat_data_checkedCalc

scat_species* and particle_masses must either be empty or have a size that matches the other data. If non-empty, some check of these variables are performed.

If any test fails, there is an error. Otherwise, cloudbox_checked is set to 1.

Author
Patrick Eriksson, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]negative_pnd_ok- Flag whether to accept pnd_field < 0. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77054 of file autoarts.h.

◆ cloudbox_field_monoIterate()

MRecord ARTS::AgendaMethod::cloudbox_field_monoIterate ( [[maybe_unused] ] Workspace ws,
const Var::Index accelerated = {} 
)
inline

Iterative solution of the VRTE (DOIT method).

A solution for the RTE with scattering is found using the DOIT method:

  1. Calculate scattering integral using doit_scat_field_agenda.
  2. Calculate RT with fixed scattered field using doit_rte_agenda*.
  3. Convergence test using doit_conv_test_agenda.

Note: The atmospheric dimensionality atmosphere_dim can be either 1 or 3. To these dimensions the method adapts automatically. 2D scattering calculations are not supported.

Author
Claudia Emde, Jakob Doerr
Parameters
[in,out]Workspacews - An ARTS workspace
[in]accelerated- Index wether to accelerate only the intensity (1) or the whole Stokes Vector (4) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77096 of file autoarts.h.

◆ cloudbox_field_monoOptimizeReverse()

MRecord ARTS::AgendaMethod::cloudbox_field_monoOptimizeReverse ( [[maybe_unused] ] Workspace ws)
inline

Interpolate cloudbox_field_mono back to the original p_grid. For detailed description, see OptimizeDoitPressureGrid.

Author
Jakob Doerr
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77514 of file autoarts.h.

◆ cloudbox_field_monoSetConst()

MRecord ARTS::AgendaMethod::cloudbox_field_monoSetConst ( [[maybe_unused] ] Workspace ws,
const Var::Vector  value 
)
inline

This method sets the initial field inside the cloudbox to a constant value. The method works only for monochromatic calculations (number of elements in f_grid=1).

The user can specify a value for each Stokes dimension in the control file by value.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- A vector containing 4 elements with the value of the initial field for each Stokes dimension.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77287 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ cloudbox_fieldCrop()

MRecord ARTS::AgendaMethod::cloudbox_fieldCrop ( [[maybe_unused] ] Workspace ws,
const Var::Index new_limit0 = {},
const Var::Index new_limit1 = {},
const Var::Index new_limit2 = {},
const Var::Index new_limit3 = {},
const Var::Index new_limit4 = {},
const Var::Index new_limit5 = {} 
)
inline

Extracts a part of an existing cloudbox_field.

The cropping is defined by defining new cloudbox limits. Note that new_limit0* is an index with respect to p_grid, etc.

The following must be valid: new_limit0 >= cloudbox_limits[0] new_limit1 <= cloudbox_limits[1] new_limit2 >= cloudbox_limits[2] new_limit3 <= cloudbox_limits[3] new_limit4 >= cloudbox_limits[4] new_limit5 <= cloudbox_limits[5]

Indexes for dimensions not used are ignored.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]new_limit0- New value for cloudbox_limits[0]. (default: 0)
[in]new_limit1- New value for cloudbox_limits[1]. (default: 0)
[in]new_limit2- New value for cloudbox_limits[2]. (default: 0)
[in]new_limit3- New value for cloudbox_limits[3]. (default: 0)
[in]new_limit4- New value for cloudbox_limits[4]. (default: 0)
[in]new_limit5- New value for cloudbox_limits[5]. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77144 of file autoarts.h.

◆ cloudbox_fieldSetClearsky()

MRecord ARTS::AgendaMethod::cloudbox_fieldSetClearsky ( [[maybe_unused] ] Workspace ws,
const Var::Index all_frequencies = {} 
)
inline

Interpolate clearsky field on all gridpoints in cloudbox.

This method uses a linear 1D/3D interpolation scheme to obtain the radiation field on all grid points inside the cloud box from the clear sky field on the cloudbox boundary. This radiation field is taken as the first guess radiation field in the DOIT module.

Set the all_frequencies to 1 if the clearsky field shall be used as initial field for all frequencies. Set it to 0 if the clear sky field shall be used only for the first frequency in f_grid. For later frequencies, cloudbox_field of the previous frequency is then used.

Author
Sreerekha T.R. and Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]all_frequencies- See above. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77252 of file autoarts.h.

◆ cloudbox_fieldSetConst()

MRecord ARTS::AgendaMethod::cloudbox_fieldSetConst ( [[maybe_unused] ] Workspace ws,
const Var::Vector  value 
)
inline

This method sets the initial field inside the cloudbox to a constant value.

The user has to specify a value for each Stokes dimension in the control file by value.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- A vector containing stokes_dim elements with the value of the initial field for each Stokes dimension.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77318 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ cloudbox_fieldSetConstPerFreq()

MRecord ARTS::AgendaMethod::cloudbox_fieldSetConstPerFreq ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  value 
)
inline

This method sets the initial field inside the cloudbox to a constant value per frequency slice.

The user has specify a value for each frequency and Stokes dimension in the control file by value.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]value- A matrix containing stokes_dim elements per frequency (row) with the value of the initial field for each frequency and Stokes dimension.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77349 of file autoarts.h.

References ARTS::Var::Matrix::islast(), and ARTS::Var::Matrix::pos().

◆ cloudbox_fieldSetFromPrecalc()

MRecord ARTS::AgendaMethod::cloudbox_fieldSetFromPrecalc ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  cloudbox_field_precalc 
)
inline

Sets the initial cloudbox intensity field cloudbox_field from a precalculated field.

This method sets the (monochromatic) first guess radiation field inside the cloudbox from a precalculated cloudbox_field_precalc, e.g., from the solution of a similar atmospheric scenario. The dimensions of cloudbox_field_precalc have to be consistent with the DOIT setup in terms of frequencies, pressure levels inside the cloudbox, polar angles used as well as the stokes dimension. Incoming field on the cloudbox boundaries is adapted to the actual clearsky incoming field as, e.g., calculated by DoitGetIncoming.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]cloudbox_field_precalc- Precalculated radiation field (of type cloudbox_field)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77214 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ cloudbox_fieldUpdate1D()

MRecord ARTS::AgendaMethod::cloudbox_fieldUpdate1D ( [[maybe_unused] ] Workspace ws)
inline

RT calculation in cloudbox with fixed scattering integral (1D).

Updates the radiation field (DOIT method). The method loops through the cloudbox to update the radiation field for all positions and directions in the 1D cloudbox.

Note: This method is very inefficient, because the number of iterations scales with the number of cloudbox pressure levels. It is recommended to use cloudbox_fieldUpdateSeq1D.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77383 of file autoarts.h.

◆ cloudbox_fieldUpdateSeq1D()

MRecord ARTS::AgendaMethod::cloudbox_fieldUpdateSeq1D ( [[maybe_unused] ] Workspace ws,
const Var::Index normalize = {},
const Var::Numeric norm_error_threshold = {},
const Var::Index norm_debug = {} 
)
inline

RT calculation in cloudbox with fixed scattering integral.

Updates radiation field (cloudbox_field) in DOIT module. This method loops through the cloudbox to update the radiation field for all positions and directions in the 1D cloudbox. The method applies the sequential update. For more information refer to AUG.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]normalize- Apply normalization to scattered field. (default: 1)
[in]norm_error_threshold- Error threshold for scattered field correction factor. (default: 1.0)
[in]norm_debug- Debugging flag. Set to 1 to output normalization factor to out0. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77413 of file autoarts.h.

◆ cloudbox_fieldUpdateSeq1DPP()

MRecord ARTS::AgendaMethod::cloudbox_fieldUpdateSeq1DPP ( [[maybe_unused] ] Workspace ws)
inline

RT calculation in cloudbox with fixed scattering integral.

Update radiation field (cloudbox_field) in DOIT module. This method loops through the cloudbox to update the radiation field for all positions and directions in the 1D cloudbox. The method applies the sequential update and the plane parallel approximation. This method is only slightly faster than cloudbox_fieldUpdateSeq1D* and it is less accurate. It can not be used for limb simulations.

Author
Sreerekha T.R.
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77463 of file autoarts.h.

◆ cloudbox_fieldUpdateSeq3D()

MRecord ARTS::AgendaMethod::cloudbox_fieldUpdateSeq3D ( [[maybe_unused] ] Workspace ws)
inline

RT calculation in cloudbox with fixed scattering integral.

Update radiation field (cloudbox_field) in DOIT module. This method loops through the cloudbox to update the radiation field for all positions and directions in the 3D cloudbox. The method applies the sequential update. For more information please refer to AUG. Surface reflections are not yet implemented in 3D scattering calculations.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77492 of file autoarts.h.

◆ cloudboxOff()

MRecord ARTS::AgendaMethod::cloudboxOff ( [[maybe_unused] ] Workspace ws)
inline

Deactivates the cloud box.

Use this method if no scattering calculations shall be performed.

The function sets cloudbox_on to 0, cloudbox_limits, pnd_field*, scat_data, scat_data_raw, iy_cloudbox_agenda and particle_masses to be empty and sizes dpnd_field_dx to be consitent with jacobian_quantities.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76804 of file autoarts.h.

◆ cloudboxSetAutomatically()

MRecord ARTS::AgendaMethod::cloudboxSetAutomatically ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  particle_field,
const Var::ArrayOfIndex cloudbox_limits_old = {},
const Var::Numeric cloudbox_margin = {} 
)
inline

Sets the cloud box to encompass the cloud given by the entries in particle_field.

This WSM handles one Tensor4 type particle_field at a time. It can be used to determine the cloudbox from particle_bulkprop_field

The function must be called before executing any WSM that applies cloudbox_limits*.

The function iterates over all 3D fields in particle_field (which might correspond to different particle bulk properties as in particle_bulkprop_field*). Each field is searched for the first and last pressure index, where the value is unequal to zero. This index is then copied to cloudbox_limits. If particle_field is empty, the cloudbox is switched off (cloudbox_on=0).

Additionaly the lower cloudbox_limit is altered by cloudbox_margin. The margin is given as a height difference in meters and transformed into a pressure (via isothermal barometric height formula). This alteration is to ensure covering photons that leave the cloud, but reenter through a limb path. If cloudbox_margin is set to -1 (default), the cloudbox will extend to the surface. Hence, the lower cloudbox_limit is set to 0 (index of first pressure level). cloudbox_margin* will be applied on each call of the WSM.

Works only for atmosphere_dim==1.

Author
Jana Mendrok, Daniel Kreyling
Parameters
[in,out]Workspacews - An ARTS workspace
[in]particle_field- A collection of particle property fields (e.g. particle_bulkprop_field).
[in]cloudbox_limits_old- Preset cloudbox limits, e.g. resulting from a previous run of cloudboxSetAutomatically. (default: {-1})
[in]cloudbox_margin- Minimum distance [m] between lowest 'cloudy' level and cloudbox lower limit. If set to -1 (default), the cloudbox lower limit is fixed to 0, i.e., corresponds to the lowest atmospheric level (or the surface). (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76855 of file autoarts.h.

◆ cloudboxSetFullAtm()

MRecord ARTS::AgendaMethod::cloudboxSetFullAtm ( [[maybe_unused] ] Workspace ws)
inline

Sets the cloudbox to cover the full atmosphere.

Author
Claudia Emde, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76893 of file autoarts.h.

◆ cloudboxSetManually()

MRecord ARTS::AgendaMethod::cloudboxSetManually ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  p1,
const Var::Numeric  p2,
const Var::Numeric  lat1,
const Var::Numeric  lat2,
const Var::Numeric  lon1,
const Var::Numeric  lon2 
)
inline

Sets the cloud box to encompass the given positions.

The function sets cloudbox_on to 1 and sets cloudbox_limits following the given pressure, latitude and longitude positions. The index limits in cloudbox_limits are selected to give the smallest possible cloud box that encompass the given points.

The points must be given in the same order as used in cloudbox_limits*. That means that the first keyword argument shall be a higher pressure than argument two, while the latitude and longitude points are given in increasing order. Positions given for dimensions not used by the selected atmospheric dimensionality are ignored.

The given pressure points can be outside the range of p_grid. The pressure limit is then set to the end point of p_grid. The given latitude and longitude points must be inside the range of the corresponding grid. In addition, the latitude and longitude points cannot be inside the outermost grid ranges as the latitude and longitude limits in cloudbox_limits are not allowed to be grid end points.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]p1- Upper pressure point.
[in]p2- Lower pressure point.
[in]lat1- Lower latitude point.
[in]lat2- Upper latitude point.
[in]lon1- Lower longitude point.
[in]lon2- Upper longitude point.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76940 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ cloudboxSetManuallyAltitude()

MRecord ARTS::AgendaMethod::cloudboxSetManuallyAltitude ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  z1,
const Var::Numeric  z2,
const Var::Numeric  lat1,
const Var::Numeric  lat2,
const Var::Numeric  lon1,
const Var::Numeric  lon2 
)
inline

Sets the cloud box to encompass the given positions.

As cloudboxSetManually but uses altitudes instead of pressure. The given altitude points can be outside the range of z_field. The altitude limit is then set to the end point of p_grid.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]z1- Lower altitude point.
[in]z2- Upper altitude point.
[in]lat1- Lower latitude point.
[in]lat2- Upper latitude point.
[in]lon1- Lower longitude point.
[in]lon2- Upper longitude point.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 76991 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ collision_coefficientsFromSplitFiles()

MRecord ARTS::AgendaMethod::collision_coefficientsFromSplitFiles ( [[maybe_unused] ] Workspace ws,
const Var::String basename = {} 
)
inline

Reads collision_coefficients and collision_line_identifiers from location on filesystem with many species. The species in this location must match abs_species. The location must also contain an ArrayOfQuantumIdentifier file ending with qid.xml

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- path to files to read (default: "./")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101245 of file autoarts.h.

◆ Compare() [1/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  var1,
const Var::ArrayOfMatrix  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77962 of file autoarts.h.

◆ Compare() [2/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor7  var1,
const Var::ArrayOfTensor7  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78014 of file autoarts.h.

◆ Compare() [3/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfVector  var1,
const Var::ArrayOfVector  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77910 of file autoarts.h.

◆ Compare() [4/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField3  var1,
const Var::GriddedField3  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78066 of file autoarts.h.

◆ Compare() [5/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  var1,
const Var::Matrix  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77650 of file autoarts.h.

◆ Compare() [6/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  var1,
const Var::Numeric  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77546 of file autoarts.h.

◆ Compare() [7/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::SingleScatteringData  var1,
const Var::SingleScatteringData  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78170 of file autoarts.h.

◆ Compare() [8/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  var1,
const Var::Sparse  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78118 of file autoarts.h.

◆ Compare() [9/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  var1,
const Var::Tensor3  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77702 of file autoarts.h.

◆ Compare() [10/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  var1,
const Var::Tensor4  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77754 of file autoarts.h.

◆ Compare() [11/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  var1,
const Var::Tensor5  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77806 of file autoarts.h.

◆ Compare() [12/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  var1,
const Var::Tensor7  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77858 of file autoarts.h.

◆ Compare() [13/13]

MRecord ARTS::AgendaMethod::Compare ( [[maybe_unused] ] Workspace ws,
const Var::Vector  var1,
const Var::Vector  var2,
const Var::Numeric maxabsdiff = {},
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables.

The two variables are checked to not deviate outside the specified value (maxabsdiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsdiff- Threshold for maximum absolute difference. (default: {})
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 77598 of file autoarts.h.

◆ CompareRelative() [1/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfMatrix  var1,
const Var::ArrayOfArrayOfMatrix  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79117 of file autoarts.h.

◆ CompareRelative() [2/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfPropagationMatrix  var1,
const Var::ArrayOfArrayOfPropagationMatrix  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79353 of file autoarts.h.

◆ CompareRelative() [3/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfStokesVector  var1,
const Var::ArrayOfArrayOfStokesVector  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79471 of file autoarts.h.

◆ CompareRelative() [4/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor3  var1,
const Var::ArrayOfArrayOfTensor3  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79176 of file autoarts.h.

◆ CompareRelative() [5/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor6  var1,
const Var::ArrayOfArrayOfTensor6  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79235 of file autoarts.h.

◆ CompareRelative() [6/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfVector  var1,
const Var::ArrayOfArrayOfVector  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79058 of file autoarts.h.

◆ CompareRelative() [7/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  var1,
const Var::ArrayOfMatrix  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78763 of file autoarts.h.

◆ CompareRelative() [8/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPropagationMatrix  var1,
const Var::ArrayOfPropagationMatrix  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79294 of file autoarts.h.

◆ CompareRelative() [9/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfStokesVector  var1,
const Var::ArrayOfStokesVector  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79412 of file autoarts.h.

◆ CompareRelative() [10/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor3  var1,
const Var::ArrayOfTensor3  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78822 of file autoarts.h.

◆ CompareRelative() [11/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor4  var1,
const Var::ArrayOfTensor4  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78881 of file autoarts.h.

◆ CompareRelative() [12/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor6  var1,
const Var::ArrayOfTensor6  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78940 of file autoarts.h.

◆ CompareRelative() [13/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor7  var1,
const Var::ArrayOfTensor7  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78999 of file autoarts.h.

◆ CompareRelative() [14/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfVector  var1,
const Var::ArrayOfVector  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78704 of file autoarts.h.

◆ CompareRelative() [15/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::EnergyLevelMap  var1,
const Var::EnergyLevelMap  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79530 of file autoarts.h.

◆ CompareRelative() [16/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  var1,
const Var::Matrix  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78350 of file autoarts.h.

◆ CompareRelative() [17/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  var1,
const Var::Numeric  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78232 of file autoarts.h.

◆ CompareRelative() [18/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  var1,
const Var::Tensor3  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78409 of file autoarts.h.

◆ CompareRelative() [19/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  var1,
const Var::Tensor4  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78468 of file autoarts.h.

◆ CompareRelative() [20/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  var1,
const Var::Tensor5  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78527 of file autoarts.h.

◆ CompareRelative() [21/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  var1,
const Var::Tensor6  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78586 of file autoarts.h.

◆ CompareRelative() [22/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  var1,
const Var::Tensor7  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78645 of file autoarts.h.

◆ CompareRelative() [23/23]

MRecord ARTS::AgendaMethod::CompareRelative ( [[maybe_unused] ] Workspace ws,
const Var::Vector  var1,
const Var::Vector  var2,
const Var::Numeric  maxabsreldiff,
const Var::String error_message = {} 
)
inline

Checks the consistency between two variables by their relative values.

The two variables are checked to not deviate outside the specified relative value (maxabsreldiff). An error is issued if this is not fulfilled.

The main application of this method is to be part of the test control files, and then used to check that a calculated value is consistent with an old, reference, value.

If either value is 0.0, the relative error is considered as 0 for easier use. This really means infinite differences, though allowing zero-crossings is useful for plenty of tests. So Be Aware!

If both var1 and var2 are non-zero, the difference is evaluated as: abs(var1/var2-1) That is, var2 is taken as the reference value.

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]var1- A first variable
[in]var2- A second variable
[in]maxabsreldiff- Threshold for maximum relative difference.
[in]error_message- Additional error message. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 78291 of file autoarts.h.

◆ complex_refr_indexConstant()

MRecord ARTS::AgendaMethod::complex_refr_indexConstant ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  refr_index_real,
const Var::Numeric  refr_index_imag 
)
inline

Set complex refractive index to a constant value.

Frequency and temperature grids are set to have length 1 (and set to the value 0).

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]refr_index_real- Real part of refractive index
[in]refr_index_imag- Imag part of refractive index

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79573 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ complex_refr_indexIceMatzler06()

MRecord ARTS::AgendaMethod::complex_refr_indexIceMatzler06 ( [[maybe_unused] ] Workspace ws,
const Var::Vector  data_f_grid,
const Var::Vector  data_T_grid 
)
inline

Refractive index of ice following Matzler06 parameterization.

Calculates temperature dependent complex refractive index of hexagonal ice at microwave and sub-mm frequencies (10MHz-3Tz).

This parametrization is also applied by the microwave and submm-wave part of the Warren08 model.

References: Matzler, C., 2006: Thermal Microwave Radiation: Application for Remote Sensing, Microwave dielectric properties of ice, pp. 455-462, Inst. Eng. Technol., Stevenage, U. K. Warren, S. G., and R. E. Brandt, 2008: Optical constants of ice from the ultraviolet to the microwave: A revised compilation, J. Geophys. Res., 113, D14220, doi:10.1029/2007JD009744.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]data_f_grid- Frequency grid for refractive index calculation
[in]data_T_grid- Temperature grid for refractive index calculation

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79618 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ complex_refr_indexIceWarren84()

MRecord ARTS::AgendaMethod::complex_refr_indexIceWarren84 ( [[maybe_unused] ] Workspace ws,
const Var::Vector  data_f_grid,
const Var::Vector  data_T_grid 
)
inline

Refractive index of ice following Warren84 parameterization.

Calculates complex refractive index of Ice 1H for wavelengths between 45 nm and 8.6 m. For wavelengths above 167 microns, temperature dependence is included for temperatures between 213 and 272K. Mainly intended for applications in Earth ice clouds and snow, not other planets or interstellar space; the temperature dependence or crystalline form of ice may be incorrect for these latter applications.

Authors of Fortran function: Stephen Warren, Univ. of Washington (1983) Bo-Cai Gao, JCESS, Univ. of Maryland (1995) Warren Wiscombe, NASA Goddard (1995)

References: Warren, S., 1984: Optical Constants of Ice from the Ultraviolet to the Microwave, Appl. Opt. 23, 1206-1225

Kou, L., D. Labrie, and P. Chylek, 1994: Refractive indices of water and ice in the 0.65- to 2.5-micron spectral range, Appl. Opt. 32, 3531-3540

Perovich, D., and J. Govoni, 1991: Absorption Coefficients of Ice from 250 to 400 nm, Geophys. Res. Lett. 18, 1233-1235

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]data_f_grid- Frequency grid for refractive index calculation
[in]data_T_grid- Temperature grid for refractive index calculation

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79674 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ complex_refr_indexWaterLiebe93()

MRecord ARTS::AgendaMethod::complex_refr_indexWaterLiebe93 ( [[maybe_unused] ] Workspace ws,
const Var::Vector  data_f_grid,
const Var::Vector  data_T_grid 
)
inline

Complex refractive index of liquid water according to Liebe 1993.

The method treats liquid water without salt. Thus, not valid below 10 GHz. Upper frequency limit not known, here set to 1000 GHz. Model parameters taken from Atmlab function epswater93 (by C. Maetzler), which refer to Liebe 1993 without closer specifications.

Temperatures must be between -40 and 100 degrees Celsius. The accuracy of the parametrization below 0 C is not known by us.

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]data_f_grid- Frequency grid for refractive index calculation
[in]data_T_grid- Temperature grid for refractive index calculation

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79715 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ Copy() [1/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::AbsorptionLines  out,
const Var::AbsorptionLines  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79760 of file autoarts.h.

References ARTS::Var::AbsorptionLines::islast(), and ARTS::Var::AbsorptionLines::pos().

◆ Copy() [2/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Agenda  out,
const Var::Agenda  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79805 of file autoarts.h.

References ARTS::Var::Agenda::islast(), and ARTS::Var::Agenda::pos().

◆ Copy() [3/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAbsorptionLines  out,
const Var::ArrayOfAbsorptionLines  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79850 of file autoarts.h.

References ARTS::Var::ArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfAbsorptionLines::pos().

◆ Copy() [4/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAgenda  out,
const Var::ArrayOfAgenda  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79940 of file autoarts.h.

References ARTS::Var::ArrayOfAgenda::islast(), and ARTS::Var::ArrayOfAgenda::pos().

◆ Copy() [5/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfAbsorptionLines  out,
const Var::ArrayOfArrayOfAbsorptionLines  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79895 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfArrayOfAbsorptionLines::pos().

◆ Copy() [6/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField1  out,
const Var::ArrayOfArrayOfGriddedField1  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 79985 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField1::pos().

◆ Copy() [7/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField2  out,
const Var::ArrayOfArrayOfGriddedField2  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80030 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField2::pos().

◆ Copy() [8/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField3  out,
const Var::ArrayOfArrayOfGriddedField3  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80075 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField3::pos().

◆ Copy() [9/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfIndex  out,
const Var::ArrayOfArrayOfIndex  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80120 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfIndex::islast(), and ARTS::Var::ArrayOfArrayOfIndex::pos().

◆ Copy() [10/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfMatrix  out,
const Var::ArrayOfArrayOfMatrix  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80165 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfMatrix::islast(), and ARTS::Var::ArrayOfArrayOfMatrix::pos().

◆ Copy() [11/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfPropagationMatrix  out,
const Var::ArrayOfArrayOfPropagationMatrix  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80255 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfArrayOfPropagationMatrix::pos().

◆ Copy() [12/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfRadiationVector  out,
const Var::ArrayOfArrayOfRadiationVector  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80300 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfArrayOfRadiationVector::pos().

◆ Copy() [13/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfScatteringMetaData  out,
const Var::ArrayOfArrayOfScatteringMetaData  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80345 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfArrayOfScatteringMetaData::pos().

◆ Copy() [14/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSingleScatteringData  out,
const Var::ArrayOfArrayOfSingleScatteringData  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80390 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfArrayOfSingleScatteringData::pos().

◆ Copy() [15/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSpeciesTag  out,
const Var::ArrayOfArrayOfSpeciesTag  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80435 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSpeciesTag::islast(), and ARTS::Var::ArrayOfArrayOfSpeciesTag::pos().

◆ Copy() [16/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfStokesVector  out,
const Var::ArrayOfArrayOfStokesVector  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80480 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfArrayOfStokesVector::pos().

◆ Copy() [17/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfString  out,
const Var::ArrayOfArrayOfString  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80525 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfString::islast(), and ARTS::Var::ArrayOfArrayOfString::pos().

◆ Copy() [18/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor3  out,
const Var::ArrayOfArrayOfTensor3  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80570 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor3::islast(), and ARTS::Var::ArrayOfArrayOfTensor3::pos().

◆ Copy() [19/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor6  out,
const Var::ArrayOfArrayOfTensor6  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80615 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor6::islast(), and ARTS::Var::ArrayOfArrayOfTensor6::pos().

◆ Copy() [20/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTime  out,
const Var::ArrayOfArrayOfTime  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80660 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTime::islast(), and ARTS::Var::ArrayOfArrayOfTime::pos().

◆ Copy() [21/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTransmissionMatrix  out,
const Var::ArrayOfArrayOfTransmissionMatrix  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80705 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfArrayOfTransmissionMatrix::pos().

◆ Copy() [22/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfVector  out,
const Var::ArrayOfArrayOfVector  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80750 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfVector::islast(), and ARTS::Var::ArrayOfArrayOfVector::pos().

◆ Copy() [23/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfCIARecord  out,
const Var::ArrayOfCIARecord  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80795 of file autoarts.h.

References ARTS::Var::ArrayOfCIARecord::islast(), and ARTS::Var::ArrayOfCIARecord::pos().

◆ Copy() [24/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField1  out,
const Var::ArrayOfGriddedField1  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80840 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfGriddedField1::pos().

◆ Copy() [25/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField2  out,
const Var::ArrayOfGriddedField2  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80885 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfGriddedField2::pos().

◆ Copy() [26/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField3  out,
const Var::ArrayOfGriddedField3  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80930 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfGriddedField3::pos().

◆ Copy() [27/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField4  out,
const Var::ArrayOfGriddedField4  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80975 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField4::islast(), and ARTS::Var::ArrayOfGriddedField4::pos().

◆ Copy() [28/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfIndex  out,
const Var::ArrayOfIndex  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81020 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), and ARTS::Var::ArrayOfIndex::pos().

◆ Copy() [29/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfMatrix  out,
const Var::ArrayOfMatrix  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81065 of file autoarts.h.

References ARTS::Var::ArrayOfMatrix::islast(), and ARTS::Var::ArrayOfMatrix::pos().

◆ Copy() [30/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPpath  out,
const Var::ArrayOfPpath  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 80210 of file autoarts.h.

References ARTS::Var::ArrayOfPpath::islast(), and ARTS::Var::ArrayOfPpath::pos().

◆ Copy() [31/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPropagationMatrix  out,
const Var::ArrayOfPropagationMatrix  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81110 of file autoarts.h.

References ARTS::Var::ArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfPropagationMatrix::pos().

◆ Copy() [32/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfQuantumIdentifier  out,
const Var::ArrayOfQuantumIdentifier  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81155 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), and ARTS::Var::ArrayOfQuantumIdentifier::pos().

◆ Copy() [33/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRadiationVector  out,
const Var::ArrayOfRadiationVector  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81200 of file autoarts.h.

References ARTS::Var::ArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfRadiationVector::pos().

◆ Copy() [34/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRetrievalQuantity  out,
const Var::ArrayOfRetrievalQuantity  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81245 of file autoarts.h.

References ARTS::Var::ArrayOfRetrievalQuantity::islast(), and ARTS::Var::ArrayOfRetrievalQuantity::pos().

◆ Copy() [35/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfScatteringMetaData  out,
const Var::ArrayOfScatteringMetaData  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81290 of file autoarts.h.

References ARTS::Var::ArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfScatteringMetaData::pos().

◆ Copy() [36/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSingleScatteringData  out,
const Var::ArrayOfSingleScatteringData  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81335 of file autoarts.h.

References ARTS::Var::ArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfSingleScatteringData::pos().

◆ Copy() [37/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSparse  out,
const Var::ArrayOfSparse  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81380 of file autoarts.h.

References ARTS::Var::ArrayOfSparse::islast(), and ARTS::Var::ArrayOfSparse::pos().

◆ Copy() [38/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfStokesVector  out,
const Var::ArrayOfStokesVector  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81425 of file autoarts.h.

References ARTS::Var::ArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfStokesVector::pos().

◆ Copy() [39/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  out,
const Var::ArrayOfString  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81470 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), and ARTS::Var::ArrayOfString::pos().

◆ Copy() [40/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTelsemAtlas  out,
const Var::ArrayOfTelsemAtlas  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81515 of file autoarts.h.

References ARTS::Var::ArrayOfTelsemAtlas::islast(), and ARTS::Var::ArrayOfTelsemAtlas::pos().

◆ Copy() [41/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor3  out,
const Var::ArrayOfTensor3  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81560 of file autoarts.h.

References ARTS::Var::ArrayOfTensor3::islast(), and ARTS::Var::ArrayOfTensor3::pos().

◆ Copy() [42/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor4  out,
const Var::ArrayOfTensor4  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81605 of file autoarts.h.

References ARTS::Var::ArrayOfTensor4::islast(), and ARTS::Var::ArrayOfTensor4::pos().

◆ Copy() [43/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor5  out,
const Var::ArrayOfTensor5  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81650 of file autoarts.h.

References ARTS::Var::ArrayOfTensor5::islast(), and ARTS::Var::ArrayOfTensor5::pos().

◆ Copy() [44/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor6  out,
const Var::ArrayOfTensor6  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81695 of file autoarts.h.

References ARTS::Var::ArrayOfTensor6::islast(), and ARTS::Var::ArrayOfTensor6::pos().

◆ Copy() [45/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor7  out,
const Var::ArrayOfTensor7  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81740 of file autoarts.h.

References ARTS::Var::ArrayOfTensor7::islast(), and ARTS::Var::ArrayOfTensor7::pos().

◆ Copy() [46/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTime  out,
const Var::ArrayOfTime  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81785 of file autoarts.h.

References ARTS::Var::ArrayOfTime::islast(), and ARTS::Var::ArrayOfTime::pos().

◆ Copy() [47/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTransmissionMatrix  out,
const Var::ArrayOfTransmissionMatrix  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81830 of file autoarts.h.

References ARTS::Var::ArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfTransmissionMatrix::pos().

◆ Copy() [48/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfVector  out,
const Var::ArrayOfVector  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81875 of file autoarts.h.

References ARTS::Var::ArrayOfVector::islast(), and ARTS::Var::ArrayOfVector::pos().

◆ Copy() [49/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfXsecRecord  out,
const Var::ArrayOfXsecRecord  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81920 of file autoarts.h.

References ARTS::Var::ArrayOfXsecRecord::islast(), and ARTS::Var::ArrayOfXsecRecord::pos().

◆ Copy() [50/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::CIARecord  out,
const Var::CIARecord  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 81965 of file autoarts.h.

References ARTS::Var::CIARecord::islast(), and ARTS::Var::CIARecord::pos().

◆ Copy() [51/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::CovarianceMatrix  out,
const Var::CovarianceMatrix  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82010 of file autoarts.h.

References ARTS::Var::CovarianceMatrix::islast(), and ARTS::Var::CovarianceMatrix::pos().

◆ Copy() [52/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::EnergyLevelMap  out,
const Var::EnergyLevelMap  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82055 of file autoarts.h.

References ARTS::Var::EnergyLevelMap::islast(), and ARTS::Var::EnergyLevelMap::pos().

◆ Copy() [53/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::GasAbsLookup  out,
const Var::GasAbsLookup  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82100 of file autoarts.h.

References ARTS::Var::GasAbsLookup::islast(), and ARTS::Var::GasAbsLookup::pos().

◆ Copy() [54/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::GriddedField1  out,
const Var::GriddedField1  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82190 of file autoarts.h.

References ARTS::Var::GriddedField1::islast(), and ARTS::Var::GriddedField1::pos().

◆ Copy() [55/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::GriddedField2  out,
const Var::GriddedField2  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82235 of file autoarts.h.

References ARTS::Var::GriddedField2::islast(), and ARTS::Var::GriddedField2::pos().

◆ Copy() [56/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::GriddedField3  out,
const Var::GriddedField3  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82280 of file autoarts.h.

References ARTS::Var::GriddedField3::islast(), and ARTS::Var::GriddedField3::pos().

◆ Copy() [57/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::GriddedField4  out,
const Var::GriddedField4  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82325 of file autoarts.h.

References ARTS::Var::GriddedField4::islast(), and ARTS::Var::GriddedField4::pos().

◆ Copy() [58/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::GriddedField5  out,
const Var::GriddedField5  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82370 of file autoarts.h.

References ARTS::Var::GriddedField5::islast(), and ARTS::Var::GriddedField5::pos().

◆ Copy() [59/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::GriddedField6  out,
const Var::GriddedField6  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82415 of file autoarts.h.

References ARTS::Var::GriddedField6::islast(), and ARTS::Var::GriddedField6::pos().

◆ Copy() [60/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::GridPos  out,
const Var::GridPos  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82145 of file autoarts.h.

References ARTS::Var::GridPos::islast(), and ARTS::Var::GridPos::pos().

◆ Copy() [61/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::HitranRelaxationMatrixData  out,
const Var::HitranRelaxationMatrixData  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82460 of file autoarts.h.

References ARTS::Var::HitranRelaxationMatrixData::islast(), and ARTS::Var::HitranRelaxationMatrixData::pos().

◆ Copy() [62/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Index  out,
const Var::Index  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82505 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ Copy() [63/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Matrix  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82595 of file autoarts.h.

References ARTS::Var::Matrix::islast(), and ARTS::Var::Matrix::pos().

◆ Copy() [64/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::MCAntenna  out,
const Var::MCAntenna  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82550 of file autoarts.h.

References ARTS::Var::MCAntenna::islast(), and ARTS::Var::MCAntenna::pos().

◆ Copy() [65/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Numeric  out,
const Var::Numeric  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82640 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ Copy() [66/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Ppath  out,
const Var::Ppath  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82685 of file autoarts.h.

References ARTS::Var::Ppath::islast(), and ARTS::Var::Ppath::pos().

◆ Copy() [67/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::PropagationMatrix  out,
const Var::PropagationMatrix  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82730 of file autoarts.h.

References ARTS::Var::PropagationMatrix::islast(), and ARTS::Var::PropagationMatrix::pos().

◆ Copy() [68/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::QuantumIdentifier  out,
const Var::QuantumIdentifier  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82775 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ Copy() [69/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::RadiationVector  out,
const Var::RadiationVector  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82820 of file autoarts.h.

References ARTS::Var::RadiationVector::islast(), and ARTS::Var::RadiationVector::pos().

◆ Copy() [70/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Rational  out,
const Var::Rational  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82865 of file autoarts.h.

References ARTS::Var::Rational::islast(), and ARTS::Var::Rational::pos().

◆ Copy() [71/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::ScatteringMetaData  out,
const Var::ScatteringMetaData  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82910 of file autoarts.h.

References ARTS::Var::ScatteringMetaData::islast(), and ARTS::Var::ScatteringMetaData::pos().

◆ Copy() [72/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::SingleScatteringData  out,
const Var::SingleScatteringData  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 82955 of file autoarts.h.

References ARTS::Var::SingleScatteringData::islast(), and ARTS::Var::SingleScatteringData::pos().

◆ Copy() [73/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Sparse  out,
const Var::Sparse  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83000 of file autoarts.h.

References ARTS::Var::Sparse::islast(), and ARTS::Var::Sparse::pos().

◆ Copy() [74/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::SpeciesAuxData  out,
const Var::SpeciesAuxData  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83045 of file autoarts.h.

References ARTS::Var::SpeciesAuxData::islast(), and ARTS::Var::SpeciesAuxData::pos().

◆ Copy() [75/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::StokesVector  out,
const Var::StokesVector  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83090 of file autoarts.h.

References ARTS::Var::StokesVector::islast(), and ARTS::Var::StokesVector::pos().

◆ Copy() [76/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::String  out,
const Var::String  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83135 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ Copy() [77/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::TelsemAtlas  out,
const Var::TelsemAtlas  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83180 of file autoarts.h.

References ARTS::Var::TelsemAtlas::islast(), and ARTS::Var::TelsemAtlas::pos().

◆ Copy() [78/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::Tensor3  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83225 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), and ARTS::Var::Tensor3::pos().

◆ Copy() [79/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::Tensor4  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83270 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), and ARTS::Var::Tensor4::pos().

◆ Copy() [80/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Tensor5  out,
const Var::Tensor5  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83315 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), and ARTS::Var::Tensor5::pos().

◆ Copy() [81/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Tensor6  out,
const Var::Tensor6  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83360 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), and ARTS::Var::Tensor6::pos().

◆ Copy() [82/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Tensor7  out,
const Var::Tensor7  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83405 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ Copy() [83/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::TessemNN  out,
const Var::TessemNN  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83540 of file autoarts.h.

References ARTS::Var::TessemNN::islast(), and ARTS::Var::TessemNN::pos().

◆ Copy() [84/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Time  out,
const Var::Time  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83495 of file autoarts.h.

References ARTS::Var::Time::islast(), and ARTS::Var::Time::pos().

◆ Copy() [85/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Timer  out,
const Var::Timer  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83450 of file autoarts.h.

References ARTS::Var::Timer::islast(), and ARTS::Var::Timer::pos().

◆ Copy() [86/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::TransmissionMatrix  out,
const Var::TransmissionMatrix  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83585 of file autoarts.h.

References ARTS::Var::TransmissionMatrix::islast(), and ARTS::Var::TransmissionMatrix::pos().

◆ Copy() [87/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Vector  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83630 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ Copy() [88/88]

MRecord ARTS::AgendaMethod::Copy ( [[maybe_unused] ] Workspace ws,
Var::Verbosity  out,
const Var::Verbosity  in 
)
inline

Copy a workspace variable.

This method can copy any workspace variable to another workspace variable of the same group. (E.g., a Matrix to another Matrix.)

As always, output comes first in the argument list!

Usage example:

Copy(f_grid, p_grid)

Will copy the content of p_grid to f_grid. The size of f_grid is adjusted automatically (the normal behaviour for workspace methods).

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Destination variable.
[in]in- Source variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83675 of file autoarts.h.

References ARTS::Var::Verbosity::islast(), and ARTS::Var::Verbosity::pos().

◆ covmat1D() [1/2]

MRecord ARTS::AgendaMethod::covmat1D ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  grid_1,
const Var::Vector  sigma_1,
const Var::Vector  cls_1,
const Var::String  fname,
const Var::Vector grid_2 = {},
const Var::Vector sigma_2 = {},
const Var::Vector cls_2 = {},
const Var::Numeric co = {} 
)
inline

Create 1D covariance matrix.

Creates a 1D covariance matrix for two retrieval quantities on given grids from a given functional form. Elements of the covariance matrix are computed as S_{i,j} = sigma_i * sigma_j * f(d_{i,j} / l_{i,j}) where d_{i,j} is the distance between the two grid points and l_{i,j} the mean of the correlation lengths of the grid points.

If a cutoff value co is given elements with absolute value less than this are set to zero.

The following functional forms are available: "exp": f(x) = exp(-x) "lin": f(x) = 1.0 - x, for x > 1.0, 0.0 otherwise "gauss": f(x) = exp(-x^2)

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The matrix in which to store the covariance matrix.
[in]grid_1- The retrieval grid for the first retrieval quantity.
[in]grid_2- The retrieval grid for the second retrieval quantity. (If empty taken as grid_1) (default: {})
[in]sigma_1- The variances of the first retrieval quantity.
[in]sigma_2- The variances of the second retrieval quantity.(If empty taken as sigma_1) (default: {})
[in]cls_1- The correlations lengths of the first retrieval quantity.
[in]cls_2- The correlations lengths of the second retrieval quantity.(If empty taken as cls_1) (default: {})
[in]co- The cutoff value for covariance matrix elements. (default: 0.0)
[in]fname- The name of the functional form to use.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83728 of file autoarts.h.

◆ covmat1D() [2/2]

MRecord ARTS::AgendaMethod::covmat1D ( [[maybe_unused] ] Workspace ws,
Var::Sparse  out,
const Var::Vector  grid_1,
const Var::Vector  sigma_1,
const Var::Vector  cls_1,
const Var::String  fname,
const Var::Vector grid_2 = {},
const Var::Vector sigma_2 = {},
const Var::Vector cls_2 = {},
const Var::Numeric co = {} 
)
inline

Create 1D covariance matrix.

Creates a 1D covariance matrix for two retrieval quantities on given grids from a given functional form. Elements of the covariance matrix are computed as S_{i,j} = sigma_i * sigma_j * f(d_{i,j} / l_{i,j}) where d_{i,j} is the distance between the two grid points and l_{i,j} the mean of the correlation lengths of the grid points.

If a cutoff value co is given elements with absolute value less than this are set to zero.

The following functional forms are available: "exp": f(x) = exp(-x) "lin": f(x) = 1.0 - x, for x > 1.0, 0.0 otherwise "gauss": f(x) = exp(-x^2)

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The matrix in which to store the covariance matrix.
[in]grid_1- The retrieval grid for the first retrieval quantity.
[in]grid_2- The retrieval grid for the second retrieval quantity. (If empty taken as grid_1) (default: {})
[in]sigma_1- The variances of the first retrieval quantity.
[in]sigma_2- The variances of the second retrieval quantity.(If empty taken as sigma_1) (default: {})
[in]cls_1- The correlations lengths of the first retrieval quantity.
[in]cls_2- The correlations lengths of the second retrieval quantity.(If empty taken as cls_1) (default: {})
[in]co- The cutoff value for covariance matrix elements. (default: 0.0)
[in]fname- The name of the functional form to use.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83814 of file autoarts.h.

◆ covmat1DMarkov() [1/2]

MRecord ARTS::AgendaMethod::covmat1DMarkov ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
Var::Matrix  out_inverse,
const Var::Vector  grid,
const Var::Vector  sigma,
const Var::Numeric  lc,
const Var::Numeric co = {} 
)
inline

Create Markov Process Covariance Matrix.

Create a markov process covariance matrix for a retrieval quantity on evenly spaced 1D grid. The correlation between two grid points i,j is is computed as cov(i,j) = sigma[i] * sigma[j] * exp(- d(i,j) / lc) where d(i,j) = abs(grid[i] - grid[j]).

This function also sets covmat_inv_block to the analytically computed inverse of the covariance matrix of the markov provess, which is tri-diagonal. Note that this requires the retrieval grid to be evenly spaced.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The matrix in which to store the covariance matrix.
[out]out_inverse- The matrix in which to store the inverse of the covariance matrix.
[in]grid- The retrieval grid.
[in]sigma- The vairance for each grid point.
[in]lc- The correlation length of the Markov process.
[in]co- The cutoff value below which elements will be set to 0.0 (default: 0.0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83892 of file autoarts.h.

◆ covmat1DMarkov() [2/2]

MRecord ARTS::AgendaMethod::covmat1DMarkov ( [[maybe_unused] ] Workspace ws,
Var::Sparse  out,
Var::Sparse  out_inverse,
const Var::Vector  grid,
const Var::Vector  sigma,
const Var::Numeric  lc,
const Var::Numeric co = {} 
)
inline

Create Markov Process Covariance Matrix.

Create a markov process covariance matrix for a retrieval quantity on evenly spaced 1D grid. The correlation between two grid points i,j is is computed as cov(i,j) = sigma[i] * sigma[j] * exp(- d(i,j) / lc) where d(i,j) = abs(grid[i] - grid[j]).

This function also sets covmat_inv_block to the analytically computed inverse of the covariance matrix of the markov provess, which is tri-diagonal. Note that this requires the retrieval grid to be evenly spaced.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The matrix in which to store the covariance matrix.
[out]out_inverse- The matrix in which to store the inverse of the covariance matrix.
[in]grid- The retrieval grid.
[in]sigma- The vairance for each grid point.
[in]lc- The correlation length of the Markov process.
[in]co- The cutoff value below which elements will be set to 0.0 (default: 0.0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 83952 of file autoarts.h.

◆ covmat_seAddBlock() [1/2]

MRecord ARTS::AgendaMethod::covmat_seAddBlock ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  block,
const Var::Index i = {},
const Var::Index j = {} 
)
inline

Add a block to the measurement covariance matrix covmat_se

This functions adds a given dense or sparse matrix as block to the covariance matrix covmat_sx. The position of the block can be given by the generic arguments i and j. Note that diagonal blocks must be added in order starting from in the top left corner. If an off-diagonal block is added it must have corresponding existing blocks on the diagonal and these must be consistent with the dimensions of the block. If i and j are not provided, the blok will be added at the first free spot on the diagonal.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]block- The block to add to the covariance matrix
[in]i- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)
[in]j- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84083 of file autoarts.h.

◆ covmat_seAddBlock() [2/2]

MRecord ARTS::AgendaMethod::covmat_seAddBlock ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  block,
const Var::Index i = {},
const Var::Index j = {} 
)
inline

Add a block to the measurement covariance matrix covmat_se

This functions adds a given dense or sparse matrix as block to the covariance matrix covmat_sx. The position of the block can be given by the generic arguments i and j. Note that diagonal blocks must be added in order starting from in the top left corner. If an off-diagonal block is added it must have corresponding existing blocks on the diagonal and these must be consistent with the dimensions of the block. If i and j are not provided, the blok will be added at the first free spot on the diagonal.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]block- The block to add to the covariance matrix
[in]i- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)
[in]j- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84132 of file autoarts.h.

◆ covmat_seAddInverseBlock() [1/2]

MRecord ARTS::AgendaMethod::covmat_seAddInverseBlock ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  block,
const Var::Index i = {},
const Var::Index j = {} 
)
inline

Add the inverse of a block to covariance matrix covmat_se

This functions adds a given matrix as the inverse of a block in the covariance matrix covmat_se. The purpose of this function is to allow the user to to use a precomputed inverse for this block in the covariance matrix, that may for example have been obtained analytically.

This function requires the corresponding non-inverse block to already be present in covmat_se

Note that for this to work this retrieval quantity must be independent from other retrieval quantities that do not have an inverse. Otherwise the inverse will be ignored and recomputed numerically.

For the rest, the same requirements as for covmat_seAddBlock apply.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]block- The inverse block to add to the covariance matrix
[in]i- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)
[in]j- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84186 of file autoarts.h.

◆ covmat_seAddInverseBlock() [2/2]

MRecord ARTS::AgendaMethod::covmat_seAddInverseBlock ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  block,
const Var::Index i = {},
const Var::Index j = {} 
)
inline

Add the inverse of a block to covariance matrix covmat_se

This functions adds a given matrix as the inverse of a block in the covariance matrix covmat_se. The purpose of this function is to allow the user to to use a precomputed inverse for this block in the covariance matrix, that may for example have been obtained analytically.

This function requires the corresponding non-inverse block to already be present in covmat_se

Note that for this to work this retrieval quantity must be independent from other retrieval quantities that do not have an inverse. Otherwise the inverse will be ignored and recomputed numerically.

For the rest, the same requirements as for covmat_seAddBlock apply.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]block- The inverse block to add to the covariance matrix
[in]i- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)
[in]j- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84240 of file autoarts.h.

◆ covmat_seSet() [1/3]

MRecord ARTS::AgendaMethod::covmat_seSet ( [[maybe_unused] ] Workspace ws,
const Var::CovarianceMatrix  covmat 
)
inline

Set covmat_se to a given matrix.

This sets the measurement covariance matrix covmat_se to the matrix given by the generic input covmat. The covariance matrix can be of type CovarianceMatrix, Matrix or Sparse.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]covmat- The matrix to set as the covariance matrix.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84283 of file autoarts.h.

References ARTS::Var::CovarianceMatrix::islast(), and ARTS::Var::CovarianceMatrix::pos().

◆ covmat_seSet() [2/3]

MRecord ARTS::AgendaMethod::covmat_seSet ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  covmat 
)
inline

Set covmat_se to a given matrix.

This sets the measurement covariance matrix covmat_se to the matrix given by the generic input covmat. The covariance matrix can be of type CovarianceMatrix, Matrix or Sparse.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]covmat- The matrix to set as the covariance matrix.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84314 of file autoarts.h.

References ARTS::Var::Matrix::islast(), and ARTS::Var::Matrix::pos().

◆ covmat_seSet() [3/3]

MRecord ARTS::AgendaMethod::covmat_seSet ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  covmat 
)
inline

Set covmat_se to a given matrix.

This sets the measurement covariance matrix covmat_se to the matrix given by the generic input covmat. The covariance matrix can be of type CovarianceMatrix, Matrix or Sparse.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]covmat- The matrix to set as the covariance matrix.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84345 of file autoarts.h.

References ARTS::Var::Sparse::islast(), and ARTS::Var::Sparse::pos().

◆ covmat_soCalc()

MRecord ARTS::AgendaMethod::covmat_soCalc ( [[maybe_unused] ] Workspace ws)
inline

Calculates the covariance matrix describing the error due to uncertainties in the observation system. The uncertainties of the observation system are described by covmat_se, which must be set by the user to include the relevant contributions from the measurement and the forward model.

Prerequisite for the calculation of covmat_so is a successful OEM computation where also the gain matrix has been computed.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104118 of file autoarts.h.

◆ covmat_ssCalc()

MRecord ARTS::AgendaMethod::covmat_ssCalc ( [[maybe_unused] ] Workspace ws)
inline

Calculates the covariance matrix describing the error due to smoothing. The calculation of covmat_ss also requires the averaging kernel matrix avk to be computed after a successful OEM calculation.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104141 of file autoarts.h.

◆ covmat_sxAddBlock() [1/2]

MRecord ARTS::AgendaMethod::covmat_sxAddBlock ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  block,
const Var::Index i = {},
const Var::Index j = {} 
)
inline

Add a block to the a priori covariance matrix covmat_sx

This functions adds a given matrix as a block in the covariance matrix covmat_sx. The position of the block can be given by the generic arguments i and j, which should give the index of the retrieval quantity in jacobian_quantities*, which is given just by the order the quantities have been added to the retrieval.

If arguments i and j are omitted, the block will be added as diagonal block for the last added retrieval quantity.

If provided, the index i must be less than or equal to j. Also the provided block must be consistent with the corresponding retrieval quantities.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]block- The block to add to the covariance matrix
[in]i- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)
[in]j- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84479 of file autoarts.h.

◆ covmat_sxAddBlock() [2/2]

MRecord ARTS::AgendaMethod::covmat_sxAddBlock ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  block,
const Var::Index i = {},
const Var::Index j = {} 
)
inline

Add a block to the a priori covariance matrix covmat_sx

This functions adds a given matrix as a block in the covariance matrix covmat_sx. The position of the block can be given by the generic arguments i and j, which should give the index of the retrieval quantity in jacobian_quantities*, which is given just by the order the quantities have been added to the retrieval.

If arguments i and j are omitted, the block will be added as diagonal block for the last added retrieval quantity.

If provided, the index i must be less than or equal to j. Also the provided block must be consistent with the corresponding retrieval quantities.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]block- The block to add to the covariance matrix
[in]i- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)
[in]j- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84532 of file autoarts.h.

◆ covmat_sxAddInverseBlock() [1/2]

MRecord ARTS::AgendaMethod::covmat_sxAddInverseBlock ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  block,
const Var::Index i = {},
const Var::Index j = {} 
)
inline

Add the inverse of a block in covariance matrix covmat_sx

This functions adds a given matrix as the inverse of a block in the covariance matrix covmat_sx. The purpose of this function is to allow the user to to use a precomputed inverse for this block in the covariance matrix, the may for example by obtained analytically.

This function requires the non-inverse block to already be present in covmat_sx

Note that for this to work this retrieval quantity must be independent from other retrieval quantities that do not have an inverse. Otherwise the inverse will be ignored and recomputed numerically.

For the rest, the same requirements as for covmat_sxAddBlock apply.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]block- The inverse block to add to the covariance matrix
[in]i- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)
[in]j- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84586 of file autoarts.h.

◆ covmat_sxAddInverseBlock() [2/2]

MRecord ARTS::AgendaMethod::covmat_sxAddInverseBlock ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  block,
const Var::Index i = {},
const Var::Index j = {} 
)
inline

Add the inverse of a block in covariance matrix covmat_sx

This functions adds a given matrix as the inverse of a block in the covariance matrix covmat_sx. The purpose of this function is to allow the user to to use a precomputed inverse for this block in the covariance matrix, the may for example by obtained analytically.

This function requires the non-inverse block to already be present in covmat_sx

Note that for this to work this retrieval quantity must be independent from other retrieval quantities that do not have an inverse. Otherwise the inverse will be ignored and recomputed numerically.

For the rest, the same requirements as for covmat_sxAddBlock apply.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]block- The inverse block to add to the covariance matrix
[in]i- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)
[in]j- Index of a retrieval quantity. Must satisfy i <= j. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84640 of file autoarts.h.

◆ covmat_sxExtractSqrtDiagonal()

MRecord ARTS::AgendaMethod::covmat_sxExtractSqrtDiagonal ( [[maybe_unused] ] Workspace ws,
Var::Vector  x_norm 
)
inline

Extract the square root of the diagonal of the state space covariance matrix. This function extracts the diagonal of the state space covariance matrix covmat_sx* and computes its square root. The resulting vector can then be used as x_norm argument for the OEM method to avoid scaling problems.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]x_norm- The vector containing the square root of the diagonal elements of covmat_sx

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84682 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ covmat_sxSet() [1/3]

MRecord ARTS::AgendaMethod::covmat_sxSet ( [[maybe_unused] ] Workspace ws,
const Var::CovarianceMatrix  covmat 
)
inline

Set covmat_sx to a given matrix.

This sets the measurement covariance matrix covmat_sx to the matrix given by the generic input covmat. The covariance matrix can be of type CovarianceMatrix, Matrix or Sparse.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]covmat- The matrix to set as the covariance matrix.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84376 of file autoarts.h.

References ARTS::Var::CovarianceMatrix::islast(), and ARTS::Var::CovarianceMatrix::pos().

◆ covmat_sxSet() [2/3]

MRecord ARTS::AgendaMethod::covmat_sxSet ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  covmat 
)
inline

Set covmat_sx to a given matrix.

This sets the measurement covariance matrix covmat_sx to the matrix given by the generic input covmat. The covariance matrix can be of type CovarianceMatrix, Matrix or Sparse.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]covmat- The matrix to set as the covariance matrix.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84407 of file autoarts.h.

References ARTS::Var::Matrix::islast(), and ARTS::Var::Matrix::pos().

◆ covmat_sxSet() [3/3]

MRecord ARTS::AgendaMethod::covmat_sxSet ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  covmat 
)
inline

Set covmat_sx to a given matrix.

This sets the measurement covariance matrix covmat_sx to the matrix given by the generic input covmat. The covariance matrix can be of type CovarianceMatrix, Matrix or Sparse.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]covmat- The matrix to set as the covariance matrix.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84438 of file autoarts.h.

References ARTS::Var::Sparse::islast(), and ARTS::Var::Sparse::pos().

◆ covmatDiagonal() [1/2]

MRecord ARTS::AgendaMethod::covmatDiagonal ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
Var::Matrix  out_inverse,
const Var::Vector  vars 
)
inline

Sets the matrix in covmat_block to a diagonal matrix with the variances provided in vars as diagonal elements. Also sets covmat_block_inv to the inverse of the block so that the computation of the inverse is avoided.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The matrix in which to store the covariance matrix.
[out]out_inverse- The matrix in which to store the inverse of the covariance matrix.
[in]vars- Variances to be used as diagonal elements of covmat_block.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84002 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ covmatDiagonal() [2/2]

MRecord ARTS::AgendaMethod::covmatDiagonal ( [[maybe_unused] ] Workspace ws,
Var::Sparse  out,
Var::Sparse  out_inverse,
const Var::Vector  vars 
)
inline

Sets the matrix in covmat_block to a diagonal matrix with the variances provided in vars as diagonal elements. Also sets covmat_block_inv to the inverse of the block so that the computation of the inverse is avoided.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The matrix in which to store the covariance matrix.
[out]out_inverse- The matrix in which to store the inverse of the covariance matrix.
[in]vars- Variances to be used as diagonal elements of covmat_block.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84040 of file autoarts.h.

References ARTS::Var::Sparse::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Sparse::pos(), and ARTS::Var::Vector::pos().

◆ Delete() [1/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::AbsorptionLines  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84713 of file autoarts.h.

References ARTS::Var::AbsorptionLines::islast(), and ARTS::Var::AbsorptionLines::pos().

◆ Delete() [2/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Agenda  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84744 of file autoarts.h.

References ARTS::Var::Agenda::islast(), and ARTS::Var::Agenda::pos().

◆ Delete() [3/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAbsorptionLines  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84775 of file autoarts.h.

References ARTS::Var::ArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfAbsorptionLines::pos().

◆ Delete() [4/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAgenda  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84837 of file autoarts.h.

References ARTS::Var::ArrayOfAgenda::islast(), and ARTS::Var::ArrayOfAgenda::pos().

◆ Delete() [5/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfAbsorptionLines  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84806 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfArrayOfAbsorptionLines::pos().

◆ Delete() [6/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField1  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84868 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField1::pos().

◆ Delete() [7/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField2  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84899 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField2::pos().

◆ Delete() [8/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField3  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84930 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField3::pos().

◆ Delete() [9/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfIndex  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84961 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfIndex::islast(), and ARTS::Var::ArrayOfArrayOfIndex::pos().

◆ Delete() [10/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfMatrix  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 84992 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfMatrix::islast(), and ARTS::Var::ArrayOfArrayOfMatrix::pos().

◆ Delete() [11/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfPropagationMatrix  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85054 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfArrayOfPropagationMatrix::pos().

◆ Delete() [12/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfRadiationVector  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85085 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfArrayOfRadiationVector::pos().

◆ Delete() [13/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfScatteringMetaData  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85116 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfArrayOfScatteringMetaData::pos().

◆ Delete() [14/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSingleScatteringData  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85147 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfArrayOfSingleScatteringData::pos().

◆ Delete() [15/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSpeciesTag  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85178 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSpeciesTag::islast(), and ARTS::Var::ArrayOfArrayOfSpeciesTag::pos().

◆ Delete() [16/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfStokesVector  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85209 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfArrayOfStokesVector::pos().

◆ Delete() [17/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfString  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85240 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfString::islast(), and ARTS::Var::ArrayOfArrayOfString::pos().

◆ Delete() [18/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor3  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85271 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor3::islast(), and ARTS::Var::ArrayOfArrayOfTensor3::pos().

◆ Delete() [19/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor6  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85302 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor6::islast(), and ARTS::Var::ArrayOfArrayOfTensor6::pos().

◆ Delete() [20/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTime  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85333 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTime::islast(), and ARTS::Var::ArrayOfArrayOfTime::pos().

◆ Delete() [21/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTransmissionMatrix  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85364 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfArrayOfTransmissionMatrix::pos().

◆ Delete() [22/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfVector  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85395 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfVector::islast(), and ARTS::Var::ArrayOfArrayOfVector::pos().

◆ Delete() [23/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfCIARecord  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85426 of file autoarts.h.

References ARTS::Var::ArrayOfCIARecord::islast(), and ARTS::Var::ArrayOfCIARecord::pos().

◆ Delete() [24/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField1  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85457 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfGriddedField1::pos().

◆ Delete() [25/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField2  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85488 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfGriddedField2::pos().

◆ Delete() [26/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField3  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85519 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfGriddedField3::pos().

◆ Delete() [27/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField4  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85550 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField4::islast(), and ARTS::Var::ArrayOfGriddedField4::pos().

◆ Delete() [28/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfIndex  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85581 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), and ARTS::Var::ArrayOfIndex::pos().

◆ Delete() [29/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85612 of file autoarts.h.

References ARTS::Var::ArrayOfMatrix::islast(), and ARTS::Var::ArrayOfMatrix::pos().

◆ Delete() [30/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPpath  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85023 of file autoarts.h.

References ARTS::Var::ArrayOfPpath::islast(), and ARTS::Var::ArrayOfPpath::pos().

◆ Delete() [31/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPropagationMatrix  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85643 of file autoarts.h.

References ARTS::Var::ArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfPropagationMatrix::pos().

◆ Delete() [32/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85674 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), and ARTS::Var::ArrayOfQuantumIdentifier::pos().

◆ Delete() [33/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRadiationVector  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85705 of file autoarts.h.

References ARTS::Var::ArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfRadiationVector::pos().

◆ Delete() [34/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRetrievalQuantity  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85736 of file autoarts.h.

References ARTS::Var::ArrayOfRetrievalQuantity::islast(), and ARTS::Var::ArrayOfRetrievalQuantity::pos().

◆ Delete() [35/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfScatteringMetaData  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85767 of file autoarts.h.

References ARTS::Var::ArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfScatteringMetaData::pos().

◆ Delete() [36/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSingleScatteringData  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85798 of file autoarts.h.

References ARTS::Var::ArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfSingleScatteringData::pos().

◆ Delete() [37/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSparse  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85829 of file autoarts.h.

References ARTS::Var::ArrayOfSparse::islast(), and ARTS::Var::ArrayOfSparse::pos().

◆ Delete() [38/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfStokesVector  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85860 of file autoarts.h.

References ARTS::Var::ArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfStokesVector::pos().

◆ Delete() [39/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85891 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), and ARTS::Var::ArrayOfString::pos().

◆ Delete() [40/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTelsemAtlas  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85922 of file autoarts.h.

References ARTS::Var::ArrayOfTelsemAtlas::islast(), and ARTS::Var::ArrayOfTelsemAtlas::pos().

◆ Delete() [41/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor3  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85953 of file autoarts.h.

References ARTS::Var::ArrayOfTensor3::islast(), and ARTS::Var::ArrayOfTensor3::pos().

◆ Delete() [42/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor4  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 85984 of file autoarts.h.

References ARTS::Var::ArrayOfTensor4::islast(), and ARTS::Var::ArrayOfTensor4::pos().

◆ Delete() [43/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor5  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86015 of file autoarts.h.

References ARTS::Var::ArrayOfTensor5::islast(), and ARTS::Var::ArrayOfTensor5::pos().

◆ Delete() [44/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor6  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86046 of file autoarts.h.

References ARTS::Var::ArrayOfTensor6::islast(), and ARTS::Var::ArrayOfTensor6::pos().

◆ Delete() [45/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor7  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86077 of file autoarts.h.

References ARTS::Var::ArrayOfTensor7::islast(), and ARTS::Var::ArrayOfTensor7::pos().

◆ Delete() [46/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTime  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86108 of file autoarts.h.

References ARTS::Var::ArrayOfTime::islast(), and ARTS::Var::ArrayOfTime::pos().

◆ Delete() [47/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTransmissionMatrix  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86139 of file autoarts.h.

References ARTS::Var::ArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfTransmissionMatrix::pos().

◆ Delete() [48/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfVector  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86170 of file autoarts.h.

References ARTS::Var::ArrayOfVector::islast(), and ARTS::Var::ArrayOfVector::pos().

◆ Delete() [49/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfXsecRecord  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86201 of file autoarts.h.

References ARTS::Var::ArrayOfXsecRecord::islast(), and ARTS::Var::ArrayOfXsecRecord::pos().

◆ Delete() [50/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::CIARecord  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86232 of file autoarts.h.

References ARTS::Var::CIARecord::islast(), and ARTS::Var::CIARecord::pos().

◆ Delete() [51/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::CovarianceMatrix  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86263 of file autoarts.h.

References ARTS::Var::CovarianceMatrix::islast(), and ARTS::Var::CovarianceMatrix::pos().

◆ Delete() [52/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::EnergyLevelMap  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86294 of file autoarts.h.

References ARTS::Var::EnergyLevelMap::islast(), and ARTS::Var::EnergyLevelMap::pos().

◆ Delete() [53/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::GasAbsLookup  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86325 of file autoarts.h.

References ARTS::Var::GasAbsLookup::islast(), and ARTS::Var::GasAbsLookup::pos().

◆ Delete() [54/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField1  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86387 of file autoarts.h.

References ARTS::Var::GriddedField1::islast(), and ARTS::Var::GriddedField1::pos().

◆ Delete() [55/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField2  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86418 of file autoarts.h.

References ARTS::Var::GriddedField2::islast(), and ARTS::Var::GriddedField2::pos().

◆ Delete() [56/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField3  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86449 of file autoarts.h.

References ARTS::Var::GriddedField3::islast(), and ARTS::Var::GriddedField3::pos().

◆ Delete() [57/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField4  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86480 of file autoarts.h.

References ARTS::Var::GriddedField4::islast(), and ARTS::Var::GriddedField4::pos().

◆ Delete() [58/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField5  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86511 of file autoarts.h.

References ARTS::Var::GriddedField5::islast(), and ARTS::Var::GriddedField5::pos().

◆ Delete() [59/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField6  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86542 of file autoarts.h.

References ARTS::Var::GriddedField6::islast(), and ARTS::Var::GriddedField6::pos().

◆ Delete() [60/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::GridPos  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86356 of file autoarts.h.

References ARTS::Var::GridPos::islast(), and ARTS::Var::GridPos::pos().

◆ Delete() [61/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::HitranRelaxationMatrixData  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86573 of file autoarts.h.

References ARTS::Var::HitranRelaxationMatrixData::islast(), and ARTS::Var::HitranRelaxationMatrixData::pos().

◆ Delete() [62/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Index  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86604 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ Delete() [63/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86666 of file autoarts.h.

References ARTS::Var::Matrix::islast(), and ARTS::Var::Matrix::pos().

◆ Delete() [64/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::MCAntenna  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86635 of file autoarts.h.

References ARTS::Var::MCAntenna::islast(), and ARTS::Var::MCAntenna::pos().

◆ Delete() [65/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86697 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ Delete() [66/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Ppath  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86728 of file autoarts.h.

References ARTS::Var::Ppath::islast(), and ARTS::Var::Ppath::pos().

◆ Delete() [67/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::PropagationMatrix  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86759 of file autoarts.h.

References ARTS::Var::PropagationMatrix::islast(), and ARTS::Var::PropagationMatrix::pos().

◆ Delete() [68/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86790 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ Delete() [69/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::RadiationVector  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86821 of file autoarts.h.

References ARTS::Var::RadiationVector::islast(), and ARTS::Var::RadiationVector::pos().

◆ Delete() [70/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Rational  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86852 of file autoarts.h.

References ARTS::Var::Rational::islast(), and ARTS::Var::Rational::pos().

◆ Delete() [71/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::ScatteringMetaData  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86883 of file autoarts.h.

References ARTS::Var::ScatteringMetaData::islast(), and ARTS::Var::ScatteringMetaData::pos().

◆ Delete() [72/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::SingleScatteringData  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86914 of file autoarts.h.

References ARTS::Var::SingleScatteringData::islast(), and ARTS::Var::SingleScatteringData::pos().

◆ Delete() [73/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86945 of file autoarts.h.

References ARTS::Var::Sparse::islast(), and ARTS::Var::Sparse::pos().

◆ Delete() [74/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::SpeciesAuxData  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 86976 of file autoarts.h.

References ARTS::Var::SpeciesAuxData::islast(), and ARTS::Var::SpeciesAuxData::pos().

◆ Delete() [75/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::StokesVector  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87007 of file autoarts.h.

References ARTS::Var::StokesVector::islast(), and ARTS::Var::StokesVector::pos().

◆ Delete() [76/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::String  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87038 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ Delete() [77/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::TelsemAtlas  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87069 of file autoarts.h.

References ARTS::Var::TelsemAtlas::islast(), and ARTS::Var::TelsemAtlas::pos().

◆ Delete() [78/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87100 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), and ARTS::Var::Tensor3::pos().

◆ Delete() [79/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87131 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), and ARTS::Var::Tensor4::pos().

◆ Delete() [80/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87162 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), and ARTS::Var::Tensor5::pos().

◆ Delete() [81/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87193 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), and ARTS::Var::Tensor6::pos().

◆ Delete() [82/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87224 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ Delete() [83/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::TessemNN  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87317 of file autoarts.h.

References ARTS::Var::TessemNN::islast(), and ARTS::Var::TessemNN::pos().

◆ Delete() [84/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Time  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87286 of file autoarts.h.

References ARTS::Var::Time::islast(), and ARTS::Var::Time::pos().

◆ Delete() [85/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Timer  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87255 of file autoarts.h.

References ARTS::Var::Timer::islast(), and ARTS::Var::Timer::pos().

◆ Delete() [86/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::TransmissionMatrix  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87348 of file autoarts.h.

References ARTS::Var::TransmissionMatrix::islast(), and ARTS::Var::TransmissionMatrix::pos().

◆ Delete() [87/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Vector  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87379 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ Delete() [88/88]

MRecord ARTS::AgendaMethod::Delete ( [[maybe_unused] ] Workspace ws,
const Var::Verbosity  v 
)
inline

Deletes a workspace variable.

The variable is marked as uninitialized and its memory freed. It is not removed from the workspace though, therefore you don't need to/can't call Create for this variable again.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to be deleted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87410 of file autoarts.h.

References ARTS::Var::Verbosity::islast(), and ARTS::Var::Verbosity::pos().

◆ DiagonalMatrix() [1/2]

MRecord ARTS::AgendaMethod::DiagonalMatrix ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  v 
)
inline

Create a diagonal matrix from a vector. This creates a dense or sparse diagonal matrix with the elements of the given vector on the diagonal.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The diagonal matrix
[in]v- The vector containing the diagonal elements.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87548 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ DiagonalMatrix() [2/2]

MRecord ARTS::AgendaMethod::DiagonalMatrix ( [[maybe_unused] ] Workspace ws,
Var::Sparse  out,
const Var::Vector  v 
)
inline

Create a diagonal matrix from a vector. This creates a dense or sparse diagonal matrix with the elements of the given vector on the diagonal.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The diagonal matrix
[in]v- The vector containing the diagonal elements.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87581 of file autoarts.h.

References ARTS::Var::Sparse::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Sparse::pos(), and ARTS::Var::Vector::pos().

◆ diameter_maxFromDiameter_volume_equ()

MRecord ARTS::AgendaMethod::diameter_maxFromDiameter_volume_equ ( [[maybe_unused] ] Workspace ws,
Var::Numeric  diameter_max,
Var::Numeric  diameter_area_equ,
const Var::String  shape,
const Var::Numeric  diameter_volume_equ,
const Var::Numeric  aspect_ratio 
)
inline

Calculates maximum and area equivalent diameters from volume equivalent diameter.

This is primarily a help function for using the T-matrix method and only a few particle shapes are handled. For shapes handled and further comments on the input arguments, see scat_data_singleTmatrix*.

Area equivalent diameter is the equivalent sphere diameter corresponding to the "maximum axial area". This is the largest cross-sectional area of the particle, observed either along the particle's main axis or in the perpendicular direction. That is, for a cylinder having diameter d and thickness h, this area is either (pi*d^2)/4 or (h*d).

Author
Johan Strandgren
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]diameter_max- Maximum dimension of the particle.
[out]diameter_area_equ- Maximum axial area equivalent diameter of the particle, see above.
[in]shape- Particle shape.
[in]diameter_volume_equ- Particle equivalent volume diameter.
[in]aspect_ratio- Particle aspect ratio.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87455 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::String::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::String::pos().

◆ diameter_volume_equFromDiameter_max()

MRecord ARTS::AgendaMethod::diameter_volume_equFromDiameter_max ( [[maybe_unused] ] Workspace ws,
Var::Numeric  diameter_volume_equ,
Var::Numeric  volume,
const Var::String  shape,
const Var::Numeric  diameter_max,
const Var::Numeric  aspect_ratio 
)
inline

Converts from maximum to volume equivalent diameter.

This is primarily a help function for using the T-matrix part and only a few particle shapes are handled. For shapes handled and further comments on the input arguments, see scat_data_singleTmatrix.

Also the volume is provided. It is simply sqrt(pi*dveq^3/6).

Author
Johan Strandgren
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]diameter_volume_equ- Particle volume equivalent diameter.
[out]volume- Volume of the particle.
[in]shape- Particle shape.
[in]diameter_max- Maximum dimension of the particle.
[in]aspect_ratio- Particle aspect ratio.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87506 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::String::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::String::pos().

◆ DiffZaAa()

MRecord ARTS::AgendaMethod::DiffZaAa ( [[maybe_unused] ] Workspace ws,
Var::Matrix  dlos,
const Var::Vector  ref_los,
const Var::Matrix  other_los 
)
inline

Derives the difference betwenn zenith and azimuth angles.

Determines the difference between a set of angles (other_los) and a reference direction (ref_los). This method reverses the addition made by AddZaAa.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]dlos- Derived differences in line-of-sight.
[in]ref_los- Reference line-of-sight (a single LOS).
[in]other_los- Other line-of-sights (can be multiple LOS).

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87617 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ DisortCalc()

MRecord ARTS::AgendaMethod::DisortCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index nstreams = {},
const Var::String pfct_method = {},
const Var::Index Npfct = {},
const Var::Index quiet = {} 
)
inline

Interface to the DISORT scattering solver (by Stamnes et al.).

DISCLAIMER: There is a couple of known issues with the current implementation (see below). Use this WSM with care and only if these limitations/requirements are fulfilled. Results might be erroneous otherwise.

DISORT provides the radiation field (cloudbox_field) from a scalar 1D scattering solution assuming a plane-parallel atmosphere (flat Earth). Only totally randomly oriented particles are allowed. Refraction is not taken into account. Only Lambertian surface reflection is handled.

nstreams* is the number of polar angles taken into account internally in the scattering solution, za_grid is the polar angle grid on which cloudbox_field is provided. nstreams* determines the angular resolution, hence the accuracy, of the scattering solution. The more anisotropic the bulk scattering matrix, the more streams are required. The computational burden increases approximately linearly with nstreams. The default value (8) is sufficient for most microwave scattering calculations. It is likely insufficient for IR calculations involving ice clouds, though.

Further, za_grid determines the resolution of the output radiation field. The size of za_grid has no practical impact on computation time in the case of Disort and higher resolution generally improves the interpolation results, hence larger za_grid are recommended. To ensure sufficient interpolation accuracy, we require a (hardcoded) minimum size of 38.

Different sphericity levels are emulated here by embedding DISORT in different ways and using different output. The available options (from low to high sphericity level) are:

  • Cloudbox extends over whole atmosphere (e.g. by setting cloudbox from cloudboxSetFullAtm).
  • Cloudbox extends over a limited part of the atmosphere only (e.g. by setting cloudbox from cloudboxSetAutomatically or cloudboxSetManually*). Internally, DISORT is run over the whole atmosphere, but only the radiation field within the cloudbox is passed on and used further in ARTS (e.g. by yCalc).

Known issues of ARTS implementation:

  • Surface altitude is not an interface parameter. Surface is implicitly assumed to be at the lowest atmospheric level.
  • Scattering angle grids of all scattering elements have to be identical (except if pfct_method is 'interpolate').

Keyword pfct_method allows to chose the method to extract phase function. 'interpolate' considers temperature dependence. Others neglect it by chosing one specific temperature grid point from the single scattering data: 'low' choses the lowest T-point, 'high' the highest T-point, and 'median' the median T-point. As different scattering elements can have different temperature grids, the actual temperature value used can differ between the scattering elements. Currently, other methods than 'interpolate' require all scattering elements to be given on identical scattering angle grids. Note that this keyword solely affects the phase function; extinction/absorption/scattering cross sections are always interpolated to the actual temperature.

Author
Claudia Emde, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]nstreams- Number of polar angle directions (streams) in DISORT solution (must be an even number). (default: 8)
[in]pfct_method- Flag which method to apply to derive phase function. (default: "median")
[in]Npfct- Number of angular grid points to calculate bulk phase function on (and derive Legendre polnomials from). If <0, the finest za_grid from scat_data will be used. (default: 181)
[in]quiet- Silence C Disort warnings. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87712 of file autoarts.h.

◆ DisortCalcClearsky()

MRecord ARTS::AgendaMethod::DisortCalcClearsky ( [[maybe_unused] ] Workspace ws,
const Var::Index nstreams = {},
const Var::Index quiet = {} 
)
inline

Interface to DISORT for running clear-sky cases.

The method runs DISORT with pnd_field set to zero.

Note that this version returns spectral_radiance_field, i.e. the solution for the full atmosphere. The standard DisortCalc only returns the field inside the cloudbox.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]nstreams- Number of polar angle directions (streams) in DISORT solution (must be an even number). (default: 8)
[in]quiet- Silence C Disort warnings. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87818 of file autoarts.h.

◆ DisortCalcWithARTSSurface()

MRecord ARTS::AgendaMethod::DisortCalcWithARTSSurface ( [[maybe_unused] ] Workspace ws,
const Var::Index nstreams = {},
const Var::String pfct_method = {},
const Var::Index Npfct = {},
const Var::Index quiet = {} 
)
inline

DISORT with surface.

Author
Claudia Emde, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]nstreams- Number of polar angle directions (streams) in DISORT solution (must be an even number). (default: 8)
[in]pfct_method- Flag which method to apply to derive phase function. (default: "median")
[in]Npfct- Number of angular grid points to calculate bulk phase function on (and derive Legendre polnomials from). If <0, the finest za_grid from scat_data will be used. (default: 181)
[in]quiet- Silence C Disort warnings. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87763 of file autoarts.h.

◆ DOAngularGridsSet()

MRecord ARTS::AgendaMethod::DOAngularGridsSet ( [[maybe_unused] ] Workspace ws,
const Var::Index  N_za_grid,
const Var::Index N_aa_grid = {},
const Var::String za_grid_opt_file = {} 
)
inline

Sets the angular grids for Discrete Ordinate type scattering calculations.

This method sets the angular grids for the Discrete Ordinate type scattering calculations (DOIT, DISORT). For down- und up-looking geometries it suffices to define N_za_grid (both solvers) and N_aa_grid* (DOIT). From these numbers equally spaced grids are created and stored in the WSVs za_grid and aa_grid.

For limb simulations it is important to use an optimized zenith angle grid with a very fine resolution around the horizon (za=90 degrees). Such a grid can be generated using doit_za_grid_optCalc*. To be applied, the name of the file holding the optimized angle grid has to be given (za_grid_opt_file).

When an optimized grid is present, the equidistant grid is used for the calculation of the scattering integrals, while the optimized grid is applied for the integration of the radiative transfer equation. Otherwise the equidistant grid is used throughout. For down-looking cases using the equidistant grid typically suffices and speeds up the calculations.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]N_za_grid- Number of grid points in zenith angle grid. Recommended value is 19.
[in]N_aa_grid- Number of grid points in azimuth angle grid. Recommended value is 37. (default: 1)
[in]za_grid_opt_file- Name of special grid for RT part. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87939 of file autoarts.h.

◆ DOBatchCalc()

MRecord ARTS::AgendaMethod::DOBatchCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index robust = {} 
)
inline

Performs batch calculations for radiation fields.

We perform ybatch_n jobs, starting at index ybatch_start. (Zero based indexing, as usual.) The output arrays will have ybatch_n elements. Indices in the output array start with zero, independent of ybatch_start.

WARNING, MEMORY INTENSIVE!!!: Since the outputs of this methods can be very large, make sure you only pass back output you need. Estimate the size of your output by looking at the dimensions beforehand. If you only want to pass back some fields, make sure to empty the others at the end of your dobatch_calc_agenda. E.g.: Tensor7SetConstant(cloudbox_field, 0, 0, 0, 0, 0, 0, 0, 0.)

The method performs the following:

  1. Sets ybatch_index = ybatch_start.
  2. Performs a-d until ybatch_index* = ybatch_start + ybatch_n. a. Executes dobatch_calc_agenda. b. If ybatch_index = ybatch_start, resizes the output arrays based on ybatch_n. c. Copies calculated fields to ybatch_index - ybatch_start of output arrays. d. Adds 1 to ybatch_index.

Beside the dobatch_calc_agenda, the WSVs ybatch_start and ybatch_n must be set before calling this method.

The input variable ybatch_start is set to a default of zero in general.arts*.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]robust- A flag with value 1 or 0. If set to one, the batch calculation will continue, even if individual jobs fail. In that case, a warning message is written to screen and file (out1 output stream), and the output array entry for the failed job in the output fields is left empty. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87887 of file autoarts.h.

◆ doit_conv_flagAbs()

MRecord ARTS::AgendaMethod::doit_conv_flagAbs ( [[maybe_unused] ] Workspace ws,
const Var::Vector  epsilon,
const Var::Index max_iterations = {},
const Var::Index nonconv_return_nan = {} 
)
inline

DOIT convergence test (maximum absolute difference).

The function calculates the absolute differences for two successive iteration fields. It picks out the maximum values for each Stokes component separately. The convergence test is fullfilled under the following conditions: |I(m+1) - I(m)| < epsilon_1 Intensity. |Q(m+1) - Q(m)| < epsilon_2 The other Stokes components. |U(m+1) - U(m)| < epsilon_3
|V(m+1) - V(m)| < epsilon_4
These conditions have to be valid for all positions in the cloudbox and for all directions.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]epsilon- Limits for convergence. A vector with length matching stokes_dim with unit [W / (m^2 Hz sr)].
[in]max_iterations- Maximum number of iterations allowed to reach convergencelimit. (default: 100)
[in]nonconv_return_nan- Flag whether to accept result at max_iterations (0=default)or whether to return NaNs in case of non-convergence atmax_iterations (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88204 of file autoarts.h.

◆ doit_conv_flagAbsBT()

MRecord ARTS::AgendaMethod::doit_conv_flagAbsBT ( [[maybe_unused] ] Workspace ws,
const Var::Vector  epsilon,
const Var::Index max_iterations = {},
const Var::Index nonconv_return_nan = {} 
)
inline

DOIT convergence test (maximum absolute difference in Rayleigh Jeans BT)

As doit_conv_flagAbs but convergence limits are specified in Rayleigh-Jeans brighntess temperatures.

Author
Sreerekha T.R.
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]epsilon- Limits for convergence. A vector with length matching stokes_dim with unit [K].
[in]max_iterations- Maximum number of iterations allowed to reach convergencelimit. (default: 100)
[in]nonconv_return_nan- Flag whether to accept result at max_iterations (0=default)or whether to return NaNs in case of non-convergence atmax_iterations (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88249 of file autoarts.h.

◆ doit_conv_flagLsq()

MRecord ARTS::AgendaMethod::doit_conv_flagLsq ( [[maybe_unused] ] Workspace ws,
const Var::Vector  epsilon,
const Var::Index max_iterations = {},
const Var::Index nonconv_return_nan = {} 
)
inline

DOIT convergence test (least squares).

As doit_conv_flagAbsBT but applies a least squares convergence test between two successive iteration fields.

Warning: This method is not recommended because this kind of convergence test is not sufficiently strict, so that the DOIT result might be wrong.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]epsilon- Limits for convergence. A vector with length matching stokes_dim with unit [K].
[in]max_iterations- Maximum number of iterations allowed to reach convergencelimit. (default: 100)
[in]nonconv_return_nan- Flag whether to accept result at max_iterations (0=default)or whether to return NaNs in case of non-convergence atmax_iterations (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88297 of file autoarts.h.

◆ doit_scat_fieldCalc()

MRecord ARTS::AgendaMethod::doit_scat_fieldCalc ( [[maybe_unused] ] Workspace ws)
inline

Calculates the scattering integral field in the DOIT module.

The scattering integral field is generated by integrating the product of phase matrix and Stokes vector over all incident angles. For more information please refer to AUG.

Author
Sreerekha T.R.
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88396 of file autoarts.h.

◆ doit_scat_fieldCalcLimb()

MRecord ARTS::AgendaMethod::doit_scat_fieldCalcLimb ( [[maybe_unused] ] Workspace ws)
inline

Calculates the scattering integral field in the DOIT module (limb).

The scattering integral field is the field generated by integrating the product of phase matrix and the Stokes vector over all incident angles.

For limb simulations it makes sense to use different zenith angle grids for the scattering integral part and the RT part, because the latter part requires a much finer resolution near 90 degrees. Taking an optimized grid for the RT part and an equidistant grid for the scattering integral part saves very much CPU time. This method uses the equidistant za_grid defined in DOAngularGridsSet* and it should always be used for limb simulations.

For more information please refer to AUG.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88432 of file autoarts.h.

◆ doit_za_grid_optCalc()

MRecord ARTS::AgendaMethod::doit_za_grid_optCalc ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  acc 
)
inline

Zenith angle grid optimization for scattering calculation.

This method optimizes the zenith angle grid. As input it requires a radiation field (cloudbox_field) which is calculated on a very fine zenith angle grid (za_grid). Based on this field zenith angle grid points are selected, such that the maximum difference between the radiation field represented on the very fine zenith angle grid and the radiation field represented on the optimized grid (doit_za_grid_opt) is less than the accuracy (acc). Between the grid points the radiation field is interpolated linearly or polynomially depending on doit_za_interp.

Note: The method works only for a 1D atmosphere and for one frequency.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]acc- Accuracy to achieve [%].

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88467 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ doit_za_interpSet()

MRecord ARTS::AgendaMethod::doit_za_interpSet ( [[maybe_unused] ] Workspace ws,
const Var::String interp_method = {} 
)
inline

Define interpolation method for zenith angle dimension.

You can use this method to choose the interpolation method for interpolations in the zenith angle dimension.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]interp_method- Interpolation method ("linear" or "polynomial"). (default: "linear")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88497 of file autoarts.h.

◆ DoitCalc()

MRecord ARTS::AgendaMethod::DoitCalc ( [[maybe_unused] ] Workspace ws)
inline

Main DOIT method.

This method executes doit_mono_agenda for each frequency in f_grid. The output is the radiation field inside the cloudbox (cloudbox_field).

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 87981 of file autoarts.h.

◆ DoitGetIncoming()

MRecord ARTS::AgendaMethod::DoitGetIncoming ( [[maybe_unused] ] Workspace ws,
const Var::Index rigorous = {},
const Var::Numeric maxratio = {} 
)
inline

Calculates incoming radiation field of the cloudbox by repeated radiative transfer calculations.

The method performs monochromatic pencil beam calculations for all grid positions on the cloudbox boundary, and all directions given by scattering angle grids (scat_za/aa_grid). Found radiances are stored in cloudbox_field which can be used as boundary conditions when scattering inside the cloud box is solved by the DoitCalc* method.

Note that cloudbox_field will always hold intensity in terms of radiances, regardless of the setting of iy_unit (unit conversion is done within yCalc or iyCalc, which will provide their output in terms of the specified iy_unit; no explicit unit conversion by the user necessary.).

Author
Sreerekha T.R.
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]rigorous- Fail if incoming field is not safely interpolable. (default: 1)
[in]maxratio- Maximum allowed ratio of two radiances regarded as interpolable. (default: 100)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88019 of file autoarts.h.

◆ DoitGetIncoming1DAtm()

MRecord ARTS::AgendaMethod::DoitGetIncoming1DAtm ( [[maybe_unused] ] Workspace ws)
inline

As DoitGetIncoming but assumes clear sky part to be 1D. The incoming field is calculated only for one position and azimuth angle for each cloud box boundary, and obtained values are used for all other postions and azimuth angles. This works if a 3D cloud box is put into an 1D background atmosphere.

This method can only be used for 3D cases.

Author
Sreerekha T.R.
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88061 of file autoarts.h.

◆ DoitInit()

MRecord ARTS::AgendaMethod::DoitInit ( [[maybe_unused] ] Workspace ws)
inline

Initialises variables for DOIT scattering calculations.

Note that multi-dimensional output variables (Tensors, specifically) are NaN-initialized. That is, this methods needs to be called BEFORE other WSMs that provide input to DoitCalc, e.g. before DoitGetIncoming*.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88087 of file autoarts.h.

◆ DoitScatteringDataPrepare()

MRecord ARTS::AgendaMethod::DoitScatteringDataPrepare ( [[maybe_unused] ] Workspace ws)
inline

Prepares single scattering data for a DOIT scattering calculation.

First the scattering data is interpolated in frequency using scat_data_monoCalc*. Then the phase matrix data is transformed or interpolated from the raw data to the laboratory frame for all possible combinations of the angles contained in the angular grids which are set in DOAngularGridsSet. The resulting phase matrices are stored in pha_mat_sptDOITOpt.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88115 of file autoarts.h.

◆ DoitWriteIterationFields()

MRecord ARTS::AgendaMethod::DoitWriteIterationFields ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfIndex iterations = {},
const Var::ArrayOfIndex frequencies = {} 
)
inline

Writes DOIT iteration fields.

This method writes intermediate iteration fields to xml-files. The method can be used as a part of doit_conv_test_agenda.

The iterations to be stored are specified by iterations, e.g.: iterations = [3, 6, 9] In this case the 3rd, 6th and 9th iterations are stored. If a number is larger than the total number of iterations, this number is ignored. If all iterations should be stored set iterations = [-1]

The frequencies to be stored are specified by frequencies in the same way as the iterations. The frequency index corresponds to the order of frequencies in f_grid.

The output files are named doit_iteration_fX_iY.xml with X being the frequency index and iY the iteration counter.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]iterations- Selection of iterations to store. (default: {-1})
[in]frequencies- Selection of frequencies to store. (default: {-1})

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88155 of file autoarts.h.

◆ Duration()

MRecord ARTS::AgendaMethod::Duration ( [[maybe_unused] ] Workspace ws,
Var::Numeric  duration,
const Var::Time  start,
const Var::Time  end 
)
inline

Sets the seconds between two times.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]duration- Time in seconds between start and end
[in]start- Start time
[in]end- End time

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88529 of file autoarts.h.

References Zeeman::end(), ARTS::Var::Numeric::islast(), ARTS::Var::Numeric::pos(), and Zeeman::start().

◆ EnergyLevelMapSet()

MRecord ARTS::AgendaMethod::EnergyLevelMapSet ( [[maybe_unused] ] Workspace ws,
Var::EnergyLevelMap  x,
const Var::EnergyLevelMap  y 
)
inline

Sets an EnergyLevelMap

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]x- out
[in]y- in

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88563 of file autoarts.h.

References ARTS::Var::Vector::islast(), ARTS::Var::Vector::pos(), ARTS::Var::x(), and ARTS::Var::y().

◆ Error()

MRecord ARTS::AgendaMethod::Error ( [[maybe_unused] ] Workspace ws,
const Var::String  msg 
)
inline

Issues an error and exits ARTS.

This method can be placed in agendas that must be specified, but are expected not to be used for the particular case. An inclusion in surface_rtprop_agenda could look like: Error{"Surface interceptions of propagation path not expected."}

Ignore and other dummy method calls must still be included.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]msg- String describing the error.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88600 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ Exit()

MRecord ARTS::AgendaMethod::Exit ( [[maybe_unused] ] Workspace ws)
inline

Stops the execution and exits ARTS.

This method is handy if you want to debug one of your control files. You can insert it anywhere in the control file. When it is reached, it will terminate the program.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88630 of file autoarts.h.

◆ ext_matAddGas()

MRecord ARTS::AgendaMethod::ext_matAddGas ( [[maybe_unused] ] Workspace ws)
inline

Add gas absorption to all diagonal elements of extinction matrix.

The task of this method is to sum up the gas absorption of the different gas species and add the result to the extinction matrix.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89423 of file autoarts.h.

◆ Extract() [1/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField3  needle,
const Var::ArrayOfArrayOfGriddedField3  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89092 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField3::islast(), ARTS::Var::ArrayOfGriddedField3::islast(), ARTS::Var::Index::islast(), ARTS::Var::ArrayOfArrayOfGriddedField3::pos(), ARTS::Var::ArrayOfGriddedField3::pos(), and ARTS::Var::Index::pos().

◆ Extract() [2/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfIndex  needle,
const Var::ArrayOfArrayOfIndex  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88705 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfIndex::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::Index::islast(), ARTS::Var::ArrayOfArrayOfIndex::pos(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::Index::pos().

◆ Extract() [3/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSingleScatteringData  needle,
const Var::ArrayOfArrayOfSingleScatteringData  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89264 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSingleScatteringData::islast(), ARTS::Var::ArrayOfSingleScatteringData::islast(), ARTS::Var::Index::islast(), ARTS::Var::ArrayOfArrayOfSingleScatteringData::pos(), ARTS::Var::ArrayOfSingleScatteringData::pos(), and ARTS::Var::Index::pos().

◆ Extract() [4/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::GriddedField3  needle,
const Var::ArrayOfGriddedField3  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89049 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField3::islast(), ARTS::Var::GriddedField3::islast(), ARTS::Var::Index::islast(), ARTS::Var::ArrayOfGriddedField3::pos(), ARTS::Var::GriddedField3::pos(), and ARTS::Var::Index::pos().

◆ Extract() [5/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::GriddedField4  needle,
const Var::ArrayOfGriddedField4  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89135 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField4::islast(), ARTS::Var::GriddedField4::islast(), ARTS::Var::Index::islast(), ARTS::Var::ArrayOfGriddedField4::pos(), ARTS::Var::GriddedField4::pos(), and ARTS::Var::Index::pos().

◆ Extract() [6/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::Index  needle,
const Var::ArrayOfIndex  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88662 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::Index::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::Index::pos().

◆ Extract() [7/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::Matrix  needle,
const Var::ArrayOfMatrix  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88834 of file autoarts.h.

References ARTS::Var::ArrayOfMatrix::islast(), ARTS::Var::Index::islast(), ARTS::Var::Matrix::islast(), ARTS::Var::ArrayOfMatrix::pos(), ARTS::Var::Index::pos(), and ARTS::Var::Matrix::pos().

◆ Extract() [8/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::Matrix  needle,
const Var::Tensor3  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88877 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::Matrix::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::Index::pos(), ARTS::Var::Matrix::pos(), and ARTS::Var::Tensor3::pos().

◆ Extract() [9/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::Numeric  needle,
const Var::Vector  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88748 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Index::pos(), ARTS::Var::Numeric::pos(), and ARTS::Var::Vector::pos().

◆ Extract() [10/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::QuantumIdentifier  needle,
const Var::ArrayOfQuantumIdentifier  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89350 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), ARTS::Var::Index::islast(), ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::ArrayOfQuantumIdentifier::pos(), ARTS::Var::Index::pos(), and ARTS::Var::QuantumIdentifier::pos().

◆ Extract() [11/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::SingleScatteringData  needle,
const Var::ArrayOfSingleScatteringData  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89221 of file autoarts.h.

References ARTS::Var::ArrayOfSingleScatteringData::islast(), ARTS::Var::Index::islast(), ARTS::Var::SingleScatteringData::islast(), ARTS::Var::ArrayOfSingleScatteringData::pos(), ARTS::Var::Index::pos(), and ARTS::Var::SingleScatteringData::pos().

◆ Extract() [12/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::String  needle,
const Var::ArrayOfString  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89178 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), ARTS::Var::Index::islast(), ARTS::Var::String::islast(), ARTS::Var::ArrayOfString::pos(), ARTS::Var::Index::pos(), and ARTS::Var::String::pos().

◆ Extract() [13/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::TelsemAtlas  needle,
const Var::ArrayOfTelsemAtlas  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89307 of file autoarts.h.

References ARTS::Var::ArrayOfTelsemAtlas::islast(), ARTS::Var::Index::islast(), ARTS::Var::TelsemAtlas::islast(), ARTS::Var::ArrayOfTelsemAtlas::pos(), ARTS::Var::Index::pos(), and ARTS::Var::TelsemAtlas::pos().

◆ Extract() [14/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  needle,
const Var::Tensor4  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88920 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::Index::pos(), ARTS::Var::Tensor3::pos(), and ARTS::Var::Tensor4::pos().

◆ Extract() [15/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  needle,
const Var::ArrayOfTensor4  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88963 of file autoarts.h.

References ARTS::Var::ArrayOfTensor4::islast(), ARTS::Var::Index::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::ArrayOfTensor4::pos(), ARTS::Var::Index::pos(), and ARTS::Var::Tensor4::pos().

◆ Extract() [16/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  needle,
const Var::Tensor5  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89006 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::Tensor5::islast(), ARTS::Var::Index::pos(), ARTS::Var::Tensor4::pos(), and ARTS::Var::Tensor5::pos().

◆ Extract() [17/17]

MRecord ARTS::AgendaMethod::Extract ( [[maybe_unused] ] Workspace ws,
Var::Vector  needle,
const Var::ArrayOfVector  haystack,
const Var::Index  index 
)
inline

Extracts an element from an array.

Copies the element with the given Index from the input variable to the output variable.

For a Tensor3 as an input, it copies the page with the given Index from the input Tensor3 variable to the output Matrix.

In other words, the selection is always done on the first dimension.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needle- Extracted element.
[in]haystack- Variable to extract from.
[in]index- Position of the element which should be extracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88791 of file autoarts.h.

References ARTS::Var::ArrayOfVector::islast(), ARTS::Var::Index::islast(), ARTS::Var::Vector::islast(), ARTS::Var::ArrayOfVector::pos(), ARTS::Var::Index::pos(), and ARTS::Var::Vector::pos().

◆ ExtractFromMetaSingleScatSpecies()

MRecord ARTS::AgendaMethod::ExtractFromMetaSingleScatSpecies ( [[maybe_unused] ] Workspace ws,
Var::Vector  meta_param,
const Var::String  meta_name,
const Var::Index  scat_species_index 
)
inline

Extract (numeric) parameters from scat_meta of a single scattering species.

...

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[out]meta_param- The extracted meta parameter values.
[in]meta_name- Name of the meta parameter to extract.
[in]scat_species_index- Array index of scattering species from which to extract.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89388 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Index::pos(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ f_gridFromAbsorptionLines()

MRecord ARTS::AgendaMethod::f_gridFromAbsorptionLines ( [[maybe_unused] ] Workspace ws,
const Var::Index  num_freqs,
const Var::Numeric delta_f_low = {},
const Var::Numeric delta_f_upp = {} 
)
inline

Sets f_grid to a grid relative to abs_lines_per_species

Each line will have abs_lines_per_species will have a grid of num_freqs grid points in [f0+*delta_f_low*, f0+*delta_f_upp*], where f0 is the line center.

Before leaving the function, f_grid is sorted.

Note that this method could generate significantly large f_grid if used carelessly

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]delta_f_low- Lower range of delta f (default: -5e6)
[in]delta_f_upp- Upper range of delta f (default: 5e6)
[in]num_freqs- Number of frequencies

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90285 of file autoarts.h.

◆ f_gridFromGasAbsLookup()

MRecord ARTS::AgendaMethod::f_gridFromGasAbsLookup ( [[maybe_unused] ] Workspace ws)
inline

Sets f_grid to the frequency grid of abs_lookup.

Must be called between importing/creating raw absorption table and call of abs_lookupAdapt.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90326 of file autoarts.h.

◆ f_gridFromSensorAMSU()

MRecord ARTS::AgendaMethod::f_gridFromSensorAMSU ( [[maybe_unused] ] Workspace ws,
const Var::Numeric spacing = {} 
)
inline

Automatically calculate f_grid to match the sensor.

This method is handy if you are simulating an AMSU-type instrument, consisting of a few discrete channels. The case that channels touch, as for MHS, is handled correctly. But the case that channels overlap is not (yet) handled and results in an error message.

The method calculates f_grid to match the instrument, as given by the local oscillator frequencies lo_multi, the backend frequencies f_backend_multi, and the backend channel responses backend_channel_response_multi.

You have to specify the desired spacing in the keyword spacing, which has a default value of 100 MHz. (The actual value is 0.1e9, since our unit is Hz.)

The produced grid will not have exactly the requested spacing, but will not be coarser than requested. The algorithm starts with the band edges, then adds additional points until the spacing is at least as fine as requested.

There is a similar method for HIRS-type instruments, see f_gridFromSensorHIRS.

Author
Stefan Buehler, Mathias Milz
Parameters
[in,out]Workspacews - An ARTS workspace
[in]spacing- Desired grid spacing in Hz. (default: .1e9)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90370 of file autoarts.h.

◆ f_gridFromSensorAMSUgeneric()

MRecord ARTS::AgendaMethod::f_gridFromSensorAMSUgeneric ( [[maybe_unused] ] Workspace ws,
const Var::Numeric spacing = {},
const Var::Vector verbosityVect = {} 
)
inline

Automatcially calculate f_grid to match the sensor. This function is based on 'f_gridFromSensorAMSU'

The method calculates f_grid to match the instrument, as given by the backend frequencies f_backend, and the backend channel responses backend_channel_response.

You have to specify the desired spacing in the keyword spacing, which has a default value of 100 MHz. (The actual value is 0.1e9, since our unit is Hz.) The produced grid will not have exactly the requested spacing, but it will not be coarser than requested. The algorithm starts with the band edges, then adds additional points until the spacing is at least as fine as requested.

Author
Oscar Isoz
Parameters
[in,out]Workspacews - An ARTS workspace
[in]spacing- Desired grid spacing in Hz. (default: .1e9)
[in]verbosityVect- Bandwidth adjusted spacing (default: {})

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90414 of file autoarts.h.

◆ f_gridFromSensorHIRS()

MRecord ARTS::AgendaMethod::f_gridFromSensorHIRS ( [[maybe_unused] ] Workspace ws,
const Var::Numeric spacing = {} 
)
inline

Automatically calculate f_grid to match the sensor.

This method is handy if you are simulating a HIRS-type instrument, consisting of a few discrete channels.

It calculates f_grid to match the instrument, as given by the nominal band frequencies f_backend and the spectral channel response functions given by backend_channel_response.

You have to specify the desired spacing in the keyword spacing, which has a default value of 5e8 Hz.

The produced grid will not have exactly the requested spacing, but will not be coarser than requested. The algorithm starts with the band edges, then adds additional points until the spacing is at least as fine as requested.

There is a similar method for AMSU-type instruments, see f_gridFromSensorAMSU*.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]spacing- Desired grid spacing in Hz. (default: 5e8)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90468 of file autoarts.h.

◆ f_gridMetMM()

MRecord ARTS::AgendaMethod::f_gridMetMM ( [[maybe_unused] ] Workspace ws,
const Var::Vector freq_spacing = {},
const Var::ArrayOfIndex freq_number = {},
const Var::Numeric freq_merge_threshold = {} 
)
inline

Sets f_grid and associated variables match MetMM settings.

The method calculates f_grid to match the specifications of a met_mm_backend* table and method arguments.

You have to specify the desired spacing using the keyword freq_spacing. You can pass a Vector with one element to apply the same spacing to all channels or pass a spacing value for each channel separately.

Optionally, freq_number can be set to specify the mininum number of frequencies per passband for each channel. The frequencies are placed equally spaced in each passband. The minimum spacing resulting from freq_number* and freq_spacing will be used for the calculation. To explicitly use freq_spacing for a channel, freq_number can be set to -1 for this channel.

The number of elements in freq_number can either be the number of channels or 1. If only one element is given, this number is used for all channels. If freq_number is 1 and freq_spacing is wider than the bandwidth of the channel, one frequency is placed in the middle of each passband.

Frequencies that would be closer than freq_merge_threshold in the generated f_grid are merged together. This value should be left at the default value. This is only meant to compensate for numerical inaccuracies in the frequency calculation to merge frequency that are supposed to be identical.

Author
Oliver Lemke
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]freq_spacing- Desired grid spacing in Hz. (default: {.1e9})
[in]freq_number- Number of frequencies per passband for each channel. (default: {-1})
[in]freq_merge_threshold- Merge frequencies that are closer than this value in Hz. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90527 of file autoarts.h.

◆ FastemStandAlone()

MRecord ARTS::AgendaMethod::FastemStandAlone ( [[maybe_unused] ] Workspace ws,
Var::Matrix  emissivity,
Var::Matrix  reflectivity,
const Var::Numeric  za,
const Var::Numeric  wind_speed,
const Var::Numeric  rel_aa,
const Var::Vector  transmittance,
const Var::Numeric salinity = {},
const Var::Index fastem_version = {} 
)
inline

Stand-alone usage of FASTEM.

FASTEM is a parameterisation of the emissivity of water surfaces including the impact of waves, salinity and non-specular effects. This is more or less direct interface to FASTEM, but slightly adopted to fit with ARTS. The unit of frequency and salinity differ, and this version is "vectorised" in frequency.

The output is four emissivity and reflectivity values for each frequency. These values are defined in Eq. 13 of "An Improved Fast Microwave Water Emissivity Model" by Liu, Weng and English, I3TRGS, 2011. Note that emissivity and reflectivity do not add up to 1, which is the way FASTEM compensates for non-specular effects.

There is an error if any frequency is above 250 GHz, or if the skin temperature is below 260 K. If the skin temperature is below 270 K, it is adjusted to 270 K.

FASTEM returns unphysical values for propagation close to the horizon, here emissivity and reflectivity can be outside [0,1]. If either emissivity or reflectivity is below/above 0/1, it is set to 0/1, and the other value is set to 1/0. That is, e+r=1 is enforced. These problems start about 15 degrees from the horizon.

Author
Oliver Lemke, Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]emissivity- Emission values. One row for each frequency. See above.
[out]reflectivity- Reflectivity values. One row for each frequency. See above.
[in]za- Zenith angle of line-of-sigh, 90 to 180 deg.
[in]salinity- Salinity, 0-1. That is, 3% is given as 0.03. (default: 0.035)
[in]wind_speed- Wind speed.
[in]rel_aa- Azimuth angle between wind direction and line-of-sight. This angle is measured clockwise from north, i.e. E=90deg.
[in]transmittance- The transmission of the atmosphere, along the propagation path of the downwelling radiation. One value per frequency.
[in]fastem_version- The version of FASTEM to use. (default: 6)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89474 of file autoarts.h.

◆ FieldFromGriddedField() [1/4]

MRecord ARTS::AgendaMethod::FieldFromGriddedField ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::GriddedField2  in 
)
inline

Extract the data from a GriddedField.

A check is performed that the grids from the GriddedField match p_grid, lat_grid and lon_grid.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Extracted field.
[in]in- Raw input gridded field.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89532 of file autoarts.h.

References ARTS::Var::GriddedField2::islast(), ARTS::Var::Matrix::islast(), ARTS::Var::GriddedField2::pos(), and ARTS::Var::Matrix::pos().

◆ FieldFromGriddedField() [2/4]

MRecord ARTS::AgendaMethod::FieldFromGriddedField ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::GriddedField3  in 
)
inline

Extract the data from a GriddedField.

A check is performed that the grids from the GriddedField match p_grid, lat_grid and lon_grid.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Extracted field.
[in]in- Raw input gridded field.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89566 of file autoarts.h.

References ARTS::Var::GriddedField3::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::GriddedField3::pos(), and ARTS::Var::Tensor3::pos().

◆ FieldFromGriddedField() [3/4]

MRecord ARTS::AgendaMethod::FieldFromGriddedField ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::ArrayOfGriddedField3  in 
)
inline

Extract the data from a GriddedField.

A check is performed that the grids from the GriddedField match p_grid, lat_grid and lon_grid.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Extracted field.
[in]in- Raw input gridded field.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89634 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField3::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::ArrayOfGriddedField3::pos(), and ARTS::Var::Tensor4::pos().

◆ FieldFromGriddedField() [4/4]

MRecord ARTS::AgendaMethod::FieldFromGriddedField ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::GriddedField4  in 
)
inline

Extract the data from a GriddedField.

A check is performed that the grids from the GriddedField match p_grid, lat_grid and lon_grid.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Extracted field.
[in]in- Raw input gridded field.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89600 of file autoarts.h.

References ARTS::Var::GriddedField4::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::GriddedField4::pos(), and ARTS::Var::Tensor4::pos().

◆ FlagOff()

MRecord ARTS::AgendaMethod::FlagOff ( [[maybe_unused] ] Workspace ws,
Var::Index  flag 
)
inline

Sets an index variable that acts as an on/off flag to 0.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]flag- Variable to set to 0.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89664 of file autoarts.h.

◆ FlagOn()

MRecord ARTS::AgendaMethod::FlagOn ( [[maybe_unused] ] Workspace ws,
Var::Index  flag 
)
inline

Sets an index variable that acts as an on/off flag to 1.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]flag- Variable to set to 1.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89691 of file autoarts.h.

◆ Flatten() [1/8]

MRecord ARTS::AgendaMethod::Flatten ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTime  out,
const Var::ArrayOfArrayOfTime  in 
)
inline

Flattens an ArrayOfArray<T> to Array<T> or an Array of matpack-types to a larger dimension matpack (if dimensions agree)

The intended transformation for arrays is (sub-arrays can have different sizes): {{a, b, c}, {d, e}} -> {a, b, c, d, e}

The intended transformation for arrays to matpack types is (sub-types must have same size): {{a, b, c}, {d, e, f}} -> {a, b, c, d, e, f}

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Flatter array/matpack-type
[in]in- An array

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89726 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTime::islast(), ARTS::Var::ArrayOfTime::islast(), ARTS::Var::ArrayOfArrayOfTime::pos(), and ARTS::Var::ArrayOfTime::pos().

◆ Flatten() [2/8]

MRecord ARTS::AgendaMethod::Flatten ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfVector  out,
const Var::ArrayOfArrayOfVector  in 
)
inline

Flattens an ArrayOfArray<T> to Array<T> or an Array of matpack-types to a larger dimension matpack (if dimensions agree)

The intended transformation for arrays is (sub-arrays can have different sizes): {{a, b, c}, {d, e}} -> {a, b, c, d, e}

The intended transformation for arrays to matpack types is (sub-types must have same size): {{a, b, c}, {d, e, f}} -> {a, b, c, d, e, f}

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Flatter array/matpack-type
[in]in- An array

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89764 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfVector::islast(), ARTS::Var::ArrayOfVector::islast(), ARTS::Var::ArrayOfArrayOfVector::pos(), and ARTS::Var::ArrayOfVector::pos().

◆ Flatten() [3/8]

MRecord ARTS::AgendaMethod::Flatten ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::ArrayOfVector  in 
)
inline

Flattens an ArrayOfArray<T> to Array<T> or an Array of matpack-types to a larger dimension matpack (if dimensions agree)

The intended transformation for arrays is (sub-arrays can have different sizes): {{a, b, c}, {d, e}} -> {a, b, c, d, e}

The intended transformation for arrays to matpack types is (sub-types must have same size): {{a, b, c}, {d, e, f}} -> {a, b, c, d, e, f}

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Flatter array/matpack-type
[in]in- An array

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89802 of file autoarts.h.

References ARTS::Var::ArrayOfVector::islast(), ARTS::Var::Matrix::islast(), ARTS::Var::ArrayOfVector::pos(), and ARTS::Var::Matrix::pos().

◆ Flatten() [4/8]

MRecord ARTS::AgendaMethod::Flatten ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::ArrayOfMatrix  in 
)
inline

Flattens an ArrayOfArray<T> to Array<T> or an Array of matpack-types to a larger dimension matpack (if dimensions agree)

The intended transformation for arrays is (sub-arrays can have different sizes): {{a, b, c}, {d, e}} -> {a, b, c, d, e}

The intended transformation for arrays to matpack types is (sub-types must have same size): {{a, b, c}, {d, e, f}} -> {a, b, c, d, e, f}

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Flatter array/matpack-type
[in]in- An array

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89840 of file autoarts.h.

References ARTS::Var::ArrayOfMatrix::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::ArrayOfMatrix::pos(), and ARTS::Var::Tensor3::pos().

◆ Flatten() [5/8]

MRecord ARTS::AgendaMethod::Flatten ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::ArrayOfTensor3  in 
)
inline

Flattens an ArrayOfArray<T> to Array<T> or an Array of matpack-types to a larger dimension matpack (if dimensions agree)

The intended transformation for arrays is (sub-arrays can have different sizes): {{a, b, c}, {d, e}} -> {a, b, c, d, e}

The intended transformation for arrays to matpack types is (sub-types must have same size): {{a, b, c}, {d, e, f}} -> {a, b, c, d, e, f}

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Flatter array/matpack-type
[in]in- An array

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89878 of file autoarts.h.

References ARTS::Var::ArrayOfTensor3::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::ArrayOfTensor3::pos(), and ARTS::Var::Tensor4::pos().

◆ Flatten() [6/8]

MRecord ARTS::AgendaMethod::Flatten ( [[maybe_unused] ] Workspace ws,
Var::Tensor5  out,
const Var::ArrayOfTensor4  in 
)
inline

Flattens an ArrayOfArray<T> to Array<T> or an Array of matpack-types to a larger dimension matpack (if dimensions agree)

The intended transformation for arrays is (sub-arrays can have different sizes): {{a, b, c}, {d, e}} -> {a, b, c, d, e}

The intended transformation for arrays to matpack types is (sub-types must have same size): {{a, b, c}, {d, e, f}} -> {a, b, c, d, e, f}

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Flatter array/matpack-type
[in]in- An array

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89916 of file autoarts.h.

References ARTS::Var::ArrayOfTensor4::islast(), ARTS::Var::Tensor5::islast(), ARTS::Var::ArrayOfTensor4::pos(), and ARTS::Var::Tensor5::pos().

◆ Flatten() [7/8]

MRecord ARTS::AgendaMethod::Flatten ( [[maybe_unused] ] Workspace ws,
Var::Tensor6  out,
const Var::ArrayOfTensor5  in 
)
inline

Flattens an ArrayOfArray<T> to Array<T> or an Array of matpack-types to a larger dimension matpack (if dimensions agree)

The intended transformation for arrays is (sub-arrays can have different sizes): {{a, b, c}, {d, e}} -> {a, b, c, d, e}

The intended transformation for arrays to matpack types is (sub-types must have same size): {{a, b, c}, {d, e, f}} -> {a, b, c, d, e, f}

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Flatter array/matpack-type
[in]in- An array

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89954 of file autoarts.h.

References ARTS::Var::ArrayOfTensor5::islast(), ARTS::Var::Tensor6::islast(), ARTS::Var::ArrayOfTensor5::pos(), and ARTS::Var::Tensor6::pos().

◆ Flatten() [8/8]

MRecord ARTS::AgendaMethod::Flatten ( [[maybe_unused] ] Workspace ws,
Var::Tensor7  out,
const Var::ArrayOfTensor6  in 
)
inline

Flattens an ArrayOfArray<T> to Array<T> or an Array of matpack-types to a larger dimension matpack (if dimensions agree)

The intended transformation for arrays is (sub-arrays can have different sizes): {{a, b, c}, {d, e}} -> {a, b, c, d, e}

The intended transformation for arrays to matpack types is (sub-types must have same size): {{a, b, c}, {d, e, f}} -> {a, b, c, d, e, f}

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Flatter array/matpack-type
[in]in- An array

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 89992 of file autoarts.h.

References ARTS::Var::ArrayOfTensor6::islast(), ARTS::Var::Tensor7::islast(), ARTS::Var::ArrayOfTensor6::pos(), and ARTS::Var::Tensor7::pos().

◆ ForLoop()

MRecord ARTS::AgendaMethod::ForLoop ( [[maybe_unused] ] Workspace ws,
const Var::Index  start,
const Var::Index  stop,
const Var::Index  step 
)
inline

A simple for-loop.

This method is handy when you quickly want to test out a calculation with a set of different settings.

It does a for-loop from start to stop in steps of step (who would have guessed that). For each iteration, the agenda forloop_agenda is executed. Inside the agenda, the variable forloop_index is available as index counter.

There are no other inputs to forloop_agenda, and also no outputs. That means, if you want to get any results out of this loop, you have to save it to files (for example with WriteXMLIndexed), since variables used inside the agenda will only be local.

Note that this kind of for loop is not parallel.

The method is intended for simple testing, not as a replacement of ybatchCalc*. However, it is compatible with ybatchCalc, in the sense that ybatchCalc may occur inside forloop_agenda.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]start- Start value.
[in]stop- End value.
[in]step- Step size.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90043 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::Index::pos(), and Zeeman::start().

◆ FrequencyFromCGSAngularWavenumber() [1/2]

MRecord ARTS::AgendaMethod::FrequencyFromCGSAngularWavenumber ( [[maybe_unused] ] Workspace ws,
Var::Numeric  frequency,
const Var::Numeric  angular_wavenumber 
)
inline

Convert from angular wavenumber [cm^-1] to frequency [Hz].

This converts angular wavenumber (2*PI/wavelength) into frequency.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]frequency- frequency [Hz]
[in]angular_wavenumber- angular wavenumber [cm^-1]

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90145 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ FrequencyFromCGSAngularWavenumber() [2/2]

MRecord ARTS::AgendaMethod::FrequencyFromCGSAngularWavenumber ( [[maybe_unused] ] Workspace ws,
Var::Vector  frequency,
const Var::Vector  angular_wavenumber 
)
inline

Convert from angular wavenumber [cm^-1] to frequency [Hz].

This converts angular wavenumber (2*PI/wavelength) into frequency.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]frequency- frequency [Hz]
[in]angular_wavenumber- angular wavenumber [cm^-1]

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90178 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ FrequencyFromCGSKayserWavenumber() [1/2]

MRecord ARTS::AgendaMethod::FrequencyFromCGSKayserWavenumber ( [[maybe_unused] ] Workspace ws,
Var::Numeric  frequency,
const Var::Numeric  kayser_wavenumber 
)
inline

Convert from Kayser wavenumber [cm^-1] to frequency [Hz].

This converts Kayser wavenumber (1/wavelength) into frequency.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]frequency- frequency [Hz]
[in]kayser_wavenumber- Kayser wavenumber [cm^-1]

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90211 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ FrequencyFromCGSKayserWavenumber() [2/2]

MRecord ARTS::AgendaMethod::FrequencyFromCGSKayserWavenumber ( [[maybe_unused] ] Workspace ws,
Var::Vector  frequency,
const Var::Vector  kayser_wavenumber 
)
inline

Convert from Kayser wavenumber [cm^-1] to frequency [Hz].

This converts Kayser wavenumber (1/wavelength) into frequency.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]frequency- frequency [Hz]
[in]kayser_wavenumber- Kayser wavenumber [cm^-1]

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90244 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ FrequencyFromWavelength() [1/2]

MRecord ARTS::AgendaMethod::FrequencyFromWavelength ( [[maybe_unused] ] Workspace ws,
Var::Numeric  frequency,
const Var::Numeric  wavelength 
)
inline

Convert from wavelength [m] to frequency [Hz].

This is a generic method. It can take a single wavelength value or a wavelength vector as input.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[out]frequency- frequency [Hz]
[in]wavelength- wavelength [m]

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90079 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ FrequencyFromWavelength() [2/2]

MRecord ARTS::AgendaMethod::FrequencyFromWavelength ( [[maybe_unused] ] Workspace ws,
Var::Vector  frequency,
const Var::Vector  wavelength 
)
inline

Convert from wavelength [m] to frequency [Hz].

This is a generic method. It can take a single wavelength value or a wavelength vector as input.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[out]frequency- frequency [Hz]
[in]wavelength- wavelength [m]

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90112 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ g0Earth()

MRecord ARTS::AgendaMethod::g0Earth ( [[maybe_unused] ] Workspace ws)
inline

Gravity at zero altitude on Earth.

Sets g0 for the given latitude using a standard parameterisation.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90570 of file autoarts.h.

◆ g0Io()

MRecord ARTS::AgendaMethod::g0Io ( [[maybe_unused] ] Workspace ws)
inline

Gravity at zero altitude on Io.

Numeric from Wikipedia.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90593 of file autoarts.h.

◆ g0Jupiter()

MRecord ARTS::AgendaMethod::g0Jupiter ( [[maybe_unused] ] Workspace ws)
inline

Gravity at zero altitude on Jupiter.

Sets g0 to mean equatorial gravity on Jupiter. Value provided by MPS under ESA-planetary study (TN1).

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90617 of file autoarts.h.

◆ g0Mars()

MRecord ARTS::AgendaMethod::g0Mars ( [[maybe_unused] ] Workspace ws)
inline

Gravity at zero altitude on Mars.

Sets g0 to mean equatorial gravity on Mars. Value provided by MPS under ESA-planetary study (TN1).

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90641 of file autoarts.h.

◆ g0Venus()

MRecord ARTS::AgendaMethod::g0Venus ( [[maybe_unused] ] Workspace ws)
inline

Gravity at zero altitude on Venus.

Sets g0 to mean equatorial gravity on Venus. Value from Ahrens (1995), provided by MPS under ESA-planetary study (TN1).

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90665 of file autoarts.h.

◆ geo_posEndOfPpath()

MRecord ARTS::AgendaMethod::geo_posEndOfPpath ( [[maybe_unused] ] Workspace ws)
inline

Sets geo-position based on ppath.

The geo-position is set to the position of the last point of the present propagation path. This will be the surface, top-of-the atmosphere or cloudbox position, depending of observation geometry and if the cloudbox is active.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90691 of file autoarts.h.

◆ geo_posLowestAltitudeOfPpath()

MRecord ARTS::AgendaMethod::geo_posLowestAltitudeOfPpath ( [[maybe_unused] ] Workspace ws)
inline

Sets geo-position based on ppath.

The geo-position is set to the position of the last point of the present propagation path having the lowest altitude.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90715 of file autoarts.h.

◆ geo_posWherePpathPassesZref()

MRecord ARTS::AgendaMethod::geo_posWherePpathPassesZref ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  z_ref 
)
inline

Sets geo-position based on ppath.

The geo-position is set to the position where the propagation path passes the reference altitude. If this altitude is passes more than once, the passing closest to the sensor is selected. If the reference altitude is not passed at all, geo_pos is set to NaN.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]z_ref- Reference altitude.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90743 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ GetEnvironmentVariable() [1/2]

MRecord ARTS::AgendaMethod::GetEnvironmentVariable ( [[maybe_unused] ] Workspace ws,
Var::Index  out,
const Var::String  in 
)
inline

Copy the contents of an environment variable to an ARTS String or Index.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Contents of environment variable.
[in]in- Name of environment variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90802 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::String::islast(), ARTS::Var::Index::pos(), and ARTS::Var::String::pos().

◆ GetEnvironmentVariable() [2/2]

MRecord ARTS::AgendaMethod::GetEnvironmentVariable ( [[maybe_unused] ] Workspace ws,
Var::String  out,
const Var::String  in 
)
inline

Copy the contents of an environment variable to an ARTS String or Index.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Contents of environment variable.
[in]in- Name of environment variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90771 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ GetNumberOfThreads()

MRecord ARTS::AgendaMethod::GetNumberOfThreads ( [[maybe_unused] ] Workspace ws,
Var::Index  nthreads 
)
inline

Returns the number of threads used by ARTS.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]nthreads- Number of threads.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90832 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ GriddedFieldGetName() [1/6]

MRecord ARTS::AgendaMethod::GriddedFieldGetName ( [[maybe_unused] ] Workspace ws,
Var::String  name,
const Var::GriddedField1  griddedfield 
)
inline

Get the name of a GriddedField.

See ArrayOfGriddedFieldGetNames.

Author
Lukas Kluft
Parameters
[in,out]Workspacews - An ARTS workspace
[out]name- Name of the GriddedField.
[in]griddedfield- GriddedField.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90862 of file autoarts.h.

References ARTS::Var::GriddedField1::islast(), ARTS::Var::String::islast(), ARTS::Var::GriddedField1::pos(), and ARTS::Var::String::pos().

◆ GriddedFieldGetName() [2/6]

MRecord ARTS::AgendaMethod::GriddedFieldGetName ( [[maybe_unused] ] Workspace ws,
Var::String  name,
const Var::GriddedField2  griddedfield 
)
inline

Get the name of a GriddedField.

See ArrayOfGriddedFieldGetNames.

Author
Lukas Kluft
Parameters
[in,out]Workspacews - An ARTS workspace
[out]name- Name of the GriddedField.
[in]griddedfield- GriddedField.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90895 of file autoarts.h.

References ARTS::Var::GriddedField2::islast(), ARTS::Var::String::islast(), ARTS::Var::GriddedField2::pos(), and ARTS::Var::String::pos().

◆ GriddedFieldGetName() [3/6]

MRecord ARTS::AgendaMethod::GriddedFieldGetName ( [[maybe_unused] ] Workspace ws,
Var::String  name,
const Var::GriddedField3  griddedfield 
)
inline

Get the name of a GriddedField.

See ArrayOfGriddedFieldGetNames.

Author
Lukas Kluft
Parameters
[in,out]Workspacews - An ARTS workspace
[out]name- Name of the GriddedField.
[in]griddedfield- GriddedField.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90928 of file autoarts.h.

References ARTS::Var::GriddedField3::islast(), ARTS::Var::String::islast(), ARTS::Var::GriddedField3::pos(), and ARTS::Var::String::pos().

◆ GriddedFieldGetName() [4/6]

MRecord ARTS::AgendaMethod::GriddedFieldGetName ( [[maybe_unused] ] Workspace ws,
Var::String  name,
const Var::GriddedField4  griddedfield 
)
inline

Get the name of a GriddedField.

See ArrayOfGriddedFieldGetNames.

Author
Lukas Kluft
Parameters
[in,out]Workspacews - An ARTS workspace
[out]name- Name of the GriddedField.
[in]griddedfield- GriddedField.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90961 of file autoarts.h.

References ARTS::Var::GriddedField4::islast(), ARTS::Var::String::islast(), ARTS::Var::GriddedField4::pos(), and ARTS::Var::String::pos().

◆ GriddedFieldGetName() [5/6]

MRecord ARTS::AgendaMethod::GriddedFieldGetName ( [[maybe_unused] ] Workspace ws,
Var::String  name,
const Var::GriddedField5  griddedfield 
)
inline

Get the name of a GriddedField.

See ArrayOfGriddedFieldGetNames.

Author
Lukas Kluft
Parameters
[in,out]Workspacews - An ARTS workspace
[out]name- Name of the GriddedField.
[in]griddedfield- GriddedField.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 90994 of file autoarts.h.

References ARTS::Var::GriddedField5::islast(), ARTS::Var::String::islast(), ARTS::Var::GriddedField5::pos(), and ARTS::Var::String::pos().

◆ GriddedFieldGetName() [6/6]

MRecord ARTS::AgendaMethod::GriddedFieldGetName ( [[maybe_unused] ] Workspace ws,
Var::String  name,
const Var::GriddedField6  griddedfield 
)
inline

Get the name of a GriddedField.

See ArrayOfGriddedFieldGetNames.

Author
Lukas Kluft
Parameters
[in,out]Workspacews - An ARTS workspace
[out]name- Name of the GriddedField.
[in]griddedfield- GriddedField.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91027 of file autoarts.h.

References ARTS::Var::GriddedField6::islast(), ARTS::Var::String::islast(), ARTS::Var::GriddedField6::pos(), and ARTS::Var::String::pos().

◆ GriddedFieldLatLonExpand() [1/4]

MRecord ARTS::AgendaMethod::GriddedFieldLatLonExpand ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField3  out,
const Var::ArrayOfGriddedField3  in 
)
inline

Expands the latitude and longitude grid of the GriddedField to [-90, 90] and [0,360], respectively. Expansion is only done in the dimension(s), where the grid size is 1. The values from the input data will be duplicated to accomodate for the larger size of the output field. gfield_raw_out and gfield_raw_in can be the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Expanded gridded field.
[in]in- Raw input gridded field.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91171 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfGriddedField3::pos().

◆ GriddedFieldLatLonExpand() [2/4]

MRecord ARTS::AgendaMethod::GriddedFieldLatLonExpand ( [[maybe_unused] ] Workspace ws,
Var::GriddedField2  out,
const Var::GriddedField2  in 
)
inline

Expands the latitude and longitude grid of the GriddedField to [-90, 90] and [0,360], respectively. Expansion is only done in the dimension(s), where the grid size is 1. The values from the input data will be duplicated to accomodate for the larger size of the output field. gfield_raw_out and gfield_raw_in can be the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Expanded gridded field.
[in]in- Raw input gridded field.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91063 of file autoarts.h.

References ARTS::Var::GriddedField2::islast(), and ARTS::Var::GriddedField2::pos().

◆ GriddedFieldLatLonExpand() [3/4]

MRecord ARTS::AgendaMethod::GriddedFieldLatLonExpand ( [[maybe_unused] ] Workspace ws,
Var::GriddedField3  out,
const Var::GriddedField3  in 
)
inline

Expands the latitude and longitude grid of the GriddedField to [-90, 90] and [0,360], respectively. Expansion is only done in the dimension(s), where the grid size is 1. The values from the input data will be duplicated to accomodate for the larger size of the output field. gfield_raw_out and gfield_raw_in can be the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Expanded gridded field.
[in]in- Raw input gridded field.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91099 of file autoarts.h.

References ARTS::Var::GriddedField3::islast(), and ARTS::Var::GriddedField3::pos().

◆ GriddedFieldLatLonExpand() [4/4]

MRecord ARTS::AgendaMethod::GriddedFieldLatLonExpand ( [[maybe_unused] ] Workspace ws,
Var::GriddedField4  out,
const Var::GriddedField4  in 
)
inline

Expands the latitude and longitude grid of the GriddedField to [-90, 90] and [0,360], respectively. Expansion is only done in the dimension(s), where the grid size is 1. The values from the input data will be duplicated to accomodate for the larger size of the output field. gfield_raw_out and gfield_raw_in can be the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Expanded gridded field.
[in]in- Raw input gridded field.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91135 of file autoarts.h.

References ARTS::Var::GriddedField4::islast(), and ARTS::Var::GriddedField4::pos().

◆ GriddedFieldLatLonRegrid() [1/4]

MRecord ARTS::AgendaMethod::GriddedFieldLatLonRegrid ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField3  out,
const Var::ArrayOfGriddedField3  in,
const Var::Index interp_order = {} 
)
inline

Interpolates the input field along the latitude and longitude dimensions to lat_true and lon_true.

If the input longitude grid is outside of lon_true it will be shifted left or right by 360. If it covers 360 degrees, a cyclic interpolation will be performed. in and out fields can be the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Regridded gridded field.
[in]in- Raw input gridded field.
[in]interp_order- Interpolation order. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91341 of file autoarts.h.

◆ GriddedFieldLatLonRegrid() [2/4]

MRecord ARTS::AgendaMethod::GriddedFieldLatLonRegrid ( [[maybe_unused] ] Workspace ws,
Var::GriddedField2  out,
const Var::GriddedField2  in,
const Var::Index interp_order = {} 
)
inline

Interpolates the input field along the latitude and longitude dimensions to lat_true and lon_true.

If the input longitude grid is outside of lon_true it will be shifted left or right by 360. If it covers 360 degrees, a cyclic interpolation will be performed. in and out fields can be the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Regridded gridded field.
[in]in- Raw input gridded field.
[in]interp_order- Interpolation order. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91209 of file autoarts.h.

◆ GriddedFieldLatLonRegrid() [3/4]

MRecord ARTS::AgendaMethod::GriddedFieldLatLonRegrid ( [[maybe_unused] ] Workspace ws,
Var::GriddedField3  out,
const Var::GriddedField3  in,
const Var::Index interp_order = {} 
)
inline

Interpolates the input field along the latitude and longitude dimensions to lat_true and lon_true.

If the input longitude grid is outside of lon_true it will be shifted left or right by 360. If it covers 360 degrees, a cyclic interpolation will be performed. in and out fields can be the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Regridded gridded field.
[in]in- Raw input gridded field.
[in]interp_order- Interpolation order. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91253 of file autoarts.h.

◆ GriddedFieldLatLonRegrid() [4/4]

MRecord ARTS::AgendaMethod::GriddedFieldLatLonRegrid ( [[maybe_unused] ] Workspace ws,
Var::GriddedField4  out,
const Var::GriddedField4  in,
const Var::Index interp_order = {} 
)
inline

Interpolates the input field along the latitude and longitude dimensions to lat_true and lon_true.

If the input longitude grid is outside of lon_true it will be shifted left or right by 360. If it covers 360 degrees, a cyclic interpolation will be performed. in and out fields can be the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Regridded gridded field.
[in]in- Raw input gridded field.
[in]interp_order- Interpolation order. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91297 of file autoarts.h.

◆ GriddedFieldPRegrid() [1/3]

MRecord ARTS::AgendaMethod::GriddedFieldPRegrid ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField3  out,
const Var::ArrayOfGriddedField3  in,
const Var::Index interp_order = {},
const Var::Index zeropadding = {} 
)
inline

Interpolates the input field along the pressure dimension to p_grid.

If zero-padding is applied (zeropadding=1), pressures that are outside the p_grid are set to 0. This is thought, e.g., for VMR fields that outside the given pressure can safely be assumed to be zero. Note: Using zeropadding for altitude and temperature fields is strongly discouraged (it will work here, though, but likely trigger errors later on). Extrapolation is allowed within the common 0.5grid-step margin, but is overruled by zeropadding. in and out fields can be the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Regridded gridded field.
[in]in- Raw input gridded field.
[in]interp_order- Interpolation order. (default: 1)
[in]zeropadding- Apply zero-padding. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91503 of file autoarts.h.

◆ GriddedFieldPRegrid() [2/3]

MRecord ARTS::AgendaMethod::GriddedFieldPRegrid ( [[maybe_unused] ] Workspace ws,
Var::GriddedField3  out,
const Var::GriddedField3  in,
const Var::Index interp_order = {},
const Var::Index zeropadding = {} 
)
inline

Interpolates the input field along the pressure dimension to p_grid.

If zero-padding is applied (zeropadding=1), pressures that are outside the p_grid are set to 0. This is thought, e.g., for VMR fields that outside the given pressure can safely be assumed to be zero. Note: Using zeropadding for altitude and temperature fields is strongly discouraged (it will work here, though, but likely trigger errors later on). Extrapolation is allowed within the common 0.5grid-step margin, but is overruled by zeropadding. in and out fields can be the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Regridded gridded field.
[in]in- Raw input gridded field.
[in]interp_order- Interpolation order. (default: 1)
[in]zeropadding- Apply zero-padding. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91391 of file autoarts.h.

◆ GriddedFieldPRegrid() [3/3]

MRecord ARTS::AgendaMethod::GriddedFieldPRegrid ( [[maybe_unused] ] Workspace ws,
Var::GriddedField4  out,
const Var::GriddedField4  in,
const Var::Index interp_order = {},
const Var::Index zeropadding = {} 
)
inline

Interpolates the input field along the pressure dimension to p_grid.

If zero-padding is applied (zeropadding=1), pressures that are outside the p_grid are set to 0. This is thought, e.g., for VMR fields that outside the given pressure can safely be assumed to be zero. Note: Using zeropadding for altitude and temperature fields is strongly discouraged (it will work here, though, but likely trigger errors later on). Extrapolation is allowed within the common 0.5grid-step margin, but is overruled by zeropadding. in and out fields can be the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Regridded gridded field.
[in]in- Raw input gridded field.
[in]interp_order- Interpolation order. (default: 1)
[in]zeropadding- Apply zero-padding. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91447 of file autoarts.h.

◆ GriddedFieldZToPRegrid()

MRecord ARTS::AgendaMethod::GriddedFieldZToPRegrid ( [[maybe_unused] ] Workspace ws,
Var::GriddedField3  out,
const Var::GriddedField3  in,
const Var::Index interp_order = {},
const Var::Index zeropadding = {} 
)
inline

Interpolates the input field along the vertical dimension to p_grid.

This is done from z_field, and thus requires the atmosphere to be set beforehand.

The latitude and longitude grid of the input field must match lat_grid and lon_grid for the method to work.

BETA mode.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Regridded output; Pressure-gridded field.
[in]in- Raw input; Altitude-gridded field.
[in]interp_order- Interpolation order. (default: 1)
[in]zeropadding- Apply zero-padding. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91556 of file autoarts.h.

◆ heating_ratesFromIrradiance()

MRecord ARTS::AgendaMethod::heating_ratesFromIrradiance ( [[maybe_unused] ] Workspace ws)
inline

Calculates heating rates. It assumes that the heating rates depend only on the vertical derivation of the net flux. The net flux is the sum of the irradiance field in upward direction and the irradiance field in downward direction

Author
Manfred Brath
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91600 of file autoarts.h.

◆ Ignore() [1/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::AbsorptionLines  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91639 of file autoarts.h.

References ARTS::Var::AbsorptionLines::islast(), and ARTS::Var::AbsorptionLines::pos().

◆ Ignore() [2/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Agenda  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91683 of file autoarts.h.

References ARTS::Var::Agenda::islast(), and ARTS::Var::Agenda::pos().

◆ Ignore() [3/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAbsorptionLines  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91727 of file autoarts.h.

References ARTS::Var::ArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfAbsorptionLines::pos().

◆ Ignore() [4/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAgenda  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91815 of file autoarts.h.

References ARTS::Var::ArrayOfAgenda::islast(), and ARTS::Var::ArrayOfAgenda::pos().

◆ Ignore() [5/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfAbsorptionLines  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91771 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfArrayOfAbsorptionLines::pos().

◆ Ignore() [6/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField1  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91859 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField1::pos().

◆ Ignore() [7/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField2  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91903 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField2::pos().

◆ Ignore() [8/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField3  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91947 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField3::pos().

◆ Ignore() [9/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfIndex  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 91991 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfIndex::islast(), and ARTS::Var::ArrayOfArrayOfIndex::pos().

◆ Ignore() [10/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfMatrix  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92035 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfMatrix::islast(), and ARTS::Var::ArrayOfArrayOfMatrix::pos().

◆ Ignore() [11/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfPropagationMatrix  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92123 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfArrayOfPropagationMatrix::pos().

◆ Ignore() [12/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfRadiationVector  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92167 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfArrayOfRadiationVector::pos().

◆ Ignore() [13/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfScatteringMetaData  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92211 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfArrayOfScatteringMetaData::pos().

◆ Ignore() [14/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSingleScatteringData  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92255 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfArrayOfSingleScatteringData::pos().

◆ Ignore() [15/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSpeciesTag  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92299 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSpeciesTag::islast(), and ARTS::Var::ArrayOfArrayOfSpeciesTag::pos().

◆ Ignore() [16/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfStokesVector  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92343 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfArrayOfStokesVector::pos().

◆ Ignore() [17/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfString  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92387 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfString::islast(), and ARTS::Var::ArrayOfArrayOfString::pos().

◆ Ignore() [18/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor3  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92431 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor3::islast(), and ARTS::Var::ArrayOfArrayOfTensor3::pos().

◆ Ignore() [19/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor6  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92475 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor6::islast(), and ARTS::Var::ArrayOfArrayOfTensor6::pos().

◆ Ignore() [20/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTime  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92519 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTime::islast(), and ARTS::Var::ArrayOfArrayOfTime::pos().

◆ Ignore() [21/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTransmissionMatrix  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92563 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfArrayOfTransmissionMatrix::pos().

◆ Ignore() [22/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfVector  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92607 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfVector::islast(), and ARTS::Var::ArrayOfArrayOfVector::pos().

◆ Ignore() [23/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfCIARecord  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92651 of file autoarts.h.

References ARTS::Var::ArrayOfCIARecord::islast(), and ARTS::Var::ArrayOfCIARecord::pos().

◆ Ignore() [24/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField1  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92695 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfGriddedField1::pos().

◆ Ignore() [25/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField2  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92739 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfGriddedField2::pos().

◆ Ignore() [26/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField3  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92783 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfGriddedField3::pos().

◆ Ignore() [27/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField4  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92827 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField4::islast(), and ARTS::Var::ArrayOfGriddedField4::pos().

◆ Ignore() [28/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfIndex  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92871 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), and ARTS::Var::ArrayOfIndex::pos().

◆ Ignore() [29/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92915 of file autoarts.h.

References ARTS::Var::ArrayOfMatrix::islast(), and ARTS::Var::ArrayOfMatrix::pos().

◆ Ignore() [30/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPpath  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92079 of file autoarts.h.

References ARTS::Var::ArrayOfPpath::islast(), and ARTS::Var::ArrayOfPpath::pos().

◆ Ignore() [31/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPropagationMatrix  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 92959 of file autoarts.h.

References ARTS::Var::ArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfPropagationMatrix::pos().

◆ Ignore() [32/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93003 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), and ARTS::Var::ArrayOfQuantumIdentifier::pos().

◆ Ignore() [33/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRadiationVector  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93047 of file autoarts.h.

References ARTS::Var::ArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfRadiationVector::pos().

◆ Ignore() [34/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRetrievalQuantity  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93091 of file autoarts.h.

References ARTS::Var::ArrayOfRetrievalQuantity::islast(), and ARTS::Var::ArrayOfRetrievalQuantity::pos().

◆ Ignore() [35/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfScatteringMetaData  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93135 of file autoarts.h.

References ARTS::Var::ArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfScatteringMetaData::pos().

◆ Ignore() [36/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSingleScatteringData  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93179 of file autoarts.h.

References ARTS::Var::ArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfSingleScatteringData::pos().

◆ Ignore() [37/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSparse  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93223 of file autoarts.h.

References ARTS::Var::ArrayOfSparse::islast(), and ARTS::Var::ArrayOfSparse::pos().

◆ Ignore() [38/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfStokesVector  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93267 of file autoarts.h.

References ARTS::Var::ArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfStokesVector::pos().

◆ Ignore() [39/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93311 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), and ARTS::Var::ArrayOfString::pos().

◆ Ignore() [40/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTelsemAtlas  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93355 of file autoarts.h.

References ARTS::Var::ArrayOfTelsemAtlas::islast(), and ARTS::Var::ArrayOfTelsemAtlas::pos().

◆ Ignore() [41/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor3  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93399 of file autoarts.h.

References ARTS::Var::ArrayOfTensor3::islast(), and ARTS::Var::ArrayOfTensor3::pos().

◆ Ignore() [42/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor4  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93443 of file autoarts.h.

References ARTS::Var::ArrayOfTensor4::islast(), and ARTS::Var::ArrayOfTensor4::pos().

◆ Ignore() [43/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor5  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93487 of file autoarts.h.

References ARTS::Var::ArrayOfTensor5::islast(), and ARTS::Var::ArrayOfTensor5::pos().

◆ Ignore() [44/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor6  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93531 of file autoarts.h.

References ARTS::Var::ArrayOfTensor6::islast(), and ARTS::Var::ArrayOfTensor6::pos().

◆ Ignore() [45/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor7  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93575 of file autoarts.h.

References ARTS::Var::ArrayOfTensor7::islast(), and ARTS::Var::ArrayOfTensor7::pos().

◆ Ignore() [46/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTime  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93619 of file autoarts.h.

References ARTS::Var::ArrayOfTime::islast(), and ARTS::Var::ArrayOfTime::pos().

◆ Ignore() [47/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTransmissionMatrix  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93663 of file autoarts.h.

References ARTS::Var::ArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfTransmissionMatrix::pos().

◆ Ignore() [48/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfVector  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93707 of file autoarts.h.

References ARTS::Var::ArrayOfVector::islast(), and ARTS::Var::ArrayOfVector::pos().

◆ Ignore() [49/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfXsecRecord  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93751 of file autoarts.h.

References ARTS::Var::ArrayOfXsecRecord::islast(), and ARTS::Var::ArrayOfXsecRecord::pos().

◆ Ignore() [50/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::CIARecord  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93795 of file autoarts.h.

References ARTS::Var::CIARecord::islast(), and ARTS::Var::CIARecord::pos().

◆ Ignore() [51/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::CovarianceMatrix  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93839 of file autoarts.h.

References ARTS::Var::CovarianceMatrix::islast(), and ARTS::Var::CovarianceMatrix::pos().

◆ Ignore() [52/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::EnergyLevelMap  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93883 of file autoarts.h.

References ARTS::Var::EnergyLevelMap::islast(), and ARTS::Var::EnergyLevelMap::pos().

◆ Ignore() [53/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::GasAbsLookup  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93927 of file autoarts.h.

References ARTS::Var::GasAbsLookup::islast(), and ARTS::Var::GasAbsLookup::pos().

◆ Ignore() [54/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField1  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94015 of file autoarts.h.

References ARTS::Var::GriddedField1::islast(), and ARTS::Var::GriddedField1::pos().

◆ Ignore() [55/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField2  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94059 of file autoarts.h.

References ARTS::Var::GriddedField2::islast(), and ARTS::Var::GriddedField2::pos().

◆ Ignore() [56/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField3  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94103 of file autoarts.h.

References ARTS::Var::GriddedField3::islast(), and ARTS::Var::GriddedField3::pos().

◆ Ignore() [57/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField4  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94147 of file autoarts.h.

References ARTS::Var::GriddedField4::islast(), and ARTS::Var::GriddedField4::pos().

◆ Ignore() [58/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField5  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94191 of file autoarts.h.

References ARTS::Var::GriddedField5::islast(), and ARTS::Var::GriddedField5::pos().

◆ Ignore() [59/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField6  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94235 of file autoarts.h.

References ARTS::Var::GriddedField6::islast(), and ARTS::Var::GriddedField6::pos().

◆ Ignore() [60/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::GridPos  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 93971 of file autoarts.h.

References ARTS::Var::GridPos::islast(), and ARTS::Var::GridPos::pos().

◆ Ignore() [61/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::HitranRelaxationMatrixData  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94279 of file autoarts.h.

References ARTS::Var::HitranRelaxationMatrixData::islast(), and ARTS::Var::HitranRelaxationMatrixData::pos().

◆ Ignore() [62/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Index  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94323 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ Ignore() [63/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94411 of file autoarts.h.

References ARTS::Var::Matrix::islast(), and ARTS::Var::Matrix::pos().

◆ Ignore() [64/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::MCAntenna  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94367 of file autoarts.h.

References ARTS::Var::MCAntenna::islast(), and ARTS::Var::MCAntenna::pos().

◆ Ignore() [65/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94455 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ Ignore() [66/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Ppath  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94499 of file autoarts.h.

References ARTS::Var::Ppath::islast(), and ARTS::Var::Ppath::pos().

◆ Ignore() [67/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::PropagationMatrix  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94543 of file autoarts.h.

References ARTS::Var::PropagationMatrix::islast(), and ARTS::Var::PropagationMatrix::pos().

◆ Ignore() [68/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94587 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ Ignore() [69/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::RadiationVector  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94631 of file autoarts.h.

References ARTS::Var::RadiationVector::islast(), and ARTS::Var::RadiationVector::pos().

◆ Ignore() [70/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Rational  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94675 of file autoarts.h.

References ARTS::Var::Rational::islast(), and ARTS::Var::Rational::pos().

◆ Ignore() [71/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::ScatteringMetaData  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94719 of file autoarts.h.

References ARTS::Var::ScatteringMetaData::islast(), and ARTS::Var::ScatteringMetaData::pos().

◆ Ignore() [72/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::SingleScatteringData  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94763 of file autoarts.h.

References ARTS::Var::SingleScatteringData::islast(), and ARTS::Var::SingleScatteringData::pos().

◆ Ignore() [73/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94807 of file autoarts.h.

References ARTS::Var::Sparse::islast(), and ARTS::Var::Sparse::pos().

◆ Ignore() [74/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::SpeciesAuxData  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94851 of file autoarts.h.

References ARTS::Var::SpeciesAuxData::islast(), and ARTS::Var::SpeciesAuxData::pos().

◆ Ignore() [75/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::StokesVector  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94895 of file autoarts.h.

References ARTS::Var::StokesVector::islast(), and ARTS::Var::StokesVector::pos().

◆ Ignore() [76/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::String  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94939 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ Ignore() [77/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::TelsemAtlas  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 94983 of file autoarts.h.

References ARTS::Var::TelsemAtlas::islast(), and ARTS::Var::TelsemAtlas::pos().

◆ Ignore() [78/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95027 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), and ARTS::Var::Tensor3::pos().

◆ Ignore() [79/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95071 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), and ARTS::Var::Tensor4::pos().

◆ Ignore() [80/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95115 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), and ARTS::Var::Tensor5::pos().

◆ Ignore() [81/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95159 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), and ARTS::Var::Tensor6::pos().

◆ Ignore() [82/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95203 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ Ignore() [83/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::TessemNN  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95335 of file autoarts.h.

References ARTS::Var::TessemNN::islast(), and ARTS::Var::TessemNN::pos().

◆ Ignore() [84/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Time  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95291 of file autoarts.h.

References ARTS::Var::Time::islast(), and ARTS::Var::Time::pos().

◆ Ignore() [85/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Timer  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95247 of file autoarts.h.

References ARTS::Var::Timer::islast(), and ARTS::Var::Timer::pos().

◆ Ignore() [86/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::TransmissionMatrix  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95379 of file autoarts.h.

References ARTS::Var::TransmissionMatrix::islast(), and ARTS::Var::TransmissionMatrix::pos().

◆ Ignore() [87/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Vector  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95423 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ Ignore() [88/88]

MRecord ARTS::AgendaMethod::Ignore ( [[maybe_unused] ] Workspace ws,
const Var::Verbosity  in 
)
inline

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This method can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ Ignore(ls_sigma) elsLorentz }

Without Ignore you would get an error message, because 'els_agenda' is supposed to use the Doppler width 'ls_sigma', but the Lorentz lineshape 'elsLorentz' does not need it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be ignored.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95467 of file autoarts.h.

References ARTS::Var::Verbosity::islast(), and ARTS::Var::Verbosity::pos().

◆ INCLUDE()

MRecord ARTS::AgendaMethod::INCLUDE ( [[maybe_unused] ] Workspace ws)
inline

Includes the contents of another controlfile.

The INCLUDE statement inserts the contents of the controlfile with the given name into the current controlfile. If the filename is given without path information, ARTS will first search for the file in all directories specified with the -I (see arts -h) commandline option and then in directories given in the environment variable ARTS_INCLUDE_PATH. In the environment variable multiple paths have to be separated by colons.

Note that INCLUDE is not a workspace method and thus the syntax is different:

Arts { INCLUDE "general.arts" }

Includes can also be nested. In the example above general.arts can contain further includes which will then be treated the same way.

The idea behind this mechanism is that you can write common settings for a bunch of calculations into one file. Then, you can create several controlfiles which include the basic settings and tweak them for different cases. When you decide to make changes to your setup that should apply to all calculations, you only have to make a single change in the include file instead of modifying all your controlfiles.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95520 of file autoarts.h.

◆ IndexAdd()

MRecord ARTS::AgendaMethod::IndexAdd ( [[maybe_unused] ] Workspace ws,
Var::Index  out,
const Var::Index  in,
const Var::Index  value 
)
inline

Adds a index and a value (out = in+value).

The result can either be stored in the same or another index. (in and out can be the same variable, but not out and value)

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output numeric.
[in]in- Input Index.
[in]value- Value to add.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95547 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ IndexNumberOfAtmosphericPoints()

MRecord ARTS::AgendaMethod::IndexNumberOfAtmosphericPoints ( [[maybe_unused] ] Workspace ws,
Var::Index  n 
)
inline

Counts number of points in the atmosphere.

For a 3D atmosphere the method sets n to: p_grid.nelem()*lat_grid.nelem()*lon_grid.nelem() For 1D and 2D the same calculation is done, but ignoring dimensions not active.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]n- Variable to set with number of points.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95585 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ IndexSet()

MRecord ARTS::AgendaMethod::IndexSet ( [[maybe_unused] ] Workspace ws,
Var::Index  out,
const Var::Index  value 
)
inline

Sets an index workspace variable to the given value.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- Value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95613 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::Index::pos(), and ARTS::Var::Index::value().

◆ IndexSetToLast() [1/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAbsorptionLines  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95647 of file autoarts.h.

References ARTS::Var::ArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfAbsorptionLines::pos().

◆ IndexSetToLast() [2/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAgenda  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95709 of file autoarts.h.

References ARTS::Var::ArrayOfAgenda::islast(), and ARTS::Var::ArrayOfAgenda::pos().

◆ IndexSetToLast() [3/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfAbsorptionLines  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95678 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfArrayOfAbsorptionLines::pos().

◆ IndexSetToLast() [4/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField1  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95740 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField1::pos().

◆ IndexSetToLast() [5/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField2  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95771 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField2::pos().

◆ IndexSetToLast() [6/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField3  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95802 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField3::pos().

◆ IndexSetToLast() [7/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfIndex  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95833 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfIndex::islast(), and ARTS::Var::ArrayOfArrayOfIndex::pos().

◆ IndexSetToLast() [8/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfMatrix  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95864 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfMatrix::islast(), and ARTS::Var::ArrayOfArrayOfMatrix::pos().

◆ IndexSetToLast() [9/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfPropagationMatrix  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95926 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfArrayOfPropagationMatrix::pos().

◆ IndexSetToLast() [10/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfRadiationVector  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95957 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfArrayOfRadiationVector::pos().

◆ IndexSetToLast() [11/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfScatteringMetaData  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95988 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfArrayOfScatteringMetaData::pos().

◆ IndexSetToLast() [12/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSingleScatteringData  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96019 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfArrayOfSingleScatteringData::pos().

◆ IndexSetToLast() [13/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSpeciesTag  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96050 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSpeciesTag::islast(), and ARTS::Var::ArrayOfArrayOfSpeciesTag::pos().

◆ IndexSetToLast() [14/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfStokesVector  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96081 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfArrayOfStokesVector::pos().

◆ IndexSetToLast() [15/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfString  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96112 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfString::islast(), and ARTS::Var::ArrayOfArrayOfString::pos().

◆ IndexSetToLast() [16/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor3  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96143 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor3::islast(), and ARTS::Var::ArrayOfArrayOfTensor3::pos().

◆ IndexSetToLast() [17/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor6  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96174 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor6::islast(), and ARTS::Var::ArrayOfArrayOfTensor6::pos().

◆ IndexSetToLast() [18/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTime  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96205 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTime::islast(), and ARTS::Var::ArrayOfArrayOfTime::pos().

◆ IndexSetToLast() [19/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTransmissionMatrix  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96236 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfArrayOfTransmissionMatrix::pos().

◆ IndexSetToLast() [20/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfVector  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96267 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfVector::islast(), and ARTS::Var::ArrayOfArrayOfVector::pos().

◆ IndexSetToLast() [21/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfCIARecord  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96298 of file autoarts.h.

References ARTS::Var::ArrayOfCIARecord::islast(), and ARTS::Var::ArrayOfCIARecord::pos().

◆ IndexSetToLast() [22/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField1  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96329 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfGriddedField1::pos().

◆ IndexSetToLast() [23/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField2  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96360 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfGriddedField2::pos().

◆ IndexSetToLast() [24/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField3  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96391 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfGriddedField3::pos().

◆ IndexSetToLast() [25/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField4  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96422 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField4::islast(), and ARTS::Var::ArrayOfGriddedField4::pos().

◆ IndexSetToLast() [26/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfIndex  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96453 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), and ARTS::Var::ArrayOfIndex::pos().

◆ IndexSetToLast() [27/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96484 of file autoarts.h.

References ARTS::Var::ArrayOfMatrix::islast(), and ARTS::Var::ArrayOfMatrix::pos().

◆ IndexSetToLast() [28/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPpath  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 95895 of file autoarts.h.

References ARTS::Var::ArrayOfPpath::islast(), and ARTS::Var::ArrayOfPpath::pos().

◆ IndexSetToLast() [29/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPropagationMatrix  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96515 of file autoarts.h.

References ARTS::Var::ArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfPropagationMatrix::pos().

◆ IndexSetToLast() [30/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96546 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), and ARTS::Var::ArrayOfQuantumIdentifier::pos().

◆ IndexSetToLast() [31/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRadiationVector  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96577 of file autoarts.h.

References ARTS::Var::ArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfRadiationVector::pos().

◆ IndexSetToLast() [32/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRetrievalQuantity  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96608 of file autoarts.h.

References ARTS::Var::ArrayOfRetrievalQuantity::islast(), and ARTS::Var::ArrayOfRetrievalQuantity::pos().

◆ IndexSetToLast() [33/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfScatteringMetaData  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96639 of file autoarts.h.

References ARTS::Var::ArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfScatteringMetaData::pos().

◆ IndexSetToLast() [34/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSingleScatteringData  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96670 of file autoarts.h.

References ARTS::Var::ArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfSingleScatteringData::pos().

◆ IndexSetToLast() [35/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSparse  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96701 of file autoarts.h.

References ARTS::Var::ArrayOfSparse::islast(), and ARTS::Var::ArrayOfSparse::pos().

◆ IndexSetToLast() [36/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfStokesVector  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96732 of file autoarts.h.

References ARTS::Var::ArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfStokesVector::pos().

◆ IndexSetToLast() [37/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96763 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), and ARTS::Var::ArrayOfString::pos().

◆ IndexSetToLast() [38/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTelsemAtlas  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96794 of file autoarts.h.

References ARTS::Var::ArrayOfTelsemAtlas::islast(), and ARTS::Var::ArrayOfTelsemAtlas::pos().

◆ IndexSetToLast() [39/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor3  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96825 of file autoarts.h.

References ARTS::Var::ArrayOfTensor3::islast(), and ARTS::Var::ArrayOfTensor3::pos().

◆ IndexSetToLast() [40/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor4  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96856 of file autoarts.h.

References ARTS::Var::ArrayOfTensor4::islast(), and ARTS::Var::ArrayOfTensor4::pos().

◆ IndexSetToLast() [41/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor5  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96887 of file autoarts.h.

References ARTS::Var::ArrayOfTensor5::islast(), and ARTS::Var::ArrayOfTensor5::pos().

◆ IndexSetToLast() [42/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor6  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96918 of file autoarts.h.

References ARTS::Var::ArrayOfTensor6::islast(), and ARTS::Var::ArrayOfTensor6::pos().

◆ IndexSetToLast() [43/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor7  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96949 of file autoarts.h.

References ARTS::Var::ArrayOfTensor7::islast(), and ARTS::Var::ArrayOfTensor7::pos().

◆ IndexSetToLast() [44/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTime  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 96980 of file autoarts.h.

References ARTS::Var::ArrayOfTime::islast(), and ARTS::Var::ArrayOfTime::pos().

◆ IndexSetToLast() [45/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTransmissionMatrix  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97011 of file autoarts.h.

References ARTS::Var::ArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfTransmissionMatrix::pos().

◆ IndexSetToLast() [46/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfVector  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97042 of file autoarts.h.

References ARTS::Var::ArrayOfVector::islast(), and ARTS::Var::ArrayOfVector::pos().

◆ IndexSetToLast() [47/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfXsecRecord  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97073 of file autoarts.h.

References ARTS::Var::ArrayOfXsecRecord::islast(), and ARTS::Var::ArrayOfXsecRecord::pos().

◆ IndexSetToLast() [48/48]

MRecord ARTS::AgendaMethod::IndexSetToLast ( [[maybe_unused] ] Workspace ws,
const Var::Vector  v 
)
inline

Set an Index to point towards last position of array-type variables.

This method works as nelemGet, but gives the index number of the last element (which equals nelem-1).

Author
Patrick Eriksson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- The method is defined for these groups.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97104 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ IndexStepDown()

MRecord ARTS::AgendaMethod::IndexStepDown ( [[maybe_unused] ] Workspace ws,
Var::Index  out,
const Var::Index  in 
)
inline

Performas: out = in - 1

Input and output can be same variable.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output index variable.
[in]in- Input index variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97134 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ IndexStepUp()

MRecord ARTS::AgendaMethod::IndexStepUp ( [[maybe_unused] ] Workspace ws,
Var::Index  out,
const Var::Index  in 
)
inline

Performas: out = in + 1

Input and output can be same variable.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output index variable.
[in]in- Input index variable.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97167 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ InterpAtmFieldToPosition()

MRecord ARTS::AgendaMethod::InterpAtmFieldToPosition ( [[maybe_unused] ] Workspace ws,
Var::Numeric  out,
const Var::Tensor3  field 
)
inline

Point interpolation of atmospheric fields.

The default way to specify the position is by rtp_pos.

Linear interpolation is applied.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Value obtained by the interpolation.
[in]field- Field to interpolate.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97202 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor3::pos().

◆ InterpGriddedField2ToPosition()

MRecord ARTS::AgendaMethod::InterpGriddedField2ToPosition ( [[maybe_unused] ] Workspace ws,
Var::Numeric  out,
const Var::GriddedField2  gfield2 
)
inline

Latitude and longitude interpolation of a GriddedField2.

The default way to specify the position is by rtp_pos.

The interpolation is done for the latitude and longitude in rtp_pos*. The altitude in rtp_pos is completely ignored. Linear interpolation is applied.

The input field (gfield2) is expected to have latitude and longitude as first and second dimension.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Value obtained by interpolation.
[in]gfield2- Gridded field to interpolate.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97242 of file autoarts.h.

References ARTS::Var::GriddedField2::islast(), ARTS::Var::Numeric::islast(), ARTS::Var::GriddedField2::pos(), and ARTS::Var::Numeric::pos().

◆ InterpSurfaceFieldToPosition()

MRecord ARTS::AgendaMethod::InterpSurfaceFieldToPosition ( [[maybe_unused] ] Workspace ws,
Var::Numeric  out,
const Var::Matrix  field 
)
inline

Point interpolation of surface fields.

The default way to specify the position is by rtp_pos.

Linear interpolation is applied.

The interpolation is done for the latitude and longitude in rtp_pos*, while the altitude in rtp_pos is not part of the calculations. However, it is checked that the altitude of rtp_pos is inside the range covered by z_surface with a 1 m margin, to give a warning when the specified position is not consistent with the surface altitudes.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Value obtained by interpolation.
[in]field- Field to interpolate.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97284 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Numeric::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Numeric::pos().

◆ irradiance_fieldFromRadiance()

MRecord ARTS::AgendaMethod::irradiance_fieldFromRadiance ( [[maybe_unused] ] Workspace ws)
inline

Calculate the irradiance also known as flux density from the radiance_field . by integrating over the angular grids according to the grids set by AngularGridsSetFluxCalc See AngularGridsSetFluxCalc to set za_grid, aa_grid, and za_grid_weights

Author
Manfred Brath
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97317 of file autoarts.h.

◆ isotopologue_ratiosInitFromBuiltin()

MRecord ARTS::AgendaMethod::isotopologue_ratiosInitFromBuiltin ( [[maybe_unused] ] Workspace ws)
inline

Initialize isotopologue ratios with default values from built-in species data.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97339 of file autoarts.h.

◆ iy_transmitterMultiplePol()

MRecord ARTS::AgendaMethod::iy_transmitterMultiplePol ( [[maybe_unused] ] Workspace ws)
inline

Transmitted signal having multiple polarisations.

The method is intended to be part of iy_transmitter_agenda. It sets iy to describe the transmitted signal/pulses. The polarisation state is taken from instrument_pol, where instrument_pol must contain an element for each frequency in f_grid. The transmitted signal/pulses are set to be of unit magnitude, such as [1,1,0,0].

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98204 of file autoarts.h.

◆ iy_transmitterSinglePol()

MRecord ARTS::AgendaMethod::iy_transmitterSinglePol ( [[maybe_unused] ] Workspace ws)
inline

Transmitted signal having a single polarisations.

The method is intended to be part of iy_transmitter_agenda. It sets iy to describe the transmitted pulses/signal. The polarisation state is taken from instrument_pol, where instrument_pol must contain a single value. This polarisation state is applied for all frequencies. The transmitted pulses/signals are set to be of unit magnitude, such as [1,1,0,0].

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98232 of file autoarts.h.

◆ iyActiveSingleScat()

MRecord ARTS::AgendaMethod::iyActiveSingleScat ( [[maybe_unused] ] Workspace ws,
const Var::Index trans_in_jacobian = {},
const Var::Numeric pext_scaling = {},
const Var::Index t_interp_order = {} 
)
inline

Simulation of radar/lidar, restricted to single scattering.

The WSM treats e.g. radar measurements of cloud and precipitation, on the condition that multiple scattering can be ignored. Beside the direct backsacttering, the two-way attenuation by gases and particles is considered. Surface scattering is ignored.

The method could potentially be used for lidars, but multiple scattering poses here a must stronger constrain for the range of applications.

The method can be used with iyCalc, but not with yCalc. In the later case, use instead yActive.

The method returns the backscattering for each point of ppath. Several frequencies can be treated in parallel. The size of iy is [ nf*np, stokes_dim ], where nf is the length of f_grid and np is the number of path points. The data are stored in blocks of [ np, stokes_dim ]. That is, all the results for the first frequency occupy the np first rows of iy etc.

The polarisation state of the transmitted pulse is taken from iy_transmitter_agenda*. If the radar transmits several polarisations at the same frequency, you need to handle this by using two frequencies in f_grid, but these can be almost identical.

This method does not consider iy_unit. Unit changes are insted applied in *yActive. The output of this method matches the option "1".

Transmission is handled in a slightly simplified manner for efficiency reasons. First of all, the transmission matrix is assumed to be the same in both directions between the sensor and the point of back-scattering. This should in general be true, but exceptions could exist. The extinction due to particles can also be scaled, which could be of interest when e.g. characterising inversions.

Further, for Jacobian calculations the default is to assume that the transmission is unaffected by the retrieval quantities. This is done to save computational time, and should be a valid approximation for the single-scattering conditions. Set trans_in_jacobian to 1 to obtain the more accurate Jacobian.

Some auxiliary radiative transfer quantities can be obtained. Auxiliary quantities are selected by iy_aux_vars and returned by iy_aux. Valid choices for auxiliary data are: "Radiative background": Index value flagging the radiative background. The following coding is used: 0=space, 1=surface and 2=cloudbox. "Backscattering": The unattenuated backscattering. That is, as iy* but with no attenuated applied. Here all columns are filled. "Optical depth": Scalar, total and two-way, optical depth between sensor and each point of the propagation path. Calculated based on the (1,1)-element of the transmission matrix (1-based indexing), i.e. only fully valid for scalar RT. "Particle extinction": As "Optical depth", but only with particle attenuation included. That is, gas absorption is ignored. If nothing else is stated, only the first column of iy_aux is filled, i.e. the column matching Stokes element I, while remaing columns are are filled with zeros.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]trans_in_jacobian- Flag determining if change in transmission is considered in calculation of the Jacobian or not. (default: 0)
[in]pext_scaling- Particle extinction is scaled with this value. A value inside [0,2]. Set it to 0 if you want to remove particle extinction totally. (default: 1)
[in]t_interp_order- Interpolation order of temperature for scattering data (so far only applied in phase matrix, not in extinction and absorption. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97421 of file autoarts.h.

◆ iyActiveSingleScat2()

MRecord ARTS::AgendaMethod::iyActiveSingleScat2 ( [[maybe_unused] ] Workspace ws,
const Var::Index trans_in_jacobian = {},
const Var::Numeric pext_scaling = {},
const Var::Index t_interp_order = {} 
)
inline

TESTING

Author
Patrick Eriksson
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]trans_in_jacobian- Flag determining if change in transmission is considered in calculation of the Jacobian or not. (default: 0)
[in]pext_scaling- Particle extinction is scaled with this value. A value inside [0,2]. Set it to 0 if you want to remove particle extinction totally. (default: 1)
[in]t_interp_order- Interpolation order of temperature for scattering data (so far only applied in phase matrix, not in extinction and absorption. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97466 of file autoarts.h.

◆ iyApplyUnit()

MRecord ARTS::AgendaMethod::iyApplyUnit ( [[maybe_unused] ] Workspace ws)
inline

Conversion of iy to other spectral units.

The method allows a change of unit, as a post-processing step, ignoring the n2-law of radiance.

The conversion made inside iyEmissionStandard is mimiced, see that method for constraints and selection of output units. Restricted to that the n2-law can be ignored. This assumption is valid if the sensor is placed in space, or if the refractive index only deviates slightly from unity.

It is stressed that there is no automatic check that the method is applied correctly, it is up to the user to ensure that the input data are suitable for the conversion.

Beside iy, these auxilary quantities are modified: "iy", "Error" and "Error (uncorrelated)"

Please note that diy_dx is not handled.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97525 of file autoarts.h.

◆ iyCalc()

MRecord ARTS::AgendaMethod::iyCalc ( [[maybe_unused] ] Workspace ws)
inline

A single monochromatic pencil beam calculation.

Performs monochromatic radiative transfer calculations for the specified position (rte_pos) and line-of-sight (rte_pos). See iy and associated variables for format of output.

Please note that Jacobian type calculations not are supported. For this use yCalc.

No sensor characteristics are applied. These are most easily incorporated by using yCalc

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97556 of file autoarts.h.

◆ iyEmissionStandard()

MRecord ARTS::AgendaMethod::iyEmissionStandard ( [[maybe_unused] ] Workspace ws)
inline

Standard method for radiative transfer calculations with emission.

Designed to be part of iy_main_agenda. That is, only valid outside the cloudbox (no scattering). For details se the user guide.

The possible choices for iy_unit are "1" : No conversion, i.e. [W/(m^2 Hz sr)] (radiance per frequency unit). "RJBT" : Conversion to Rayleigh-Jean brightness temperature. "PlanckBT" : Conversion to Planck brightness temperature. "W/(m^2 m sr)" : Conversion to [W/(m^2 m sr)] (radiance per wavelength unit). "W/(m^2 m-1 sr)": Conversion to [W/(m^2 m-1 sr)] (radiance per wavenumber unit). Expressions applied and considerations for the unit conversion of radiances are discussed in Sec. 5.7 of the ARTS-2.0 article.

iy_unit* is only applied if iy_agenda_call1 is 1. This means that no unit ocnversion is applied for internal iterative calls.

Some auxiliary radiative transfer quantities can be obtained. Auxiliary quantities are selected by iy_aux_vars and returned by iy_aux. Valid choices for auxiliary data are: "Radiative background": Index value flagging the radiative background. The following coding is used: 0=space, 1=surface and 2=cloudbox. "Optical depth": Scalar optical depth between the observation point and the end of the present propagation path. Calculated based on the (1,1)-element of the transmission matrix (1-based indexing), i.e. only fully valid for scalar RT. If nothing else is stated, only the first column of iy_aux is filled, i.e. the column matching Stokes element I, while remaing columns are are filled with zeros.

Author
Patrick Eriksson
Richard Larsson
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97612 of file autoarts.h.

◆ iyEmissionStandardSequential()

MRecord ARTS::AgendaMethod::iyEmissionStandardSequential ( [[maybe_unused] ] Workspace ws)
inline

DEPRECATED! Should go away soon Sequential version of iyEmissionStandard

For documentation see iyEmissionStandard.

Author
Patrick Eriksson
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97637 of file autoarts.h.

◆ iyHybrid()

MRecord ARTS::AgendaMethod::iyHybrid ( [[maybe_unused] ] Workspace ws,
const Var::Index Naa_grid = {},
const Var::Index t_interp_order = {} 
)
inline

So far just for testing.

Author
Patrick Eriksson
Jana Mendrok
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]Naa_grid- Number of azimuth angles to consider in scattering source term integral. (default: 19)
[in]t_interp_order- Interpolation order of temperature for scattering data (so far only applied in phase matrix, not in extinction and absorption. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97662 of file autoarts.h.

◆ iyHybrid2()

MRecord ARTS::AgendaMethod::iyHybrid2 ( [[maybe_unused] ] Workspace ws,
const Var::Index Naa_grid = {},
const Var::Index t_interp_order = {} 
)
inline

So far just for even more testing.

Author
Patrick Eriksson
Jana Mendrok
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]Naa_grid- Number of azimuth angles to consider in scattering source term integral. (default: 19)
[in]t_interp_order- Interpolation order of temperature for scattering data (so far only applied in phase matrix, not in extinction and absorption. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97701 of file autoarts.h.

◆ iyIndependentBeamApproximation()

MRecord ARTS::AgendaMethod::iyIndependentBeamApproximation ( [[maybe_unused] ] Workspace ws,
const Var::Index return_atm1d = {},
const Var::Index skip_vmr = {},
const Var::Index skip_pnd = {},
const Var::Index return_masses = {} 
)
inline

In development ....

Describe how atm_fields_compact is filled.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]return_atm1d- Flag to trigger that atm_fields_compact is filled. (default: 0)
[in]skip_vmr- Flag to not include vmr data in atm_fields_compact. (default: 0)
[in]skip_pnd- Flag to not include pnd data in atm_fields_compact. (default: 0)
[in]return_masses- Flag to include particle category masses in atm_fields_compact.Conversion is done by particle_masses. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97742 of file autoarts.h.

◆ iyInterpCloudboxField()

MRecord ARTS::AgendaMethod::iyInterpCloudboxField ( [[maybe_unused] ] Workspace ws,
const Var::Index za_interp_order = {},
const Var::Index za_restrict = {},
const Var::Index cos_za_interp = {},
const Var::Numeric za_extpolfac = {},
const Var::Index aa_interp_order = {} 
)
inline

Interpolates the intensity field of the cloud box.

Determines the intensity field at the position and direction specified by rte_pos and rte_los. The position can be both inside the cloud box or at its edge.

The interpolation in the spatial dimensions is linear.

For the zenith angle dimensions several options for controlling the interpolation are at hand. Default is linear interpolation. Higher order polynomial interpolation is activated by setting za_interp_order* to a value > 1. Default is to perform the interpolation separately for [0,90[ and ]90,180]. To handle 90 degree or use the full range ([0,180]) as basis for the interpolation, set za_restrict to 0. You can select to use cos(za) as the independent variable (instead of za) by setting cos_za_interp* to 1.

For the azimuth dimension the interpolation order can be selected, in the same manner as for zenith.

Author
Claudia Emde
Patrick Eriksson
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]za_interp_order- Zenith angle interpolation order. (default: 1)
[in]za_restrict- Flag whether to restric zenith angle interpolation to one hemisphere. (default: 1)
[in]cos_za_interp- Flag whether to do zenith angle interpolation in cosine space. (default: 0)
[in]za_extpolfac- Maximum allowed extrapolation range in zenith angle. (default: 0.5)
[in]aa_interp_order- Azimuth angle interpolation order. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97815 of file autoarts.h.

◆ iyLoopFrequencies()

MRecord ARTS::AgendaMethod::iyLoopFrequencies ( [[maybe_unused] ] Workspace ws)
inline

Radiative transfer calculations one frequency at the time.

The method loops the frequencies in f_grid and calls iy_loop_freqs_agenda* for each individual value. This method is placed in iy_main_agenda, and the actual radiative transfer method is put in iy_loop_freqs_agenda.

A common justification for using the method should be to consider dispersion. By using this method it is ensured that the propagation path for each individual frequency is calculated.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97877 of file autoarts.h.

◆ iyMC()

MRecord ARTS::AgendaMethod::iyMC ( [[maybe_unused] ] Workspace ws,
const Var::Index t_interp_order = {} 
)
inline

Interface to Monte Carlo part for iy_main_agenda.

Basically an interface to MCGeneral for doing monochromatic pencil beam calculations. This functions allows Monte Carlo (MC) calculations for sets of frequencies and sensor pos/los in a single run. Sensor responses can be included in the standard manner (through yCalc).

This function does not apply the MC approach when it comes to sensor properties. These properties are not considered when tracking photons, which is done in MCGeneral (but then only for the antenna pattern).

Output unit options (iy_unit) exactly as for MCGeneral.

The MC calculation errors are all assumed be uncorrelated and each have a normal distribution. These properties are of relevance when weighting the errors with the sensor repsonse matrix. The seed is reset for each call of MCGeneral to obtain uncorrelated errors.

MC control arguments (mc_std_err, mc_max_time, mc_min_iter, mc_max_iter mc_taustep_limit) as for MCGeneral. The arguments are applied for each monochromatic pencil beam calculation individually. As for MCGeneral, the value of mc_error shall be adopted to iy_unit*.

The following auxiliary data can be obtained: "Error (uncorrelated)": Calculation error. Size: [nf,ns,1,1]. (The later part of the text string is required. It is used as a flag to yCalc for how to apply the sensor data.) where nf: Number of frequencies. ns: Number of Stokes elements.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]t_interp_order- Interpolation order of temperature for scattering data (so far only applied in phase matrix, not in extinction and absorption. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97931 of file autoarts.h.

◆ iyReplaceFromAux()

MRecord ARTS::AgendaMethod::iyReplaceFromAux ( [[maybe_unused] ] Workspace ws,
const Var::String  aux_var 
)
inline

Change of main output variable.

With this method you can replace the content of iy with one of the auxiliary variables. The selected variable (by aux_var) must be part of iy_aux_vars. The corresponding data from iy_aux are copied to form a new iy (iy_aux is left unchanged). Elements of iy* correponding to Stokes elements not covered by the auxiliary variable are just set to zero.

Jacobian variables are not handled.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]aux_var- Auxiliary variable to insert as iy.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 97970 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ iySurfaceCallAgendaX()

MRecord ARTS::AgendaMethod::iySurfaceCallAgendaX ( [[maybe_unused] ] Workspace ws)
inline

Switch between the elements of iy_surface_agenda_array.

This method simply calls the agenda matching surface_type and returns the results. That is, the agenda in iy_surface_agenda_array with index surface_type (0-based) is called.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98000 of file autoarts.h.

◆ iySurfaceFastem()

MRecord ARTS::AgendaMethod::iySurfaceFastem ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  wind_speed,
const Var::Numeric salinity = {},
const Var::Numeric wind_direction = {},
const Var::Index fastem_version = {} 
)
inline

Usage of FASTEM for emissivity and reflectivity of water surfaces.

This method allows usage of the FASTEM model inside iy_surface_agenda*. The aim is to use FASTEM in the exact same way as done in RTTOV. For example, the transmittance for down- welling radiation is considered. RTTOV os just 1D. Here 2D and 3D are handled as the 1D case, the down-welling radiation is just calculated for the directuon matching specular reflection.

The wind direction is given as the azimuth angle, counted clockwise from north (i.e. an easterly wind is at 90 deg). This matches the general definition of azimuth inside ARTS. For 1D and 2D, the wind direction must be adjusted to match the fact that the line-of-sight is locked to be at 0 deg (180 for 2D in the case of a negative zenith angle). For 3D, the true wind direction shall be used.

FASTEM is called by FastemStandAlone. See that WSM for further comments on variables and limitations.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]salinity- Salinity, 0-1. That is, 3% is given as 0.03. (default: 0.035)
[in]wind_speed- Wind speed.
[in]wind_direction- Wind direction. See further above. (default: 0)
[in]fastem_version- The version of FASTEM to use. (default: 6)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98043 of file autoarts.h.

◆ iySurfaceRtpropAgenda()

MRecord ARTS::AgendaMethod::iySurfaceRtpropAgenda ( [[maybe_unused] ] Workspace ws)
inline

Interface to surface_rtprop_agenda for iy_surface_agenda.

This method is designed to be part of iy_surface_agenda. It determines the radiative properties of the surface by surface_rtprop_agenda* and calculates the downwelling radiation by iy_main_agenda, and sums up the terms as described in AUG. That is, this WSM uses the output from surface_rtprop_agenda in a straightforward fashion.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98094 of file autoarts.h.

◆ iySurfaceRtpropCalc()

MRecord ARTS::AgendaMethod::iySurfaceRtpropCalc ( [[maybe_unused] ] Workspace ws)
inline

Applies surface_los, surface_rmatrix and surface_emission.

This method is designed to be part of iy_surface_agenda and should be mandatory when using methods describing the surface radiative transfer properties by surface_los, surface_rmatrix and surface_emission. The task of this method is to apply these three WSVs to obtain the upwelling radiation from the surface. This upwelling radiation is the sum of surface emission and reflected downwelling radiation. The later part is calculated by calling iy_main_agenda. See further AUG.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98124 of file autoarts.h.

◆ iyTransmissionStandard()

MRecord ARTS::AgendaMethod::iyTransmissionStandard ( [[maybe_unused] ] Workspace ws)
inline

Standard method for handling transmission measurements.

Designed to be part of iy_main_agenda. Treatment of the cloudbox is incorporated (that is, no need to define iy_cloudbox_agenda).

The transmitter is assumed to be placed at the end of provided ppath. The transmitted signal is taken from iy_transmitter_agenda. This signal is propagated along the path, considering attenuation alone. That is, the result of the method (iy) is the output of iy_transmitter_agenda* multiplied with the transmission along the propagation path.

As mentioned, the given ppath determines the position of the transmitter. For clear-sky and no modification of ppath, this means that the transitter will either be found at the surface or at the top-of-the-atmosphere. If you want to maintain this even with an active cloudbox, calculate ppath as ppathCalc( cloudbox_on=0 ) Without setting cloudbox_on=0, the transmitter will end up inside or at the boundary of the cloudbox.

Some auxiliary radiative transfer quantities can be obtained. Auxiliary quantities are selected by iy_aux_vars and returned by iy_aux. Valid choices for auxiliary data are: "Radiative background": Index value flagging the radiative background. The following coding is used: 0=space, 1=surface and 2=cloudbox. The value is added to each column. "Optical depth": Scalar optical depth between the observation point and the end of the present propagation path. Calculated based on the (1,1)-element of the transmission matrix (1-based indexing), i.e. only fully valid for scalar RT. The value is added to each column.

Author
Patrick Eriksson
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98177 of file autoarts.h.

◆ jacobianAddAbsSpecies()

MRecord ARTS::AgendaMethod::jacobianAddAbsSpecies ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String  species,
const Var::String unit = {},
const Var::Index for_species_tag = {} 
)
inline

Includes an absorption species in the Jacobian.

For 1D or 2D calculations the latitude and/or longitude grid of the retrieval field should set to have zero length.

These retrieval units are at hand for all gas species: "vmr" : Volume mixing ratio. "nd" : Number density. "rel" : Relative unit (e.g. 1.1 means 10% more of the gas).

For water vapour, also these units are at hand: "rh" : Relative humidity. "q" : Specific humidity.

Note that for_species_tag is used to indicate if species tag VMR, rather than atmospheric gas VMR is calculated. Set it to 0 and we calculate the atmospheric gas VMR, but this only works for "analytical".

Note that the Jacobian is set to zero where volume mixing ratio equals zero.

The number of elements added to the state vector (x) is: n_g1 * n_g2 * n_g3 where n_g1, n_g2 and n_g3 are the length of GIN g1, g2 and g3, respectively. Here empty vectors should be considered to have a length 1. The elements are sorted with pressure as innermost loop, followed by latitude and longitude as outermost loop.

Author
Mattias Ekstrom
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]species- The species tag of the retrieval quantity.
[in]unit- Retrieval unit. See above. (default: "vmr")
[in]for_species_tag- Index-bool for acting on species tags or species. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98285 of file autoarts.h.

◆ jacobianAddBasicCatalogParameter()

MRecord ARTS::AgendaMethod::jacobianAddBasicCatalogParameter ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  catalog_identity,
const Var::String  catalog_parameter 
)
inline

Includes a basic catalog parameter in the Jacobian. These are constant over all layers and so only a single vector output is returned.

The only basic catalog parameters currently supported are: "Line Strength" "Line Center"

The catalog_identity should be able to identify one or many lines in the catalog used for calculating the spectral absorption. Note that partial matching for energy levels are allowed but not recommended, as it is somewhat nonsensical to add multiple parameters

Also note jacobianAddShapeCatalogParameter as this allows addition of shape parameters, e.g., pressure broadening coefficients

Each call to this function adds just a single value to x.

Example given the catalog_identity="O2-66 TR UP v1 0 J 1 LO v1 0 J 0", only the O2 ground-level 119 GHz line can be accessed and only its catalog_parameter will be accessed. However, the more lenient catalog_identity="O2-66 TR UP J 1 LO J 0" may be used, but then the 118 GHz line belonging to v1=1 branch will be added to the same x.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]catalog_identity- The catalog line matching information.
[in]catalog_parameter- The catalog parameter of the retrieval quantity.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98355 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::String::islast(), ARTS::Var::QuantumIdentifier::pos(), and ARTS::Var::String::pos().

◆ jacobianAddBasicCatalogParameters()

MRecord ARTS::AgendaMethod::jacobianAddBasicCatalogParameters ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  catalog_identities,
const Var::ArrayOfString  catalog_parameters 
)
inline

See jacobianAddBasicCatalogParameter.

This adds a multiple of parameters for first each catalog_identity in catalog_identities and then for each catalog_parameter in catalog_parameters by looping calls to jacobianAddBasicCatalogParameter over these input

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]catalog_identities- The catalog line matching information.
[in]catalog_parameters- The catalog parameter of the retrieval quantity.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98390 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), ARTS::Var::ArrayOfString::islast(), ARTS::Var::ArrayOfQuantumIdentifier::pos(), and ARTS::Var::ArrayOfString::pos().

◆ jacobianAddFreqShift()

MRecord ARTS::AgendaMethod::jacobianAddFreqShift ( [[maybe_unused] ] Workspace ws,
const Var::Numeric df = {} 
)
inline

Includes a frequency fit of shift type in the Jacobian.

Retrieval of deviations between nominal and actual backend frequencies can be included by this method. The assumption here is that the deviation is a constant off-set, a shift, common for all frequencies (and not varying between measurement blocks).

This method adds one element to the state vector (x).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]df- Size of perturbation to apply. (default: 100e3)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98427 of file autoarts.h.

◆ jacobianAddFreqStretch()

MRecord ARTS::AgendaMethod::jacobianAddFreqStretch ( [[maybe_unused] ] Workspace ws,
const Var::Numeric df = {} 
)
inline

Includes a frequency fit of stretch type in the Jacobian.

Retrieval of deviations between nominal and actual backend frequencies can be included by this method. The assumption here is that the deviation varies linearly over the frequency range (following ARTS basis function for polynomial order 1).

This method adds one element to the state vector (x).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]df- Size of perturbation to apply. (default: 100e3)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98464 of file autoarts.h.

◆ jacobianAddMagField()

MRecord ARTS::AgendaMethod::jacobianAddMagField ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String component = {},
const Var::Numeric dB = {} 
)
inline

Includes one magnetic field component in the Jacobian.

The method follows the pattern of other Jacobian methods. The calculations can only be performed by analytic expressions.

The magnetic field components are retrieved separately, and, hence, the argument component can be "u", "v", "w", and "strength".

The number of elements added to the state vector (x) is: n_g1 * n_g2 * n_g3 where n_g1, n_g2 and n_g3 are the length of GIN g1, g2 and g3, respectively. Here empty vectors should be considered to have a length 1. The elements are sorted with pressure as innermost loop, followed by latitude and longitude as outermost loop.

The dB-parameter is only used for Faraday rotation

Author
Patrick Eriksson
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]component- Magnetic field component to retrieve (default: "v")
[in]dB- Magnetic field perturbation (default: 1.0e-7)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98651 of file autoarts.h.

◆ jacobianAddNLTE()

MRecord ARTS::AgendaMethod::jacobianAddNLTE ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::QuantumIdentifier  energy_level_identity,
const Var::Numeric dx = {} 
)
inline

Experimental NLTE Jacobian.

Intention: Adds the nlte_field level distribution per atmospheric grid to the Jacobian.

The number of elements added to the state vector (x) is: n_g1 * n_g2 * n_g3 where n_g1, n_g2 and n_g3 are the length of GIN g1, g2 and g3, respectively. Here empty vectors should be considered to have a length 1. The elements are sorted with pressure as innermost loop, followed by latitude and longitude as outermost loop.

The QuantumIdentifier should identify a single energy level, such as: "H2O-161 EN J 1 Ka 0 Kc 1", for one of the lower levels in the chains of transitions of water. Note that using this method directly is not best practice, as the quantum identifiers of the levels have to be known at an early stage in NLTE calculations, and will usually populate the nlte_level_identifiers* variable, meaning it is better to use jacobianAddNLTE directly than to individually call this function

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]energy_level_identity- Identifier to the eneregy level
[in]dx- Perturbation of value if required by method (default: 1.0e-3)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98718 of file autoarts.h.

◆ jacobianAddNLTEs()

MRecord ARTS::AgendaMethod::jacobianAddNLTEs ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::ArrayOfQuantumIdentifier  energy_level_identities,
const Var::Numeric dx = {} 
)
inline

Experimental NLTE Jacobian. Same as jacobianAddNLTE but for many levels

Adds energy_level_identities.nelem() times as many arguments to x as jacobianAddNLTE, ordered as energy_level_identities describes

This method is preferred to jacobianAddNLTE, since energy_level_identities is conveniently almost always the same as nlte_level_identifiers

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]energy_level_identities- Identifiers to the eneregy level
[in]dx- Perturbation of value if required by method (default: 1.0e-3)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98771 of file autoarts.h.

◆ jacobianAddPointingZa()

MRecord ARTS::AgendaMethod::jacobianAddPointingZa ( [[maybe_unused] ] Workspace ws,
const Var::Index poly_order = {},
const Var::String calcmode = {},
const Var::Numeric dza = {} 
)
inline

Adds sensor pointing zenith angle off-set jacobian.

Retrieval of deviations between nominal and actual zenith angle of the sensor can be included by this method. The weighing functions can be calculated in several ways: calcmode = "recalc": Recalculation of pencil beam spectra, shifted with dza from nominal values. A single-sided perturbation is applied (towards higher zenith angles). calcmode = "interp": Inter/extrapolation of existing pencil beam spectra. For this option, allow some extra margins for zenith angle grids, to avoid artifacts when extrapolating the data (to shifted zenith angles). The average of a negative and a positive shift is taken. The interp option is recommended. It should in general be both faster and more accurate (due to the double sided disturbance). In addition, it is less sensitive to the choice of dza (as long as a small value is applied).

The pointing off-set can be modelled to be time varying. The time variation is then described by a polynomial (with standard base functions). For example, a polynomial order of 0 means that the off-set is constant in time. If the off-set is totally uncorrelated between the spectra, set the order to -1.

The number of elements added to the state vector (x) is if poly_order < 0 : length of sensor_time otherwise : poly_order+1 In the first case, the order in x matches sensor_time. In the second case, the coefficient for polynomial order 0 comes first etc.

Author
Patrick Eriksson
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[in]poly_order- Order of polynomial to describe the time variation of pointing off-sets. (default: 0)
[in]calcmode- Calculation method. See above (default: "recalc")
[in]dza- Size of perturbation to apply (when applicable). (default: 0.01)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98844 of file autoarts.h.

◆ jacobianAddPolyfit()

MRecord ARTS::AgendaMethod::jacobianAddPolyfit ( [[maybe_unused] ] Workspace ws,
const Var::Index  poly_order,
const Var::Index no_pol_variation = {},
const Var::Index no_los_variation = {},
const Var::Index no_mblock_variation = {} 
)
inline

Includes polynomial baseline fit in the Jacobian.

This method deals with retrieval of disturbances of the spectra that can be described by an additive term, a baseline off-set.

The baseline off-set is here modelled as a polynomial. The polynomial spans the complete frequency range spanned by sensor_response_f_grid* and the method should only of interest for cases with no frequency gap in the spectra. The default assumption is that the off-set differs between all spectra, but it can also be assumed that the off-set is common for all e.g. line-of-sights.

If the simulation/retrieval deals with a single spectrum, the number of elements added to the state vector (x) is poly_order+1. The coefficient for polynomial order 0 comes first etc. The same is true if no_pol_variation, no_los_variation and no_mblock_variation all are set to 1, even if several spectra are involved. Otherwise thenumber of elements added to x depends on the number of spectra and the settings of no_pol_variation, no_los_variation and no_mblock_variation*. The coefficients of the different polynomial orders are treated as separate retrieval quantities. That is, the the elements associated with polynomial order 0 are grouped and form together a retrieval quantity. The coefficients for higher polynomial orders are treated in the same way.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]poly_order- Polynomial order to use for the fit.
[in]no_pol_variation- Set to 1 if the baseline off-set is the same for all Stokes components. (default: 0)
[in]no_los_variation- Set to 1 if the baseline off-set is the same for all line-of-sights (inside each measurement block). (default: 0)
[in]no_mblock_variation- Set to 1 if the baseline off-set is the same for all measurement blocks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98911 of file autoarts.h.

◆ jacobianAddScatSpecies()

MRecord ARTS::AgendaMethod::jacobianAddScatSpecies ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String  species,
const Var::String  quantity 
)
inline

Includes a scattering species in the Jacobian.

For 1D or 2D calculations the latitude and/or longitude grid of the retrieval field should set to have zero length.

The number of elements added to the state vector (x) is: n_g1 * n_g2 * n_g3 where n_g1, n_g2 and n_g3 are the length of GIN g1, g2 and g3, respectively. Here empty vectors should be considered to have a length 1. The elements are sorted with pressure as innermost loop, followed by latitude and longitude as outermost loop.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]species- Name of scattering species, must match one element in scat_species.
[in]quantity- Retrieval quantity, e.g. "IWC".

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98970 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ jacobianAddShapeCatalogParameter()

MRecord ARTS::AgendaMethod::jacobianAddShapeCatalogParameter ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  line_identity,
const Var::String  species,
const Var::String  variable,
const Var::String  coefficient 
)
inline

Adds a line shape parameter to the Jacobian calculations. These are constant over all levels so only a single x-value is added

Line function parameter assume the derivatives of internal pressure broadening and line mixing functionality follows a simply f(T, T0, X0, X1, X2) format. The shape of the function f() is determined by input catalog; please see the ARTS documentation for more details

The input are as follows: line_identity: Identifier of preferably a single line species: A SpeciesTag, e.g., "O2" or "H2O" for common species. Note that "SELF" and "AIR" tags are used for shape parameters affected by self and air-broadening, respectively. variable: A variable supported by the line, these can be "G0": Speed-independent pressure broadening "G2": Speed-dependent pressure broadening "D0": Speed-independent pressure shift "D2": Speed-dependent pressure shift "FVC": Frequency of velocity changing collisions "ETA": partial correlation between velocity and rotational state changes due to collisions "Y": First order line-mixing parameter "G": Second order line-mixing parameter for strength "DV": Second order line-mixing parameter for shifting coefficient: A coefficient in the model to compute the above parameters.

Note that we cannot test if the line in question supports the variable and coefficient at the level of this function, so many errors will only be reported at a later stage

For other spectroscopic parameters, see jacobianAddBasicCatalogParameter. Also see said function for an example of how to set the QuantumIdentifier

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]line_identity- Line identifier
[in]species- Species of interest
[in]variable- Variable of interest
[in]coefficient- Coefficient of interest

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98530 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::String::islast(), ARTS::Var::QuantumIdentifier::pos(), and ARTS::Var::String::pos().

◆ jacobianAddShapeCatalogParameters()

MRecord ARTS::AgendaMethod::jacobianAddShapeCatalogParameters ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  line_identities,
const Var::ArrayOfString  species,
const Var::ArrayOfString  variables,
const Var::ArrayOfString  coefficients 
)
inline

See jacobianAddShapeCatalogParameter for information on the GIN parameters

This function accepts the same input but for lists of data. The function loops over each input list individually and appends the information to jacobian_quantities.

Special "ALL" for 1 length variables and coefficients are allowed to compute all variables/coefficients in the order described in the description of jacobianAddShapeCatalogParameter

For example, if line_identities have length 5, species length 4, variables* length 3, and coefficients length 2, there will be 5*4x3x2 = 120 new additions to jacobian_quantities in the order: [{line_identities[0], species[0], variables[0] coefficients[0]}] [{line_identities[0], species[0], variables[0] coefficients[1]}] [{line_identities[0], species[0], variables[1] coefficients[0]}] [{line_identities[0], species[0], variables[1] coefficients[1]}] [{line_identities[0], species[0], variables[2] coefficients[0]}] [{line_identities[0], species[0], variables[2] coefficients[1]}] [{line_identities[0], species[1], variables[0] coefficients[0]}] ... [{line_identities[4], species[3], variables[1] coefficients[1]}] [{line_identities[4], species[3], variables[2] coefficients[0]}] [{line_identities[4], species[3], variables[2] coefficients[1]}] or in words: lines first, then species, then variables, then coefficients

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]line_identities- List of line identifiers
[in]species- List of species of interest
[in]variables- List of variables of interest
[in]coefficients- List of coefficients of interest

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 98594 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), ARTS::Var::ArrayOfString::islast(), ARTS::Var::ArrayOfQuantumIdentifier::pos(), and ARTS::Var::ArrayOfString::pos().

◆ jacobianAddSinefit()

MRecord ARTS::AgendaMethod::jacobianAddSinefit ( [[maybe_unused] ] Workspace ws,
const Var::Vector  period_lengths,
const Var::Index no_pol_variation = {},
const Var::Index no_los_variation = {},
const Var::Index no_mblock_variation = {} 
)
inline

Includes sinusoidal baseline fit in the Jacobian.

Works as jacobianAddPolyfit, beside that a series of sine and cosine terms are used for the baseline fit.

For each value in *period_lengths one sine and one cosine term are included (in mentioned order). By these two terms the amplitude and "phase" for each period length can be determined. The sine and cosine terms have value 0 and 1, respectively, for first frequency.

If the simulation/retrieval deals with a single spectrum, the number of elements added to the state vector (x) is 2*nperiods, where nperiods is the length of period_lengths. The same is true if no_pol_variation, no_los_variation and no_mblock_variation all are set to 1, even if several spectra are involved. Otherwise thenumber of elements added to x depends on the number of spectra and the settings of no_pol_variation, no_los_variation and no_mblock_variation*. The sine and cosine terms for each period length are treated as a separate retrieval quantities. That is, the the elements associated with the first period length are grouped and form together a retrieval quantity, etc. Inside each retrieval quantity the pairs of sine and cosine terms are kept together, in given order.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]period_lengths- Period lengths of the fit.
[in]no_pol_variation- Set to 1 if the baseline off-set is the same for all Stokes components. (default: 0)
[in]no_los_variation- Set to 1 if the baseline off-set is the same for all line-of-sights (inside each measurement block). (default: 0)
[in]no_mblock_variation- Set to 1 if the baseline off-set is the same for all measurement blocks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99032 of file autoarts.h.

◆ jacobianAddSpecialSpecies()

MRecord ARTS::AgendaMethod::jacobianAddSpecialSpecies ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String  species 
)
inline

Includes a special absorption species in the Jacobian.

Similar to jacobianAddAbsSpecies but only for number densities.

Species allowed are: "electrons" "particulates"

Note that the average of all particulates are used to scale its jacobian*, so this method works best when only one type of particulate is being used, i.e., when scat_data has only one scattering species.

The number of elements added to the state vector (x) is: n_g1 * n_g2 * n_g3 where n_g1, n_g2 and n_g3 are the length of GIN g1, g2 and g3, respectively. Here empty vectors should be considered to have a length 1. The elements are sorted with pressure as innermost loop, followed by latitude and longitude as outermost loop.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]species- The species of the retrieval quantity.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99098 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ jacobianAddSurfaceQuantity()

MRecord ARTS::AgendaMethod::jacobianAddSurfaceQuantity ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::String  quantity 
)
inline

Includes a surface quantity in the Jacobian.

The quantity is specified by the GIN-variable quantity. The name of the quantity must match the name used in surface_props_names.

For 1D or 2D calculations the latitude and/or longitude grid of the retrieval field should set to have zero length.

The number of elements added to the state vector (x) is: n_g1 * n_g2 where n_g1 and n_g2 are the length of GIN g1 and g2, respectively. Here empty vectors should be considered to have a length 1. The elements are sorted with latitude as innermost loop and longitude as outermost loop.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Latitude retrieval grid.
[in]g2- Longitude retreival grid.
[in]quantity- Retrieval quantity, e.g. "Wind speed".

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99149 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ jacobianAddTemperature()

MRecord ARTS::AgendaMethod::jacobianAddTemperature ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String hse = {} 
)
inline

Includes atmospheric temperatures in the Jacobian.

The calculations are performed by (semi-)analytical expressions. Hydrostatic equilibrium (HSE) can be included.

The analytical calculation approach neglects so far refraction totally, but considers the local effect of HSE. The later should be accaptable for observations around zenith and nadir. There is no warning if the method is applied incorrectly, with respect to these issues. Note that the argument hse of this WSM only refers to the Jacobian calculation, if the model and/or retrieved atmosphere actually fulfils HSE or not is governed in other manners.

The calculations (both options) assume that gas species are defined in VMR (a change in temperature then changes the number density). This has the consequence that retrieval of temperatures and number density can not be mixed. Neither any warning here!

The number of elements added to the state vector (x) is: n_g1 * n_g2 * n_g3 where n_g1, n_g2 and n_g3 are the length of GIN g1, g2 and g3, respectively. Here empty vectors should be considered to have a length 1. The elements are sorted with pressure as innermost loop, followed by latitude and longitude as outermost loop.

Author
Mattias Ekstrom
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]hse- Flag to assume HSE or not ("on" or "off"). (default: "on")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99210 of file autoarts.h.

◆ jacobianAddWind()

MRecord ARTS::AgendaMethod::jacobianAddWind ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String component = {},
const Var::Numeric dfrequency = {} 
)
inline

Includes one atmospheric wind component in the Jacobian.

The method follows the pattern of other Jacobian methods. The calculations can only be performed by analytic expressions. Some lower level function depends on frequency perturbations, however, so therefore a frequency perturbation df is required and as a consequence abs_f_interp_order must be > 0.

The wind field components are retrieved separately, and, hence, the argument component can be "u", "v" or "w" for vector components, or just "strength" for total wind speed.

The number of elements added to the state vector (x) is: n_g1 * n_g2 * n_g3 where n_g1, n_g2 and n_g3 are the length of GIN g1, g2 and g3, respectively. Here empty vectors should be considered to have a length 1. The elements are sorted with pressure as innermost loop, followed by latitude and longitude as outermost loop.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retrieval grid.
[in]component- Wind component to retrieve (default: "v")
[in]dfrequency- This is the frequency perturbation (default: 0.1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99270 of file autoarts.h.

◆ jacobianAdjustAndTransform()

MRecord ARTS::AgendaMethod::jacobianAdjustAndTransform ( [[maybe_unused] ] Workspace ws)
inline

Applies adjustments and transformations on jacobian.

The method handles two tasks:

  1. The retrieval transformations set by the user can not be applied onthe Jacobian inside yCalc. Transformations are instead applied by calling this method.
  2. It applies required adjustments of the Jacoboan. So far there is only one possible adjustment. If any absorption species uses the "rel" unit, an adjustment is needed for later iterations of the inversion.

If no tranformations are selected and the "rel" option is not used at all, there is no need to call this method(, but you can still include it without causing any error, the calculations will just be a bit slower). Otherwise, this method should be called, typically as part of inversion_iterate_agenda*.

The method accepts if jacobian is empty, and then does, nothing.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99330 of file autoarts.h.

◆ jacobianCalcDoNothing()

MRecord ARTS::AgendaMethod::jacobianCalcDoNothing ( [[maybe_unused] ] Workspace ws)
inline

This function doesn't do anything. It just exists to satisfy the input and output requirement of the jacobian_agenda.

This method is added to jacobian_agenda by jacobianAddAbsSpecies and some similar methods, and it should normally not be called by the user.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99356 of file autoarts.h.

◆ jacobianCalcFreqShift()

MRecord ARTS::AgendaMethod::jacobianCalcFreqShift ( [[maybe_unused] ] Workspace ws)
inline

Calculates frequency shift jacobians by interpolation of iyb.

This function is added to jacobian_agenda by jacobianAddFreqShift and should normally not be called by the user.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99381 of file autoarts.h.

◆ jacobianCalcFreqStretch()

MRecord ARTS::AgendaMethod::jacobianCalcFreqStretch ( [[maybe_unused] ] Workspace ws)
inline

Calculates frequency stretch jacobians by interpolation of iyb.

This function is added to jacobian_agenda by jacobianAddFreqStretch and should normally not be called by the user.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99406 of file autoarts.h.

◆ jacobianCalcPointingZaInterp()

MRecord ARTS::AgendaMethod::jacobianCalcPointingZaInterp ( [[maybe_unused] ] Workspace ws)
inline

Calculates zenith angle pointing deviation jacobians by inter-extrapolation of iyb.

This function is added to jacobian_agenda by jacobianAddPointingZa and should normally not be called by the user.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99432 of file autoarts.h.

◆ jacobianCalcPointingZaRecalc()

MRecord ARTS::AgendaMethod::jacobianCalcPointingZaRecalc ( [[maybe_unused] ] Workspace ws)
inline

Calculates zenith angle pointing deviation jacobians by recalulation of iyb.

This function is added to jacobian_agenda by jacobianAddPointingZa and should normally not be called by the user.

Author
Mattias Ekstrom
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99459 of file autoarts.h.

◆ jacobianCalcPolyfit()

MRecord ARTS::AgendaMethod::jacobianCalcPolyfit ( [[maybe_unused] ] Workspace ws,
const Var::Index  poly_coeff 
)
inline

Calculates jacobians for polynomial baseline fit.

This function is added to jacobian_agenda by jacobianAddPolyfit and should normally not be called by the user.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]poly_coeff- Polynomial coefficient to handle.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99484 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::Index::pos(), and ARTS::Var::Index::value().

◆ jacobianCalcSinefit()

MRecord ARTS::AgendaMethod::jacobianCalcSinefit ( [[maybe_unused] ] Workspace ws,
const Var::Index  period_index 
)
inline

Calculates jacobians for sinusoidal baseline fit.

This function is added to jacobian_agenda by jacobianAddPolyfit and should normally not be called by the user.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]period_index- Index among the period length specified for add-method.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99514 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::Index::pos(), and ARTS::Var::Index::value().

◆ jacobianClose()

MRecord ARTS::AgendaMethod::jacobianClose ( [[maybe_unused] ] Workspace ws)
inline

Closes the array of retrieval quantities and prepares for calculation of the Jacobian matrix.

This function closes the jacobian_quantities array and sets jacobian_do* to 1.

Retrieval quantities should not be added after a call to this WSM. No calculations are performed here.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99547 of file autoarts.h.

◆ jacobianFromTwoY()

MRecord ARTS::AgendaMethod::jacobianFromTwoY ( [[maybe_unused] ] Workspace ws,
const Var::Vector  y_pert,
const Var::Numeric  pert_size 
)
inline

Sets jacobian based on the difference vetween two measurement vectors.

This function assumes that y_pert contains a measurement calculated with some variable perturbed, in comparison to the calculation behind y. The function takes the differences between y_pert and y to form a numerical derived estimate of jacobian. This gives a Jacobian wit a single column.

jacobian* equals here: (y_pert-y)/pert_size.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]y_pert- Perturbed measurement vector
[in]pert_size- Size of perturbation behind spectra in ybatch.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99578 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Vector::pos().

◆ jacobianFromYbatch()

MRecord ARTS::AgendaMethod::jacobianFromYbatch ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  pert_size 
)
inline

Sets jacobian based on perturbation calcuations.

This function assumes that ybatch contains spectra calculated with some variable perturbed, in comparison to the calculation behind y. The function takes the differences between ybatch and y to form a numerical derived estimate of jacobian.

Column i of jacobian equals: (ybatch[i]-y)/pert_size.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]pert_size- Size of perturbation behind spectra in ybatch.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99615 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ jacobianInit()

MRecord ARTS::AgendaMethod::jacobianInit ( [[maybe_unused] ] Workspace ws)
inline

Initialises the variables connected to the Jacobian matrix.

This function initialises the jacobian_quantities array so that retrieval quantities can be added to it. Accordingly, it has to be called before any calls to jacobianAddTemperature or similar methods.

The Jacobian quantities are initialised to be empty.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99648 of file autoarts.h.

◆ jacobianOff()

MRecord ARTS::AgendaMethod::jacobianOff ( [[maybe_unused] ] Workspace ws)
inline

Makes mandatory initialisation of some jacobian variables.

Some clear-sky jacobian WSVs must be initialised even if no such calculations will be performed. This is handled with this method. That is, this method must be called when no clear-sky jacobians will be calculated (even if cloudy-sky jacobians are calculated!).

Sets jacobian_do to 0.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99676 of file autoarts.h.

◆ jacobianSetAffineTransformation()

MRecord ARTS::AgendaMethod::jacobianSetAffineTransformation ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  transformation_matrix,
const Var::Vector  offset_vector 
)
inline

Adds an affine transformation of the last element of jacobian_quantities*.

See jacobianSetFuncTransformation for a general description of how retrieval transformations are defined. Transformations are not applied by methods such as*yCalc*. Instead, the method jacobianAdjustAndTransform must be called to activate the transformations.

The affine transformation is specified by a transformation matrix, A, and an offset vector, b. These two are applied as described in jacobianSetFuncTransformation*.

The transformations is applied as x = A * ( z - b ) where z is the retrieval quantity on the standard retrieval grids and x is the final state vector.

So far, the following must be true for valid A-matrices z = A'*x + b That is, the reversed transformation is given by A transposed.

This method must only be called if an affine transformation is wanted. Default is to make no such tranformation at all.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]transformation_matrix- The transformation matrix A
[in]offset_vector- The offset vector b

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99721 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ jacobianSetFuncTransformation()

MRecord ARTS::AgendaMethod::jacobianSetFuncTransformation ( [[maybe_unused] ] Workspace ws,
const Var::String  transformation_func,
const Var::Numeric z_min = {},
const Var::Numeric z_max = {} 
)
inline

Sets the functional transformation of the last element of jacobian_quantities*.

See below for a general description of how retrieval transformations are defined. Transformations are not applied by methods such as*yCalc*. Instead, the method jacobianAdjustAndTransform must be called to activate the transformations.

The following transformations can be selected (by transformation_func): log : The natural logarithm log10 : The base-10 logarithm atanh : Area hyperbolic tangent none : No transformation at all

This method needs only to be called if a functional transformation is wanted. Default is to make no such tranformation at all (i.e. the option "none" exists only for reasons of flexibility).

The log-options are applied as log(z-z_min) and log10(z-z_min). The default for z_min is zero, but by changing it the lower limit for z can be changed. Note that z_min becomes the lower limit for allowed values of z. The GIN z_max is here ignored.

For the atanh-option, also z_max is considered. This transformation is applied as atanh((2(z-z_min)/(z_max-z_min))-1). As above,z_min is lower limit for allowed values of z. On the other hand, z_max eines the upper limit for z.

The GIN transformation_func is so far only used for atanh. The parameter specifies the maximum allowed value allowed for u. That is, the valid range for u becomes ]0,tfunc_parameter[. Note that log and log10 demands/ensures that u > 0, but implies no upper limit.

General handling of retrieval units and transformations:

Default is that quantities are retrieved as defined in ARTS, but both some unit conversion and transformations are provided. These operations are applied as: x = A * ( f(u(z)) - b ) where z is the quantity as defined ARTS u represents the change of unit f is the transformation function A and b define together an affine transformation x is the retrieved quantity For example, this systen allows to retrive a principal component representation (A and b) of the log (f) of relative humidity (u).

Change of unit is selected by the quantity specific jacobian-add methods (so far only at hand for gas species).

Activating a transformation function is done by this method. Note that the functions are defined as the transformation from z to x. For more details on affine transformations, see jacobianSetAffineTransformation*.

Author
Patrick Eriksson
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]transformation_func- The transformation function.
[in]z_min- Lower limit of z. (default: 0)
[in]z_max- Upper limit of z. (default: -99e99)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99808 of file autoarts.h.

◆ lat_gridFromRawField()

MRecord ARTS::AgendaMethod::lat_gridFromRawField ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField3  field_raw 
)
inline

Sets lat_grid according to given raw atmospheric field's lat_grid. Similar to p_gridFromZRaw, but acting on a generic GriddedField3 (e.g., a wind or magnetic field component).

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]field_raw- A raw atmospheric field.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99849 of file autoarts.h.

References ARTS::Var::GriddedField3::islast(), and ARTS::Var::GriddedField3::pos().

◆ lat_gridFromZRaw()

MRecord ARTS::AgendaMethod::lat_gridFromZRaw ( [[maybe_unused] ] Workspace ws)
inline

Sets lat_grid according to input atmosphere's z_field_raw

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110464 of file autoarts.h.

◆ lbl_checkedCalc()

MRecord ARTS::AgendaMethod::lbl_checkedCalc ( [[maybe_unused] ] Workspace ws)
inline

Checks that the line-by-line parameters are OK.

On failure, will throw. On success, lbl_checked evals as true

Note that checks may become more stringent as ARTS evolves, especially for "new" options. This test might succeed in one version of ARTS but fail in later versions

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99881 of file autoarts.h.

◆ line_irradianceCalcForSingleSpeciesNonOverlappingLinesPseudo2D()

MRecord ARTS::AgendaMethod::line_irradianceCalcForSingleSpeciesNonOverlappingLinesPseudo2D ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  df,
const Var::Index  nz,
const Var::Index  nf,
const Var::Numeric r = {} 
)
inline

Computes the line irradiance and line transmission

Presently only works for 1D atmospheres

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]df- relative frequency to line center
[in]nz- number of zeniths
[in]nf- number of frequencies per line
[in]r- Distance assumed when computing local (1-T) (default: 1.0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110672 of file autoarts.h.

◆ LocalTimeOffset()

MRecord ARTS::AgendaMethod::LocalTimeOffset ( [[maybe_unused] ] Workspace ws,
Var::Numeric  dt 
)
inline

Sets the seconds between localtime and gmtime representation of now().

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]dt- Time in seconds between local and gmt

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99903 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ lon_gridFromRawField()

MRecord ARTS::AgendaMethod::lon_gridFromRawField ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField3  field_raw 
)
inline

Sets lon_grid according to given raw atmospheric field's lat_grid. Similar to p_gridFromZRaw, but acting on a generic GriddedField3 (e.g., a wind or magnetic field component).

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]field_raw- A raw atmospheric field.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99932 of file autoarts.h.

References ARTS::Var::GriddedField3::islast(), and ARTS::Var::GriddedField3::pos().

◆ lon_gridFromZRaw()

MRecord ARTS::AgendaMethod::lon_gridFromZRaw ( [[maybe_unused] ] Workspace ws)
inline

Sets lon_grid according to input atmosphere's z_field_raw

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110485 of file autoarts.h.

◆ MagFieldsCalc()

MRecord ARTS::AgendaMethod::MagFieldsCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index interp_order = {} 
)
inline

Interpolation of raw magnetic fields to calculation grids. Heritage from AtmFieldsCalc

Internally, MagFieldsCalc applies GriddedFieldPRegrid and GriddedFieldLatLonRegrid*. Generally, 'half-grid-step' extrapolation is allowed and applied.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]interp_order- Interpolation order (1=linear interpolation). (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 99964 of file autoarts.h.

◆ MagFieldsCalcExpand1D()

MRecord ARTS::AgendaMethod::MagFieldsCalcExpand1D ( [[maybe_unused] ] Workspace ws,
const Var::Index interp_order = {} 
)
inline

Interpolation of 1D raw atmospheric fields to create 2D or 3D homogeneous magnetic fields. Derived from AtmFieldsCalcExpand1D

The method works as MagFieldsCalc, but accepts only raw 1D magnetic fields. The raw data is interpolated to p_grid and the obtained values are applied for all latitudes, and also longitudes for 3D, to create a homogeneous atmosphere.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]interp_order- Interpolation order (1=linear interpolation). (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100000 of file autoarts.h.

◆ MagFieldsFromAltitudeRawCalc()

MRecord ARTS::AgendaMethod::MagFieldsFromAltitudeRawCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index interp_order = {},
const Var::Numeric extrapolating = {} 
)
inline

Regrids the rawfield by lat-lon and interpolates to z_field.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]interp_order- Interpolation order (1=linear interpolation). (default: 1)
[in]extrapolating- Extrapolation allowed in interpolation of altitude. (default: 1e99)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100031 of file autoarts.h.

◆ MagRawRead()

MRecord ARTS::AgendaMethod::MagRawRead ( [[maybe_unused] ] Workspace ws,
const Var::String  basename 
)
inline

Reads magnetic field data from a scenario.

A full set of field components is read (NOTE: fails if scenario only contains selected field components). The files can be anywhere, but must all be in the same directory specified by 'basename'. Naming convention for the field component files is basename.mag_u.xml for the u-component, v- and w-components accordingly.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- Name of scenario, probably including the full path. For example: "/data/magnetic_field"

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100074 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ Matrix1ColFromVector()

MRecord ARTS::AgendaMethod::Matrix1ColFromVector ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  v 
)
inline

Forms a matrix containing one column from a vector.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]v- The vector to be copied.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100591 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ Matrix1RowFromVector()

MRecord ARTS::AgendaMethod::Matrix1RowFromVector ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  v 
)
inline

Forms a matrix containing one row from a vector.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]v- The vector to be copied.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100702 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ Matrix2ColFromVectors()

MRecord ARTS::AgendaMethod::Matrix2ColFromVectors ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  v1,
const Var::Vector  v2 
)
inline

Forms a matrix containing two columns from two vectors.

The vectors are included as columns in the matrix in the same order as they are given.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]v1- The vector to be copied into the first column.
[in]v2- The vector to be copied into the second column.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100626 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ Matrix2RowFromVectors()

MRecord ARTS::AgendaMethod::Matrix2RowFromVectors ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  v1,
const Var::Vector  v2 
)
inline

Forms a matrix containing two rows from two vectors.

The vectors are included as rows in the matrix in the same order as they are given.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]v1- The vector to be copied into the first row.
[in]v2- The vector to be copied into the second row.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100737 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ Matrix3ColFromVectors()

MRecord ARTS::AgendaMethod::Matrix3ColFromVectors ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  v1,
const Var::Vector  v2,
const Var::Vector  v3 
)
inline

Forms a matrix containing three columns from three vectors.

The vectors are included as columns in the matrix in the same order as they are given.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]v1- The vector to be copied into the first column.
[in]v2- The vector to be copied into the second column.
[in]v3- The vector to be copied into the third column.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100665 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ Matrix3RowFromVectors()

MRecord ARTS::AgendaMethod::Matrix3RowFromVectors ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  v1,
const Var::Vector  v2,
const Var::Vector  v3 
)
inline

Forms a matrix containing three rows from three vectors.

The vectors are included as rows in the matrix in the same order as they are given.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]v1- The vector to be copied into the first row.
[in]v2- The vector to be copied into the second row.
[in]v3- The vector to be copied into the third row.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100776 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ MatrixAddScalar()

MRecord ARTS::AgendaMethod::MatrixAddScalar ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Matrix  in,
const Var::Numeric  value 
)
inline

Adds a scalar to all elements of a matrix.

The result can either be stored in the same or another matrix.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output matrix
[in]in- Input matrix.
[in]value- The value to be added to the matrix.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100105 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Numeric::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Numeric::pos().

◆ MatrixCBR()

MRecord ARTS::AgendaMethod::MatrixCBR ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  f 
)
inline

Sets a matrix to hold cosmic background radiation (CBR).

The CBR is assumed to be un-polarized and Stokes components 2-4 are zero. Number of Stokes components, that equals the number of columns in the created matrix, is determined by stokes_dim. The number of rows in the created matrix equals the length of the given frequency vector.

The cosmic radiation is modelled as blackbody radiation for the temperature given by the global constant COSMIC_BG_TEMP, set in the file constants.cc. The frequencies are taken from the generic input vector.

The standard definition, in ARTS, of the Planck function is followed and the unit of the returned data is W/(m3 * Hz * sr).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]f- Frequency vector.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100153 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ MatrixCopySparse()

MRecord ARTS::AgendaMethod::MatrixCopySparse ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Sparse  in 
)
inline

Creates a matrix by copying a variable of type Sparse.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Created (full) matrix.
[in]in- The sparse matrix to be copied.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100184 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Sparse::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Sparse::pos().

◆ MatrixExtractFromTensor3()

MRecord ARTS::AgendaMethod::MatrixExtractFromTensor3 ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Tensor3  in,
const Var::Index  i,
const Var::String  direction 
)
inline

Extracts a Matrix from a Tensor3.

Copies page or row or column with given Index from input Tensor3 variable to output Matrix. Higher order equivalent of VectorExtractFromMatrix.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Extracted matrix.
[in]in- Input matrix.
[in]i- Index of page or row or column to extract.
[in]direction- Direction. "page" or "row" or "column".

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100221 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::Matrix::islast(), ARTS::Var::String::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::Index::pos(), ARTS::Var::Matrix::pos(), ARTS::Var::String::pos(), and ARTS::Var::Tensor3::pos().

◆ MatrixFromCovarianceMatrix()

MRecord ARTS::AgendaMethod::MatrixFromCovarianceMatrix ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::CovarianceMatrix  in 
)
inline

Turns a covariance matrix into a Matrix.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Dense Matrix.
[in]in- Input covariance matrix.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100258 of file autoarts.h.

References ARTS::Var::CovarianceMatrix::islast(), ARTS::Var::Matrix::islast(), ARTS::Var::CovarianceMatrix::pos(), and ARTS::Var::Matrix::pos().

◆ MatrixIdentity()

MRecord ARTS::AgendaMethod::MatrixIdentity ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Index  n,
const Var::Numeric value = {} 
)
inline

Returns an identity matrix.

The size if the matrix created is n x n. Default is to return a true identity matrix (I), but you can also select another value along the diagonal by setting value. That is, the output is value*I.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output matrix
[in]n- Size of the matrix
[in]value- The value along the diagonal. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100295 of file autoarts.h.

◆ MatrixMatrixMultiply()

MRecord ARTS::AgendaMethod::MatrixMatrixMultiply ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Matrix  m,
const Var::Matrix  x 
)
inline

Multiply a Matrix with another Matrix and store the result in the result Matrix.

This just computes the normal Matrix-Matrix product, Y=M*X. It is ok if Y and X are the same Matrix.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The result of the multiplication (dimension mxc).
[in]m- The Matrix to multiply (dimension mxn).
[in]x- The original Matrix (dimension nxc).

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100337 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), ARTS::Var::Vector::pos(), and ARTS::Var::x().

◆ MatrixPlanck()

MRecord ARTS::AgendaMethod::MatrixPlanck ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  f,
const Var::Numeric  t 
)
inline

Sets a matrix to hold blackbody radiation.

The radiation is assumed to be un-polarized and Stokes components 2-4 are zero. Number of Stokes components, that equals the number of columns in the created matrix, is determined by stokes_dim. The number of rows in the created matrix equals the length of the given frequency vector.

The standard definition, in ARTS, of the Planck function is followed and the unit of the returned data is W/(m3 * Hz * sr).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]f- Frequency vector.
[in]t- Temperature [K].

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100381 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), ARTS::Var::Numeric::pos(), and ARTS::Var::Vector::pos().

◆ MatrixScale()

MRecord ARTS::AgendaMethod::MatrixScale ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Matrix  in,
const Var::Numeric  value 
)
inline

Scales all elements of a matrix with the specified value.

The result can either be stored in the same or another variable.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output matrix
[in]in- Input matrix.
[in]value- The value to be multiplied with the matrix.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100419 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Numeric::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Numeric::pos().

◆ MatrixSet()

MRecord ARTS::AgendaMethod::MatrixSet ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Matrix  value 
)
inline

Initialize a Matrix from the given list of numbers.

Usage: MatrixSet(m1, [1, 2, 3; 4, 5, 6])

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The newly created matrix
[in]value- The values of the newly created matrix. Elements are separated by commas, rows by semicolons.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100456 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Matrix::value().

◆ MatrixSetConstant()

MRecord ARTS::AgendaMethod::MatrixSetConstant ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Numeric  value 
)
inline

Creates a matrix and sets all elements to the specified value.

The size is determined by ncols and nrows.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- Matrix value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100489 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Numeric::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Numeric::pos().

◆ MatrixUnitIntensity()

MRecord ARTS::AgendaMethod::MatrixUnitIntensity ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::Vector  f 
)
inline

Sets a matrix to hold unpolarised radiation with unit intensity.

Works as MatrixPlanck where the radiation is set to 1.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]f- Frequency vector.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100522 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ MatrixVectorMultiply()

MRecord ARTS::AgendaMethod::MatrixVectorMultiply ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Matrix  m,
const Var::Vector  v 
)
inline

Multiply a Matrix with a Vector

Computes the normal Matrix-Vector product, out=m*v. It is ok if out and v are the same Vector.

Author
Stefan Buehler and Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The result of the multiplication (length m).
[in]m- The Matrix to multiply (dimension mxn).
[in]v- The original Vector (length n).

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100557 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ mblock_dlos_gridUniformCircular()

MRecord ARTS::AgendaMethod::mblock_dlos_gridUniformCircular ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  spacing,
const Var::Numeric  width,
const Var::Index centre = {} 
)
inline

Gives mblock_dlos_grid roughly circular coverage, with uniform spacing.

The method considers points on a regular grid with a spacing set by GIN spacing. All points inside a radius from (0,0) are included in mblock_dlos_grid*. The positions in mblock_dlos_grid thus covers a roughly circular domain, and cover the same solid beam angle. The radius is adjusted according to spacing' and *centre, but is ensured to be >= width.

Note that the method assumes that width is small and the solid beam angle does not change with distance from (0.0).

Defualt is to consider grid positions of ..., -spacing/2, spacing/2, ... If you want to have (0,0) as a point in mblock_dlos_grid, change centre* from its default value.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]spacing- The angular spacing between points.
[in]width- The minimum distance from (0,0) to cover.
[in]centre- Set to 1 to place a point at (0,0). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100828 of file autoarts.h.

◆ mblock_dlos_gridUniformRectangular()

MRecord ARTS::AgendaMethod::mblock_dlos_gridUniformRectangular ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  spacing,
const Var::Numeric  za_width,
const Var::Numeric  aa_width,
const Var::Index centre = {} 
)
inline

Gives mblock_dlos_grid rectangular coverage, with uniform spacing.

The method creates an equidistant rectangular grid. The width in zenith and azimuth can differ. Note that selected widths are half-widths (i.e. distance from (0,0), and refers to the mimumum value allowed. The actual width depends on values selected for spacing and centre.

Defualt is to consider grid positions of ..., -spacing/2, spacing/2, ... If you want to have (0,0) as a point in mblock_dlos_grid, change centre* from its default value.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]spacing- The angular spacing between points.
[in]za_width- Min value of half-width in zenith angle direction.
[in]aa_width- Min value of half-width in azimuth angle direction.
[in]centre- Set to 1 to place a point at (0,0). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100876 of file autoarts.h.

◆ mc_antennaSetGaussian()

MRecord ARTS::AgendaMethod::mc_antennaSetGaussian ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  za_sigma,
const Var::Numeric  aa_sigma 
)
inline

Makes mc_antenna (used by MCGeneral) a 2D Gaussian pattern.

The gaussian antenna pattern is determined by za_sigma and aa_sigma*, which represent the standard deviations in the uncorrelated bivariate normal distribution.

Author
Cory Davis
Parameters
[in,out]Workspacews - An ARTS workspace
[in]za_sigma- Width in the zenith angle dimension as described above.
[in]aa_sigma- Width in the azimuth angle dimension as described above.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100920 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ mc_antennaSetGaussianByFWHM()

MRecord ARTS::AgendaMethod::mc_antennaSetGaussianByFWHM ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  za_fwhm,
const Var::Numeric  aa_fwhm 
)
inline

Makes mc_antenna (used by MCGeneral) a 2D Gaussian pattern.

The gaussian antenna pattern is determined by za_fwhm and aa_fwhm*, which represent the full width half maximum (FWHM) of the antenna response, in the zenith and azimuthal planes.

Author
Cory Davis
Parameters
[in,out]Workspacews - An ARTS workspace
[in]za_fwhm- Width in the zenith angle dimension as described above.
[in]aa_fwhm- Width in the azimuth angle dimension as described above.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100955 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ mc_antennaSetPencilBeam()

MRecord ARTS::AgendaMethod::mc_antennaSetPencilBeam ( [[maybe_unused] ] Workspace ws)
inline

Makes mc_antenna (used by MCGeneral) a pencil beam.

This WSM makes the subsequent MCGeneral WSM perform pencil beam RT calculations.

Author
Cory Davis
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 100987 of file autoarts.h.

◆ MCGeneral()

MRecord ARTS::AgendaMethod::MCGeneral ( [[maybe_unused] ] Workspace ws,
const Var::Index l_mc_scat_order = {},
const Var::Index t_interp_order = {} 
)
inline

A generalised 3D reversed Monte Carlo radiative algorithm, that allows for 2D antenna patterns, surface reflection and arbitrary sensor positions.

The main output variables y and mc_error represent the Stokes vector integrated over the antenna function, and the estimated error in this vector, respectively.

The WSV mc_max_iter describes the maximum number of ‘photons’ used in the simulation (more photons means smaller mc_error). mc_std_err* is the desired value of mc_error. mc_max_time is the maximum allowed number of seconds for MCGeneral. The method will terminate once any of the max_iter, std_err, max_time criteria are met. If negative values are given for these parameters then it is ignored.

The WSV mc_min_iter sets the minimum number of photons to apply before the condition set by mc_std_err is considered. Values of mc_min_iter below 100 are not accepted.

Only "1" and "RJBT" are allowed for iy_unit. The value of mc_error* follows the selection for iy_unit (both for in- and output.

Author
Cory Davis
Parameters
[in,out]Workspacews - An ARTS workspace
[in]l_mc_scat_order- The length to be given to mc_scat_order. Note that scattering orders equal and above this value will not be counted. (default: 11)
[in]t_interp_order- Interpolation order of temperature for scattering data (so far only applied in phase matrix, not in extinction and absorption. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101032 of file autoarts.h.

◆ MCRadar()

MRecord ARTS::AgendaMethod::MCRadar ( [[maybe_unused] ] Workspace ws,
const Var::Numeric ze_tref = {},
const Var::Numeric k2 = {},
const Var::Index t_interp_order = {} 
)
inline

A radar 3D foward Monte Carlo radiative algorithm, that allows for 2D antenna patterns and arbitrary sensor positions. Surface reflections are currently ignored.

The main output variable y and mc_error represent the radar reflectivity integrated over the antenna function, and the estimated error in this vector, respectively.

Unlike with yActive, the range bins gives the boundaries of the range bins as either round-trip time or distance from radar.

The WSV mc_y_tx gives the polarization state of the transmitter.

The WSV mc_max_scatorder prescribes the maximum scattering order to consider, after which ‘photon’-tracing will be terminated. A value of one calculates only single scattering.

The WSV mc_max_iter describes the maximum number of ‘photons’ used in the simulation (more photons means smaller mc_error). The method will terminate once the max_iter criterium is met. If negative values are given for these parameters then it is ignored.

Only "1" and "Ze" are allowed for iy_unit. The value of mc_error* follows the selection for iy_unit (both for in- and output.

Author
Ian S. Adams
Parameters
[in,out]Workspacews - An ARTS workspace
[in]ze_tref- Reference temperature for conversion to Ze. (default: 273.15)
[in]k2- Reference dielectric factor. (default: -1)
[in]t_interp_order- Interpolation order of temperature for scattering data (so far only applied in phase matrix, not in extinction and absorption. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101096 of file autoarts.h.

◆ MCSetSeedFromTime()

MRecord ARTS::AgendaMethod::MCSetSeedFromTime ( [[maybe_unused] ] Workspace ws)
inline

Sets the value of mc_seed from system time

Author
Cory Davis
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101137 of file autoarts.h.

◆ nbooksGet() [1/4]

MRecord ARTS::AgendaMethod::nbooksGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  v 
)
inline

Retrieve nbooks from given variable and store the value in the workspace variable nbooks

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of books from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103403 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), and ARTS::Var::Tensor4::pos().

◆ nbooksGet() [2/4]

MRecord ARTS::AgendaMethod::nbooksGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  v 
)
inline

Retrieve nbooks from given variable and store the value in the workspace variable nbooks

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of books from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103431 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), and ARTS::Var::Tensor5::pos().

◆ nbooksGet() [3/4]

MRecord ARTS::AgendaMethod::nbooksGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  v 
)
inline

Retrieve nbooks from given variable and store the value in the workspace variable nbooks

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of books from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103459 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), and ARTS::Var::Tensor6::pos().

◆ nbooksGet() [4/4]

MRecord ARTS::AgendaMethod::nbooksGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  v 
)
inline

Retrieve nbooks from given variable and store the value in the workspace variable nbooks

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of books from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103487 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ ncolsGet() [1/7]

MRecord ARTS::AgendaMethod::ncolsGet ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  v 
)
inline

Retrieve ncols from given variable and store the value in the workspace variable ncols

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of columns from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102871 of file autoarts.h.

References ARTS::Var::Matrix::islast(), and ARTS::Var::Matrix::pos().

◆ ncolsGet() [2/7]

MRecord ARTS::AgendaMethod::ncolsGet ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  v 
)
inline

Retrieve ncols from given variable and store the value in the workspace variable ncols

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of columns from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102899 of file autoarts.h.

References ARTS::Var::Sparse::islast(), and ARTS::Var::Sparse::pos().

◆ ncolsGet() [3/7]

MRecord ARTS::AgendaMethod::ncolsGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  v 
)
inline

Retrieve ncols from given variable and store the value in the workspace variable ncols

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of columns from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102927 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), and ARTS::Var::Tensor3::pos().

◆ ncolsGet() [4/7]

MRecord ARTS::AgendaMethod::ncolsGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  v 
)
inline

Retrieve ncols from given variable and store the value in the workspace variable ncols

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of columns from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102955 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), and ARTS::Var::Tensor4::pos().

◆ ncolsGet() [5/7]

MRecord ARTS::AgendaMethod::ncolsGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  v 
)
inline

Retrieve ncols from given variable and store the value in the workspace variable ncols

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of columns from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102983 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), and ARTS::Var::Tensor5::pos().

◆ ncolsGet() [6/7]

MRecord ARTS::AgendaMethod::ncolsGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  v 
)
inline

Retrieve ncols from given variable and store the value in the workspace variable ncols

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of columns from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103011 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), and ARTS::Var::Tensor6::pos().

◆ ncolsGet() [7/7]

MRecord ARTS::AgendaMethod::ncolsGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  v 
)
inline

Retrieve ncols from given variable and store the value in the workspace variable ncols

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of columns from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103039 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ nelemGet() [1/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAbsorptionLines  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101527 of file autoarts.h.

References ARTS::Var::ArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfAbsorptionLines::pos().

◆ nelemGet() [2/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAgenda  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101583 of file autoarts.h.

References ARTS::Var::ArrayOfAgenda::islast(), and ARTS::Var::ArrayOfAgenda::pos().

◆ nelemGet() [3/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfAbsorptionLines  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101555 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfArrayOfAbsorptionLines::pos().

◆ nelemGet() [4/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField1  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101611 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField1::pos().

◆ nelemGet() [5/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField2  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101639 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField2::pos().

◆ nelemGet() [6/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField3  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101667 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField3::pos().

◆ nelemGet() [7/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfIndex  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101695 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfIndex::islast(), and ARTS::Var::ArrayOfArrayOfIndex::pos().

◆ nelemGet() [8/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfMatrix  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101723 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfMatrix::islast(), and ARTS::Var::ArrayOfArrayOfMatrix::pos().

◆ nelemGet() [9/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfPropagationMatrix  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101779 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfArrayOfPropagationMatrix::pos().

◆ nelemGet() [10/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfRadiationVector  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101807 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfArrayOfRadiationVector::pos().

◆ nelemGet() [11/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfScatteringMetaData  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101835 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfArrayOfScatteringMetaData::pos().

◆ nelemGet() [12/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSingleScatteringData  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101863 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfArrayOfSingleScatteringData::pos().

◆ nelemGet() [13/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSpeciesTag  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101891 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSpeciesTag::islast(), and ARTS::Var::ArrayOfArrayOfSpeciesTag::pos().

◆ nelemGet() [14/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfStokesVector  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101919 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfArrayOfStokesVector::pos().

◆ nelemGet() [15/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfString  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101947 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfString::islast(), and ARTS::Var::ArrayOfArrayOfString::pos().

◆ nelemGet() [16/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor3  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101975 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor3::islast(), and ARTS::Var::ArrayOfArrayOfTensor3::pos().

◆ nelemGet() [17/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor6  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102003 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor6::islast(), and ARTS::Var::ArrayOfArrayOfTensor6::pos().

◆ nelemGet() [18/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTime  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102031 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTime::islast(), and ARTS::Var::ArrayOfArrayOfTime::pos().

◆ nelemGet() [19/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTransmissionMatrix  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102059 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfArrayOfTransmissionMatrix::pos().

◆ nelemGet() [20/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfVector  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102087 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfVector::islast(), and ARTS::Var::ArrayOfArrayOfVector::pos().

◆ nelemGet() [21/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfCIARecord  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102115 of file autoarts.h.

References ARTS::Var::ArrayOfCIARecord::islast(), and ARTS::Var::ArrayOfCIARecord::pos().

◆ nelemGet() [22/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField1  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102143 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfGriddedField1::pos().

◆ nelemGet() [23/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField2  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102171 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfGriddedField2::pos().

◆ nelemGet() [24/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField3  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102199 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfGriddedField3::pos().

◆ nelemGet() [25/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField4  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102227 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField4::islast(), and ARTS::Var::ArrayOfGriddedField4::pos().

◆ nelemGet() [26/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfIndex  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102255 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), and ARTS::Var::ArrayOfIndex::pos().

◆ nelemGet() [27/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102283 of file autoarts.h.

References ARTS::Var::ArrayOfMatrix::islast(), and ARTS::Var::ArrayOfMatrix::pos().

◆ nelemGet() [28/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPpath  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101751 of file autoarts.h.

References ARTS::Var::ArrayOfPpath::islast(), and ARTS::Var::ArrayOfPpath::pos().

◆ nelemGet() [29/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPropagationMatrix  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102311 of file autoarts.h.

References ARTS::Var::ArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfPropagationMatrix::pos().

◆ nelemGet() [30/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102339 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), and ARTS::Var::ArrayOfQuantumIdentifier::pos().

◆ nelemGet() [31/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRadiationVector  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102367 of file autoarts.h.

References ARTS::Var::ArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfRadiationVector::pos().

◆ nelemGet() [32/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRetrievalQuantity  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102395 of file autoarts.h.

References ARTS::Var::ArrayOfRetrievalQuantity::islast(), and ARTS::Var::ArrayOfRetrievalQuantity::pos().

◆ nelemGet() [33/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfScatteringMetaData  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102423 of file autoarts.h.

References ARTS::Var::ArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfScatteringMetaData::pos().

◆ nelemGet() [34/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSingleScatteringData  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102451 of file autoarts.h.

References ARTS::Var::ArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfSingleScatteringData::pos().

◆ nelemGet() [35/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSparse  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102479 of file autoarts.h.

References ARTS::Var::ArrayOfSparse::islast(), and ARTS::Var::ArrayOfSparse::pos().

◆ nelemGet() [36/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfStokesVector  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102507 of file autoarts.h.

References ARTS::Var::ArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfStokesVector::pos().

◆ nelemGet() [37/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102535 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), and ARTS::Var::ArrayOfString::pos().

◆ nelemGet() [38/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTelsemAtlas  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102563 of file autoarts.h.

References ARTS::Var::ArrayOfTelsemAtlas::islast(), and ARTS::Var::ArrayOfTelsemAtlas::pos().

◆ nelemGet() [39/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor3  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102591 of file autoarts.h.

References ARTS::Var::ArrayOfTensor3::islast(), and ARTS::Var::ArrayOfTensor3::pos().

◆ nelemGet() [40/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor4  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102619 of file autoarts.h.

References ARTS::Var::ArrayOfTensor4::islast(), and ARTS::Var::ArrayOfTensor4::pos().

◆ nelemGet() [41/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor5  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102647 of file autoarts.h.

References ARTS::Var::ArrayOfTensor5::islast(), and ARTS::Var::ArrayOfTensor5::pos().

◆ nelemGet() [42/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor6  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102675 of file autoarts.h.

References ARTS::Var::ArrayOfTensor6::islast(), and ARTS::Var::ArrayOfTensor6::pos().

◆ nelemGet() [43/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor7  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102703 of file autoarts.h.

References ARTS::Var::ArrayOfTensor7::islast(), and ARTS::Var::ArrayOfTensor7::pos().

◆ nelemGet() [44/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTime  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102731 of file autoarts.h.

References ARTS::Var::ArrayOfTime::islast(), and ARTS::Var::ArrayOfTime::pos().

◆ nelemGet() [45/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTransmissionMatrix  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102759 of file autoarts.h.

References ARTS::Var::ArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfTransmissionMatrix::pos().

◆ nelemGet() [46/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfVector  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102787 of file autoarts.h.

References ARTS::Var::ArrayOfVector::islast(), and ARTS::Var::ArrayOfVector::pos().

◆ nelemGet() [47/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfXsecRecord  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102815 of file autoarts.h.

References ARTS::Var::ArrayOfXsecRecord::islast(), and ARTS::Var::ArrayOfXsecRecord::pos().

◆ nelemGet() [48/48]

MRecord ARTS::AgendaMethod::nelemGet ( [[maybe_unused] ] Workspace ws,
const Var::Vector  v 
)
inline

Retrieve nelem from given variable and store the value in the variable nelem.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of elements from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 102843 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ nlibrariesGet()

MRecord ARTS::AgendaMethod::nlibrariesGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  v 
)
inline

Retrieve nlibraries from given variable and store the value in the workspace variable nlibraries

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of libraries from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103655 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ nlte_fieldForSingleSpeciesNonOverlappingLines()

MRecord ARTS::AgendaMethod::nlte_fieldForSingleSpeciesNonOverlappingLines ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  df,
const Var::Index  nz,
const Var::Index  nf,
const Var::Index  dampened,
const Var::Numeric convergence_limit = {},
const Var::Index iteration_limit = {} 
)
inline

NLTE field for a simple setup.

This will solve for nlte_field in the input atmosphere. The solver depends on the lines not overlapping and that there is only a single species in the atmosphere.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]df- relative frequency to line center
[in]convergence_limit- max relative change in ratio of level to stop iterations (default: 1e-6)
[in]nz- number of zenith angles
[in]nf- number of frequency grid-points per line
[in]dampened- use transmission dampening or not
[in]iteration_limit- max number of iterations before defaul break of iterations (default: 20)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101195 of file autoarts.h.

◆ nlte_fieldFromRaw()

MRecord ARTS::AgendaMethod::nlte_fieldFromRaw ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  data 
)
inline

Sets NLTE values manually

Touch

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]data- Vibrational data [nlevels, np, nlat, nlon]

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103779 of file autoarts.h.

References data.

◆ nlte_fieldRescalePopulationLevels()

MRecord ARTS::AgendaMethod::nlte_fieldRescalePopulationLevels ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  s 
)
inline

Rescale NLTE field to expected total distribution amongst levels

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]s- Scaling (e.g., 0.75 for only orth-water on Earth)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101159 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ nlte_fieldSetLteExternalPartitionFunction()

MRecord ARTS::AgendaMethod::nlte_fieldSetLteExternalPartitionFunction ( [[maybe_unused] ] Workspace ws)
inline

Turns on NTLE calculations.

Sets NLTE ratios to those expected for LTE calculations with a known partition function

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103808 of file autoarts.h.

◆ nlte_fieldSetLteInternalPartitionFunction()

MRecord ARTS::AgendaMethod::nlte_fieldSetLteInternalPartitionFunction ( [[maybe_unused] ] Workspace ws)
inline

Turns on NTLE calculations.

Sets NLTE ratios to those expected for LTE calculations with estimation of the partition function as the sum of all states of a species

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103870 of file autoarts.h.

◆ nlte_sourceFromTemperatureAndSrcCoefPerSpecies()

MRecord ARTS::AgendaMethod::nlte_sourceFromTemperatureAndSrcCoefPerSpecies ( [[maybe_unused] ] Workspace ws)
inline

Turn NLTE absorption per species into the source function by multiplying NLTE absorption per species with the LTE Planck source function.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103682 of file autoarts.h.

◆ nlteOff()

MRecord ARTS::AgendaMethod::nlteOff ( [[maybe_unused] ] Workspace ws)
inline

Disable Non-LTE calculations.

The variables are set as follows: nlte_field : Empty. nlte_level_identifiers : Empty.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103707 of file autoarts.h.

◆ nlteSetByQuantumIdentifiers()

MRecord ARTS::AgendaMethod::nlteSetByQuantumIdentifiers ( [[maybe_unused] ] Workspace ws)
inline

Turns on NTLE calculations.

Takes the quantum identifers for NLTE temperatures and matches it to lines in abs_lines_per_species. abs_species must be set and is used to speed up calculations. After the function is done, all affected lines in abs_lines_per_species will have an internal tag to the relevant quantum identifier, which is a requirement for deeper code.

If vibrational_energies is input it must match nlte_level_identifiers in length. The vibrational energies of the affected lines will then be set by the function. Otherwise, it is assumed the vibrational energies are set by another method. If they are not set, calculations will complain later on while running deeper code.

For now only vibrational energy states are assumed to be able to be in non-LTE conditions. The QuantumIdentifier for an energy state in ARTS can look like: "CO2-626 EN v1 0/1 v2 1/1 l2 1/1 v3 0/1 r 1/1" and the matching will match ALL lines with the above. Note then that if, e.g., the "v1 0/1" term was removed from the above, then ARTS will assume that "v1" is not part of the level of energy state of interest, so lines of different "v1" will be matched as the same state. If a line is matched to more than one energy state, errors should be thrown, but be careful.

Set type of population to change computations and expected input as: LTE: Compute population by ratios found from LTE temperatures TV: Compute population by ratios found from NLTE vibrational temperatures ND: Compute population by ratios found from NLTE number densities

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103755 of file autoarts.h.

◆ npagesGet() [1/5]

MRecord ARTS::AgendaMethod::npagesGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  v 
)
inline

Retrieve npages from given variable and store the value in the workspace variable npages

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of pages from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103263 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), and ARTS::Var::Tensor3::pos().

◆ npagesGet() [2/5]

MRecord ARTS::AgendaMethod::npagesGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  v 
)
inline

Retrieve npages from given variable and store the value in the workspace variable npages

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of pages from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103291 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), and ARTS::Var::Tensor4::pos().

◆ npagesGet() [3/5]

MRecord ARTS::AgendaMethod::npagesGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  v 
)
inline

Retrieve npages from given variable and store the value in the workspace variable npages

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of pages from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103319 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), and ARTS::Var::Tensor5::pos().

◆ npagesGet() [4/5]

MRecord ARTS::AgendaMethod::npagesGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  v 
)
inline

Retrieve npages from given variable and store the value in the workspace variable npages

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of pages from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103347 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), and ARTS::Var::Tensor6::pos().

◆ npagesGet() [5/5]

MRecord ARTS::AgendaMethod::npagesGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  v 
)
inline

Retrieve npages from given variable and store the value in the workspace variable npages

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of pages from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103375 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ nrowsGet() [1/7]

MRecord ARTS::AgendaMethod::nrowsGet ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  v 
)
inline

Retrieve nrows from given variable and store the value in the workspace variable nrows

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of rows from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103067 of file autoarts.h.

References ARTS::Var::Matrix::islast(), and ARTS::Var::Matrix::pos().

◆ nrowsGet() [2/7]

MRecord ARTS::AgendaMethod::nrowsGet ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  v 
)
inline

Retrieve nrows from given variable and store the value in the workspace variable nrows

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of rows from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103095 of file autoarts.h.

References ARTS::Var::Sparse::islast(), and ARTS::Var::Sparse::pos().

◆ nrowsGet() [3/7]

MRecord ARTS::AgendaMethod::nrowsGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  v 
)
inline

Retrieve nrows from given variable and store the value in the workspace variable nrows

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of rows from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103123 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), and ARTS::Var::Tensor3::pos().

◆ nrowsGet() [4/7]

MRecord ARTS::AgendaMethod::nrowsGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  v 
)
inline

Retrieve nrows from given variable and store the value in the workspace variable nrows

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of rows from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103151 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), and ARTS::Var::Tensor4::pos().

◆ nrowsGet() [5/7]

MRecord ARTS::AgendaMethod::nrowsGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  v 
)
inline

Retrieve nrows from given variable and store the value in the workspace variable nrows

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of rows from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103179 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), and ARTS::Var::Tensor5::pos().

◆ nrowsGet() [6/7]

MRecord ARTS::AgendaMethod::nrowsGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  v 
)
inline

Retrieve nrows from given variable and store the value in the workspace variable nrows

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of rows from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103207 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), and ARTS::Var::Tensor6::pos().

◆ nrowsGet() [7/7]

MRecord ARTS::AgendaMethod::nrowsGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  v 
)
inline

Retrieve nrows from given variable and store the value in the workspace variable nrows

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of rows from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103235 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ nshelvesGet() [1/3]

MRecord ARTS::AgendaMethod::nshelvesGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  v 
)
inline

Retrieve nshelves from given variable and store the value in the workspace variable nshelves

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of shelves from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103515 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), and ARTS::Var::Tensor5::pos().

◆ nshelvesGet() [2/3]

MRecord ARTS::AgendaMethod::nshelvesGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  v 
)
inline

Retrieve nshelves from given variable and store the value in the workspace variable nshelves

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of shelves from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103543 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), and ARTS::Var::Tensor6::pos().

◆ nshelvesGet() [3/3]

MRecord ARTS::AgendaMethod::nshelvesGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  v 
)
inline

Retrieve nshelves from given variable and store the value in the workspace variable nshelves

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of shelves from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103571 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ NumericAdd()

MRecord ARTS::AgendaMethod::NumericAdd ( [[maybe_unused] ] Workspace ws,
Var::Numeric  out,
const Var::Numeric  in,
const Var::Numeric  value 
)
inline

Adds a numeric and a value (out = in+value).

The result can either be stored in the same or another numeric. (in and out can be the same varible, but not out and value)

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output numeric.
[in]in- Input numeric.
[in]value- Value to add.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101280 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ NumericFromVector()

MRecord ARTS::AgendaMethod::NumericFromVector ( [[maybe_unused] ] Workspace ws,
Var::Numeric  out,
const Var::Vector  in,
const Var::String  op 
)
inline

Derivs a numeric from a vector, following selected operation.

The following operations can be selected: first : Selects the first element of the vector. last : Selects the last element of the vector. max : Selects the maximum element of the vector. min : Selects the minimum element of the vector. mean : Calculates the mean of the vector.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output numeric.
[in]in- Input vector.
[in]op- Selected operation.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101322 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Numeric::pos(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ NumericInvScale()

MRecord ARTS::AgendaMethod::NumericInvScale ( [[maybe_unused] ] Workspace ws,
Var::Numeric  out,
const Var::Numeric  in,
const Var::Numeric  value 
)
inline

Inversely scales/divides a numeric with a value (out = in/value).

The result can either be stored in the same or another numeric. (in and out can be the same varible, but not out and value)

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output numeric.
[in]in- Input numeric.
[in]value- Scaling value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101360 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ NumericScale()

MRecord ARTS::AgendaMethod::NumericScale ( [[maybe_unused] ] Workspace ws,
Var::Numeric  out,
const Var::Numeric  in,
const Var::Numeric  value 
)
inline

Scales/multiplies a numeric with a value (out = in*value).

The result can either be stored in the same or another numeric. (in and out can be the same varible, but not out and value)

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output numeric.
[in]in- Input numeric.
[in]value- Scaling value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101398 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ NumericSet()

MRecord ARTS::AgendaMethod::NumericSet ( [[maybe_unused] ] Workspace ws,
Var::Numeric  out,
const Var::Numeric  value 
)
inline

Sets a numeric workspace variable to the given value.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- The value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101432 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Numeric::value().

◆ nvitrinesGet() [1/2]

MRecord ARTS::AgendaMethod::nvitrinesGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  v 
)
inline

Retrieve nvitrines from given variable and store the value in the workspace variable nvitrines

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of vitrines from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103599 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), and ARTS::Var::Tensor6::pos().

◆ nvitrinesGet() [2/2]

MRecord ARTS::AgendaMethod::nvitrinesGet ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  v 
)
inline

Retrieve nvitrines from given variable and store the value in the workspace variable nvitrines

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]v- Variable to get the number of vitrines from.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103627 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ OEM()

MRecord ARTS::AgendaMethod::OEM ( [[maybe_unused] ] Workspace ws,
const Var::String  method,
const Var::Numeric max_start_cost = {},
const Var::Vector x_norm = {},
const Var::Index max_iter = {},
const Var::Numeric stop_dx = {},
const Var::Vector lm_ga_settings = {},
const Var::Index clear_matrices = {},
const Var::Index display_progress = {} 
)
inline

Inversion by the so called optimal estimation method (OEM).

Work in progress ...

The cost function to minimise, including a normalisation with lengthof y, is: cost = cost_y + cost_x where cost_y = 1/m * [y-yf]' * covmat_se_inv * [y-yf] cost_x = 1/m * [x-xa]' * covmat_sx_inv * [x-xa]

The current implementation provides 3 methods for the minimization of the cost functional: Linear, Gauss-Newton and Levenberg-Marquardt. The Gauss-Newton minimizer attempts to find a minimum solution by fitting a quadratic function to the cost functional. The linear minimizer is a special case of the Gauss-Newton method, since for a linear forward model the exact solution of the minimization problem is obtained after the first step. The Levenberg-Marquardt method adaptively constrains the search region for the next iteration step by means of the so-called gamma-factor. This makes the method more suitable for strongly non-linear problems. If the gamma-factor is 0, Levenberg-Marquardt and Gauss-Newton method are identical. Each minimization method (li,gn,lm) has an indirect variant (li_cg,gn_cg,lm_cg), which uses the conjugate gradient solver for the linear system that has to be solved in each minimzation step. This of advantage for very large problems, that would otherwise require the computation of expensive matrix products.

Description of the special input arguments:

method* "li": A linear problem is assumed and a single iteration is performed. "li_cg": A linear problem is assumed and solved using the CG solver. "gn": Non-linear, with Gauss-Newton iteration scheme. "gn_cg": Non-linear, with Gauss-Newton and conjugate gradient solver. "lm": Non-linear, with Levenberg-Marquardt (LM) iteration scheme. "lm_cg": Non-linear, with Levenberg-Marquardt (LM) iteration scheme and conjugate gradient solver. max_start_cost* No inversion is done if the cost matching the a priori state is above this value. If set to a negative value, all values are accepted. This argument also controls if the start cost is calculated. If set to <= 0, the start cost in oem_diagnostics is set to NaN when using "li" and "gn". x_norm* A normalisation vector for x. A normalisation of x can be needed due to limited numerical precision. If this vector is set to be empty no normalisation is done (defualt case). Otherwise, this must be a vector with same length as x, just having values above zero. Elementwise division between x and x_norm (x./x_norm) shall give a vector where all values are in the order of unity. Maybe the best way to set x_norm is x_norm = sqrt( diag( Sx ) ). max_iter* Maximum number of iterations to perform. No effect for "li". stop_dx* Iteration stop criterion. The criterion used is the same as given in Rodgers' "Inverse Methods for Atmospheric Sounding" lm_ga_settings* Settings controlling the gamma factor, part of the "LM" method. This is a vector of length 6, having the elements (0-based index): 0: Start value. 1: Fractional decrease after succesfull iteration. 2: Fractional increase after unsuccessful iteration. 3: Maximum allowed value. If the value is passed, the inversion is halted. 4: Lower treshold. If the threshold is passed, gamma is set to zero. If gamma must be increased from zero, gamma is set to this value. 5: Gamma limit. This is an additional stop criterion. Convergence is not considered until there has been one succesful iteration having a gamma <= this value. The default setting triggers an error if "lm" is selected. clear matrices* With this flag set to 1, jacobian and dxdy are returned as empty matrices. display_progress* Controls if there is any screen output. The overall report level is ignored by this WSM.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]method- Iteration method. For this and all options below, see further above.
[in]max_start_cost- Maximum allowed value of cost function at start. (default: std::numeric_limits<Numeric>::infinity())
[in]x_norm- Normalisation of Sx. (default: {})
[in]max_iter- Maximum number of iterations. (default: 10)
[in]stop_dx- Stop criterion for iterative inversions. (default: 0.01)
[in]lm_ga_settings- Settings associated with the ga factor of the LM method. (default: {})
[in]clear_matrices- An option to save memory. (default: 0)
[in]display_progress- Flag to control if inversion diagnostics shall be printed on the screen. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104020 of file autoarts.h.

◆ opt_prop_bulkCalc()

MRecord ARTS::AgendaMethod::opt_prop_bulkCalc ( [[maybe_unused] ] Workspace ws)
inline

Calculates bulk absorption extinction at one atmospheric grid point.

This WSM sums up the monochromatic absorption vectors and extinction matrices of all scattering elements (abs_vec_spt and ext_mat_spt*, respectively) weighted by their respective particle number density given by pnd_field, for a single location within the cloudbox, given by scat_p_index, scat_lat_index, and scat_lon_index*. The resulting extinction matrix is added to the workspace variable ext_mat*.

Author
Jana Mendrok, Sreerekha T.R.
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104171 of file autoarts.h.

◆ opt_prop_sptFromData()

MRecord ARTS::AgendaMethod::opt_prop_sptFromData ( [[maybe_unused] ] Workspace ws)
inline

Calculates monochromatic optical properties for all scattering elements.

In this function the extinction matrix and the absorption vector are calculated in the laboratory frame. An interpolation of the data on the actual frequency is the first step in this function. The next step is a transformation from the database coordinate system to the laboratory coordinate system.

Output of the function are ext_mat_spt and abs_vec_spt, which hold the optical properties for a specified propagation direction for each scattering element.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104203 of file autoarts.h.

◆ opt_prop_sptFromMonoData()

MRecord ARTS::AgendaMethod::opt_prop_sptFromMonoData ( [[maybe_unused] ] Workspace ws)
inline

Calculates optical properties for the scattering elements.

As opt_prop_sptFromData but no frequency interpolation is performed. The single scattering data is here obtained from scat_data_mono*, instead of scat_data.

Author
Cory Davis
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104254 of file autoarts.h.

◆ opt_prop_sptFromScat_data()

MRecord ARTS::AgendaMethod::opt_prop_sptFromScat_data ( [[maybe_unused] ] Workspace ws)
inline

Derives monochromatic optical properties for all scattering elements.

As opt_prop_sptFromData, but using frequency pre-interpolated data (as produced by scat_dataCalc), i.e. in here no frequency interpolation is done anymore.

Author
Jana Mendrok, Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104229 of file autoarts.h.

◆ OptimizeDoitPressureGrid()

MRecord ARTS::AgendaMethod::OptimizeDoitPressureGrid ( [[maybe_unused] ] Workspace ws,
const Var::Numeric tau_scat_max = {},
const Var::Numeric sgl_alb_max = {},
const Var::Index cloudbox_size_max = {} 
)
inline

Optimization of the pressure grid for RT calculation. The methods consists of three parts: 1) Calculate the single scattering albedo and the scattering opticalthickness from the scattering and absorption species. 2) Enhance z_field according to the two thresholds sgl_alb_max and tau_scat_max.If the resulting cloudbox size is bigger than cloudbox_size_max, this step is repeated with a higher threshold of tau_scat_max. 3) Interpolate all variables used in doit_mono_agenda to the new z_field This method should be called inside doit_mono_agenda*, right before cloudbox_field_monoIterate. It can only be used if ScatSpeciesMerge has been called and if it is called, cloudbox_field_monoOptimizeReverse has to be called right after cloudbox_field_monoIterate to interpolate cloudbox_field_mono* back to the original size. Optimization currently only works with stokes_dim = 1 .

Author
Jakob Doerr
Parameters
[in,out]Workspacews - An ARTS workspace
[in]tau_scat_max- Maximum scattering optical thickness (default: 0.1)
[in]sgl_alb_max- Maximum single scattering albedo (default: 0.9)
[in]cloudbox_size_max- Maximum cloudbox size (default: 200)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 88350 of file autoarts.h.

◆ output_file_formatSetAscii()

MRecord ARTS::AgendaMethod::output_file_formatSetAscii ( [[maybe_unused] ] Workspace ws)
inline

Sets the output file format to ASCII.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104275 of file autoarts.h.

◆ output_file_formatSetBinary()

MRecord ARTS::AgendaMethod::output_file_formatSetBinary ( [[maybe_unused] ] Workspace ws)
inline

Sets the output file format to binary.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104296 of file autoarts.h.

◆ output_file_formatSetZippedAscii()

MRecord ARTS::AgendaMethod::output_file_formatSetZippedAscii ( [[maybe_unused] ] Workspace ws)
inline

Sets the output file format to zipped ASCII.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104317 of file autoarts.h.

◆ p_gridDensify()

MRecord ARTS::AgendaMethod::p_gridDensify ( [[maybe_unused] ] Workspace ws,
const Var::Vector  p_grid_old,
const Var::Index nfill = {} 
)
inline

A simple way to make p_grid more dense.

The method includes new values in p_grid. For each intermediate pressure range, nfill points are added. That is, setting nfill to zero returns an unmodified copy of p_grid_old. The number of elements of the new p_grid is (n0-1)*(1+nfill)+1, where n0 is the length of p_grid_old.

The new points are distributed equidistant in log(p).

For safety, new grid and old grid Vectors are not allowed to be the same variable (both will be needed later on for regridding of the atmospheric fields), and atmospheric field related *checked WSV are reset to 0 (unchecked).

Author
Patrick Eriksson, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]p_grid_old- A copy of the current (the old) p_grid. Not allowed to be the same variable as the output p_grid.
[in]nfill- Number of points to add between adjacent pressure points.The default value (-1) results in an error. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110399 of file autoarts.h.

◆ p_gridFromGasAbsLookup()

MRecord ARTS::AgendaMethod::p_gridFromGasAbsLookup ( [[maybe_unused] ] Workspace ws)
inline

Sets p_grid to the pressure grid of abs_lookup.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110536 of file autoarts.h.

◆ p_gridFromZRaw()

MRecord ARTS::AgendaMethod::p_gridFromZRaw ( [[maybe_unused] ] Workspace ws,
const Var::Index no_negZ = {} 
)
inline

Sets p_grid according to input atmosphere's raw z_field, derived e.g. from AtmRawRead. Attention: as default only pressure values for altitudes >= 0 are extracted. If negative altitudes shall also be selected, set no_neg=0.

Author
Claudia Emde, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]no_negZ- Exclude negative altitudes. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110435 of file autoarts.h.

◆ p_gridRefine()

MRecord ARTS::AgendaMethod::p_gridRefine ( [[maybe_unused] ] Workspace ws,
const Var::Vector  p_grid_old,
const Var::Numeric  p_step 
)
inline

Provides refined pressure grid.

Created new pressure grid has (log10) spacings below a given threshold.

For safety, new grid and old grid Vectors are not allowed to be the same variable (both will be needed later on for regridding of the atmospheric fields), and atmospheric field related *checked WSV are reset to 0 (unchecked).

Author
Stefan Buehler, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]p_grid_old- A copy of the current (the old) p_grid. Not allowed to be the same variable as the output p_grid.
[in]p_step- Maximum step in log10(p[Pa]). If the pressure grid is coarser than this, additional points are added until each log step is smaller than this.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110567 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Vector::pos().

◆ particle_bulkprop_fieldClip()

MRecord ARTS::AgendaMethod::particle_bulkprop_fieldClip ( [[maybe_unused] ] Workspace ws,
const Var::String  bulkprop_name,
const Var::Numeric limit_low = {},
const Var::Numeric limit_high = {} 
)
inline

Clipping of particle_bulkprop_field.

The method allows you to apply hard limits the values of particle_bulkprop_field*. All values, of the property selected, below limit_low, are simply set to limit_low. And the same is performed with respect to limit_high. That is, the data in x for the retrieval quantity are forced to be inside the range [limit_low,limit_high].

Setting species="ALL", is a shortcut for applying the limits on all properties.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]bulkprop_name- Name of bulk property to consider, or "ALL".
[in]limit_low- Lower limit for clipping. (default: -std::numeric_limits<Numeric>::infinity())
[in]limit_high- Upper limit for clipping. (default: std::numeric_limits<Numeric>::infinity())

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104351 of file autoarts.h.

◆ particle_bulkprop_fieldPerturb()

MRecord ARTS::AgendaMethod::particle_bulkprop_fieldPerturb ( [[maybe_unused] ] Workspace ws,
const Var::String  particle_type,
const Var::Vector  p_ret_grid,
const Var::Vector  lat_ret_grid,
const Var::Vector  lon_ret_grid,
const Var::Index  pert_index,
const Var::Numeric  pert_size,
const Var::String pert_mode = {} 
)
inline

Adds a perturbation to particle_bulkprop_field.

Works as AtmFieldPerturb but acts on particle_bulkprop_field.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]particle_type- Name of field to perturb, such as IWC.
[in]p_ret_grid- Pressure retrieval grid.
[in]lat_ret_grid- Latitude retrieval grid.
[in]lon_ret_grid- Longitude retrieval grid.
[in]pert_index- Index of position where the perturbation shall be performed.
[in]pert_size- Size of perturbation.
[in]pert_mode- Type of perturbation, ansolute or relative. (default: "absolute")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104398 of file autoarts.h.

◆ particle_bulkprop_fieldPerturbAtmGrids()

MRecord ARTS::AgendaMethod::particle_bulkprop_fieldPerturbAtmGrids ( [[maybe_unused] ] Workspace ws,
const Var::String  particle_type,
const Var::Index  pert_index,
const Var::Numeric  pert_size,
const Var::String pert_mode = {} 
)
inline

Adds a perturbation to particle_bulkprop_field.

Works as AtmFieldPerturbAtmGrids but acts on particle_bulkprop_field.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]particle_type- Name of field to perturb, such as IWC.
[in]pert_index- Index of position where the perturbation shall be performed.
[in]pert_size- Size of perturbation.
[in]pert_mode- Type of perturbation, ansolute or relative. (default: "absolute")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104451 of file autoarts.h.

◆ particle_fieldCleanup()

MRecord ARTS::AgendaMethod::particle_fieldCleanup ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  particle_field_out,
const Var::Tensor4  particle_field_in,
const Var::Numeric  threshold 
)
inline

Removes unrealistically small or erroneous data from particle fields.

This WSM checks if the input particle field (e.g. particle_bulkprop_field*) contains values smaller than the given threshold. In this case, these values will be set to zero.

The method should be applied if the particle fields contain unrealistically small or erroneous data (NWP/GCM model data, e.g. from the Chevallierl_91l sets, often contain very small or even negative values, which are numerical artefacts rather than physical values.) For the scat_species_XXX_fields, it needs to be applied separately per Tensor4 type field collection. This allows to use different thresholds for the different types of fields (not for the different scattering species, though).

particle_fieldCleanup* shall be called after generation of the atmopheric fields.

Author
Daniel Kreyling
Parameters
[in,out]Workspacews - An ARTS workspace
[out]particle_field_out- A particle property field, e.g. particle_bulkprop_field
[in]particle_field_in- A particle property field, e.g. particle_bulkprop_field
[in]threshold- Threshold below which the particle_field values are set to zero.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123863 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor4::pos().

◆ particle_massesFromMetaData()

MRecord ARTS::AgendaMethod::particle_massesFromMetaData ( [[maybe_unused] ] Workspace ws)
inline

Derives particle_masses from scat_meta.

This method is supposed to be used to derive particle_masses when pnd_field is internally calculated using pnd_fieldCalcFromParticleBulkProps* (in contrast to reading it from external sources using ScatElementsPndAndScatAdd and pnd_fieldCalcFrompnd_field_raw*). It extracts the mass information of the scattering elements from scat_meta*. Each scattering species is taken as a separate category of particle_masses, i.e., the resulting particle_masses* matrix will contain as many columns as scattering species are present in scat_meta.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104536 of file autoarts.h.

◆ particle_massesFromMetaDataSingleCategory()

MRecord ARTS::AgendaMethod::particle_massesFromMetaDataSingleCategory ( [[maybe_unused] ] Workspace ws)
inline

Sets particle_masses based on scat_meta assuming all particles are of the same mass category.

This method derives the particle masses from the mass entry of each scattering element. It is assumed that all scattering elements represent particles of the same (bulk) matter (e.g. water or ice). With other words, a single mass category is assumed (see particle_masses for a definition of "mass category").

To be clear, the above are assumptions of the method, the user is free to work with any scattering element. For Earth and just having cloud and particles, the resulting mass category can be seen as the total cloud water content, with possible contribution from both ice and liquid phase.

Author
Jana Mendrok
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104504 of file autoarts.h.

◆ partition_functionsInitFromBuiltin()

MRecord ARTS::AgendaMethod::partition_functionsInitFromBuiltin ( [[maybe_unused] ] Workspace ws)
inline

Initialize partition functions with default values from built-in species data.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104558 of file autoarts.h.

◆ PFromZSimple()

MRecord ARTS::AgendaMethod::PFromZSimple ( [[maybe_unused] ] Workspace ws,
Var::Vector  p_grid,
const Var::Vector  z_grid 
)
inline

Simple conversion from altitude to pressure.

This function converts a vector of altitudes to an approximate vector of corresponding pressures. The formula used to convert altitide z to height is: p = 10.0^(5.0 - z / 1600)

Note that all altitude values in the vector must be less than 120 km, otherwise an error will be thrown.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]p_grid- Approximate pressures of corresponding to given altitudes.
[in]z_grid- Altitude grid.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108512 of file autoarts.h.

References ARTS::Var::Vector::islast(), ARTS::Var::p_grid(), and ARTS::Var::Vector::pos().

◆ pha_mat_sptFromData()

MRecord ARTS::AgendaMethod::pha_mat_sptFromData ( [[maybe_unused] ] Workspace ws)
inline

Calculation of the phase matrix of the individual scattering elements.

This function can be used in pha_mat_spt_agenda as part of the calculation of the scattering integral.

First, data at the requested frequency (given by f_grid and f_index*) and temperature (given by rtp_temperature) is extracted. This is followed by a transformation from the database coordinate system to the laboratory coordinate system.

Frequency extraction is always done by (linear) interpolation. Temperature is (linearly) interpolated when at least two temperature grid points are present in the scat_data and rtp_temperature* is positive. If only a single temperature point is available, data for this point is used without modification. In order to speed up calculations, temperature interpolation can be avoided by passing a rtp_temperature<0. In this case, a specific temperature grid from the scat_data grid is used without modification. The selection is as follows: -10 < rtp_temperature * < 0 T_grid[0] lowest temperature -20 < *rtp_temperature * < -10 T_grid[nT-1] highest temperature rtp_temperature < -20 T_grid[nT/2] median grid point

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104627 of file autoarts.h.

◆ pha_mat_sptFromDataDOITOpt()

MRecord ARTS::AgendaMethod::pha_mat_sptFromDataDOITOpt ( [[maybe_unused] ] Workspace ws)
inline

Calculation of the phase matrix of the individual scattering elements.

In this function the phase matrix is extracted from pha_mat_sptDOITOpt*. It can be used in the agenda pha_mat_spt_agenda*. This method must be used in combination with DoitScatteringDataPrepare*.

Temperature is considered as described for pha_mat_sptFromData

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104655 of file autoarts.h.

◆ pha_mat_sptFromMonoData()

MRecord ARTS::AgendaMethod::pha_mat_sptFromMonoData ( [[maybe_unused] ] Workspace ws)
inline

Calculation of the phase matrix of the individual scattering elements.

This function is the monochromatic version of pha_mat_sptFromData.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104678 of file autoarts.h.

◆ pha_mat_sptFromScat_data()

MRecord ARTS::AgendaMethod::pha_mat_sptFromScat_data ( [[maybe_unused] ] Workspace ws)
inline

Calculation of the phase matrix of the individual scattering elements.

As pha_mat_sptFromData, but using frequency pre-interpolated data (as produced by scat_dataCalc), i.e. in here no frequency interpolation is done anymore.

Author
Jana Mendrok, Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104703 of file autoarts.h.

◆ pha_matCalc()

MRecord ARTS::AgendaMethod::pha_matCalc ( [[maybe_unused] ] Workspace ws)
inline

Calculates the total phase matrix of all scattering elements.

This function sums up the monochromatic phase matrices of all scattering elements pha_mat_spt weighted with their respective particle number density, given by pnd_field, for a single location within the cloudbox, given by scat_p_index, scat_lat_index, and scat_lon_index*.

Author
Sreerekha T.R.
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104585 of file autoarts.h.

◆ pnd_fieldCalcFromParticleBulkProps()

MRecord ARTS::AgendaMethod::pnd_fieldCalcFromParticleBulkProps ( [[maybe_unused] ] Workspace ws)
inline

Converts particle bulk property data to pnd_field.

In short, the method combines scat_species, pnd_agenda_array, particle_bulkprop_field* and their associated variables to derive pnd_field*.

The method does nothing if cloudbox is inactive.

Otherwise, cloudbox limits must be set before calling the method, and particle_bulkprop_field is checked to have non-zero elements just inside the cloudbox.

Author
Patrick Eriksson, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104853 of file autoarts.h.

◆ pnd_fieldCalcFrompnd_field_raw()

MRecord ARTS::AgendaMethod::pnd_fieldCalcFrompnd_field_raw ( [[maybe_unused] ] Workspace ws,
const Var::Index zeropadding = {} 
)
inline

Interpolation of particle number density fields to calculation grid inside cloudbox.

This method interpolates the particle number density field from the raw data pnd_field_raw to obtain pnd_field. For 1D cases, where internally GriddedFieldPRegrid and GriddedFieldLatLonRegrid* are applied, zeropadding=1 sets the pnd_field* at pressure levels levels exceeding pnd_field_raw's pressure grid to 0 (not implemented for 2D and 3D yet). Default: zeropadding=0, which throws an error if the calculation pressure grid p_grid* is not completely covered by pnd_field_raw's pressure grid.

Author
Sreerekha T.R.
Claudia Emde
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]zeropadding- Allow zeropadding of pnd_field. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104887 of file autoarts.h.

◆ pnd_fieldExpand1D()

MRecord ARTS::AgendaMethod::pnd_fieldExpand1D ( [[maybe_unused] ] Workspace ws,
const Var::Index nzero = {} 
)
inline

Maps a 1D pnd_field to a (homogeneous) 2D or 3D pnd_field.

This method takes a 1D pnd_field and converts it to a 2D or 3D "cloud". It is assumed that a complete 1D case has been created, and after this atmosphere_dim, lat_grid, lon_grid and cloudbox_limits* have been changed to a 2D or 3D case (without changing the vertical extent of the cloudbox.

No modification of pnd_field is made for the pressure dimension. At the latitude and longitude cloudbox edge points pnd_field is set to zero. This corresponds to nzero=1. If you want a larger margin between the lat and lon cloudbox edges and the "cloud" you increase nzero*, where nzero is the number of grid points for which pnd_field* shall be set to 0, counted from each lat and lon edge.

See further AtmFieldsExpand1D.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]nzero- Number of zero values inside lat and lon limits. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104932 of file autoarts.h.

◆ pnd_fieldZero()

MRecord ARTS::AgendaMethod::pnd_fieldZero ( [[maybe_unused] ] Workspace ws)
inline

Sets pnd_field to zero.

Creates an empty pnd_field of cloudbox size according to cloudbox_limits* and with number of scattering elemements according to scat_data. If scat_data is not set yet, it will be filled with one dummy scattering element.

The method works with both scat_data and scat_data_raw. This method primarily exists for testing purposes. On the one hand, empty pnd_field runs can be used to test the agreement between true clear-sky (cloudboxOff) solutions and the scattering solver solution in factual clear-sky conditions. It is important to avoid discontinuities when switching from thin-cloud to clear-sky conditions. Moreover, scattering calculations using the DOIT method include interpolation errors. If one is interested in this effect, one should compare the DOIT result with an empty cloudbox to a clearsky calculation. That means that the iterative method is performed for a cloudbox with no particles.

Author
Claudia Emde, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104979 of file autoarts.h.

◆ pndFromPsd()

MRecord ARTS::AgendaMethod::pndFromPsd ( [[maybe_unused] ] Workspace ws,
const Var::Index  scat_index,
const Var::Index quad_order = {},
const Var::Numeric threshold_se_ext = {},
const Var::Numeric threshold_ss_ext = {},
const Var::Numeric threshold_se_pnd = {} 
)
inline

Calculates pnd_data from given psd_data for one scattering species.

Performs integration of the size distribution over the size grid bin deriving pnd (units #/m3) from psd (units #/m3/m). Some checks on the sufficiency of the size grid range and coverage are applied.

quad_order* can be 0 for rectangular or 1 for trapezoidal integration. The only difference is the treatment of the start and end nodes. For trapezoidal their corresponding bins end exactly at the nodes, while for rectangular they extend further out by the half distance to the neighbor node (but not beyond 0).

Attempts to check that the size grids and scat_data represent the bulk extinction sufficiently. Specifically, it is tested that (a) psd*ext is decreasing at the small and large particle size ends of the size grid - but only if scattering species bulk extinction exceeds 1% of threshold_ss_ext. (b) removing the smallest and largest particles changes the resulting bulk extinction by less then a fraction of threshold_se_ext* - but only if scattering species bulk extinction exceeds threshold_ss_ext and number density (pnd) of the edge size point at this atmospheric level is larger than threshold_se_pnd times the maximum pnd of this scattering element over all atmospheric levels. Skipping tests in case of low extinction is done in order to minimize issues arising from very low mass densities, particularly at single atmospheric levels, and very low bulk extinctions, i.e. in cases where the effects on the radiance fields are estimated to be low. NOTE: The tests are only approximate and do not guarantee the validity of the resulting bulk properties (and increasing the thresholds will decrease the reliability of the bulk properties).

Author
Jana Mendrok, Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]quad_order- Order of bin quadrature. (default: 1)
[in]scat_index- Take data from scattering species of this index (0-based) in scat_data.
[in]threshold_se_ext- Maximum allowed extinction fraction in each of the edge size bins. (default: 0.02)
[in]threshold_ss_ext- Minimum bulk extinction in the processed scattering species for which to apply size grid representation checks. (default: 1e-8)
[in]threshold_se_pnd- Minimum ratio of edge point pnd to maximum pnd of this scattering element over all pressure levels. (default: 0.02)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104760 of file autoarts.h.

◆ pndFromPsdBasic()

MRecord ARTS::AgendaMethod::pndFromPsdBasic ( [[maybe_unused] ] Workspace ws,
const Var::Index quad_order = {} 
)
inline

Calculates pnd_data from given psd_data.

As pndFromPsdBasic, but without bulk extinction representation checks.

Author
Jana Mendrok, Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]quad_order- Order of bin quadrature. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 104814 of file autoarts.h.

◆ ppath_fieldCalc()

MRecord ARTS::AgendaMethod::ppath_fieldCalc ( [[maybe_unused] ] Workspace ws)
inline

Stand-alone calculation of propagation path field from sensors.

Uses ppathCalc internally.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105078 of file autoarts.h.

◆ ppath_fieldFromDownUpLimbGeoms()

MRecord ARTS::AgendaMethod::ppath_fieldFromDownUpLimbGeoms ( [[maybe_unused] ] Workspace ws,
const Var::Index nz = {} 
)
inline

Computes ppath_field from "standalone" sensors looking upwards from 0 m altitude with zenith angles range [0, 90], downwards from the top of the atmosphere covering the zenith angle range from 180 degrees to the surface tangent minus 1e-4 degrees, and through the limb covering at the same position as the downwards looking sensor covering the zenith angle range from the surface tangent plus 1e-4 degrees to 90 degrees minus 1e-4 degrees.

The top of the atmosphere is from z_field(-1, 0, 0) [python range notation].

The field will consist of 3*nz arrays structured as [up, limb, down]

The intent of this function is to generate a field so that calculations of ppvar_iy of all the fields will cover the zenith angle space of all positions in z_field.

Only works for atmosphere_dim 1, spherical planets, and ppath_lmax<0

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]nz- Number of zenith angles per position (default: 3)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105017 of file autoarts.h.

◆ ppath_stepGeometric()

MRecord ARTS::AgendaMethod::ppath_stepGeometric ( [[maybe_unused] ] Workspace ws)
inline

Calculates a geometrical propagation path step.

This function determines a propagation path step by pure geometrical calculations. That is, refraction is neglected. Path points are always included for crossings with the grids, tangent points and intersection points with the surface. The WSV ppath_lmax gives the option to include additional points to ensure that the distance along the path between the points does not exceed the selected maximum length. No additional points are included if ppath_lmax* is set to <= 0.

For further information, type see the on-line information for ppath_step_agenda*.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105332 of file autoarts.h.

◆ ppath_stepRefractionBasic()

MRecord ARTS::AgendaMethod::ppath_stepRefractionBasic ( [[maybe_unused] ] Workspace ws)
inline

Calculates a propagation path step, considering refraction by a basic approach.

Refraction is taken into account by probably the simplest approach possible. The path is treated to consist of piece-wise geometric steps. A geometric path step is calculated from each point by using the local line-of-sight. Snell's law for spherical symmetry is used for 1D to determine the zenith angle at the new point. For 2D and 3D, the zenith angle is calculated using the average gradient of the refractive index between the two points. For 3D, the azimuth angle is treated in the same way as the zenith one.

The maximum length of each ray tracing step is given by the WSV ppath_lraytrace*. The length will never exceed the given maximum, but it can be smaller. The ray tracing steps are only used to determine the path. Points to describe the path are included as for ppath_stepGeometric, this including the functionality of ppath_lmax*.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105370 of file autoarts.h.

◆ ppathCalc()

MRecord ARTS::AgendaMethod::ppathCalc ( [[maybe_unused] ] Workspace ws)
inline

Stand-alone calculation of propagation paths.

Beside a few checks of input data, the only operation of this method is to execute ppath_agenda.

Propagation paths are normally calculated as part of the radiative transfer calculations, and this method is not part of the control file. A reason to call this function directly would be to obtain a propagation path for plotting. Anyhow, use this method instead of calling e.g.*ppathStepByStep directly.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105055 of file autoarts.h.

◆ ppathCalcFromAltitude()

MRecord ARTS::AgendaMethod::ppathCalcFromAltitude ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  altitude,
const Var::Numeric accuracy = {} 
)
inline

Moves rte_pos forwards to near altitude before calling ppathCalc to compute a different ppath. The accuracy-variable gives minimum distance before the input altitude.

The forward-moving algorithm calls ppathCalc several times at reduced maximum distances. The intention is to maintain the correct rte_los for a given rte_pos at all altitudes. The method is thus relatively slow, and VERY memory intense at low accuracy.

Intended to be used with "tropospheric corrections" from ground geometry. Not well-tested

Throws error if no altitude is in line of sight.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]altitude- Altitude to move forward towards
[in]accuracy- Accuracy of altitude (default: 0.5)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105114 of file autoarts.h.

◆ ppathFromRtePos2()

MRecord ARTS::AgendaMethod::ppathFromRtePos2 ( [[maybe_unused] ] Workspace ws,
const Var::Numeric za_accuracy = {},
const Var::Numeric pplrt_factor = {},
const Var::Numeric pplrt_lowest = {} 
)
inline

Determines the propagation path from rte_pos2 to rte_pos.

The propagation path linking rte_pos and rte_pos2 is calculated and returned. The method determines the path in a pure numerical manner, where a simple algorithm is applied. The task is to find the value of rte_los (at rte_pos) linking the two positions.

See the user guide for a description of the search algorithm, including a more detailed definition of za_accuracy, pplrt_factor* and pplrt_lowest.

The standard application of this method should be to radio link calculations, where rte_pos2 corresponds to a transmitter, and rte_pos* to the receiver/sensor.

The details of the ray tracing is controlled by ppath_step_agenda as usual.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]za_accuracy- Required accuracy, in form of the maximum allowed angular off-set [deg]. (default: 2e-5)
[in]pplrt_factor- The factor with which ppath_lraytrace is decreased if no solution is found. (default: 5)
[in]pplrt_lowest- Lowest value ppath_lraytrace to consider. The calculations are halted if this length is passed. (default: 0.5)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105165 of file autoarts.h.

◆ ppathPlaneParallel()

MRecord ARTS::AgendaMethod::ppathPlaneParallel ( [[maybe_unused] ] Workspace ws)
inline

Propagation path calculations for a plane parallel atmosphere.

This method basically assumes that the planet's radius is infinite, i.e. the planet surface has no curvature. Some consequences of this assumption:

  • the mathod can only be used for 1D
  • zenith angles between 89.9 and 90.1 deg are not allowed
  • refraction is always neglected
  • radii in ppath are set to Inf

Notice that the method provides full propagation paths. This means that ppath_step_agenda is ignored (and thus also refraction). On the other hand, the method considers the cloudbox exactly as the standard path calculations.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105219 of file autoarts.h.

◆ ppathStepByStep()

MRecord ARTS::AgendaMethod::ppathStepByStep ( [[maybe_unused] ] Workspace ws)
inline

Standard method for calculation of propagation paths.

This method calculates complete propagation paths in a stepwise manner. Each step is denoted as a "ppath_step" and is the path through/inside a single grid box.

The definition of a propgation path cannot be accommodated here. For more information read the chapter on propagation paths in the ARTS user guide.

This method should never be called directly. Use ppathCalc instead if you want to extract propagation paths.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105251 of file autoarts.h.

◆ ppathWriteXMLPartial()

MRecord ARTS::AgendaMethod::ppathWriteXMLPartial ( [[maybe_unused] ] Workspace ws,
const Var::String filename = {},
const Var::Index file_index = {} 
)
inline

WSM to only write a reduced Ppath, omitting grid positions.

The following fields are set to be empty: gp_p, gp_lat and gp_lon. This cam drastically decrease the time for reading the structure by some external software.

If file_index is >= 0, the variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of *file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]filename- File name. See above. (default: "")
[in]file_index- Optional file index to append to filename. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105285 of file autoarts.h.

◆ ppvar_optical_depthFromPpvar_trans_cumulat()

MRecord ARTS::AgendaMethod::ppvar_optical_depthFromPpvar_trans_cumulat ( [[maybe_unused] ] Workspace ws)
inline

Sets ppvar_optical_depth according to provided transmission data.

The values in ppvar_optical_depth are set to -log( ppvar_trans_cumulat(joker,joker,0,0) ).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105394 of file autoarts.h.

◆ Print() [1/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::AbsorptionLines  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105417 of file autoarts.h.

◆ Print() [2/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Agenda  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105451 of file autoarts.h.

◆ Print() [3/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAbsorptionLines  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105485 of file autoarts.h.

◆ Print() [4/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAgenda  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105553 of file autoarts.h.

◆ Print() [5/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfAbsorptionLines  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105519 of file autoarts.h.

◆ Print() [6/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField1  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105587 of file autoarts.h.

◆ Print() [7/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField2  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105621 of file autoarts.h.

◆ Print() [8/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField3  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105655 of file autoarts.h.

◆ Print() [9/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfIndex  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105689 of file autoarts.h.

◆ Print() [10/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfMatrix  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105723 of file autoarts.h.

◆ Print() [11/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfPropagationMatrix  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105791 of file autoarts.h.

◆ Print() [12/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfRadiationVector  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105825 of file autoarts.h.

◆ Print() [13/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfScatteringMetaData  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105859 of file autoarts.h.

◆ Print() [14/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSingleScatteringData  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105893 of file autoarts.h.

◆ Print() [15/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSpeciesTag  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105927 of file autoarts.h.

◆ Print() [16/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfStokesVector  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105961 of file autoarts.h.

◆ Print() [17/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfString  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105995 of file autoarts.h.

◆ Print() [18/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor3  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106029 of file autoarts.h.

◆ Print() [19/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor6  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106063 of file autoarts.h.

◆ Print() [20/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTime  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106097 of file autoarts.h.

◆ Print() [21/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTransmissionMatrix  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106131 of file autoarts.h.

◆ Print() [22/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfVector  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106165 of file autoarts.h.

◆ Print() [23/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfCIARecord  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106199 of file autoarts.h.

◆ Print() [24/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField1  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106233 of file autoarts.h.

◆ Print() [25/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField2  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106267 of file autoarts.h.

◆ Print() [26/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField3  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106301 of file autoarts.h.

◆ Print() [27/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField4  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106335 of file autoarts.h.

◆ Print() [28/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfIndex  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106369 of file autoarts.h.

◆ Print() [29/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106403 of file autoarts.h.

◆ Print() [30/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPpath  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 105757 of file autoarts.h.

◆ Print() [31/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPropagationMatrix  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106437 of file autoarts.h.

◆ Print() [32/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106471 of file autoarts.h.

◆ Print() [33/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRadiationVector  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106505 of file autoarts.h.

◆ Print() [34/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRetrievalQuantity  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106539 of file autoarts.h.

◆ Print() [35/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfScatteringMetaData  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106573 of file autoarts.h.

◆ Print() [36/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSingleScatteringData  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106607 of file autoarts.h.

◆ Print() [37/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSparse  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106641 of file autoarts.h.

◆ Print() [38/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfStokesVector  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106675 of file autoarts.h.

◆ Print() [39/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106709 of file autoarts.h.

◆ Print() [40/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTelsemAtlas  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106743 of file autoarts.h.

◆ Print() [41/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor3  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106777 of file autoarts.h.

◆ Print() [42/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor4  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106811 of file autoarts.h.

◆ Print() [43/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor5  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106845 of file autoarts.h.

◆ Print() [44/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor6  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106879 of file autoarts.h.

◆ Print() [45/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor7  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106913 of file autoarts.h.

◆ Print() [46/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTime  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106947 of file autoarts.h.

◆ Print() [47/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTransmissionMatrix  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 106981 of file autoarts.h.

◆ Print() [48/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfVector  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107015 of file autoarts.h.

◆ Print() [49/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfXsecRecord  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107049 of file autoarts.h.

◆ Print() [50/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::CIARecord  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107083 of file autoarts.h.

◆ Print() [51/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::CovarianceMatrix  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107117 of file autoarts.h.

◆ Print() [52/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::EnergyLevelMap  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107151 of file autoarts.h.

◆ Print() [53/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::GasAbsLookup  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107185 of file autoarts.h.

◆ Print() [54/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField1  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107253 of file autoarts.h.

◆ Print() [55/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField2  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107287 of file autoarts.h.

◆ Print() [56/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField3  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107321 of file autoarts.h.

◆ Print() [57/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField4  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107355 of file autoarts.h.

◆ Print() [58/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField5  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107389 of file autoarts.h.

◆ Print() [59/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField6  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107423 of file autoarts.h.

◆ Print() [60/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::GridPos  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107219 of file autoarts.h.

◆ Print() [61/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::HitranRelaxationMatrixData  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107457 of file autoarts.h.

◆ Print() [62/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Index  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107491 of file autoarts.h.

◆ Print() [63/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107559 of file autoarts.h.

◆ Print() [64/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::MCAntenna  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107525 of file autoarts.h.

◆ Print() [65/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107593 of file autoarts.h.

◆ Print() [66/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Ppath  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107627 of file autoarts.h.

◆ Print() [67/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::PropagationMatrix  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107661 of file autoarts.h.

◆ Print() [68/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107695 of file autoarts.h.

◆ Print() [69/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::RadiationVector  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107729 of file autoarts.h.

◆ Print() [70/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Rational  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107763 of file autoarts.h.

◆ Print() [71/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::ScatteringMetaData  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107797 of file autoarts.h.

◆ Print() [72/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::SingleScatteringData  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107831 of file autoarts.h.

◆ Print() [73/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107865 of file autoarts.h.

◆ Print() [74/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::SpeciesAuxData  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107899 of file autoarts.h.

◆ Print() [75/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::StokesVector  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107933 of file autoarts.h.

◆ Print() [76/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::String  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 107967 of file autoarts.h.

◆ Print() [77/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::TelsemAtlas  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108001 of file autoarts.h.

◆ Print() [78/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108035 of file autoarts.h.

◆ Print() [79/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108069 of file autoarts.h.

◆ Print() [80/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108103 of file autoarts.h.

◆ Print() [81/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108137 of file autoarts.h.

◆ Print() [82/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108171 of file autoarts.h.

◆ Print() [83/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::TessemNN  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108273 of file autoarts.h.

◆ Print() [84/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Time  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108239 of file autoarts.h.

◆ Print() [85/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Timer  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108205 of file autoarts.h.

◆ Print() [86/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::TransmissionMatrix  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108307 of file autoarts.h.

◆ Print() [87/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Vector  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108341 of file autoarts.h.

◆ Print() [88/88]

MRecord ARTS::AgendaMethod::Print ( [[maybe_unused] ] Workspace ws,
const Var::Verbosity  in,
const Var::Index level = {} 
)
inline

Prints a variable on the screen.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be printed.
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108375 of file autoarts.h.

◆ PrintPhysicalConstants()

MRecord ARTS::AgendaMethod::PrintPhysicalConstants ( [[maybe_unused] ] Workspace ws)
inline

Prints (most) physical constants used in ARTS.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108407 of file autoarts.h.

◆ PrintWorkspace()

MRecord ARTS::AgendaMethod::PrintWorkspace ( [[maybe_unused] ] Workspace ws,
const Var::Index only_allocated = {},
const Var::Index level = {} 
)
inline

Prints a list of the workspace variables.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]only_allocated- Flag for printing either all variables (0) or only allocated ones (1). (default: 1)
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108430 of file autoarts.h.

◆ propmat_clearsky_agenda_checkedCalc()

MRecord ARTS::AgendaMethod::propmat_clearsky_agenda_checkedCalc ( [[maybe_unused] ] Workspace ws)
inline

Checks if the propmat_clearsky_agenda contains all necessary methods to calculate all the species in abs_species.

This method should be called just before the propmat_clearsky_agenda is used, e.g. DoitGetIncoming, ybatchCalc, yCalc

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108935 of file autoarts.h.

◆ propmat_clearsky_fieldCalc()

MRecord ARTS::AgendaMethod::propmat_clearsky_fieldCalc ( [[maybe_unused] ] Workspace ws,
const Var::Vector doppler = {},
const Var::Vector los = {} 
)
inline

Calculate (vector) gas absorption coefficients for all points in the atmosphere.

This is useful in two different contexts:

  1. For testing and plotting gas absorption. (For RT calculations, gas absorption is calculated or extracted locally, therefore there is no need to calculate a global field. But this method is handy for easy plotting of absorption vs. pressure, for example.)
  2. Inside the scattering region, monochromatic absorption is pre-calculated for the entire atmospheric field.

The calculation itself is performed by the propmat_clearsky_agenda*.

Author
Stefan Buehler, Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]doppler- A vector of doppler shift values in Hz. Must either be empty or have same dimension as p_grid. (default: {})
[in]los- Line of sight (default: {})

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108972 of file autoarts.h.

◆ propmat_clearskyAddFaraday()

MRecord ARTS::AgendaMethod::propmat_clearskyAddFaraday ( [[maybe_unused] ] Workspace ws)
inline

Calculates absorption matrix describing Faraday rotation.

Faraday rotation is a change of polarization state of an electromagnetic wave propagating through charged matter by interaction with a magnetic field. Hence, this method requires abs_species* to contain 'free_electrons' and electron content field (as part of vmr_field) as well as magnetic field (mag_u_field, mag_v_field*, mag_w_field) to be specified.

Faraday rotation affects Stokes parameters 2 and 3 (but not intensity!). Therefore, this method requires stokes_dim>2.

Like all 'propmat_clearskyAdd*' methods, the method is additive, i.e., does not overwrite the propagation matrix propmat_clearsky, but adds further contributions.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108555 of file autoarts.h.

◆ propmat_clearskyAddFromAbsCoefPerSpecies()

MRecord ARTS::AgendaMethod::propmat_clearskyAddFromAbsCoefPerSpecies ( [[maybe_unused] ] Workspace ws)
inline

Copy propmat_clearsky from abs_coef_per_species. This is handy for putting an explicit line-by-line calculation into the propmat_clearsky_agenda*. This method is also used internally by. propmat_clearskyAddOnTheFly*. Like all other propmat_clearsky methods, this method does not overwrite prior content of propmat_clearsky, but adds to it.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108581 of file autoarts.h.

◆ propmat_clearskyAddFromLookup()

MRecord ARTS::AgendaMethod::propmat_clearskyAddFromLookup ( [[maybe_unused] ] Workspace ws,
const Var::Numeric extpolfac = {} 
)
inline

Extract gas absorption coefficients from lookup table.

This extracts the absorption coefficient for all species from the lookup table, and adds them to the propagation matrix. Extraction is for one specific atmospheric condition, i.e., a set of pressure, temperature, and VMR values.

Some special species are ignored, for example Zeeman species and free electrons, since their absorption properties are not simple scalars and cannot be handled by the lookup table.

The interpolation order in T and H2O is given by abs_t_interp_order and abs_nls_interp_order, respectively.

Extraction is done for the frequencies in f_grid. Frequency interpolation is controlled by abs_f_interp_order. If this is zero, then f_grid must either be the same as the internal frequency grid of the lookup table (for efficiency reasons, only the first and last element of f_grid are checked), or must have only a single element. If abs_f_interp_order is above zero, then frequency is interpolated along with the other interpolation dimensions. This is useful for calculations with Doppler shift.

For Doppler calculations, you should generate the table with a somewhat larger frequency grid than the calculation itself has, since the Doppler shift will push the frequency grid out of the table range on one side.

Some extrapolation is allowed. For pressure and frequency interpolation the standard extrapolation factor of 0.5 is applied. The factor is the default for temperature and VMR interpolation, but the extrapolation limit can here be adjusted by the extpolfac argument.

See also: propmat_clearskyAddOnTheFly.

Author
Stefan Buehler, Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]extpolfac- Extrapolation factor (for temperature and VMR grid edges). (default: 0.5)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108636 of file autoarts.h.

◆ propmat_clearskyAddHitranLineMixingLines()

MRecord ARTS::AgendaMethod::propmat_clearskyAddHitranLineMixingLines ( [[maybe_unused] ] Workspace ws)
inline

Calculates gas absorption coefficients line-by-line for HITRAN line mixed data.

Wigner6Init* or Wigner3Init must be called before this function.

Please ensure you cite the original authors when you use this function: J. Lamouroux, L. Realia, X. Thomas, et al., J.Q.S.R.T. 151 (2015), 88-96

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108671 of file autoarts.h.

◆ propmat_clearskyAddOnTheFly()

MRecord ARTS::AgendaMethod::propmat_clearskyAddOnTheFly ( [[maybe_unused] ] Workspace ws)
inline

Calculates gas absorption coefficients line-by-line.

This method can be used inside propmat_clearsky_agenda just like propmat_clearskyAddFromLookup*. It is a shortcut for putting in some other methods explicitly, namely:

  1. AbsInputFromRteScalars
  2. Execute abs_xsec_agenda
  3. abs_coefCalcFromXsec
  4. propmat_clearskyAddFromAbsCoefPerSpecies

The calculation is for one specific atmospheric condition, i.e., a set of pressure, temperature, and VMR values.

Author
Stefan Buehler, Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108704 of file autoarts.h.

◆ propmat_clearskyAddParticles()

MRecord ARTS::AgendaMethod::propmat_clearskyAddParticles ( [[maybe_unused] ] Workspace ws,
const Var::Index use_abs_as_ext = {} 
)
inline

Calculates absorption coefficients of particles to be used in clearsky (non-cloudbox) calculations.

This is a method to include particles (neglecting possible scattering components) in a clearsky calculation, i.e. without applying the cloudbox and scattering solvers. Particles are handled as absorbing species with one instance of 'particles' per scattering element considered added to abs_species. Particle absorption cross- sections at current atmospheric conditions are extracted from the single scattering data stored in scat_data, i.e., one array element per 'particles' instance in abs_species is required. Number densities are stored in vmr_field_raw or vmr_field as for all abs_species*, but can be taken from (raw) pnd_field type data.

Note that the absorption coefficient is applied both in the extinction term (neglecting scattering out of the line of sight) and the emission term (neglecting the scattering source term, i.e. scattering into the line of sight).

Optionally, particle extinction (sum of absorption and scattering coefficient) can be used instead of absorption only. To choose this case, set the use_abs_as_ext flag to 0. However, be aware that this creates some unphysical emission term, hence is only suitable, where the source term is negligible anyways, e.g. for occultation simulations.

A line-of-sight direction rtp_los is required as particles can exhibit directional dependent absorption properties, which is taken into account by this method. ScatElementsToabs_speciesAdd* can be used to add all required settings/data for individual scattering elements at once, i.e. a 'particles' tag to abs_species, a set of single scattering data to scat_data* and a number density field to vmr_field_raw (vmr_field is derived applying AtmFieldsCalc once VMRs for all abs_species* have been added) is appended for each scattering element.

Like all 'propmat_clearskyAdd*' methods, the method is additive, i.e., does not overwrite the propagation matrix propmat_clearsky, but adds further contributions.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]use_abs_as_ext- A flag with value 1 or 0. If set to one, particle absorption is used in extinction and emission parts of the RT equation, and scattering out of LOS as well as into LOS is neglected. Otherwise, particle extinction (absorption+scattering) is applied in both the extinction as well as the emission part of the RT equation. That is, true extinction is applied, but emission also includes a pseudo-emission contribution from the scattering coefficient. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108773 of file autoarts.h.

◆ propmat_clearskyAddZeeman()

MRecord ARTS::AgendaMethod::propmat_clearskyAddZeeman ( [[maybe_unused] ] Workspace ws,
const Var::Index manual_zeeman_tag = {},
const Var::Numeric manual_zeeman_magnetic_field_strength = {},
const Var::Numeric manual_zeeman_theta = {},
const Var::Numeric manual_zeeman_eta = {} 
)
inline

Calculates Zeeman-affected polarized propagation matrix and its derivatives.

Otherwise as propmat_clearskyAddFromLookup

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]manual_zeeman_tag- Manual angles tag (default: 0)
[in]manual_zeeman_magnetic_field_strength- Manual Magnetic Field Strength (default: 1.0)
[in]manual_zeeman_theta- Manual theta given positive tag (default: 0.0)
[in]manual_zeeman_eta- Manual eta given positive tag (default: 0.0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108809 of file autoarts.h.

◆ propmat_clearskyForceNegativeToZero()

MRecord ARTS::AgendaMethod::propmat_clearskyForceNegativeToZero ( [[maybe_unused] ] Workspace ws)
inline

Sets propmat_clearsky to match zero attenuation if negative value. Useful for line mixing in some cases.

Use this method just if you know what you are doing!

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108910 of file autoarts.h.

◆ propmat_clearskyInit()

MRecord ARTS::AgendaMethod::propmat_clearskyInit ( [[maybe_unused] ] Workspace ws)
inline

Initialize propmat_clearsky and nlte_source.

This method must be used inside propmat_clearsky_agenda and then be called first.

Author
Oliver Lemke, Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108859 of file autoarts.h.

◆ propmat_clearskyZero()

MRecord ARTS::AgendaMethod::propmat_clearskyZero ( [[maybe_unused] ] Workspace ws)
inline

Sets propmat_clearsky to match zero attenuation.

Use this method just if you know what you are doing!

If you want to make a calculation with no clear-sky attenuation at all, fill propmat_clearsky_agenda with this method and required Ignore statements (don't include propmat_clearskyInit).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108886 of file autoarts.h.

◆ psdAbelBoutle12()

MRecord ARTS::AgendaMethod::psdAbelBoutle12 ( [[maybe_unused] ] Workspace ws,
const Var::Numeric t_min = {},
const Var::Numeric t_max = {},
const Var::Index picky = {} 
)
inline

Abel and Boutle [2012] particle size distribution for rain.

Reference: Abel and Boutle, An improved representation of the raindrop size distribution for single-moment microphysics schemes, QJRMS, 2012.

This is a 1-parameter PSD, i.e. pnd_agenda_input shall have one column and pnd_agenda_input_names shall contain a single string. The input data in pnd_agenda_input shall be rain mass content in unit of [kg/m3]. The naming used is pnd_agenda_input_names is free but the same name must be used in particle_bulkprop_names and dpnd_data_dx_names*.

Particles are assumed to be near-spherical, ie. psd_size_grid can either be in terms of volume (or mass) equivalent diameter or maximum diameter.

Derivatives are obtained analytically.

The validity range of mass content is not limited. Negative mass contents will produce negative psd values following a distribution given by abs(RWC), ie. abs(psd)=f(abs(RWC)).

If temperature is outside [t_min,t_max] psd=0 and dpsd=0 if picky=0, or an error is thrown if picky=1.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]t_min- Low temperature limit to calculate a psd. (default: 273)
[in]t_max- High temperature limit to calculate a psd. (default: 373)
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109034 of file autoarts.h.

◆ psdDelanoeEtAl14()

MRecord ARTS::AgendaMethod::psdDelanoeEtAl14 ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  t_min,
const Var::Numeric  t_max,
const Var::Numeric iwc = {},
const Var::Numeric n0Star = {},
const Var::Numeric Dm = {},
const Var::Numeric rho = {},
const Var::Numeric alpha = {},
const Var::Numeric beta = {},
const Var::Numeric dm_min = {},
const Var::Index picky = {} 
)
inline

Normalized PSD as proposed in Delanoë et al. ((2014)),

Title and journal: 'Normalized particle size distribution for remote sensing application', J. Geophys. Res. Atmos., 119, 4204–422.

The PSD has two independent parameters n0Star, the intercept parameter, and Dm, the volume-weighted diameter. This implementation expects as input two out of the following three quantities: iwc, n0Star, Dm. In this case one of the input parameters iwc, n0Star, Dm must be set to -999. It is also possible to provide only iwc, in which case an a priori assumption will be used to deduce n0Star from temperature. In this case both n0Star and Dm must be set to -999.0.

This PSD is not defined for vanishing concentrations of scatterers as it requires normalization by Dm. It is up to the user to ensure that the value of Dm is sufficiently large. An error is thrown if Dm is zero or below the value provided by dm_min.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]iwc- Ice water content (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]n0Star- Intercept parameter (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]Dm- Volume weighted diameter (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]rho- Density of ice (default: 917.6)
[in]alpha- alpha parameter of the shape function (default: -0.237)
[in]beta- beta paramter of the shape function (default: 1.839)
[in]t_min- Low temperature limit to calculate a psd.
[in]t_max- High temperature limit to calculate a psd.
[in]dm_min- Lower threshold for Dm below which an error is thrown. (default: -1.0)
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109104 of file autoarts.h.

◆ psdFieldEtAl07()

MRecord ARTS::AgendaMethod::psdFieldEtAl07 ( [[maybe_unused] ] Workspace ws,
const Var::String  regime,
const Var::Numeric t_min = {},
const Var::Numeric t_max = {},
const Var::Numeric t_min_psd = {},
const Var::Numeric t_max_psd = {},
const Var::Numeric beta_min = {},
const Var::Numeric beta_max = {},
const Var::Index picky = {} 
)
inline

The Field et al. [2007] particle size distribution for snow and cloud ice.

This is a 1-parameter PSD, i.e. pnd_agenda_input shall have one column and pnd_agenda_input_names shall contain a single string. The input data in pnd_agenda_input shall be ice hydrometeor mass content in unit of [kg/m3]. The naming used is pnd_agenda_input_names is free but the same name must be used in particle_bulkprop_names and dpnd_data_dx_names*.

psd_size_grid* shall contain size in terms of maximum diameter.

Derivatives are obtained by perturbation of 0.1%, but not less than 1e-9 kg/m3.

Both parametrization for tropics and midlatitudes are handled, governed by setting of regime, where "TR" selectes the tropical case, and "ML" the midlatitude one.

The validity range of mass content is not limited. Negative mass contents will produce negative psd values following a distribution given by abs(IWC), ie. abs(psd)=f(abs(IWC)).

If temperature is outside [t_min,t_max] psd=0 and dpsd=0 if picky=0, or an error is thrown if picky=1.

For temperatures below t_min_psd, the size distribution is calculated for T = t_min_psd. Likewise, for temperatures above t_max_psd*, the distribution is derived for T = t_max_psd.

Defaults of t_min_psd and t_max_psd were set considering that the parametrization has been derived from measurements over temperatures of -60C to 0C. Checks of the sanity of the mass-dimension relationship are performed Errors are thrown if:

  • Mass-dimension relation exponent scat_species_b is outside [beta_min, beta_max].
Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]regime- Parametrization regime ("TR"=tropical or "ML"=midlatitude).
[in]t_min- Low temperature limit to calculate a psd. (default: 0)
[in]t_max- High temperature limit to calculate a psd. (default: 290.)
[in]t_min_psd- Low temperature limit to use as paramtrization temperature. (default: 200.)
[in]t_max_psd- High temperature limit to use as paramtrization temperature. (default: 273.15)
[in]beta_min- Low b limit (only if picky). (default: 1.01)
[in]beta_max- High b limit (only if picky). (default: 4)
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109225 of file autoarts.h.

◆ psdFieldEtAl19()

MRecord ARTS::AgendaMethod::psdFieldEtAl19 ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  t_min,
const Var::Numeric  t_max,
const Var::Index picky = {} 
)
inline

The Field [2019] particle size distribution for hail.

Reference: Field, Normalized hail particle size distributions from the T-28 storm-penetrating aircraft, JAMC, 2019

This is a 1-parmater PSD i.e. pnd_agenda_input shall have one column and pnd_agenda_input_names* shall contain a single string. The input data in pnd_agenda_input shall be hail mass content in unit of [kg/m3]. The naming used is pnd_agenda_input_names is free but the same name must be used in particle_bulkprop_names and dpnd_data_dx_names*. The parameters assume a constant effective density, i.e. scat_species_b pprox 3

Derivatives are obtained analytically.

The validity range of mass content is not limited. Negative mass contents will produce negative psd values following a distribution given by abs(HWC), ie. abs(psd)=f(abs(HWC)).

If temperature is outside [t_min,t_max] psd=0 and dpsd=0 if picky=0, or an error is thrown if picky=1.

Author
Stuart Fox
Parameters
[in,out]Workspacews - An ARTS workspace
[in]t_min- Low temperature limit to calculate a psd.
[in]t_max- High temperature limit to calculate a psd.
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109316 of file autoarts.h.

◆ psdMcFarquaharHeymsfield97()

MRecord ARTS::AgendaMethod::psdMcFarquaharHeymsfield97 ( [[maybe_unused] ] Workspace ws,
const Var::Numeric t_min = {},
const Var::Numeric t_max = {},
const Var::Numeric t_min_psd = {},
const Var::Numeric t_max_psd = {},
const Var::Index picky = {},
const Var::Index noisy = {} 
)
inline

McFarquahar and Heymsfield [1997] particle size distribution for cloud ice.

This is a 1-parameter PSD, i.e. pnd_agenda_input shall have one column and pnd_agenda_input_names shall contain a single string. The input data in pnd_agenda_input shall be ice hydrometeor mass content in unit of [kg/m3]. The naming used is pnd_agenda_input_names is free but the same name must be used in particle_bulkprop_names and dpnd_data_dx_names*.

psd_size_grid* shall contain size in terms of volume equivalent diameter.

Derivatives are obtained by perturbation of 0.1%, but not less than 1e-9 kg/m3.

The validity range of mass content is not limited. Negative mass contents will produce negative psd values following a distribution given by abs(IWC), ie. abs(psd)=f(abs(IWC)).

If temperature is outside [t_min,t_max] psd=0 and dpsd=0 if picky=0, or an error is thrown if picky=1.

For temperatures below t_min_psd, the size distribution is calculated for T = t_min_psd. Likewise, for temperatures above t_max_psd*, the distribution is derived for T = t_max_psd.

Defaults of t_min_psd and t_max_psd were set considering that the parametrization has been derived from measurements over temperatures of -70C to -20C. The noisy option can not be used together with calculation of derivatives (ie. when dpnd_data_dx_names is not empty).

Author
Patrick Eriksson, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]t_min- Low temperature limit to calculate a psd. (default: 0)
[in]t_max- High temperature limit to calculate a psd. (default: 280.)
[in]t_min_psd- Low temperature limit to use as paramtrization temperature. (default: 180)
[in]t_max_psd- High temperature limit to use as paramtrization temperature. (default: 273.15)
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)
[in]noisy- Distribution parameter perturbance flag (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109387 of file autoarts.h.

◆ psdMilbrandtYau05()

MRecord ARTS::AgendaMethod::psdMilbrandtYau05 ( [[maybe_unused] ] Workspace ws,
const Var::String  hydrometeor_type,
const Var::Numeric t_min = {},
const Var::Numeric t_max = {},
const Var::Index picky = {} 
)
inline

Calculates psd_data and dpsd_data_dx following Milbrandt and Yau (2005) two moment particle size distribution for cloud water, cloud ice, rain, snow, graupel and hail, which is used in the GEM model.

WSM for use in pnd_agenda_array for mapping particle_bulkprop_field to pnd_field using pnd_fieldCalcFromParticleBulkProps. Produces the particle size distribution values (dN/dD) and their derivates with respect to independent variables x by dpnd_data_dx_names over multiple particle sizes and atmospheric levels (or SWC/T combinations).

psd_size_grid* is considered to be in terms of maximum diameter. WC is considered to be in terms of mass content (or mass density), ie. units of [kg/m3]. N_tot in terms of number density, ie. units of [1/m3] . Derivatives with respect to WC and N_tot are obtained analytically.

Six particle size distributions for the different hydrometeors are handled, governed by setting of hydrometeor_type, where "cloud_water" selects cloud liquid water , "cloud_ice" selects cloud ice, "snow" selects snow, "rain" selects rain, "graupel" selects graupel, and "hail" selects hail,

Requirements:

pnd_agenda_input_names* must include : ["X-mass_density", "X-number_density" ]. "X" is an arbitrary name The entries in dpnd_data_dx_names (ie. the allowed independent variablea ) can be "X-mass_density" and\or "X-number_density".

The validity range of WC is not limited. Negative WC will produce negative psd values following a distribution given by abs(WC), ie. abs(psd)=f(abs(WC)).

If temperature is outside [t_min,t_max] psd=0 and dpsd=0 if picky=0, or an error is thrown if picky=1.

Author
Manfred Brath
Parameters
[in,out]Workspacews - An ARTS workspace
[in]hydrometeor_type- Hydrometeor type (see above description).
[in]t_min- Low temperature limit to calculate a psd. (default: 0)
[in]t_max- High temperature limit to calculate a psd. (default: 999)
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109488 of file autoarts.h.

◆ psdModifiedGamma()

MRecord ARTS::AgendaMethod::psdModifiedGamma ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  t_min,
const Var::Numeric  t_max,
const Var::Numeric n0 = {},
const Var::Numeric mu = {},
const Var::Numeric la = {},
const Var::Numeric ga = {},
const Var::Index picky = {} 
)
inline

Modified gamma distribution PSD using n0, mu, la and ga as parameters.

The modified gamma distribution is a 4-parameter (n0, mu, la and ga) distribution [Petty & Huang, JAS, 2011)]: n(x) = n0 * x^mu * exp( -la*x^ga ) where x is particle size or mass.

The parameters can be given in two ways, either by pnd_agenda_input or as GIN arguments. The first option allows the parameter to vary, while in the second case the parameter gets a constant value. If a parameter is part of pnd_agenda_input, the corresponding GIN argument must be set to NaN (which is default). This means that the number of columns in pnd_agenda_input* and the number of non-NaN choices for n0, mu, la and ga must add up to four.

Data in pnd_agenda_input are linked to the MGD parameters in term of order, the naming in pnd_agenda_input_names is free. If all four parameteras are specified by pnd_agenda_input, the data in the first column are taken as n0, the second column as mu etc. If a parameter is given as a GIN argument, the columns are just shifted with one position. For example, if mu and ga are specified as GIN arguments, pnd_agenda_input shall have two columns, with n0-values in the first one and la-values in the second one.

The GIN route is especially suitable for selecting special cases of MGD. For example, by setting mu=0 and ga=1, an exponential PSD is obtained: n(x) = n0 * exp( -la*x ) With mu=1 and ga=1, the gamma PSD is obtained: n(x) = n0 * x^mu *exp( -la*x ) There should be little overhead in using the method for exponential and gamma PSDs, there is an internal switch to dedicated expressions for those PSDs.

Derivatives can only be obtained for parameters that are specified by pnd_agenda_input*.

If temperature is outside [t_min,t_max] psd=0 and dpsd=0 if picky=0, or an error is thrown if picky=1.

These requirements apply to the MGD parameters: la > 0 ga > 0

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]n0- n0 (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]mu- mu (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]la- la (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]ga- ga (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]t_min- Low temperature limit to calculate a psd.
[in]t_max- High temperature limit to calculate a psd.
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109580 of file autoarts.h.

◆ psdModifiedGammaMass()

MRecord ARTS::AgendaMethod::psdModifiedGammaMass ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  t_min,
const Var::Numeric  t_max,
const Var::Numeric n0 = {},
const Var::Numeric mu = {},
const Var::Numeric la = {},
const Var::Numeric ga = {},
const Var::Index picky = {} 
)
inline

Modified gamma distribution (MGD) PSD, with mass content as input.

See psdModifiedGamma for a defintion of MGD parameters and how this PSD is handled in ARTS. Only deviations with respect to psdModifiedGamma* are described here.

This version of MGD PSD takes mass content as first input argument. This means that the first column of pnd_agenda_input shall hold mass content data.

The mass content basically replaces one of the standard parameters (n0, mu, la and ga). This parameter is denoted as the dependent one. The dependent parameter is selected by setting the corresponding GIN to -999. So far only n0 and la are allowed to be dependent.

Regarding remaining columns in pnd_agenda_input and constant parameter values (by GIN) follows the same principle as for psdModifiedGamma* except that mass is always in column one (as mentioned) and that there is no position in pnd_agenda_input for the dependent parameter.

These requirements apply to the MGD parameters: mu + scat_species_b + 1 > 0 la > 0 ga > 0 If la is the dependent parameter, mass content must be > 0.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]n0- n0 (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]mu- mu (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]la- la (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]ga- ga (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]t_min- Low temperature limit to calculate a psd.
[in]t_max- High temperature limit to calculate a psd.
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109671 of file autoarts.h.

◆ psdModifiedGammaMassMeanParticleMass()

MRecord ARTS::AgendaMethod::psdModifiedGammaMassMeanParticleMass ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  t_min,
const Var::Numeric  t_max,
const Var::Numeric n0 = {},
const Var::Numeric mu = {},
const Var::Numeric la = {},
const Var::Numeric ga = {},
const Var::Index picky = {} 
)
inline

Modified gamma distribution PSD, with mass content and mean particle mass (Mmean) as inputs.

"Mean particle mass" is here defined as the mass content divided with the total number density.

This version of MGD PSD works as psdModifiedGammaMass, but takes mass content and mean particle mass as first two arguments. This means that the first and second column of pnd_agenda_input shall hold mass content and Mmean, respectively. Accordingly, the number of dependent parameters is two.

These requirements apply to the MGD parameters: mu + 1 > 0 la > 0 ga > 0 Mmean must be > 0.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]n0- n0 (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]mu- mu (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]la- la (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]ga- ga (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]t_min- Low temperature limit to calculate a psd.
[in]t_max- High temperature limit to calculate a psd.
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109832 of file autoarts.h.

◆ psdModifiedGammaMassNtot()

MRecord ARTS::AgendaMethod::psdModifiedGammaMassNtot ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  t_min,
const Var::Numeric  t_max,
const Var::Numeric n0 = {},
const Var::Numeric mu = {},
const Var::Numeric la = {},
const Var::Numeric ga = {},
const Var::Index picky = {} 
)
inline

Modified gamma distribution PSD, with mass content and total number density (Ntot) as inputs.

This version of MGD PSD works as psdModifiedGammaMass, but takes mass content and total number density as first two arguments. This means that the first and second column of pnd_agenda_input shall hold mass content and Ntot, respectively. Accordingly, the number of dependent parameters is two.

These requirements apply: mu + 1 > 0 la > 0 ga > 0 Ntot must be > 0.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]n0- n0 (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]mu- mu (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]la- la (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]ga- ga (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]t_min- Low temperature limit to calculate a psd.
[in]t_max- High temperature limit to calculate a psd.
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109750 of file autoarts.h.

◆ psdModifiedGammaMassSingleMoment()

MRecord ARTS::AgendaMethod::psdModifiedGammaMassSingleMoment ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  n_alpha,
const Var::Numeric  n_b,
const Var::Numeric  mu,
const Var::Numeric  gamma,
const Var::Numeric  t_min,
const Var::Numeric  t_max,
const Var::Index picky = {} 
)
inline

Modified gamma distribution PSD, with mass content as input.

The intercept parameter N0 is assumed dependent on the slope parameter lambda, such that N0=N_alpha*lambda^n_b with fixed N_alpha and n_b. This is a common form for many PSD parametrizations for use with single-moment mass-based schemes.

This version of MGD PSD takes mass content as first input argument. This means that the first column of pnd_agenda_input shall hold mass content data. The dependent parameter is assumed to be lambda.

Author
Stuart Fox
Parameters
[in,out]Workspacews - An ARTS workspace
[in]n_alpha- n_alpha
[in]n_b- n_b
[in]mu- mu
[in]gamma- gamma
[in]t_min- Low temperature limit to calculate a psd.
[in]t_max- High temperature limit to calculate a psd.
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109907 of file autoarts.h.

◆ psdModifiedGammaMassXmean()

MRecord ARTS::AgendaMethod::psdModifiedGammaMassXmean ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  t_min,
const Var::Numeric  t_max,
const Var::Numeric n0 = {},
const Var::Numeric mu = {},
const Var::Numeric la = {},
const Var::Numeric ga = {},
const Var::Index picky = {} 
)
inline

Modified gamma distribution PSD, with mass content and mean size (Xmean) as inputs.

"Mean size" is here defined as mass weighted size. Remembering that mass is a*x^b, this mean size can be expressed as M_b+1/M_b where M_b is b:th moment of the PSD (see e.g. Eq. 17 in Petty&Huang, JAS, 2011).

This version of MGD PSD works as psdModifiedGammaMass, but takes mass content and mass size as first two arguments. This means that the first and second column of pnd_agenda_input shall hold mass content and Xmean, respectively. Accordingly, the number of dependent parameters is two.

These requirements apply to the MGD parameters: mu + scat_species_b + 1 > 0 la > 0 ga > 0 Xmean must be > 0.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]n0- n0 (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]mu- mu (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]la- la (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]ga- ga (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]t_min- Low temperature limit to calculate a psd.
[in]t_max- High temperature limit to calculate a psd.
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 109978 of file autoarts.h.

◆ psdModifiedGammaMassXmedian()

MRecord ARTS::AgendaMethod::psdModifiedGammaMassXmedian ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  t_min,
const Var::Numeric  t_max,
const Var::Numeric n0 = {},
const Var::Numeric mu = {},
const Var::Numeric la = {},
const Var::Numeric ga = {},
const Var::Index picky = {} 
)
inline

Modified gamma distribution PSD, with mass content and median size (Xmedian) as inputs.

This version of MGD PSD works as psdModifiedGammaMass, but takes mass content and median size as first two arguments. This means that the first and second column of pnd_agenda_input shall hold mass content and Xmedian, respectively. Accordingly, the number of dependent parameters is two.

These requirements apply to the MGD parameters: mu + scat_species_b + 1 > 0 la > 0 ga > 0 Xmedian must be > 0.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]n0- n0 (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]mu- mu (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]la- la (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]ga- ga (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]t_min- Low temperature limit to calculate a psd.
[in]t_max- High temperature limit to calculate a psd.
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110058 of file autoarts.h.

◆ psdMonoDispersive()

MRecord ARTS::AgendaMethod::psdMonoDispersive ( [[maybe_unused] ] Workspace ws,
const Var::Index  species_index,
const Var::Numeric  t_min,
const Var::Numeric  t_max,
const Var::Index picky = {} 
)
inline

Mono-dispersive PSD, with number density given.

This is a 1-parameter PSD, i.e. pnd_agenda_input shall have one column and pnd_agenda_input_names shall contain a single string. The input data in pnd_agenda_input shall be number densities, in unit of [#/m3]. The naming used is pnd_agenda_input_names is free but the same name must be used in particle_bulkprop_names and dpnd_data_dx_names*.

The method checks that the scattering species indicated (by species_index*) has a single element, and just inserts the provided number density in psd_data.

If temperature is outside [t_min,t_max] psd=0 and dpsd=0 if picky=0, or an error is thrown if picky=1.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]species_index- The index of the scattering species of concern (0-based).
[in]t_min- Low temperature limit to calculate a psd.
[in]t_max- High temperature limit to calculate a psd.
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110135 of file autoarts.h.

◆ psdMonoMass()

MRecord ARTS::AgendaMethod::psdMonoMass ( [[maybe_unused] ] Workspace ws,
const Var::Index  species_index,
const Var::Numeric  t_min,
const Var::Numeric  t_max,
const Var::Index picky = {} 
)
inline

Mono-dispersive PSD, with mass content given.

This is a 1-parameter PSD, i.e. pnd_agenda_input shall have one column and pnd_agenda_input_names shall contain a single string. The input data in pnd_agenda_input shall be mass contents, in unit of [#/m3]. The naming used is pnd_agenda_input_names is free but the same name must be used in particle_bulkprop_names and dpnd_data_dx_names*.

The method checks that the scattering species indicated (by species_index*) has a single element, and sets psd_data based on the mass contents given and the particle mass (derived from scat_meta*).

If temperature is outside [t_min,t_max] psd=0 and dpsd=0 if picky=0, or an error is thrown if picky=1.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]species_index- The index of the scattering species of concern (0-based).
[in]t_min- Low temperature limit to calculate a psd.
[in]t_max- High temperature limit to calculate a psd.
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110192 of file autoarts.h.

◆ psdSeifertBeheng06()

MRecord ARTS::AgendaMethod::psdSeifertBeheng06 ( [[maybe_unused] ] Workspace ws,
const Var::String  hydrometeor_type,
const Var::Numeric t_min = {},
const Var::Numeric t_max = {},
const Var::Index picky = {} 
)
inline

Calculates psd_data and dpsd_data_dx following Seifert and Beheng (2006) two moment particle size distribution for cloud water, cloud ice, rain, snow, graupel and hail, which is used in the ICON model.

WSM for use in pnd_agenda_array for mapping particle_bulkprop_field to pnd_field using pnd_fieldCalcFromParticleBulkProps. Produces the particle size distribution values (dN/dD) and their derivates with respect to independent variables x by dpnd_data_dx_names over multiple particle sizes and atmospheric levels (or SWC/T combinations).

psd_size_grid* is considered to be in terms of mass. WC is considered to be in terms of mass content (or mass density), ie. units of [kg/m3]. N_tot in terms of number density, ie. units of [1/m3] . Derivatives with respect to WC and N_tot are obtained analytically.

Six particle size distributions for the different hydrometeors are handled, governed by setting of hydrometeor_type, where "cloud_water" selects cloud liquid water , "cloud_ice" selects cloud ice, "snow" selects snow, "rain" selects rain, "graupel" selects graupel, and "hail" selects hail,

Requirements:

pnd_agenda_input_names* must include : ["X-mass_density", "X-number_density" ]. "X" is an arbitrary name The entries in dpnd_data_dx_names (ie. the allowed independent variablea ) can be "X-mass_density" and\or "X-number_density".

The validity range of WC is not limited. Negative WC will produce negative psd values following a distribution given by abs(WC), ie. abs(psd)=f(abs(WC)).

If temperature is outside [t_min,t_max] psd=0 and dpsd=0 if picky=0, or an error is thrown if picky=1.

Author
Manfred Brath
Parameters
[in,out]Workspacews - An ARTS workspace
[in]hydrometeor_type- Hydrometeor type (see above description).
[in]t_min- Low temperature limit to calculate a psd. (default: 0)
[in]t_max- High temperature limit to calculate a psd. (default: 999)
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110272 of file autoarts.h.

◆ psdWangEtAl16()

MRecord ARTS::AgendaMethod::psdWangEtAl16 ( [[maybe_unused] ] Workspace ws,
const Var::Numeric t_min = {},
const Var::Numeric t_max = {},
const Var::Index picky = {} 
)
inline

Wang et al. [2016] particle size distribution for rain.

Reference: Wang et al., Investigation of liquid cloud microphysical properties of deep convective systems: 1. Parameterization raindrop size distribution and its application ..., 2016.

This is a 1-parameter PSD, i.e. pnd_agenda_input shall have one column and pnd_agenda_input_names shall contain a single string. The input data in pnd_agenda_input shall be rain mass content in unit of [kg/m3]. The naming used is pnd_agenda_input_names is free but the same name must be used in particle_bulkprop_names and dpnd_data_dx_names*.

Particles are assumed to be near-spherical, ie. psd_size_grid can either be in terms of volume (or mass) equivalent diameter or maximum diameter.

Derivatives are obtained analytically.

The validity range of mass content is not limited. Negative mass contents will produce negative psd values following a distribution given by abs(RWC), ie. abs(psd)=f(abs(RWC)).

If temperature is outside [t_min,t_max] psd=0 and dpsd=0 if picky=0, or an error is thrown if picky=1.

Author
Jana Mendrok, Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]t_min- Low temperature limit to calculate a psd. (default: 273)
[in]t_max- High temperature limit to calculate a psd. (default: 373)
[in]picky- Flag whether to be strict with parametrization value checks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110343 of file autoarts.h.

◆ QuantumIdentifierSet()

MRecord ARTS::AgendaMethod::QuantumIdentifierSet ( [[maybe_unused] ] Workspace ws,
Var::QuantumIdentifier  out,
const Var::String  string_initializer 
)
inline

Sets a QuantumIdentifier workspace variable to the given value by converting the input String

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]string_initializer- The string representing the value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 101464 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::String::islast(), ARTS::Var::QuantumIdentifier::pos(), and ARTS::Var::String::pos().

◆ RadiationFieldSpectralIntegrate() [1/2]

MRecord ARTS::AgendaMethod::RadiationFieldSpectralIntegrate ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  radiation_field,
const Var::Tensor5  spectral_radiation_field 
)
inline

Integrates fields like spectral_irradiance_field or cloudbox_field over frequency. Important, the first dimension must be the frequency dimension! If a field like cloudbox_field is input, the stokes dimension is also removed.

Author
Manfred Brath
Parameters
[in,out]Workspacews - An ARTS workspace
[out]radiation_field- TBD
[in]spectral_radiation_field- TBD

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110602 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), ARTS::Var::Tensor5::islast(), ARTS::Var::Tensor4::pos(), and ARTS::Var::Tensor5::pos().

◆ RadiationFieldSpectralIntegrate() [2/2]

MRecord ARTS::AgendaMethod::RadiationFieldSpectralIntegrate ( [[maybe_unused] ] Workspace ws,
Var::Tensor5  radiation_field,
const Var::Tensor7  spectral_radiation_field 
)
inline

Integrates fields like spectral_irradiance_field or cloudbox_field over frequency. Important, the first dimension must be the frequency dimension! If a field like cloudbox_field is input, the stokes dimension is also removed.

Author
Manfred Brath
Parameters
[in,out]Workspacews - An ARTS workspace
[out]radiation_field- TBD
[in]spectral_radiation_field- TBD

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110637 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), ARTS::Var::Tensor7::islast(), ARTS::Var::Tensor5::pos(), and ARTS::Var::Tensor7::pos().

◆ RationalAdd()

MRecord ARTS::AgendaMethod::RationalAdd ( [[maybe_unused] ] Workspace ws,
Var::Rational  out,
const Var::Rational  in,
const Var::Rational  value 
)
inline

Adds a Rational and a value (out = in+value).

The result can either be stored in the same or another Rational. (in and out can be the same varible, but not out and value)

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output Rational.
[in]in- Input Rational.
[in]value- Value to add.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110716 of file autoarts.h.

References ARTS::Var::Rational::islast(), and ARTS::Var::Rational::pos().

◆ RationalInvScale()

MRecord ARTS::AgendaMethod::RationalInvScale ( [[maybe_unused] ] Workspace ws,
Var::Rational  out,
const Var::Rational  in,
const Var::Rational  value 
)
inline

Inversely scales/divides a Rational with a value (out = in/value).

The result can either be stored in the same or another Rational. (in and out can be the same varible, but not out and value)

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output Rational.
[in]in- Input Rational.
[in]value- Scaling Rational.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110754 of file autoarts.h.

References ARTS::Var::Rational::islast(), and ARTS::Var::Rational::pos().

◆ RationalScale()

MRecord ARTS::AgendaMethod::RationalScale ( [[maybe_unused] ] Workspace ws,
Var::Rational  out,
const Var::Rational  in,
const Var::Rational  value 
)
inline

Scales/multiplies a Rational with a value (out = in*value).

The result can either be stored in the same or another Rational. (in and out can be the same varible, but not out and value)

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output Rational.
[in]in- Input Rational.
[in]value- Scaling value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110792 of file autoarts.h.

References ARTS::Var::Rational::islast(), and ARTS::Var::Rational::pos().

◆ RationalSet()

MRecord ARTS::AgendaMethod::RationalSet ( [[maybe_unused] ] Workspace ws,
Var::Rational  out,
const Var::Index  numerator,
const Var::Index denominator = {} 
)
inline

Sets a Rational workspace variable to the given value.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]numerator- The numerator.
[in]denominator- The denominator. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110827 of file autoarts.h.

◆ ReadArrayOfARTSCAT()

MRecord ARTS::AgendaMethod::ReadArrayOfARTSCAT ( [[maybe_unused] ] Workspace ws,
const Var::String  filename,
const Var::Numeric fmin = {},
const Var::Numeric fmax = {},
const Var::String globalquantumnumbers = {},
const Var::String localquantumnumbers = {},
const Var::String normalization_option = {},
const Var::String mirroring_option = {},
const Var::String population_option = {},
const Var::String lineshapetype_option = {},
const Var::String cutoff_option = {},
const Var::Numeric cutoff_value = {},
const Var::Numeric linemixinglimit_value = {} 
)
inline

Reads an old Array<ArrayOfLineRecord> ARTSCAT file.

Note that the ARTSCAT-5 had quantum numbers and options stored inside it but that the options will overwrite that information. Be careful setting the options!

Author
Stefan Buehler
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]filename- Name of the ARTSCAT file
[in]fmin- Minimum frequency of read lines (default: 0)
[in]fmax- Maximum frequency of read lines (default: 1e99)
[in]globalquantumnumbers- Global quantum number list (space-separated) (default: "")
[in]localquantumnumbers- Local quantum number list (space-separated) (default: "")
[in]normalization_option- Normalization option, see abs_linesSetNormalization (default: "None")
[in]mirroring_option- Mirroring option, see abs_linesSetMirroring (default: "None")
[in]population_option- Population option, see abs_linesSetPopulation (default: "LTE")
[in]lineshapetype_option- Lineshape option, see abs_linesSetLineShapeType (default: "VP")
[in]cutoff_option- Cutoff option, see abs_linesSetCutoff (default: "None")
[in]cutoff_value- Cutoff value, see abs_linesSetCutoff (default: 750e9)
[in]linemixinglimit_value- Line mixing limit, see abs_linesSetLinemixingLimit (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110879 of file autoarts.h.

◆ ReadARTSCAT()

MRecord ARTS::AgendaMethod::ReadARTSCAT ( [[maybe_unused] ] Workspace ws,
const Var::String  filename,
const Var::Numeric fmin = {},
const Var::Numeric fmax = {},
const Var::String globalquantumnumbers = {},
const Var::String localquantumnumbers = {},
const Var::String normalization_option = {},
const Var::String mirroring_option = {},
const Var::String population_option = {},
const Var::String lineshapetype_option = {},
const Var::String cutoff_option = {},
const Var::Numeric cutoff_value = {},
const Var::Numeric linemixinglimit_value = {} 
)
inline

Reads an old ArrayOfLineRecord ARTSCAT file

Note that the ARTSCAT-5 had quantum numbers and options stored inside it but that the options will overwrite that information. Be careful setting the options!

Author
Stefan Buehler
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]filename- Name of the ARTSCAT file
[in]fmin- Minimum frequency of read lines (default: 0)
[in]fmax- Maximum frequency of read lines (default: 1e99)
[in]globalquantumnumbers- Global quantum number list (space-separated) (default: "")
[in]localquantumnumbers- Local quantum number list (space-separated) (default: "")
[in]normalization_option- Normalization option, see abs_linesSetNormalization (default: "None")
[in]mirroring_option- Mirroring option, see abs_linesSetMirroring (default: "None")
[in]population_option- Population option, see abs_linesSetPopulation (default: "LTE")
[in]lineshapetype_option- Lineshape option, see abs_linesSetLineShapeType (default: "VP")
[in]cutoff_option- Cutoff option, see abs_linesSetCutoff (default: "None")
[in]cutoff_value- Cutoff value, see abs_linesSetCutoff (default: 750e9)
[in]linemixinglimit_value- Line mixing limit, see abs_linesSetLinemixingLimit (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111104 of file autoarts.h.

◆ ReadHITRAN()

MRecord ARTS::AgendaMethod::ReadHITRAN ( [[maybe_unused] ] Workspace ws,
const Var::String  filename,
const Var::Numeric fmin = {},
const Var::Numeric fmax = {},
const Var::String globalquantumnumbers = {},
const Var::String localquantumnumbers = {},
const Var::String hitran_type = {},
const Var::String normalization_option = {},
const Var::String mirroring_option = {},
const Var::String population_option = {},
const Var::String lineshapetype_option = {},
const Var::String cutoff_option = {},
const Var::Numeric cutoff_value = {},
const Var::Numeric linemixinglimit_value = {} 
)
inline

Reads a HITRAN .par file.

The HITRAN type switch can be: "Pre2004" - for old format "Post2004" - for new format "Online" - for the online format with quantum numbers (highly experimental)

Be careful setting the options!

Author
Hermann Berg
Thomas Kuhn
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]filename- Name of the HITRAN file
[in]fmin- Minimum frequency of read lines (default: 0)
[in]fmax- Maximum frequency of read lines (default: 1e99)
[in]globalquantumnumbers- Global quantum number list (space-separated) (default: "")
[in]localquantumnumbers- Local quantum number list (space-separated) (default: "")
[in]hitran_type- Method to use to read the line data (default: "Post2004")
[in]normalization_option- Normalization option, see abs_linesSetNormalization (default: "None")
[in]mirroring_option- Mirroring option, see abs_linesSetMirroring (default: "None")
[in]population_option- Population option, see abs_linesSetPopulation (default: "LTE")
[in]lineshapetype_option- Lineshape option, see abs_linesSetLineShapeType (default: "VP")
[in]cutoff_option- Cutoff option, see abs_linesSetCutoff (default: "None")
[in]cutoff_value- Cutoff value, see abs_linesSetCutoff (default: 750e9)
[in]linemixinglimit_value- Line mixing limit, see abs_linesSetLinemixingLimit (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111218 of file autoarts.h.

◆ ReadJPL()

MRecord ARTS::AgendaMethod::ReadJPL ( [[maybe_unused] ] Workspace ws,
const Var::String  filename,
const Var::Numeric fmin = {},
const Var::Numeric fmax = {},
const Var::String globalquantumnumbers = {},
const Var::String localquantumnumbers = {},
const Var::String normalization_option = {},
const Var::String mirroring_option = {},
const Var::String population_option = {},
const Var::String lineshapetype_option = {},
const Var::String cutoff_option = {},
const Var::Numeric cutoff_value = {},
const Var::Numeric linemixinglimit_value = {} 
)
inline

Reads a JPL file.

Be careful setting the options!

Author
Thomas Kuhn
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]filename- Name of the JPL file
[in]fmin- Minimum frequency of read lines (default: 0)
[in]fmax- Maximum frequency of read lines (default: 1e99)
[in]globalquantumnumbers- Global quantum number list (space-separated) (default: "")
[in]localquantumnumbers- Local quantum number list (space-separated) (default: "")
[in]normalization_option- Normalization option, see abs_linesSetNormalization (default: "None")
[in]mirroring_option- Mirroring option, see abs_linesSetMirroring (default: "None")
[in]population_option- Population option, see abs_linesSetPopulation (default: "LTE")
[in]lineshapetype_option- Lineshape option, see abs_linesSetLineShapeType (default: "VP")
[in]cutoff_option- Cutoff option, see abs_linesSetCutoff (default: "None")
[in]cutoff_value- Cutoff value, see abs_linesSetCutoff (default: 750e9)
[in]linemixinglimit_value- Line mixing limit, see abs_linesSetLinemixingLimit (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111545 of file autoarts.h.

◆ ReadLBLRTM()

MRecord ARTS::AgendaMethod::ReadLBLRTM ( [[maybe_unused] ] Workspace ws,
const Var::String  filename,
const Var::Numeric fmin = {},
const Var::Numeric fmax = {},
const Var::String globalquantumnumbers = {},
const Var::String localquantumnumbers = {},
const Var::String normalization_option = {},
const Var::String mirroring_option = {},
const Var::String population_option = {},
const Var::String lineshapetype_option = {},
const Var::String cutoff_option = {},
const Var::Numeric cutoff_value = {},
const Var::Numeric linemixinglimit_value = {} 
)
inline

Reads a LBLRTM file.

Be careful setting the options!

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]filename- Name of the LBLRTM file
[in]fmin- Minimum frequency of read lines (default: 0)
[in]fmax- Maximum frequency of read lines (default: 1e99)
[in]globalquantumnumbers- Global quantum number list (space-separated) (default: "")
[in]localquantumnumbers- Local quantum number list (space-separated) (default: "")
[in]normalization_option- Normalization option, see abs_linesSetNormalization (default: "None")
[in]mirroring_option- Mirroring option, see abs_linesSetMirroring (default: "None")
[in]population_option- Population option, see abs_linesSetPopulation (default: "LTE")
[in]lineshapetype_option- Lineshape option, see abs_linesSetLineShapeType (default: "VP")
[in]cutoff_option- Cutoff option, see abs_linesSetCutoff (default: "None")
[in]cutoff_value- Cutoff value, see abs_linesSetCutoff (default: 750e9)
[in]linemixinglimit_value- Line mixing limit, see abs_linesSetLinemixingLimit (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111330 of file autoarts.h.

◆ ReadMytran2()

MRecord ARTS::AgendaMethod::ReadMytran2 ( [[maybe_unused] ] Workspace ws,
const Var::String  filename,
const Var::Numeric fmin = {},
const Var::Numeric fmax = {},
const Var::String globalquantumnumbers = {},
const Var::String localquantumnumbers = {},
const Var::String normalization_option = {},
const Var::String mirroring_option = {},
const Var::String population_option = {},
const Var::String lineshapetype_option = {},
const Var::String cutoff_option = {},
const Var::Numeric cutoff_value = {},
const Var::Numeric linemixinglimit_value = {} 
)
inline

Reads a Mytran2 file.

Be careful setting the options!

Author
Axel von Engeln
Stefan Buehler
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]filename- Name of the Mytran2 file
[in]fmin- Minimum frequency of read lines (default: 0)
[in]fmax- Maximum frequency of read lines (default: 1e99)
[in]globalquantumnumbers- Global quantum number list (space-separated) (default: "")
[in]localquantumnumbers- Local quantum number list (space-separated) (default: "")
[in]normalization_option- Normalization option, see abs_linesSetNormalization (default: "None")
[in]mirroring_option- Mirroring option, see abs_linesSetMirroring (default: "None")
[in]population_option- Population option, see abs_linesSetPopulation (default: "LTE")
[in]lineshapetype_option- Lineshape option, see abs_linesSetLineShapeType (default: "VP")
[in]cutoff_option- Cutoff option, see abs_linesSetCutoff (default: "None")
[in]cutoff_value- Cutoff value, see abs_linesSetCutoff (default: 750e9)
[in]linemixinglimit_value- Line mixing limit, see abs_linesSetLinemixingLimit (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111438 of file autoarts.h.

◆ ReadNetCDF() [1/8]

MRecord ARTS::AgendaMethod::ReadNetCDF ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfMatrix  out,
const Var::String  filename 
)
inline

Reads a workspace variable from a NetCDF file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the NetCDF file.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112003 of file autoarts.h.

References ARTS::Var::ArrayOfMatrix::islast(), ARTS::Var::String::islast(), ARTS::Var::ArrayOfMatrix::pos(), and ARTS::Var::String::pos().

◆ ReadNetCDF() [2/8]

MRecord ARTS::AgendaMethod::ReadNetCDF ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfVector  out,
const Var::String  filename 
)
inline

Reads a workspace variable from a NetCDF file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the NetCDF file.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111967 of file autoarts.h.

References ARTS::Var::ArrayOfVector::islast(), ARTS::Var::String::islast(), ARTS::Var::ArrayOfVector::pos(), and ARTS::Var::String::pos().

◆ ReadNetCDF() [3/8]

MRecord ARTS::AgendaMethod::ReadNetCDF ( [[maybe_unused] ] Workspace ws,
Var::GasAbsLookup  out,
const Var::String  filename 
)
inline

Reads a workspace variable from a NetCDF file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the NetCDF file.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112039 of file autoarts.h.

References ARTS::Var::GasAbsLookup::islast(), ARTS::Var::String::islast(), ARTS::Var::GasAbsLookup::pos(), and ARTS::Var::String::pos().

◆ ReadNetCDF() [4/8]

MRecord ARTS::AgendaMethod::ReadNetCDF ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::String  filename 
)
inline

Reads a workspace variable from a NetCDF file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the NetCDF file.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111823 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::String::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::String::pos().

◆ ReadNetCDF() [5/8]

MRecord ARTS::AgendaMethod::ReadNetCDF ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::String  filename 
)
inline

Reads a workspace variable from a NetCDF file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the NetCDF file.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111859 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::String::pos(), and ARTS::Var::Tensor3::pos().

◆ ReadNetCDF() [6/8]

MRecord ARTS::AgendaMethod::ReadNetCDF ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::String  filename 
)
inline

Reads a workspace variable from a NetCDF file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the NetCDF file.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111895 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::String::pos(), and ARTS::Var::Tensor4::pos().

◆ ReadNetCDF() [7/8]

MRecord ARTS::AgendaMethod::ReadNetCDF ( [[maybe_unused] ] Workspace ws,
Var::Tensor5  out,
const Var::String  filename 
)
inline

Reads a workspace variable from a NetCDF file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the NetCDF file.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111931 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::Tensor5::islast(), ARTS::Var::String::pos(), and ARTS::Var::Tensor5::pos().

◆ ReadNetCDF() [8/8]

MRecord ARTS::AgendaMethod::ReadNetCDF ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::String  filename 
)
inline

Reads a workspace variable from a NetCDF file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the NetCDF file.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 111787 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ ReadSplitARTSCAT()

MRecord ARTS::AgendaMethod::ReadSplitARTSCAT ( [[maybe_unused] ] Workspace ws,
const Var::String  basename,
const Var::Numeric fmin = {},
const Var::Numeric fmax = {},
const Var::String globalquantumnumbers = {},
const Var::String localquantumnumbers = {},
const Var::Index ignore_missing = {},
const Var::String normalization_option = {},
const Var::String mirroring_option = {},
const Var::String population_option = {},
const Var::String lineshapetype_option = {},
const Var::String cutoff_option = {},
const Var::Numeric cutoff_value = {},
const Var::Numeric linemixinglimit_value = {} 
)
inline

Reads several old ArrayOfLineRecord ARTSCAT file

Note that the ARTSCAT-5 had quantum numbers and options stored inside it but that the options will overwrite that information. Be careful setting the options!

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- Path to the files
[in]fmin- Minimum frequency of read lines (default: 0)
[in]fmax- Maximum frequency of read lines (default: 1e99)
[in]globalquantumnumbers- Global quantum number list (space-separated) (default: "")
[in]localquantumnumbers- Local quantum number list (space-separated) (default: "")
[in]ignore_missing- Ignores instead of throws if an abs_species is missing (default: 0)
[in]normalization_option- Normalization option, see abs_linesSetNormalization (default: "None")
[in]mirroring_option- Mirroring option, see abs_linesSetMirroring (default: "None")
[in]population_option- Population option, see abs_linesSetPopulation (default: "LTE")
[in]lineshapetype_option- Lineshape option, see abs_linesSetLineShapeType (default: "VP")
[in]cutoff_option- Cutoff option, see abs_linesSetCutoff (default: "None")
[in]cutoff_value- Cutoff value, see abs_linesSetCutoff (default: 750e9)
[in]linemixinglimit_value- Line mixing limit, see abs_linesSetLinemixingLimit (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 110989 of file autoarts.h.

◆ ReadXML() [1/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::AbsorptionLines  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112077 of file autoarts.h.

◆ ReadXML() [2/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Agenda  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112118 of file autoarts.h.

◆ ReadXML() [3/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAbsorptionLines  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112159 of file autoarts.h.

◆ ReadXML() [4/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAgenda  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112241 of file autoarts.h.

◆ ReadXML() [5/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfAbsorptionLines  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112200 of file autoarts.h.

◆ ReadXML() [6/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField1  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112282 of file autoarts.h.

◆ ReadXML() [7/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField2  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112323 of file autoarts.h.

◆ ReadXML() [8/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField3  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112364 of file autoarts.h.

◆ ReadXML() [9/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfIndex  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112405 of file autoarts.h.

◆ ReadXML() [10/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfMatrix  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112446 of file autoarts.h.

◆ ReadXML() [11/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfPropagationMatrix  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112528 of file autoarts.h.

◆ ReadXML() [12/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfRadiationVector  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112569 of file autoarts.h.

◆ ReadXML() [13/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfScatteringMetaData  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112610 of file autoarts.h.

◆ ReadXML() [14/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSingleScatteringData  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112651 of file autoarts.h.

◆ ReadXML() [15/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSpeciesTag  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112692 of file autoarts.h.

◆ ReadXML() [16/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfStokesVector  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112733 of file autoarts.h.

◆ ReadXML() [17/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfString  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112774 of file autoarts.h.

◆ ReadXML() [18/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor3  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112815 of file autoarts.h.

◆ ReadXML() [19/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor6  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112856 of file autoarts.h.

◆ ReadXML() [20/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTime  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112897 of file autoarts.h.

◆ ReadXML() [21/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTransmissionMatrix  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112938 of file autoarts.h.

◆ ReadXML() [22/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfVector  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112979 of file autoarts.h.

◆ ReadXML() [23/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfCIARecord  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113020 of file autoarts.h.

◆ ReadXML() [24/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField1  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113061 of file autoarts.h.

◆ ReadXML() [25/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField2  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113102 of file autoarts.h.

◆ ReadXML() [26/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField3  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113143 of file autoarts.h.

◆ ReadXML() [27/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField4  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113184 of file autoarts.h.

◆ ReadXML() [28/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfIndex  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113225 of file autoarts.h.

◆ ReadXML() [29/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfMatrix  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113266 of file autoarts.h.

◆ ReadXML() [30/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPpath  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 112487 of file autoarts.h.

◆ ReadXML() [31/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPropagationMatrix  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113307 of file autoarts.h.

◆ ReadXML() [32/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfQuantumIdentifier  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113348 of file autoarts.h.

◆ ReadXML() [33/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRadiationVector  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113389 of file autoarts.h.

◆ ReadXML() [34/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRetrievalQuantity  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113430 of file autoarts.h.

◆ ReadXML() [35/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfScatteringMetaData  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113471 of file autoarts.h.

◆ ReadXML() [36/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSingleScatteringData  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113512 of file autoarts.h.

◆ ReadXML() [37/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSparse  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113553 of file autoarts.h.

◆ ReadXML() [38/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfStokesVector  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113594 of file autoarts.h.

◆ ReadXML() [39/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113635 of file autoarts.h.

◆ ReadXML() [40/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTelsemAtlas  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113676 of file autoarts.h.

◆ ReadXML() [41/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor3  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113717 of file autoarts.h.

◆ ReadXML() [42/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor4  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113758 of file autoarts.h.

◆ ReadXML() [43/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor5  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113799 of file autoarts.h.

◆ ReadXML() [44/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor6  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113840 of file autoarts.h.

◆ ReadXML() [45/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor7  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113881 of file autoarts.h.

◆ ReadXML() [46/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTime  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113922 of file autoarts.h.

◆ ReadXML() [47/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTransmissionMatrix  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 113963 of file autoarts.h.

◆ ReadXML() [48/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfVector  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114004 of file autoarts.h.

◆ ReadXML() [49/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfXsecRecord  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114045 of file autoarts.h.

◆ ReadXML() [50/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::CIARecord  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114086 of file autoarts.h.

◆ ReadXML() [51/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::CovarianceMatrix  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114127 of file autoarts.h.

◆ ReadXML() [52/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::EnergyLevelMap  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114168 of file autoarts.h.

◆ ReadXML() [53/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::GasAbsLookup  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114209 of file autoarts.h.

◆ ReadXML() [54/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::GriddedField1  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114291 of file autoarts.h.

◆ ReadXML() [55/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::GriddedField2  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114332 of file autoarts.h.

◆ ReadXML() [56/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::GriddedField3  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114373 of file autoarts.h.

◆ ReadXML() [57/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::GriddedField4  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114414 of file autoarts.h.

◆ ReadXML() [58/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::GriddedField5  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114455 of file autoarts.h.

◆ ReadXML() [59/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::GriddedField6  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114496 of file autoarts.h.

◆ ReadXML() [60/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::GridPos  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114250 of file autoarts.h.

◆ ReadXML() [61/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::HitranRelaxationMatrixData  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114537 of file autoarts.h.

◆ ReadXML() [62/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Index  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114578 of file autoarts.h.

◆ ReadXML() [63/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114660 of file autoarts.h.

◆ ReadXML() [64/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::MCAntenna  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114619 of file autoarts.h.

◆ ReadXML() [65/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Numeric  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114701 of file autoarts.h.

◆ ReadXML() [66/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Ppath  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114742 of file autoarts.h.

◆ ReadXML() [67/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::PropagationMatrix  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114783 of file autoarts.h.

◆ ReadXML() [68/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::QuantumIdentifier  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114824 of file autoarts.h.

◆ ReadXML() [69/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::RadiationVector  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114865 of file autoarts.h.

◆ ReadXML() [70/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Rational  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114906 of file autoarts.h.

◆ ReadXML() [71/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::ScatteringMetaData  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114947 of file autoarts.h.

◆ ReadXML() [72/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::SingleScatteringData  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 114988 of file autoarts.h.

◆ ReadXML() [73/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Sparse  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115029 of file autoarts.h.

◆ ReadXML() [74/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::SpeciesAuxData  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115070 of file autoarts.h.

◆ ReadXML() [75/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::StokesVector  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115111 of file autoarts.h.

◆ ReadXML() [76/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::String  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115152 of file autoarts.h.

◆ ReadXML() [77/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::TelsemAtlas  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115193 of file autoarts.h.

◆ ReadXML() [78/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115234 of file autoarts.h.

◆ ReadXML() [79/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115275 of file autoarts.h.

◆ ReadXML() [80/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Tensor5  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115316 of file autoarts.h.

◆ ReadXML() [81/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Tensor6  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115357 of file autoarts.h.

◆ ReadXML() [82/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Tensor7  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115398 of file autoarts.h.

◆ ReadXML() [83/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::TessemNN  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115521 of file autoarts.h.

◆ ReadXML() [84/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Time  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115480 of file autoarts.h.

◆ ReadXML() [85/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Timer  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115439 of file autoarts.h.

◆ ReadXML() [86/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::TransmissionMatrix  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115562 of file autoarts.h.

◆ ReadXML() [87/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115603 of file autoarts.h.

◆ ReadXML() [88/88]

MRecord ARTS::AgendaMethod::ReadXML ( [[maybe_unused] ] Workspace ws,
Var::Verbosity  out,
const Var::String filename = {} 
)
inline

Reads a workspace variable from an XML file.

This method can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml. If the given filename does not exist, this method will also look for files with an added .xml, .xml.gz and .gz extension

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to be read.
[in]filename- Name of the XML file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115644 of file autoarts.h.

◆ ReadXMLIndexed() [1/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::AbsorptionLines  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115687 of file autoarts.h.

◆ ReadXMLIndexed() [2/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Agenda  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115736 of file autoarts.h.

◆ ReadXMLIndexed() [3/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAbsorptionLines  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115785 of file autoarts.h.

◆ ReadXMLIndexed() [4/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAgenda  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115883 of file autoarts.h.

◆ ReadXMLIndexed() [5/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfAbsorptionLines  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115834 of file autoarts.h.

◆ ReadXMLIndexed() [6/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField1  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115932 of file autoarts.h.

◆ ReadXMLIndexed() [7/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField2  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 115981 of file autoarts.h.

◆ ReadXMLIndexed() [8/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField3  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116030 of file autoarts.h.

◆ ReadXMLIndexed() [9/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfIndex  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116079 of file autoarts.h.

◆ ReadXMLIndexed() [10/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfMatrix  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116128 of file autoarts.h.

◆ ReadXMLIndexed() [11/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfPropagationMatrix  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116226 of file autoarts.h.

◆ ReadXMLIndexed() [12/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfRadiationVector  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116275 of file autoarts.h.

◆ ReadXMLIndexed() [13/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfScatteringMetaData  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116324 of file autoarts.h.

◆ ReadXMLIndexed() [14/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSingleScatteringData  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116373 of file autoarts.h.

◆ ReadXMLIndexed() [15/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSpeciesTag  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116422 of file autoarts.h.

◆ ReadXMLIndexed() [16/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfStokesVector  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116471 of file autoarts.h.

◆ ReadXMLIndexed() [17/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfString  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116520 of file autoarts.h.

◆ ReadXMLIndexed() [18/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor3  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116569 of file autoarts.h.

◆ ReadXMLIndexed() [19/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor6  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116618 of file autoarts.h.

◆ ReadXMLIndexed() [20/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTime  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116667 of file autoarts.h.

◆ ReadXMLIndexed() [21/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTransmissionMatrix  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116716 of file autoarts.h.

◆ ReadXMLIndexed() [22/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfVector  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116765 of file autoarts.h.

◆ ReadXMLIndexed() [23/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfCIARecord  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116814 of file autoarts.h.

◆ ReadXMLIndexed() [24/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField1  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116863 of file autoarts.h.

◆ ReadXMLIndexed() [25/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField2  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116912 of file autoarts.h.

◆ ReadXMLIndexed() [26/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField3  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116961 of file autoarts.h.

◆ ReadXMLIndexed() [27/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField4  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117010 of file autoarts.h.

◆ ReadXMLIndexed() [28/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfIndex  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117059 of file autoarts.h.

◆ ReadXMLIndexed() [29/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfMatrix  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117108 of file autoarts.h.

◆ ReadXMLIndexed() [30/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPpath  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 116177 of file autoarts.h.

◆ ReadXMLIndexed() [31/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPropagationMatrix  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117157 of file autoarts.h.

◆ ReadXMLIndexed() [32/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfQuantumIdentifier  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117206 of file autoarts.h.

◆ ReadXMLIndexed() [33/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRadiationVector  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117255 of file autoarts.h.

◆ ReadXMLIndexed() [34/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRetrievalQuantity  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117304 of file autoarts.h.

◆ ReadXMLIndexed() [35/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfScatteringMetaData  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117353 of file autoarts.h.

◆ ReadXMLIndexed() [36/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSingleScatteringData  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117402 of file autoarts.h.

◆ ReadXMLIndexed() [37/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSparse  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117451 of file autoarts.h.

◆ ReadXMLIndexed() [38/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfStokesVector  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117500 of file autoarts.h.

◆ ReadXMLIndexed() [39/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117549 of file autoarts.h.

◆ ReadXMLIndexed() [40/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTelsemAtlas  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117598 of file autoarts.h.

◆ ReadXMLIndexed() [41/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor3  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117647 of file autoarts.h.

◆ ReadXMLIndexed() [42/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor4  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117696 of file autoarts.h.

◆ ReadXMLIndexed() [43/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor5  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117745 of file autoarts.h.

◆ ReadXMLIndexed() [44/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor6  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117794 of file autoarts.h.

◆ ReadXMLIndexed() [45/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor7  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117843 of file autoarts.h.

◆ ReadXMLIndexed() [46/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTime  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117892 of file autoarts.h.

◆ ReadXMLIndexed() [47/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTransmissionMatrix  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117941 of file autoarts.h.

◆ ReadXMLIndexed() [48/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfVector  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 117990 of file autoarts.h.

◆ ReadXMLIndexed() [49/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfXsecRecord  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118039 of file autoarts.h.

◆ ReadXMLIndexed() [50/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::CIARecord  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118088 of file autoarts.h.

◆ ReadXMLIndexed() [51/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::CovarianceMatrix  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118137 of file autoarts.h.

◆ ReadXMLIndexed() [52/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::EnergyLevelMap  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118186 of file autoarts.h.

◆ ReadXMLIndexed() [53/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::GasAbsLookup  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118235 of file autoarts.h.

◆ ReadXMLIndexed() [54/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::GriddedField1  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118333 of file autoarts.h.

◆ ReadXMLIndexed() [55/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::GriddedField2  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118382 of file autoarts.h.

◆ ReadXMLIndexed() [56/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::GriddedField3  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118431 of file autoarts.h.

◆ ReadXMLIndexed() [57/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::GriddedField4  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118480 of file autoarts.h.

◆ ReadXMLIndexed() [58/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::GriddedField5  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118529 of file autoarts.h.

◆ ReadXMLIndexed() [59/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::GriddedField6  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118578 of file autoarts.h.

◆ ReadXMLIndexed() [60/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::GridPos  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118284 of file autoarts.h.

◆ ReadXMLIndexed() [61/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::HitranRelaxationMatrixData  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118627 of file autoarts.h.

◆ ReadXMLIndexed() [62/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Index  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118676 of file autoarts.h.

◆ ReadXMLIndexed() [63/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Matrix  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118774 of file autoarts.h.

◆ ReadXMLIndexed() [64/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::MCAntenna  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118725 of file autoarts.h.

◆ ReadXMLIndexed() [65/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Numeric  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118823 of file autoarts.h.

◆ ReadXMLIndexed() [66/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Ppath  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118872 of file autoarts.h.

◆ ReadXMLIndexed() [67/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::PropagationMatrix  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118921 of file autoarts.h.

◆ ReadXMLIndexed() [68/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::QuantumIdentifier  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 118970 of file autoarts.h.

◆ ReadXMLIndexed() [69/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::RadiationVector  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119019 of file autoarts.h.

◆ ReadXMLIndexed() [70/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Rational  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119068 of file autoarts.h.

◆ ReadXMLIndexed() [71/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::ScatteringMetaData  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119117 of file autoarts.h.

◆ ReadXMLIndexed() [72/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::SingleScatteringData  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119166 of file autoarts.h.

◆ ReadXMLIndexed() [73/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Sparse  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119215 of file autoarts.h.

◆ ReadXMLIndexed() [74/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::SpeciesAuxData  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119264 of file autoarts.h.

◆ ReadXMLIndexed() [75/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::StokesVector  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119313 of file autoarts.h.

◆ ReadXMLIndexed() [76/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::String  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119362 of file autoarts.h.

◆ ReadXMLIndexed() [77/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::TelsemAtlas  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119411 of file autoarts.h.

◆ ReadXMLIndexed() [78/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119460 of file autoarts.h.

◆ ReadXMLIndexed() [79/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119509 of file autoarts.h.

◆ ReadXMLIndexed() [80/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Tensor5  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119558 of file autoarts.h.

◆ ReadXMLIndexed() [81/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Tensor6  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119607 of file autoarts.h.

◆ ReadXMLIndexed() [82/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Tensor7  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119656 of file autoarts.h.

◆ ReadXMLIndexed() [83/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::TessemNN  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119803 of file autoarts.h.

◆ ReadXMLIndexed() [84/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Time  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119754 of file autoarts.h.

◆ ReadXMLIndexed() [85/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Timer  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119705 of file autoarts.h.

◆ ReadXMLIndexed() [86/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::TransmissionMatrix  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119852 of file autoarts.h.

◆ ReadXMLIndexed() [87/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119901 of file autoarts.h.

◆ ReadXMLIndexed() [88/88]

MRecord ARTS::AgendaMethod::ReadXMLIndexed ( [[maybe_unused] ] Workspace ws,
Var::Verbosity  out,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As ReadXML, but reads indexed file names.

The variable is read from a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for ReadXML.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Workspace variable to be read.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 119950 of file autoarts.h.

◆ Reduce() [1/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Matrix  o,
const Var::Tensor3  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120547 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Tensor3::pos().

◆ Reduce() [2/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Matrix  o,
const Var::Tensor4  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120589 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Tensor4::pos().

◆ Reduce() [3/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Matrix  o,
const Var::Tensor5  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120631 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Tensor5::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Tensor5::pos().

◆ Reduce() [4/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Matrix  o,
const Var::Tensor6  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120673 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Tensor6::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Tensor6::pos().

◆ Reduce() [5/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Matrix  o,
const Var::Tensor7  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120715 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Tensor7::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Tensor7::pos().

◆ Reduce() [6/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Numeric  o,
const Var::Matrix  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120043 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Numeric::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Numeric::pos().

◆ Reduce() [7/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Numeric  o,
const Var::Tensor3  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120085 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor3::pos().

◆ Reduce() [8/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Numeric  o,
const Var::Tensor4  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120127 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor4::pos().

◆ Reduce() [9/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Numeric  o,
const Var::Tensor5  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120169 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor5::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor5::pos().

◆ Reduce() [10/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Numeric  o,
const Var::Tensor6  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120211 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor6::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor6::pos().

◆ Reduce() [11/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Numeric  o,
const Var::Tensor7  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120253 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor7::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor7::pos().

◆ Reduce() [12/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Numeric  o,
const Var::Vector  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120001 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Vector::pos().

◆ Reduce() [13/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  o,
const Var::Tensor4  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120757 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::Tensor3::pos(), and ARTS::Var::Tensor4::pos().

◆ Reduce() [14/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  o,
const Var::Tensor5  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120799 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), ARTS::Var::Tensor5::islast(), ARTS::Var::Tensor3::pos(), and ARTS::Var::Tensor5::pos().

◆ Reduce() [15/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  o,
const Var::Tensor6  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120841 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), ARTS::Var::Tensor6::islast(), ARTS::Var::Tensor3::pos(), and ARTS::Var::Tensor6::pos().

◆ Reduce() [16/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  o,
const Var::Tensor7  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120883 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), ARTS::Var::Tensor7::islast(), ARTS::Var::Tensor3::pos(), and ARTS::Var::Tensor7::pos().

◆ Reduce() [17/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  o,
const Var::Tensor5  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120925 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), ARTS::Var::Tensor5::islast(), ARTS::Var::Tensor4::pos(), and ARTS::Var::Tensor5::pos().

◆ Reduce() [18/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  o,
const Var::Tensor6  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120967 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), ARTS::Var::Tensor6::islast(), ARTS::Var::Tensor4::pos(), and ARTS::Var::Tensor6::pos().

◆ Reduce() [19/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  o,
const Var::Tensor7  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121009 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), ARTS::Var::Tensor7::islast(), ARTS::Var::Tensor4::pos(), and ARTS::Var::Tensor7::pos().

◆ Reduce() [20/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Tensor5  o,
const Var::Tensor6  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121051 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), ARTS::Var::Tensor6::islast(), ARTS::Var::Tensor5::pos(), and ARTS::Var::Tensor6::pos().

◆ Reduce() [21/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Tensor5  o,
const Var::Tensor7  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121093 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), ARTS::Var::Tensor7::islast(), ARTS::Var::Tensor5::pos(), and ARTS::Var::Tensor7::pos().

◆ Reduce() [22/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Tensor6  o,
const Var::Tensor7  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121135 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), ARTS::Var::Tensor7::islast(), ARTS::Var::Tensor6::pos(), and ARTS::Var::Tensor7::pos().

◆ Reduce() [23/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Vector  o,
const Var::Matrix  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120295 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ Reduce() [24/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Vector  o,
const Var::Tensor3  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120337 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Tensor3::pos(), and ARTS::Var::Vector::pos().

◆ Reduce() [25/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Vector  o,
const Var::Tensor4  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120379 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Tensor4::pos(), and ARTS::Var::Vector::pos().

◆ Reduce() [26/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Vector  o,
const Var::Tensor5  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120421 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Tensor5::pos(), and ARTS::Var::Vector::pos().

◆ Reduce() [27/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Vector  o,
const Var::Tensor6  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120463 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Tensor6::pos(), and ARTS::Var::Vector::pos().

◆ Reduce() [28/28]

MRecord ARTS::AgendaMethod::Reduce ( [[maybe_unused] ] Workspace ws,
Var::Vector  o,
const Var::Tensor7  i 
)
inline

Reduces a larger class to a smaller class of same size.

The Reduce command reduces all "1"-dimensions to nil. Examples: 1) 1 Vector can be reduced to a Numeric 2) 2x1 Matrix can be reduced to 2 Vector 3) 1x3x1 Tensor3 can be reduced to 3 Vector 4) 1x1x1x1 Tensor4 can be reduced to a Numeric 5) 3x1x4x1x5 Tensor5 can only be reduced to 3x4x5 Tensor3 6) 1x1x1x1x2x3 Tensor6 can be reduced to 2x3 Matrix 7) 2x3x4x5x6x7x1 Tensor7 can be reduced to 2x3x4x5x6x7 Tensor6 And so on

Author
Oliver Lemke
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]o- Reduced form of input.
[in]i- Over-dimensioned input

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 120505 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Tensor7::pos(), and ARTS::Var::Vector::pos().

◆ refellipsoidEarth()

MRecord ARTS::AgendaMethod::refellipsoidEarth ( [[maybe_unused] ] Workspace ws,
const Var::String model = {} 
)
inline

Earth reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model the Earth, following different models. The options are:

"Sphere" : A spherical Earth. The radius is set following the value set for the Earth radius in constants.cc.

"WGS84" : The reference ellipsoid used by the GPS system. Should be the standard choice for a non-spherical Earth.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]model- Model ellipsoid to use. Options listed above. (default: "Sphere")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121174 of file autoarts.h.

◆ refellipsoidEuropa()

MRecord ARTS::AgendaMethod::refellipsoidEuropa ( [[maybe_unused] ] Workspace ws,
const Var::String model = {} 
)
inline

Io reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Io, folowing different models. The options are:

"Sphere" : A spherical planetesimal. The radius is taken from report of the IAU/IAG Working Group.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]model- Model ellipsoid to use. Options listed above. (default: "Sphere")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121282 of file autoarts.h.

◆ refellipsoidForAzimuth()

MRecord ARTS::AgendaMethod::refellipsoidForAzimuth ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  latitude,
const Var::Numeric  azimuth 
)
inline

Conversion of 3D ellipsoid to 1D curvature radius.

Calculates the curvature radius for the given latitude and azimuth angle, and uses this to set a spherical reference ellipsoid suitable for 1D calculations. The curvature radius is a better local approximation than using the local ellipsoid radius.

The used expression assumes a geodetic latitude, but also latitudes should be OK as using this method anyhow signifies an approximation.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]latitude- Latitude.
[in]azimuth- Azimuth angle.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121246 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ refellipsoidGanymede()

MRecord ARTS::AgendaMethod::refellipsoidGanymede ( [[maybe_unused] ] Workspace ws,
const Var::String model = {} 
)
inline

Ganymede reference ellipsoids.

From Wikipedia

Author
Takayoshi Yamada
Parameters
[in,out]Workspacews - An ARTS workspace
[in]model- Model ellipsoid to use. Options listed above. (default: "Sphere")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121206 of file autoarts.h.

◆ refellipsoidIo()

MRecord ARTS::AgendaMethod::refellipsoidIo ( [[maybe_unused] ] Workspace ws,
const Var::String model = {} 
)
inline

Io reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Io, folowing different models. The options are:

"Sphere" : A spherical planetesimal. The radius is taken from report of the IAU/IAG Working Group.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]model- Model ellipsoid to use. Options listed above. (default: "Sphere")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121318 of file autoarts.h.

◆ refellipsoidJupiter()

MRecord ARTS::AgendaMethod::refellipsoidJupiter ( [[maybe_unused] ] Workspace ws,
const Var::String model = {} 
)
inline

Jupiter reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Jupiter, folowing different models. The options are:

"Sphere" : A spherical planet. The radius is taken from a report of the IAU/IAG Working Group.

"Ellipsoid" : A reference ellipsoid with parameters taken from a report of the IAU/IAG Working Group.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]model- Model ellipsoid to use. Options listed above. (default: "Sphere")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121357 of file autoarts.h.

◆ refellipsoidMars()

MRecord ARTS::AgendaMethod::refellipsoidMars ( [[maybe_unused] ] Workspace ws,
const Var::String model = {} 
)
inline

Mars reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Mars, folowing different models. The options are:

"Sphere" : A spherical planet. The radius is taken from a report of the IAU/IAG Working Group.

"Ellipsoid" : A reference ellipsoid with parameters taken from a report of the IAU/IAG Working Group.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]model- Model ellipsoid to use. Options listed above. (default: "Sphere")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121396 of file autoarts.h.

◆ refellipsoidMoon()

MRecord ARTS::AgendaMethod::refellipsoidMoon ( [[maybe_unused] ] Workspace ws,
const Var::String model = {} 
)
inline

Moon reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Moon, folowing different models. The options are:

"Sphere" : A spherical planet. The radius is taken from a report of the IAU/IAG Working Group.

"Ellipsoid" : A reference ellipsoid with parameters taken from Wikepedia (see code for details). The IAU/IAG working group defines the Moon ellipsoid to be a sphere.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]model- Model ellipsoid to use. Options listed above. (default: "Sphere")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121436 of file autoarts.h.

◆ refellipsoidOrbitPlane()

MRecord ARTS::AgendaMethod::refellipsoidOrbitPlane ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  orbitinc 
)
inline

Conversion of 3D ellipsoid to 2D orbit track geometry.

Determines an approximate reference ellipsoid following an orbit track. The new ellipsoid is determined simply, by determining the radius at the maximum latitude and from this value calculate a new new eccentricity. The orbit is specified by giving the orbit inclination (orbitinc), that is normally a value around 100 deg for polar sun-synchronous orbits.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]orbitinc- Orbit inclination.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121473 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ refellipsoidSet()

MRecord ARTS::AgendaMethod::refellipsoidSet ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  re,
const Var::Numeric e = {} 
)
inline

Manual setting of the reference ellipsoid.

The two values of refellipsoid can here be set manually. The two arguments correspond directly to first and second element of refellipsoid*.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]re- Average or equatorial radius.
[in]e- Eccentricity (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121505 of file autoarts.h.

◆ refellipsoidVenus()

MRecord ARTS::AgendaMethod::refellipsoidVenus ( [[maybe_unused] ] Workspace ws,
const Var::String model = {} 
)
inline

Venus reference ellipsoids.

The reference ellipsoid (refellipsoid) is set to model Venus, folowing different models. The options are:

"Sphere" : A spherical planet. The radius is taken from a report of the IAU/IAG Working Group.

According to the report used above, the Venus ellipsoid lacks eccentricity and no further models should be required.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]model- Model ellipsoid to use. Options listed above. (default: "Sphere")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121547 of file autoarts.h.

◆ refr_index_airFreeElectrons()

MRecord ARTS::AgendaMethod::refr_index_airFreeElectrons ( [[maybe_unused] ] Workspace ws,
const Var::Index demand_vmr_value = {} 
)
inline

Microwave refractive index due to free electrons.

The refractive index of free electrons is added to refr_index_air. To obtain the complete value, refr_index_air should be set to 1 before calling this WSM. This applies also to refr_index_air_group.

The expression applied is n=sqrt(1-wp^2/w^2) where wp is the plasma frequency, and w is the angular frequency (the function returns n-1, that here is slightly negative). This expressions is found in many textbooks, e.g. Rybicki and Lightman (1979). The above refers to refr_index_air. refr_index_air_group is sqrt(1+wp^2/w^2).

The expression is dispersive. The frequency applied is the mean of first and last element of f_grid is selected. This frequency must be at least twice the plasma frequency.

An error is issued if free electrons not are part of abs_species (and there exist a corresponding "vmr"-value). This demand is removed if demand_vmr_value is set to 0, but use this option with care.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]demand_vmr_value- Flag to control if it is demanded that free electrons are in abs_species. Default is that this is demanded. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121596 of file autoarts.h.

◆ refr_index_airInfraredEarth()

MRecord ARTS::AgendaMethod::refr_index_airInfraredEarth ( [[maybe_unused] ] Workspace ws)
inline

Calculates the IR refractive index due to gases in the Earth's atmosphere.

Only refractivity of dry air is considered. The formula used is contributed by Michael Hoepfner, Forschungszentrum Karlsruhe.

The refractivity of dry air is added to refr_index_air. To obtain the complete value, refr_index_air should be set to 1 before calling this WSM. This applies also to refr_index_air_group.

The expression used is non-dispersive. Hence, refr_index_air and refr_index_air_group* are identical.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121636 of file autoarts.h.

◆ refr_index_airMicrowavesEarth()

MRecord ARTS::AgendaMethod::refr_index_airMicrowavesEarth ( [[maybe_unused] ] Workspace ws,
const Var::Numeric k1 = {},
const Var::Numeric k2 = {},
const Var::Numeric k3 = {} 
)
inline

Microwave refractive index in Earth's atmosphere.

This method just considers pressure, temperature and water vapour, which should suffice for Earth. For a more general method, see refr_index_airMicrowavesGeneral.

The refractivity of dry air and water vapour is added to refr_index_air*. To obtain the complete value, refr_index_air should be set to 1 before calling this WSM. This applies also to refr_index_air_group.

The expression used is non-dispersive. Hence, refr_index_air and refr_index_air_group are identical.

The standard expression for Earth and microwaves is used: N = k1*(P-e)/T + k2*e/T + k3*e/T^2 where N is refractivity, P is pressure, T is temperature and e is water vapour partial pressure. The values of k1, k2 and k3 can be modified.

Many different values of k1, k2 and k3 can be found in the literature. The default values applied here are taken from Bevis et al., GPS meteorology: Mapping ..., JAM, 1994. More specifically, these value are found in Table 1, listed as "Present study". Note that in ARTS Pa is used for pressure and k1, k2 and k3 must be adjusted accordingly.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]k1- Coefficient a, see above (default: 77.6e-8)
[in]k2- Coefficient b, see above (default: 70.4e-8)
[in]k3- Coefficient c, see above (default: 3.739e-3)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121685 of file autoarts.h.

◆ refr_index_airMicrowavesGeneral()

MRecord ARTS::AgendaMethod::refr_index_airMicrowavesGeneral ( [[maybe_unused] ] Workspace ws)
inline

Microwave refractive index due to gases in planetary atmospheres.

The refractivity of a specified gas mixture is calculated and added to refr_index_air. To obtain the complete value, refr_index_air should be set to 1 before calling this WSM. This applies also to refr_index_air_group.

The expression used is non-dispersive. Hence, refr_index_air and refr_index_air_group* are identical.

Uses the methodology introduced by Newell&Baird (1965) for calculating refractivity of variable gas mixtures based on refractivity of the individual gases at reference conditions. Assuming ideal gas law for converting reference refractivity to actual pressure and temperature conditions. Reference refractivities are also taken from Newell&Baird (1965) and are vailable for N2, O2, CO2, H2, and He. Additionally, H2O reference refractivity has been derived from H2O contribution in Thayer (see refr_index_airMicrowavesEarth*) for T0=273.15K. Any mixture of these gases can be taken into account.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121744 of file autoarts.h.

◆ retrievalAddAbsSpecies()

MRecord ARTS::AgendaMethod::retrievalAddAbsSpecies ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String  species,
const Var::String unit = {},
const Var::Index for_species_tag = {} 
)
inline

Adds an absorption species to the retrieval quantities.

Similar to jacobianAddAbsSpecies but also sets the corresponding block in covmat_sx* to the matrices provided in covmat_block and covmat_inv_block. The dimensions of covmat_block are required to agree with the dimensions of the retrieval grid.

covmat_inv_block* must be either empty or the same dimension as covmat_block. If provided, this matrix will be used as the inverse for the covariance matrix block and numerical inversion of this block is thus avoided. Note, however, that this is only effective if this block is uncorrelated with any other retrieval quantity.

For number and order of elements added to x, see jacobianAddAbsSpecies.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]species- The species tag of the retrieval quantity.
[in]unit- Retrieval unit. See above. (default: "rel")
[in]for_species_tag- Index-bool for acting on species tags or species. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121808 of file autoarts.h.

◆ retrievalAddCatalogParameter()

MRecord ARTS::AgendaMethod::retrievalAddCatalogParameter ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  catalog_identity,
const Var::String  catalog_parameter,
const Var::Numeric  var 
)
inline

Similar to jacobianAddBasicCatalogParameter but also adds a corresponding block to covmat_sx with the given var as variance value.

For number and order of elements added to x, see jacobianAddBasicCatalogParameter.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]catalog_identity- The catalog line matching information.
[in]catalog_parameter- The catalog parameter of the retrieval quantity.
[in]var- The variance of the catalog parameter.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121966 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), ARTS::Var::String::islast(), ARTS::Var::QuantumIdentifier::pos(), ARTS::Var::String::pos(), and linalg::var().

◆ retrievalAddCatalogParameters()

MRecord ARTS::AgendaMethod::retrievalAddCatalogParameters ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  catalog_identities,
const Var::ArrayOfString  catalog_parameters 
)
inline

Same as jacobianAddBasicCatalogParameters but also adds a new block to covmat_sx using the matrices in covmat_block and covmat_inv_block*.

If covmat_inv_block is non-empty, it is used as inverse for the added block which avoids its numerical computation.

For number and order of elements added to x, see jacobianAddBasicCatalogParameters.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]catalog_identities- The catalog line matching informations.
[in]catalog_parameters- The catalog parameters of the retrieval quantity.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122008 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), ARTS::Var::ArrayOfString::islast(), ARTS::Var::ArrayOfQuantumIdentifier::pos(), and ARTS::Var::ArrayOfString::pos().

◆ retrievalAddFreqShift()

MRecord ARTS::AgendaMethod::retrievalAddFreqShift ( [[maybe_unused] ] Workspace ws,
const Var::Numeric df = {} 
)
inline

Same as jacobianAddFreqShift but also adds the correlation block contained in covmat_block and covmat_inv_block to covmat_sx.

For number and order of elements added to x, see jacobianAddFreqShift.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]df- Size of perturbation to apply. (default: 100e3)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121859 of file autoarts.h.

◆ retrievalAddFreqStretch()

MRecord ARTS::AgendaMethod::retrievalAddFreqStretch ( [[maybe_unused] ] Workspace ws,
const Var::Numeric df = {} 
)
inline

Same as jacobianAddFreqShift but also adds the correlation block contained in covmat_block and covmat_inv_block to covmat_sx.

For number and order of elements added to x, see jacobianAddFreqStretch.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]df- Size of perturbation to apply. (default: 100e3)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121892 of file autoarts.h.

◆ retrievalAddMagField()

MRecord ARTS::AgendaMethod::retrievalAddMagField ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String component = {},
const Var::Numeric dB = {} 
)
inline

Same as jacobianAddMagField but also adds a new block to covmat_sx using the matrices in covmat_block and covmat_inv_block.

If covmat_inv_block is non-empty, it is used as inverse for the added block which avoids its numerical computation.

For number and order of elements added to x, see jacobianAddMagField.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]component- Magnetic field component to retrieve (default: "v")
[in]dB- Magnetic field perturbation (default: 1.0e-7)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122048 of file autoarts.h.

◆ retrievalAddPointingZa()

MRecord ARTS::AgendaMethod::retrievalAddPointingZa ( [[maybe_unused] ] Workspace ws,
const Var::Index poly_order = {},
const Var::String calcmode = {},
const Var::Numeric dza = {} 
)
inline

Same as jacobianAddPointingZa but also adds a new block to covmat_sx using the matrices in covmat_block and covmat_inv_block.

If covmat_inv_block is non-empty, it is used as inverse for the added block which avoids its numerical computation.

For number and order of elements added to x, see jacobianAddPointingZa.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]poly_order- Order of polynomial to describe the time variation of pointing off-sets. (default: 0)
[in]calcmode- Calculation method. See above (default: "recalc")
[in]dza- Size of perturbation to apply (when applicable). (default: 0.01)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122101 of file autoarts.h.

◆ retrievalAddPolyfit()

MRecord ARTS::AgendaMethod::retrievalAddPolyfit ( [[maybe_unused] ] Workspace ws,
const Var::Index  poly_order,
const Var::Index no_pol_variation = {},
const Var::Index no_los_variation = {},
const Var::Index no_mblock_variation = {} 
)
inline

Same as jacobianAddPolyfit but also adds a new block to covmat_sx using the matrices in covmat_block and covmat_inv_block.

If covmat_inv_block is non-empty, it is used as inverse for the added block which avoids its numerical computation.

For number and order of elements added to x, see jacobianAddPolyfit.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]poly_order- Polynomial order to use for the fit.
[in]no_pol_variation- Set to 1 if the baseline off-set is the same for all Stokes components. (default: 0)
[in]no_los_variation- Set to 1 if the baseline off-set is the same for all line-of-sights (inside each measurement block). (default: 0)
[in]no_mblock_variation- Set to 1 if the baseline off-set is the same for all measurement blocks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122152 of file autoarts.h.

◆ retrievalAddScatSpecies()

MRecord ARTS::AgendaMethod::retrievalAddScatSpecies ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String  species,
const Var::String  quantity 
)
inline

Same as jacobianAddPolyfit but also adds a new block to covmat_sx using the matrices in covmat_block and covmat_inv_block.

If covmat_inv_block is non-empty, it is used as inverse for the added block which avoids its numerical computation.

For number and order of elements added to x, see jacobianAddScatSpecies.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]species- Name of scattering species, must match one element in scat_species.
[in]quantity- Retrieval quantity, e.g. "IWC".

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122207 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ retrievalAddSinefit()

MRecord ARTS::AgendaMethod::retrievalAddSinefit ( [[maybe_unused] ] Workspace ws,
const Var::Vector  period_lengths,
const Var::Index no_pol_variation = {},
const Var::Index no_los_variation = {},
const Var::Index no_mblock_variation = {} 
)
inline

Same as jacobianAddSinefit but also adds a new block to covmat_sx using the matrices in covmat_block and covmat_inv_block.

If covmat_inv_block is non-empty, it is used as inverse for the added block which avoids its numerical computation.

For number and order of elements added to x, see jacobianAddSinefit.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]period_lengths- Period lengths of the fit.
[in]no_pol_variation- Set to 1 if the baseline off-set is the same for all Stokes components. (default: 0)
[in]no_los_variation- Set to 1 if the baseline off-set is the same for all line-of-sights (inside each measurement block). (default: 0)
[in]no_mblock_variation- Set to 1 if the baseline off-set is the same for all measurement blocks. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122255 of file autoarts.h.

◆ retrievalAddSpecialSpecies()

MRecord ARTS::AgendaMethod::retrievalAddSpecialSpecies ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String  species 
)
inline

Same as jacobianAddSpecialSpecies but also adds a new block to covmat_sx using the matrices in covmat_block and covmat_inv_block.

If covmat_inv_block is non-empty, it is used as inverse for the added block which avoids its numerical computation.

For number and order of elements added to x, see jacobianAddSpecialSpecies.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]species- The species of the retrieval quantity.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122309 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ retrievalAddSurfaceQuantity()

MRecord ARTS::AgendaMethod::retrievalAddSurfaceQuantity ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::String  quantity 
)
inline

Same as jacobianAddSurfaceQuantity but also adds a new block to covmat_sx using the matrices in covmat_block and covmat_inv_block.

If covmat_inv_block is non-empty, it is used as inverse for the added block which avoids its numerical computation.

For number and order of elements added to x, see jacobianAddSurfaceQuantity.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Latitude retrieval grid.
[in]g2- Longitude retreival grid.
[in]quantity- Retrieval quantity, e.g. "Wind speed".

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122353 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ retrievalAddTemperature()

MRecord ARTS::AgendaMethod::retrievalAddTemperature ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String hse = {} 
)
inline

Same as jacobianAddTemperature but also adds a new block to covmat_sx using the matrices in covmat_block and covmat_inv_block.

If covmat_inv_block is non-empty, it is used as inverse for the added block which avoids its numerical computation.

For number and order of elements added to x, see jacobianAddTemperature.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retreival grid.
[in]hse- Flag to assume HSE or not ("on" or "off"). (default: "on")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122395 of file autoarts.h.

◆ retrievalAddWind()

MRecord ARTS::AgendaMethod::retrievalAddWind ( [[maybe_unused] ] Workspace ws,
const Var::Vector  g1,
const Var::Vector  g2,
const Var::Vector  g3,
const Var::String component = {},
const Var::Numeric dfrequency = {} 
)
inline

Same as jacobianAddWind but also adds a new block to covmat_sx using the matrices in covmat_block and covmat_inv_block.

If covmat_inv_block is non-empty, it is used as inverse for the added block which avoids its numerical computation.

For number and order of elements added to x, see jacobianAddWind.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]g1- Pressure retrieval grid.
[in]g2- Latitude retrieval grid.
[in]g3- Longitude retrieval grid.
[in]component- Wind component to retrieve (default: "v")
[in]dfrequency- This is the frequency perturbation (default: 0.1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122444 of file autoarts.h.

◆ retrievalDefClose()

MRecord ARTS::AgendaMethod::retrievalDefClose ( [[maybe_unused] ] Workspace ws)
inline

Closes the definition of retrieval quantities and correlations and prepares related WSVs for the retrieval.

This function calls jacobianClose and checks that the corvariance matrices are consistent with the Jacobian.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121769 of file autoarts.h.

◆ retrievalDefInit()

MRecord ARTS::AgendaMethod::retrievalDefInit ( [[maybe_unused] ] Workspace ws,
const Var::Index initialize_jacobian = {} 
)
inline

Begin retrieval definition section.

This function initialises all variables required for defining retrieval quantities and corresponding covariance matrices. By default, Jacobian quantities should be added withing the. retrieval definition section. If Jacobian quantities are defined separately initialize_jacobian must be set to 0, otherwise the quantities will be discarded.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]initialize_jacobian- Flag whether or not to (re)initialize Jacobian-related quantities. Set to 0 if Jacobian is already defined. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 121930 of file autoarts.h.

◆ retrievalErrorsExtract()

MRecord ARTS::AgendaMethod::retrievalErrorsExtract ( [[maybe_unused] ] Workspace ws)
inline

Extract retrieval error from covariance matrices.

Extracts the error estimates for the retrieved quantities from the covariance matrices for the error due to measurement noise covmat_so and the error due to limited resolution of the observation system covmat_ss and stores them in the vectors retrieval_eo and retrieval_ss, respectively. To etract these errors, first the convariance matrices of which the errors should be extracted have to be computed using the WSMs covmat_soCalc and covmat_ssCalc or set to be empty in order to be ignored. Note, however, that this will also set the corresponding error vector to be empty.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122497 of file autoarts.h.

◆ RT4Calc()

MRecord ARTS::AgendaMethod::RT4Calc ( [[maybe_unused] ] Workspace ws,
const Var::Index nstreams = {},
const Var::String pfct_method = {},
const Var::String quad_type = {},
const Var::Index add_straight_angles = {},
const Var::Index pfct_aa_grid_size = {},
const Var::Index auto_inc_nstreams = {},
const Var::Index robust = {},
const Var::Index za_interp_order = {},
const Var::Index cos_za_interp = {},
const Var::Numeric max_delta_tau = {} 
)
inline

Interface to the PolRadTran RT4 scattering solver (by F. Evans).

RT4 provides the radiation field (cloudbox_field) from a vector 1D scattering solution assuming a plane-parallel atmosphere (flat Earth). It calculates up to two Stokes parameters (stokes_dim<=2), i.e., all azimuthally randomly oriented particles are allowed (this also includes macroscopically isotropic particles). Refraction is not taken into account.

The scattering solution is internally obtained over the full (plane-parallel) atmosphere, i.e. not confined to the cloudbox. However, the radiation field output is limited to the cloudbox. This allows to consider clearsky RT through a non-spherical atmosphere outside the cloudbox improving the RT solution for non-plane-parallel media compared to the plain RT4 output.

nstreams* is the number of polar angles taken into account internally in the scattering solution. That is, nstreams determines the angular resolution, hence the accuracy, of the scattering solution. The more anisotropic the bulk scattering matrix, the more streams are required. The computational burden increases approximately with the third power of nstreams. The default value (nstreams=16) was found to be sufficient for most microwave scattering calculations. It is likely insufficient for IR calculations involving ice clouds, though.

Here, za_grid is NOT an input parameter, but output, and its size equals nstreams or nstreams+2 (Gauss-Legendre and Double Gauss quadratures in case add_straight_angles=1) (the reason is that the computational burden is high for additional angles, regardless whether they are quadrature angles or not; hence the quadrature angles supplemented with 0 and 180deg are considered to provide the best radiation field for a given effort).

The auto_inc_nstreams feature can be used to increase the number of streams used internally in the scattering solution when found necessary. NOTE: this number-of-streams increase is only internally - the angular dimension of the output cloudbox_field is fixed to the nstreams* given as input to this WSM.

Quadrature methods available are: 'L'obatto, 'G'auss-Legendre and 'D'ouble Gauss quadrature.

This WSM applies surface_rtprop_agenda to derive reflection matrix and surface emission vector that are directly feed into RT4's core solver (instead of their RT4-internal calculation as used by RT4CalcWithRT4Surface).

Known issues of ARTS implementation:

  • TOA incoming radiation is so far assumed as blackbody cosmic background (temperature taken from the ARTS-internal constant).

The keyword pfct_method allows to choose the method to extract the scattering matrix. 'interpolate' considers temperature dependence, others neglect it by chosing one specific temperature grid point from the single scattering data: 'low' choses the lowest T-point, 'high' the highest T-point, and 'median' the median T-point. As different scattering elements can have different temperature grids, the actual temperature value used can differ between the scattering elements. Note that this keyword solely affects the scattering matrix; extinction matrix and absorption vector are always interpolated to the actual temperature.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]nstreams- Number of polar angle directions (streams) in RT4 solution (must be an even number). (default: 16)
[in]pfct_method- Flag which method to apply to derive phase function (for available options see above). (default: "median")
[in]quad_type- Flag which quadrature to apply in RT4 solution (for available options see above). (default: "D")
[in]add_straight_angles- Flag whether to include nadir and zenith as explicit directions (only effective for quad_type G and D). (default: 1)
[in]pfct_aa_grid_size- Number of azimuthal angle grid points to consider in Fourier series decomposition of scattering matrix (only applied for randomly oriented scattering elements) (default: 19)
[in]auto_inc_nstreams- Flag whether to internally increase nstreams (individually per frequency) if norm of (bulk) scattering matrix is not preserved properly. If 0, no adaptation is done. Else auto_inc_nstreams gives the maximum number of streams to increase to. Note that the output cloudbox_field remains with angular dimension of nstreams, only the internal solution is adapted (and then interpolated to the lower-resolution output angular grid). (default: 0)
[in]robust- For auto_inc_nstreams>0, flag whether to not fail even if scattering matrix norm is not preserved when maximum stream number is reached. Internal RT4 calculations is then performed with nstreams=*auto_inc_nstreams*. (default: 0)
[in]za_interp_order- For auto_inc_nstreams>0, polar angle interpolation order for interpolation from internal increased stream to originally requested nstreams-ifield. (default: 1)
[in]cos_za_interp- For auto_inc_nstreams>0, flag whether to do polar angle interpolation in cosine (='mu') space. (default: 0)
[in]max_delta_tau- Maximum optical depth of infinitesimal layer (where single scattering approximation is assumed to apply). (default: 1e-6)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122591 of file autoarts.h.

◆ RT4CalcWithRT4Surface()

MRecord ARTS::AgendaMethod::RT4CalcWithRT4Surface ( [[maybe_unused] ] Workspace ws,
const Var::Index nstreams = {},
const Var::String pfct_method = {},
const Var::String ground_type = {},
const Var::String quad_type = {},
const Var::Index add_straight_angles = {},
const Var::Index pfct_aa_grid_size = {},
const Var::Index auto_inc_nstreams = {},
const Var::Index robust = {},
const Var::Index za_interp_order = {},
const Var::Index cos_za_interp = {},
const Var::Numeric max_delta_tau = {} 
)
inline

As RT4Calc except for using RT4's proprietary surface type handling.

This WSM is only indented for testing purposes.

The following surface type/property methods are available and require the the following input:

  • 'L'ambertian: surface_scalar_reflectivity, surface_skin_t
  • 'F'resnel: surface_complex_refr_index, surface_skin_t
  • 'S'pecular: surface_reflectivity, surface_skin_t 'L' and 'F' use proprietary RT4 methods, 'S' uses RT4's Fresnel methods modified to behave similar to ARTS' surfaceFlatReflectivity*.
Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]nstreams- Number of polar angle directions (streams) in RT4 solution (must be an even number). (default: 16)
[in]pfct_method- Flag which method to apply to derive phase function (for available options see above). (default: "median")
[in]ground_type- Flag which surface type/surface property method to use (for available options see above). (default: "A")
[in]quad_type- Flag which quadrature to apply in RT4 solution (for available options see above). (default: "D")
[in]add_straight_angles- Flag whether to include nadir and zenith as explicit directions (only effective for quad_type G and D). (default: 1)
[in]pfct_aa_grid_size- Number of azimuthal angle grid points to consider in Fourier series decomposition of scattering matrix (only applied for randomly oriented scattering elements) (default: 19)
[in]auto_inc_nstreams- Flag whether to internally increase nstreams (individually per frequency) if norm of (bulk) scattering matrix is not preserved properly. If 0, no adaptation is done. Else auto_inc_nstreams gives the maximum number of streams to increase to. (default: 0)
[in]robust- For auto_inc_nstreams>0, flag whether to not fail even if scattering matrix norm is not preserved when maximum stream number is reached. Internal RT4 calculations is then performed with nstreams=*auto_inc_nstreams*. (default: 0)
[in]za_interp_order- For auto_inc_nstreams>0, polar angle interpolation order for interpolation from internal increased stream to originally requested nstreams-ifield. (default: 1)
[in]cos_za_interp- For auto_inc_nstreams>0, flag whether to do polar angle interpolation in cosine (='mu') space. (default: 0)
[in]max_delta_tau- Maximum optical depth of infinitesimal layer (where single scattering approximation is assumed to apply). (default: 1e-6)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122696 of file autoarts.h.

◆ RT4Test()

MRecord ARTS::AgendaMethod::RT4Test ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out_rad,
const Var::String datapath = {} 
)
inline

RT4 validation test.

Executes test case testc shipped with PolRadTran/RT4 code (but uses data files converted to arts-xml). Output written to (xml-)file.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out_rad- RT4 testc calculation results.
[in]datapath- Folder containing arts-xml converted test case input data. (default: "artscomponents/polradtran/testdata/")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122790 of file autoarts.h.

◆ rte_losGeometricFromRtePosToRtePos2()

MRecord ARTS::AgendaMethod::rte_losGeometricFromRtePosToRtePos2 ( [[maybe_unused] ] Workspace ws)
inline

The geometric line-of-sight between two points.

The method sets rte_los to the line-of-sight, at rte_pos, that matches the geometrical propagation path between rte_pos and rte_pos2.

The standard case should be that rte_pos2 corresponds to a transmitter, and rte_pos to the receiver/sensor.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122829 of file autoarts.h.

◆ rte_losSet()

MRecord ARTS::AgendaMethod::rte_losSet ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  za,
const Var::Numeric  aa 
)
inline

Sets rte_los to the given angles.

The azimuth angle is ignored for 1D and 2D.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]za- Zenith angle of sensor line-of-sight.
[in]aa- Azimuth angle of sensor line-of-sight.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122854 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ rte_pos_losMoveToStartOfPpath()

MRecord ARTS::AgendaMethod::rte_pos_losMoveToStartOfPpath ( [[maybe_unused] ] Workspace ws)
inline

Sets rte_pos and rte_los to values for last point in ppath.

For example, if the propagation path intersects with the surface, this method gives you the position and angle of ppath at the surface.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122925 of file autoarts.h.

◆ rte_posSet()

MRecord ARTS::AgendaMethod::rte_posSet ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  z,
const Var::Numeric  lat,
const Var::Numeric  lon 
)
inline

Sets rte_pos to the given co-ordinates.

The longitude is ignored for 1D and 2D, and the latitude is also ignored for 1D.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]z- Geometrical altitude of sensor position.
[in]lat- Latitude of sensor position.
[in]lon- Longitude of sensor position.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122889 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::lat(), ARTS::Var::lon(), and ARTS::Var::Numeric::pos().

◆ rtp_nlteFromRaw()

MRecord ARTS::AgendaMethod::rtp_nlteFromRaw ( [[maybe_unused] ] Workspace ws,
const Var::Vector  data 
)
inline

Sets NLTE values manually

Touch

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]data- Vibrational data [nlevels]

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122949 of file autoarts.h.

References data.

◆ scat_data_checkedCalc()

MRecord ARTS::AgendaMethod::scat_data_checkedCalc ( [[maybe_unused] ] Workspace ws,
const Var::Numeric dfrel_threshold = {},
const Var::String check_level = {},
const Var::Numeric sca_mat_threshold = {} 
)
inline

Checks dimensions, grids and single scattering properties of all scattering elements in scat_data.

Dimension and grid equirements:

  • The scattering element's f_grid is either identical to f_grid or of dimension 1.
  • In the latter case, the scattering element's f_grid value must not deviate from any of the f_grid values by more than a fraction of dfrel_threshold.
  • The frequency dimension of pha_mat_data, ext_mat_data, and abs_vec_data is either equal to the scattering element's f_grid or 1.
  • The temperature dimension of pha_mat_data, ext_mat_data, and abs_vec_data is either equal to the scattering element's T_grid or 1.
  • The temperature dimension of ext_mat_data, and abs_vec_data is identical.

The single scattering property contents are checked using scat_dataCheck*. For details, see there. The depth of these checks and their rigour can adapted (see description of parameters check_level* and sca_mat_threshold in scat_dataCheck) or can be skipped entirely (setting check_level to 'none'). NOTE: These test shall only be skipped when one is confident that the data is correct, e.g. by having run scat_dataCheck on the set of data before, e.g. in a separate ARTS run.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]dfrel_threshold- Maximum relative frequency deviation between (single entry) scattering element f_grid values and the RT calculation's f_grid. (default: 0.1)
[in]check_level- See check_level in scat_dataCheck. (default: "all")
[in]sca_mat_threshold- See sca_mat_threshold in scat_dataCheck. (default: 5e-2)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123541 of file autoarts.h.

◆ scat_data_monoCalc()

MRecord ARTS::AgendaMethod::scat_data_monoCalc ( [[maybe_unused] ] Workspace ws)
inline

Interpolates scat_data by frequency to give scat_data_mono.

Author
Cory Davis
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123582 of file autoarts.h.

◆ scat_data_monoExtract()

MRecord ARTS::AgendaMethod::scat_data_monoExtract ( [[maybe_unused] ] Workspace ws)
inline

Extracts data at f_index from scat_data to give scat_data_mono.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123603 of file autoarts.h.

◆ scat_data_singleTmatrix()

MRecord ARTS::AgendaMethod::scat_data_singleTmatrix ( [[maybe_unused] ] Workspace ws,
const Var::String  shape,
const Var::Numeric  diameter_volume_equ,
const Var::Numeric  aspect_ratio,
const Var::String  ptype,
const Var::Vector  data_f_grid,
const Var::Vector  data_t_grid,
const Var::Vector  data_za_grid,
const Var::Numeric mass = {},
const Var::Vector data_aa_grid = {},
const Var::Numeric precision = {},
const Var::String cri_source = {},
const Var::Index ndgs = {},
const Var::Index robust = {},
const Var::Index quiet = {} 
)
inline

A basic interface to Mishchenko's T-matrix code linked to ARTS.

The method performs a T-matrix calculation for a single scattering element, i.e. a combination of particle shape, size, aspect ratio and orientation.

Particle shape (shape) has two options: "spheroidal" and "cylindrical"

Particle size (diameter_volume_equ) is given as the equivalent volume sphere diameter. That is, the diameter obtained if all the particle's material is rearranged into a (solid) sphere.

Particle aspect ratio ar (aspect_ratio) is a numeric value, defined according to Mishchenko's definition as ratio of horizontal axis a to vertical (rotational) axis b: ar=a/b. That is, oblates have ar>1, prolates ar<1. Perfect spheres (spheroidals with ar=1) can trigger numerical issues. To avoid these, we internally increase their aspect ratio by 1e-6, i.e. turning perfect spheres into very light oblates.

Particle type (ptype) has two options: "totally_random" and "azimuthally_random" For totally randomly oriented particles, data_aa_grid is not taken into account (but a Vector type container needs to be passed).

For further information on how aspect ratio and the different shapes and orientations are defined, see the documentation of the T-matrix code found http://www.giss.nasa.gov/staff/mmishchenko/t_matrix.html

Regarding ndgs, we refer to the this comment from the documentation: "Parameter controlling the number of division points in computing integrals over the particle surface. For compact particles, the recommended value is 2. For highly aspherical particles larger values (3, 4,...) may be necessary to obtain convergence. The code does not check convergence over this parameter. Therefore, control comparisons of results obtained with different NDGS-values are recommended."

Author
Johan Strandgren
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]shape- Particle shape. Options listed above.
[in]diameter_volume_equ- Particle volume equivalent diameter [m]. See defintion above.
[in]aspect_ratio- Particle aspect ratio.
[in]mass- Particle mass. This information is just included in the meta data, and does not affect the T-matrix calculations. (default: std::numeric_limits<Numeric>::quiet_NaN())
[in]ptype- Particle type/orientation. Options listed above.
[in]data_f_grid- Frequency grid of the scattering data to be calculated.
[in]data_t_grid- Temperature grid of the scattering data to be calculated.
[in]data_za_grid- Zenith angle grid of the scattering data to be calculated.
[in]data_aa_grid- Azimuth angle grid of the scattering data to be calculated. (default: {})
[in]precision- Accuracy of the computations. (default: 0.001)
[in]cri_source- String describing the source of complex_refr_index, for inclusion in meta data. (default: "Set by user, unknown source.")
[in]ndgs- See above. So far only applied for random orientation. (default: 2)
[in]robust- Continue even if individual T-matrix calculations fail. Respective scattering element data will be NAN. (default: 0)
[in]quiet- Suppress print output from tmatrix fortran code. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123427 of file autoarts.h.

◆ scat_dataCalc()

MRecord ARTS::AgendaMethod::scat_dataCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index interp_order = {} 
)
inline

Prepares scat_data for the scattering solver.

Derives single scattering data for the frequencies given by f_grid* by interpolation from scat_data_raw. f_grid should be the actual WSV f_grid or a single-element Vector.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]interp_order- Interpolation order. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123629 of file autoarts.h.

◆ scat_dataCheck()

MRecord ARTS::AgendaMethod::scat_dataCheck ( [[maybe_unused] ] Workspace ws,
const Var::String check_type = {},
const Var::Numeric sca_mat_threshold = {} 
)
inline

Method for checking the validity and consistency of the single scattering properties in scat_data.

It checks that scat_data does not contain any invalid values, that is any NaN elements in K, Z, or a or any negative values in the 'scalar' properties K11, Z11, and a1.

When check_type is 'all', it is furthermore checked that the scattering matrix is properly normalized, that is that the solid sphere integrated scattering matrix (int_Z11), which is supposed to be normalized to the scattering cross section, is sufficiently consistent with the scattering cross section (C_sca) derived from the difference of extinction (K11) and absorption (a1): int_z11 ~ C_sca = K11-a1. Sufficient consistency is defined by the maximum allowed deviation in single scattering albedo, sca_mat_threshold, testing for ( <int_Z11>/<C_sca>-1. ) * ( <C_sca>/<K11> ) <= sca_mat_threshold. The check is skipped if check_type is 'sane'.

Author
Claudia Emde
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]check_type- The level of checks to apply on scat_data ('sane' or 'all'; see above). (default: "all")
[in]sca_mat_threshold- Threshold for allowed albedo deviation (see above). (default: 5e-2)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123678 of file autoarts.h.

◆ scat_dataReduceT()

MRecord ARTS::AgendaMethod::scat_dataReduceT ( [[maybe_unused] ] Workspace ws,
const Var::Index  scat_index,
const Var::Numeric  temperature,
const Var::Index interp_order = {},
const Var::Index phamat_only = {},
const Var::Numeric sca_mat_threshold = {} 
)
inline

Reduces temperature dimension of single scattering to a single entry.

FIXME... Derives single scattering data for the frequencies given by f_grid* by interpolation from scat_data. f_grid should be the actual WSV f_grid or a single-element Vector.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]scat_index- Apply on scat_data from scattering species of this index (0-based).
[in]temperature- Temperature to interpolate scat_data to.
[in]interp_order- Interpolation order. (default: 1)
[in]phamat_only- Flag whether to apply temperture reduction on phase matrix data only (1) or on all single scattering properties (0). (default: 1)
[in]sca_mat_threshold- Threshold for allowed albedo deviation. (default: 5e-2)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123723 of file autoarts.h.

◆ ScatElementsPndAndScatAdd()

MRecord ARTS::AgendaMethod::ScatElementsPndAndScatAdd ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  scat_data_files,
const Var::ArrayOfString  pnd_field_files 
)
inline

Adds single scattering data and particle number density for individual scattering elements.

The methods reads the specified files and appends the obtained data to scat_data and pnd_field_raw. Scattering data is appended to the current last existing scattering species in scat_data.

Author
Claudia Emde, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]scat_data_files- List of names of single scattering data files.
[in]pnd_field_files- List of names of the corresponding pnd_field files.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 122982 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), and ARTS::Var::ArrayOfString::pos().

◆ ScatElementsSelect()

MRecord ARTS::AgendaMethod::ScatElementsSelect ( [[maybe_unused] ] Workspace ws,
const Var::String  species,
const Var::String  sizeparam,
const Var::Numeric sizemin = {},
const Var::Numeric sizemax = {},
const Var::Numeric tolerance = {},
const Var::String delim = {} 
)
inline

Allows to limit considered scattering elements according to size.

Scattering elements of a specified scattering species are removed from scat_data_raw and scat_meta, i.e. removed from further calculations, if their particle size exceeds the specified limits. Specification of the scattering species is done by name matching the scattering species name part of scat_species tag. As size parameter, all size parameters reported by the meta data can be used (see scat_meta_single for offered parameters and their naming).

Author
Daniel Kreyling, Oliver Lemke, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]species- Species on which to apply size selection.
[in]sizeparam- Size parameter to apply for size selection.
[in]sizemin- Minimum size [m] of the scattering elements to consider (default: 0.)
[in]sizemax- Maximum size [m] of the scattering elements to consider (if negative, no max. limitation is applied). (default: -1.)
[in]tolerance- Relative numerical tolerance of size limit values. (default: 1e-6)
[in]delim- Delimiter string of scat_species elements. (default: "-")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123026 of file autoarts.h.

◆ ScatElementsToabs_speciesAdd()

MRecord ARTS::AgendaMethod::ScatElementsToabs_speciesAdd ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  scat_data_files,
const Var::ArrayOfString  pnd_field_files 
)
inline

Appends scattering elements to abs_species including reading single scattering data and corresponding pnd field.

The methods reads the specified single scattering and pnd_field data of individual scattering elements and appends the obtained data to scat_data (appending to its last scattering species) and vmr_field_raw*. Per scattering element, it also appends one instance of species 'particles' to abs_species.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]scat_data_files- List of names of single scattering data files.
[in]pnd_field_files- List of names of the corresponding pnd_field files.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123088 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), and ARTS::Var::ArrayOfString::pos().

◆ ScatSpeciesExtendTemperature()

MRecord ARTS::AgendaMethod::ScatSpeciesExtendTemperature ( [[maybe_unused] ] Workspace ws,
const Var::String species = {},
const Var::String scat_species_delim = {},
const Var::Numeric T_low = {},
const Var::Numeric T_high = {} 
)
inline

Extends valid temperature range of single scattering data.

The method allows to extend the temperature range of given single scattering data by duplicating optical property data at the low and/or high limits of the associated temperature grid. T_low and T_high* specify the temperature grid points that are added. Extension is only performed if T_low is lower and T_high is higher than the original lowest and highest temperatures, respectively, and if the original data contains more than one temperature grid point (i.e., when not assumed constant anyways).

The method is thought, e.g., for atmospheric ice falling into atmospheric layers with temperatures above the melting point of ice, where ambient and particle temperature deviate (as long as frozen the ice temperature remains at the melting point temperature). It is not internally checked, whether the original data includes the melting point. The method can be used in a wider sense. However, it remains in the responsibility of the user to apply the method in a meaningful sense and on meaningful single scattering data.

The temperature extension is applied on all scattering elements of a scattering species. If scat_species is defined, species can be used to select the species on which the extension shall be applied comparing species with the scattering species name part of scat_species. If no species is specified, the method is applied on the current last existing scattering species in scat_data*. Through the latter the method can be applied for cases when scat_species is not defined (e.g. when pnd_field data is created externally instead of from hydrometeor fields

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]species- Scattering species to act on (see WSM description for details). (default: "")
[in]scat_species_delim- Delimiter string of scat_species elements. (default: "-")
[in]T_low- Temperature grid extension point at low temperature limit. (default: -1.)
[in]T_high- Temperature grid extension point at high temperature limit. (default: -1.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123150 of file autoarts.h.

◆ ScatSpeciesInit()

MRecord ARTS::AgendaMethod::ScatSpeciesInit ( [[maybe_unused] ] Workspace ws)
inline

Initializes the scattering species related data variables.

This method initializes the scat_species WSV, the variables that will hold the raw optical properties and the raw particle number distributions of the scattering elements (scat_data_raw and pnd_field_raw*, respectively) as well as the one holding the meta information about the scattering elements (scat_meta).

This method has to be executed before WSM reading/adding to the said variable, e.g. before ScatSpeciesPndAndScatAdd.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123206 of file autoarts.h.

◆ ScatSpeciesMerge()

MRecord ARTS::AgendaMethod::ScatSpeciesMerge ( [[maybe_unused] ] Workspace ws)
inline

Merges single scattering data of all scattering elements into one element of bulk properties.

Before entering the scattering solver, this method prepares the effective bulk single scattering properties of all scattering elements. Done by calculating the particle number density weighted sum of the single scattering properties of all scattering elements per pressure level. Accordingly, pnd_field is resized to [np, np, 1, 1], where np is the number of pressure levels inside the cloudbox. The diagonal elements of the new pnd_field are set to 1, all others to 0. scat_data is resized to np. Each new scattering element represents the weighted sum of all particles at one presssure level.

The method also adapts scat_species and scat_meta such that they remain consistent with pnd_field and can pass cloudbox_checkedCalc*.

The method is suggested to be called directly after pnd_fieldCalcFromParticleBulkProps* (but also after cloudbox_checkedCalc*). Its purpose is to speed up the scattering calculations.

This is an experimental method currently only working for limited cases. All scattering elements must be of the same ptype and must share the same f_grid, za_grid, and aa_grid. That is, the scattering matrix, extinction matrix, and absorption vector of all scattering elements must have the same dimensions. No interpolation (apart from temperature) is performed.

This method can only be used with a 1D atmosphere.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123257 of file autoarts.h.

◆ ScatSpeciesPndAndScatAdd()

MRecord ARTS::AgendaMethod::ScatSpeciesPndAndScatAdd ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  scat_data_files,
const Var::String  pnd_fieldarray_file 
)
inline

Adds single scattering data and particle number densities for one scattering species.

The WSV pnd_field_raw containing particle number densities for all scattering species can be generated outside ARTS, for example by using PyARTS or atmlab. This method reads this data as well as its corresponding single scattering data, which is added as a new scattering species to scat_data. This method needs as input an ArrayOfString holding the filenames of the single scattering data for each scattering element and a file containing the corresponding pnd_field_raw. In contrast to the scattering data, the pnd-fields are stored in a single XML-file containing an ArrayofGriddedField3, i.e. holding the pnd-field data of all scattering elements.

Important note: The order of the filenames for the scattering data files has to correspond to the order of the pnd-fields, stored in the variable pnd_field_raw*.

Author
Claudia Emde, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]scat_data_files- Array of names of files containing the single scattering data.
[in]pnd_fieldarray_file- Name of file holding the corresponding array of pnd_field data.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123298 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), ARTS::Var::String::islast(), ARTS::Var::ArrayOfString::pos(), and ARTS::Var::String::pos().

◆ ScatSpeciesScatAndMetaRead()

MRecord ARTS::AgendaMethod::ScatSpeciesScatAndMetaRead ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  scat_data_files 
)
inline

Reads single scattering data and scattering meta data for one scattering species.

This method takes a string array as input containing the location (path and filename) of the single scattering data. Location of corresponding scattering meta data is derived applying a naming convention: ending '.xml*' is replaced by '.meta.xml' (search for zipped files is done automatically).

All scattering elements read in one call of the method are assigned to one and the same scattering species. That is, reading in data for a bunch of scattering species can be realized by multiple call of this method. Assignment to scattering species is in the order of the calls (i.e., first method call reads data for first scat_species entry, second call for second scat_species entry and so on). Note that no two scattering elements of the same scattering species are allowed to be equal in size*

Important note: The order of the filenames for the single scattering data files has to exactly correspond to the order of the scattering meta data files.

Author
Daniel Kreyling, Oliver Lemke, Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[in]scat_data_files- Array of single scattering data file names.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123348 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), and ARTS::Var::ArrayOfString::pos().

◆ ScatSpeciesSizeMassInfo()

MRecord ARTS::AgendaMethod::ScatSpeciesSizeMassInfo ( [[maybe_unused] ] Workspace ws,
const Var::Index  species_index,
const Var::String  x_unit,
const Var::Numeric x_fit_start = {},
const Var::Numeric x_fit_end = {},
const Var::Index do_only_x = {} 
)
inline

Derives size and mass information for a scattering species. This method assumes that the mass-size relationship can described by scat_species_a and scat_species_b. See documentation of scat_species_a* for details.

The quantity to be used as size descriptor is here denoted as x, and is selected by setting x_unit. The options are: "dveq" : The size grid is set to scat_meta.diameter_volume_equ "dmax" : The size grid is set to scat_meta.diameter_max "area" : The size grid is set to scat_meta.diameter_area_equ_aerodynamical "mass" : The size grid is set to scat_meta.mass This selection determines scat_species_x.

The parameters scat_species_a and scat_species_b are determined by a numeric fit between scat_species_x and corresponding masses in scat_meta*. This fit is performed over sizes inside the range [x_fit_start,x_fit_end]. This range is allowed to be broader than the coverage of scat_species_x. There must be at least two sizes inside [x_fit_start,x_fit_end].

Author
Manfred Brath
Jana Mendrok
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]species_index- Take data from scattering species of this index (0-based) in scat_meta.
[in]x_unit- Unit for size grid, allowed options listed above.
[in]x_fit_start- Smallest size to consider in fit to determine a and b. (default: 0)
[in]x_fit_end- Largest size to consider in fit to determine a and b. (default: 1e9)
[in]do_only_x- A flag to deactivate calculation of a and b, to possibly save some time. The a and b parameters are then set to -1.Default is to calculate a and b. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123795 of file autoarts.h.

◆ Select() [1/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAbsorptionLines  needles,
const Var::ArrayOfAbsorptionLines  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123913 of file autoarts.h.

References ARTS::Var::ArrayOfAbsorptionLines::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfAbsorptionLines::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [2/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAgenda  needles,
const Var::ArrayOfAgenda  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124013 of file autoarts.h.

References ARTS::Var::ArrayOfAgenda::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfAgenda::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [3/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfAbsorptionLines  needles,
const Var::ArrayOfArrayOfAbsorptionLines  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 123963 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfAbsorptionLines::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfAbsorptionLines::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [4/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField1  needles,
const Var::ArrayOfArrayOfGriddedField1  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124063 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField1::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfGriddedField1::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [5/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField2  needles,
const Var::ArrayOfArrayOfGriddedField2  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124113 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField2::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfGriddedField2::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [6/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField3  needles,
const Var::ArrayOfArrayOfGriddedField3  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124163 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField3::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfGriddedField3::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [7/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfIndex  needles,
const Var::ArrayOfArrayOfIndex  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124213 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfIndex::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfIndex::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [8/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfMatrix  needles,
const Var::ArrayOfArrayOfMatrix  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124263 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfMatrix::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfMatrix::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [9/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfPropagationMatrix  needles,
const Var::ArrayOfArrayOfPropagationMatrix  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124363 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfPropagationMatrix::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfPropagationMatrix::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [10/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfRadiationVector  needles,
const Var::ArrayOfArrayOfRadiationVector  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124413 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfRadiationVector::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfRadiationVector::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [11/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfScatteringMetaData  needles,
const Var::ArrayOfArrayOfScatteringMetaData  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124463 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfScatteringMetaData::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfScatteringMetaData::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [12/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSingleScatteringData  needles,
const Var::ArrayOfArrayOfSingleScatteringData  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124513 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSingleScatteringData::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfSingleScatteringData::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [13/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSpeciesTag  needles,
const Var::ArrayOfArrayOfSpeciesTag  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124563 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSpeciesTag::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfSpeciesTag::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [14/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfStokesVector  needles,
const Var::ArrayOfArrayOfStokesVector  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124613 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfStokesVector::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfStokesVector::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [15/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfString  needles,
const Var::ArrayOfArrayOfString  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124663 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfString::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfString::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [16/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor3  needles,
const Var::ArrayOfArrayOfTensor3  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124713 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor3::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfTensor3::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [17/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor6  needles,
const Var::ArrayOfArrayOfTensor6  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124763 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor6::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfTensor6::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [18/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTime  needles,
const Var::ArrayOfArrayOfTime  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124813 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTime::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfTime::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [19/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTransmissionMatrix  needles,
const Var::ArrayOfArrayOfTransmissionMatrix  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124863 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTransmissionMatrix::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfTransmissionMatrix::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [20/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfVector  needles,
const Var::ArrayOfArrayOfVector  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124913 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfVector::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfArrayOfVector::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [21/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfCIARecord  needles,
const Var::ArrayOfCIARecord  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124963 of file autoarts.h.

References ARTS::Var::ArrayOfCIARecord::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfCIARecord::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [22/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField1  needles,
const Var::ArrayOfGriddedField1  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125013 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField1::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfGriddedField1::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [23/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField2  needles,
const Var::ArrayOfGriddedField2  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125063 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField2::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfGriddedField2::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [24/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField3  needles,
const Var::ArrayOfGriddedField3  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125113 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField3::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfGriddedField3::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [25/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField4  needles,
const Var::ArrayOfGriddedField4  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125163 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField4::islast(), ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfGriddedField4::pos(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [26/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfIndex  needles,
const Var::ArrayOfIndex  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125213 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), and ARTS::Var::ArrayOfIndex::pos().

◆ Select() [27/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfMatrix  needles,
const Var::ArrayOfMatrix  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125263 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfMatrix::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfMatrix::pos().

◆ Select() [28/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPpath  needles,
const Var::ArrayOfPpath  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 124313 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfPpath::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfPpath::pos().

◆ Select() [29/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPropagationMatrix  needles,
const Var::ArrayOfPropagationMatrix  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125313 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfPropagationMatrix::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfPropagationMatrix::pos().

◆ Select() [30/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfQuantumIdentifier  needles,
const Var::ArrayOfQuantumIdentifier  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125363 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfQuantumIdentifier::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfQuantumIdentifier::pos().

◆ Select() [31/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRadiationVector  needles,
const Var::ArrayOfRadiationVector  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125413 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfRadiationVector::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfRadiationVector::pos().

◆ Select() [32/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRetrievalQuantity  needles,
const Var::ArrayOfRetrievalQuantity  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125463 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfRetrievalQuantity::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfRetrievalQuantity::pos().

◆ Select() [33/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfScatteringMetaData  needles,
const Var::ArrayOfScatteringMetaData  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125513 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfScatteringMetaData::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfScatteringMetaData::pos().

◆ Select() [34/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSingleScatteringData  needles,
const Var::ArrayOfSingleScatteringData  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125563 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfSingleScatteringData::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfSingleScatteringData::pos().

◆ Select() [35/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSparse  needles,
const Var::ArrayOfSparse  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125613 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfSparse::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfSparse::pos().

◆ Select() [36/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfStokesVector  needles,
const Var::ArrayOfStokesVector  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125663 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfStokesVector::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfStokesVector::pos().

◆ Select() [37/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  needles,
const Var::ArrayOfString  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125713 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfString::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfString::pos().

◆ Select() [38/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTelsemAtlas  needles,
const Var::ArrayOfTelsemAtlas  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125763 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfTelsemAtlas::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfTelsemAtlas::pos().

◆ Select() [39/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor3  needles,
const Var::ArrayOfTensor3  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125813 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfTensor3::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfTensor3::pos().

◆ Select() [40/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor4  needles,
const Var::ArrayOfTensor4  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125863 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfTensor4::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfTensor4::pos().

◆ Select() [41/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor5  needles,
const Var::ArrayOfTensor5  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125913 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfTensor5::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfTensor5::pos().

◆ Select() [42/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor6  needles,
const Var::ArrayOfTensor6  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 125963 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfTensor6::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfTensor6::pos().

◆ Select() [43/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor7  needles,
const Var::ArrayOfTensor7  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126013 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfTensor7::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfTensor7::pos().

◆ Select() [44/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTime  needles,
const Var::ArrayOfTime  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126063 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfTime::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfTime::pos().

◆ Select() [45/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTransmissionMatrix  needles,
const Var::ArrayOfTransmissionMatrix  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126113 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfTransmissionMatrix::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfTransmissionMatrix::pos().

◆ Select() [46/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfVector  needles,
const Var::ArrayOfVector  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126163 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfVector::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfVector::pos().

◆ Select() [47/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfXsecRecord  needles,
const Var::ArrayOfXsecRecord  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126213 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::ArrayOfXsecRecord::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::ArrayOfXsecRecord::pos().

◆ Select() [48/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::Matrix  needles,
const Var::Matrix  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126313 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::Matrix::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::Matrix::pos().

◆ Select() [49/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::Sparse  needles,
const Var::Sparse  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126363 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::Sparse::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::Sparse::pos().

◆ Select() [50/50]

MRecord ARTS::AgendaMethod::Select ( [[maybe_unused] ] Workspace ws,
Var::Vector  needles,
const Var::Vector  haystack,
const Var::ArrayOfIndex  needleindexes 
)
inline

Method to select some elements from one array and copy them to a new array. (Works also for vectors.)

This works also for higher dimensional objects, where the selection is always performed in the first dimension.

If needleindexes is set to [-1], all elements are copied. For example:

Select(y,x,[0,3])

will select the first and fourth row of matrix x and copy them to the output matrix y.

Note that it is even safe to use this method if needles and haystack are the same variable.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]needles- Selected elements. Must have the same variable type as haystack.
[in]haystack- Variable to select from. May be the same variable as needles.
[in]needleindexes- The elements to select (zero based indexing, as always.)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126263 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), ARTS::Var::Vector::islast(), ARTS::Var::ArrayOfIndex::pos(), and ARTS::Var::Vector::pos().

◆ sensor_checkedCalc()

MRecord ARTS::AgendaMethod::sensor_checkedCalc ( [[maybe_unused] ] Workspace ws)
inline

Checks consistency of the sensor variables.

The following WSVs are examined: f_grid, sensor_pos, sensor_los, transmitter_pos*, mblock_dlos_grid, antenna_dim, sensor_response*, sensor_response_f, sensor_response_pol, and sensor_response_dlos.

If any of these variables are changed, then this method shall be called again (no automatic check that this is fulfilled!).

The main tests are that dimensions of sensor variables agree with other settings, e.g., the size of f_grid, atmosphere_dim, stokes_dim, etc.

If any test fails, there is an error. Otherwise, sensor_checked is set to 1.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126410 of file autoarts.h.

◆ sensor_losGeometricFromSensorPosToOtherPositions()

MRecord ARTS::AgendaMethod::sensor_losGeometricFromSensorPosToOtherPositions ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  target_pos 
)
inline

The geometric line-of-sight between pair of points.

The method sets sensor_los to the line-of-sights, that matches the geometrical propagation path from sensor_pos to target_pos. This is done for pair of positions, i.e. the two matrices shall have the same number of rows. The number of columns in target_pos shall be two for 1D and 2D and two for 3D, exactly as for rte_pos2.

See also rte_losGeometricFromRtePosToRtePos2. This method calls that method for each pair of positions, where values in sensor_pos matches rte_pos and values in target_pos matches rte_pos2.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]target_pos- Target position, for each position in sensor_pos.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126467 of file autoarts.h.

References ARTS::Var::Matrix::islast(), and ARTS::Var::Matrix::pos().

◆ sensor_responseAntenna()

MRecord ARTS::AgendaMethod::sensor_responseAntenna ( [[maybe_unused] ] Workspace ws,
const Var::String option_2d = {} 
)
inline

Includes response of the antenna.

The function returns the sensor response matrix after the antenna characteristics have been included.

The function handles "multi-beam" cases where the polarisation coordinate system is the same for all beams.

See antenna_dim, antenna_dlos and antenna_response for details on how to specify the antenna response.

The text below refers to mblock_dlos_grid despite it is not an input to the method. The method instead uses sensor_response_dlos_grid but the values in this WSV are likely coming from mblock_dlos_grid.

One dimensional antenna patterns are handled as other response functions. That is, both antenna response and radiances are treated as piece-wise linear functions, and the pencil beam calculations must cover the full sensor response (i.e. mblock_dlos_grid must be sufficiently broad).

There exist different options for two dimensional (2D) antenna patterns, see below (if 2D, the GIN option_2d must be set, the default results in an error). A normalisation is always applied for 2D antennas (i.e. sensor-norm* is ignored).

"interp_response"For this option, each direction defined by mblock_dlos_grid is considered to represent the same size in terms of solid beam angle, and the antenna pattern is interpolated to these directions. There is no check on how well mblock_dlos_grid covers the antenna response. The response is treated to be zero outside the ranges of its anular grids

"gridded_dlos"This option is more similar to the 1D case. The radiances are treated as a bi-linear function, but the antenna response is treated as step- wise constant function (in contrast to 1D). For this option mblock_dlos_grid* must match a combination of zenith and azimuth grids, and this for a particular order. If the zenith and azimuth grids have 3 and 2 values, respectively, the order shall be: [(za1,aa1); (za2,aa1); (za3,aa1); (za1,aa2); (za2,aa2); (za3,aa2) ] Both these grids must be strictly increasing and as for 1D must cover the antenna response completely.

Author
Patrick Eriksson
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[in]option_2d- Calculation option for 2D antenna cases. See above for details. (default: "-")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126536 of file autoarts.h.

◆ sensor_responseBackend()

MRecord ARTS::AgendaMethod::sensor_responseBackend ( [[maybe_unused] ] Workspace ws)
inline

Includes response of the backend (spectrometer).

The function returns the sensor response matrix after the backend characteristics have been included.

See f_backend, backend_channel_response and sensor_norm for details on how to specify the backend response.

Author
Mattias Ekstrom
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126572 of file autoarts.h.

◆ sensor_responseBackendFrequencySwitching()

MRecord ARTS::AgendaMethod::sensor_responseBackendFrequencySwitching ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  df1,
const Var::Numeric  df2 
)
inline

Frequency switching for a pure SSB reciever.

This function can be used for simulation of frequency switching. That is, when the final spectrum is the difference of two spectra shifted in frequency. The switching is performed by the LO, but for a pure singel sideband reciever this is most easily simulated by instead shifting the backend, as done here.

A strightforward frequency switching is modelled (no folding) The channel positions for the first measurement cycle are f_backend+df1, and for the second f_backend+df2. The first measurement cycle is given the negive weight. That is, the output is the spectrum for cycle2 minus the spectrum for cycle1. Output frequency grids are set to f_backend.

Use sensor_responseFrequencySwitching for double sideband cases.

The method has the same general functionality as, and can replace, sensor_responseBackend*.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]df1- Frequency throw for cycle1.
[in]df2- Frequency throw for cycle2.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126613 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ sensor_responseBeamSwitching()

MRecord ARTS::AgendaMethod::sensor_responseBeamSwitching ( [[maybe_unused] ] Workspace ws,
const Var::Numeric w1 = {},
const Var::Numeric w2 = {} 
)
inline

Simulation of "beam switching".

The measurement procedure is based on taking the difference between two spectra measured in different directions, and the calculation set-up must treat exactly two observation directions.

The returned spectrum is y = w1*y + w2*y2, where y1 and w1 are the spectrum and weight for the first direction, respectively (y2 and (w2 defined correspondingly for the second direction).

Zenith and azimuth angles after beam switching are set to the values of the second direction.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]w1- Weight for values from first viewing direction. (default: -1)
[in]w2- Weight for values from second viewing direction. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126655 of file autoarts.h.

◆ sensor_responseFillFgrid()

MRecord ARTS::AgendaMethod::sensor_responseFillFgrid ( [[maybe_unused] ] Workspace ws,
const Var::Index polyorder = {},
const Var::Index nfill = {} 
)
inline

Polynomial frequency interpolation of spectra.

The sensor response methods treat the spectra to be piece-wise linear functions. This method is a workaround for making methods handling the spectra in a more elaborate way: it generates spectra on a more dense grid by polynomial interpolation. The interpolation is not done explicitly, it is incorporated into sensor_response.

This method should in general increase the calculation accuracy for a given f_grid. However, the selection of (original) grid points becomes more sensitive when using this method. A poor choice of grid points can result in a decreased accuracy, or generation of negative radiances. Test calculations indicated that the error easily can increase with this method close the edge of f_grid, and it could be wise to make f_grid a bit wider than actually necessary to avoid this effect

The method shall be inserted before the antenna stage. That is, this method shall normally be called directly after sensor_responseInit.

Between each neighbouring points of f_grid, this method adds nfill* grid points. The polynomial order of the interpolation is polyorder*.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]polyorder- Polynomial order of interpolation (default: 3)
[in]nfill- Number of points to insert in each gap of f_grid (default: 2)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126714 of file autoarts.h.

◆ sensor_responseFrequencySwitching()

MRecord ARTS::AgendaMethod::sensor_responseFrequencySwitching ( [[maybe_unused] ] Workspace ws)
inline

Simulation of "frequency switching".

A general method for frequency switching. The WSM sensor_responseBackendFrequencySwitching* gives a description of this observation technique, and is also a more straightforward method for pure singel sideband cases.

It is here assume that sensor_responseMultiMixerBackend has been used to calculate the spectrum for two LO positions. This method calculates the difference between these two spectra, where the second spectrum gets weight 1 and the first weight -1 (as in sensor_responseBackendFrequencySwitching*).

Output frequency grids are taken from the second spectrum.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126762 of file autoarts.h.

◆ sensor_responseGenericAMSU()

MRecord ARTS::AgendaMethod::sensor_responseGenericAMSU ( [[maybe_unused] ] Workspace ws,
const Var::Numeric spacing = {} 
)
inline

Simplified sensor setup for an AMSU-type instrument.

This function is derived from 'sensor_responseSimpleAMSU' but is more generalized since the number of passbands in each can be in the range from 1 to 4 - in order to correctly simulate AMSU-A type sensors

This method allows quick and simple definition of AMSU-type sensors. Assumptions:

  1. Pencil beam antenna.
  2. 1-4 Passband/sidebands per channel.
  3. Sideband mode "upper"
  4. The channel response is rectangular.

Under these assumptions the only inputs needed are the LO positions, the offsets from the LO, and the IF bandwidths. They are provided in sensor_description_amsu.

Author
Oscar Isoz
Parameters
[in,out]Workspacews - An ARTS workspace
[in]spacing- Desired grid spacing in Hz. (default: .1e9)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127150 of file autoarts.h.

◆ sensor_responseIF2RF()

MRecord ARTS::AgendaMethod::sensor_responseIF2RF ( [[maybe_unused] ] Workspace ws)
inline

Converts sensor response variables from IF to RF.

The function converts intermediate frequencies (IF) in sensor_response_f* and sensor_response_f_grid to radio frequencies (RF). This conversion is needed if the frequency translation of a mixer is included and the position of backend channels are specified in RF.

A direct frequency conversion is performed. Values are not sorted in any way.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126792 of file autoarts.h.

◆ sensor_responseInit()

MRecord ARTS::AgendaMethod::sensor_responseInit ( [[maybe_unused] ] Workspace ws)
inline

Initialises the variables summarising the sensor response.

This method sets the variables to match monochromatic pencil beam calculations, to be further modified by inclusion of sensor characteristics. Use sensorOff if pure monochromatic pencil beam calculations shall be performed.

The variables are set as follows: sensor_response : Identity matrix, with size matching f_grid, stokes_dim* and mblock_dlos_grid. sensor_response_f : Repeated values of f_grid. sensor_response_pol : Data matching stokes_dim. sensor_response_dlos : Repeated values of mblock_dlos_grid. sensor_response_f_grid : Equal to f_grid. sensor_response_pol_grid: Set to 1:stokes_dim. sensor_response_dlos_grid : Equal to mblock_dlos_grid.

Author
Mattias Ekstrom
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126829 of file autoarts.h.

◆ sensor_responseMetMM()

MRecord ARTS::AgendaMethod::sensor_responseMetMM ( [[maybe_unused] ] Workspace ws,
const Var::Index use_antenna = {},
const Var::Index mirror_dza = {} 
)
inline

Sensor setup for meteorological millimeter instruments.

This method is handy if you are simulating a passband-type instrument, consisting of a few discrete channels.

For flexibility, the Met-MM system is seperated in two calculation steps. To fully use the system, create f_grid (and some associated variables) by f_gridMetMM before calling this method. However, it is possible to use this method with any f_grid, as long as matching f_backend*, channel2fgrid_indexes and channel2fgrid_weights are provided.

Each scan sequence is treated as a measurement block. sensor_pos is set in the standard way. The number of rows in sensor_pos determines the number of scan sequences that will be simulated. On the other hand, sensor_los* is handled in a special way. All zenith angles must be set to 180 deg. For 3D, the given azimuth angles are taken as the direction of scanning, where the azimuth angle is defined with respect to North in standard manner. For example, if the scanning happens to move from SW to NE, the azimuth angle should be set to 45 deg. The angles of the scanning sequence are taken from antenna_dlos. This WSV is here only allowed to have a single column, holding relative zenith angles. For 3D, the azimuth angles in antenna_dlos are hard-coded to zero. As zenith angles in sensor_los are locked to 180 deg, antenna_dlos effectively holds the nadir angles. These angles can be both positive or negative, where the recommended choice is to operate with negative to end up with final zenith angles between 0 and 180 deg.

The method does not support 2D atmospheres (across-track scanning is inconsistent with 2D). For simpler switching between 1D and 3D, the argument mirror_dza is at hand. It can only be used for 3D. If set to true, the zenith angles in antenna_dlos are mapped to also cover the other side of the swath and the simulations will cover both sides of the swath.

Author
Oliver Lemke
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]use_antenna- Flag to enable (1) or disable (0) antenna. (default: 0)
[in]mirror_dza- Flag to include second part of swath (only 3D, see above). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126886 of file autoarts.h.

◆ sensor_responseMixer()

MRecord ARTS::AgendaMethod::sensor_responseMixer ( [[maybe_unused] ] Workspace ws)
inline

Includes response of the mixer of a heterodyne system.

The function returns the sensor response matrix after the mixer characteristics have been included. Frequency variables are converted from radio frequency (RF) to intermediate frequency (IF). The returned frequency grid covers the range [0,max_if], where max_if is the highest IF covered by the sideband response grid.

See lo and sideband_response for details on how to specify the mixer response

Author
Mattias Ekstrom
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126931 of file autoarts.h.

◆ sensor_responseMixerBackendPrecalcWeights()

MRecord ARTS::AgendaMethod::sensor_responseMixerBackendPrecalcWeights ( [[maybe_unused] ] Workspace ws)
inline

Includes pre-calculated response covering mixer and backend.

This method acts similar to sensor_responseBackend, but uses pre-calculated weights. These weights can also include the effect of mixer and sideband filtering.

As usual, f_backend gives the frequency of the channels. This WSM has no direct influence on the result, but at least representative values must be set.

The frequency response is defined using channel2fgrid_indexes and channel2fgrid_weights*.

Both channel2fgrid_indexes and channel2fgrid_weights are assumed to be common for all viewing directions.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126966 of file autoarts.h.

◆ sensor_responseMultiMixerBackend()

MRecord ARTS::AgendaMethod::sensor_responseMultiMixerBackend ( [[maybe_unused] ] Workspace ws)
inline

Handles mixer and backend parts for an instrument having multiple mixer chains.

The WSMs sensor_responseMixer, sensor_responseIF2RF and sensor_responseBackend* are called for each mixer chain, and a complete sensor_response is assembled. The instrument responses are described by lo_multi, sideband_response_multi, sideband_mode_multi*, f_backend_multi and backend_channel_response_multi*. All these WSVs must have same vector or array length. As sensor_responseIF2RF is called, f_backend_multi* must hold RF (not IF) and output frequencies will be in absolute frequency (RF).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126998 of file autoarts.h.

◆ sensor_responsePolarisation()

MRecord ARTS::AgendaMethod::sensor_responsePolarisation ( [[maybe_unused] ] Workspace ws)
inline

Extraction of non-default polarisation components.

The default is to output the Stokes elements I, Q, U and V (up to stokes_dim*). This method allows to change the "polarisation" of the output. Polarisation components to be extracted are selected by instrument_pol*. This method can be applied at any step of the sensor matrix set-up.

The method can only be applied on data for I, Q, U and V. The value of stokes_dim must be sufficiently large for the selected components. For example, I+45 requires that stokes_dim is at least 3.

See instrument_pol for coding of polarisation states.

Note that the state of iy_unit is considered. This WSV must give the actual unit of the data. This as, the extraction of components is slightly different if data are radiances or brightness temperatures. In practise this means that iy_unit (as to be applied inside iy_main_agenda) must be set before calling this method.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127039 of file autoarts.h.

◆ sensor_responseSimpleAMSU()

MRecord ARTS::AgendaMethod::sensor_responseSimpleAMSU ( [[maybe_unused] ] Workspace ws,
const Var::Numeric spacing = {} 
)
inline

Simplified sensor setup for an AMSU-type instrument.

This method allows quick and simple definition of AMSU-type sensors. Assumptions:

  1. Pencil beam antenna.
  2. Double sideband receivers.
  3. Sideband mode "upper"
  4. The channel response is rectangular.

Under these assumptions the only inputs needed are the LO positions, the offsets from the LO, and the IF bandwidths. They are provieded in sensor_description_amsu.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]spacing- Desired grid spacing in Hz. (default: .1e9)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127103 of file autoarts.h.

◆ sensor_responseStokesRotation()

MRecord ARTS::AgendaMethod::sensor_responseStokesRotation ( [[maybe_unused] ] Workspace ws)
inline

Includes a rotation of the Stokes H and V directions.

The method applies the rotations implied by stokes_rotation. See the description of that WSV for details.

This method does not change the size of sensor_response, and the auxiliary variables (sensor_response_f etc.) are not changed.

To apply the method, stokes_dim must be >= 3. The complete effect of the rotation can not be determibed with lower stokes_dim.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127069 of file autoarts.h.

◆ sensor_responseWMRF()

MRecord ARTS::AgendaMethod::sensor_responseWMRF ( [[maybe_unused] ] Workspace ws)
inline

Adds WMRF weights to sensor response.

This method adds a spectrometer response that has been calculated with the weighted mean of representative frequencies (WMRF) method. It consists of a set of selected frequencies, and associated weights.

Author
Stefan Buehler, based on Patrick Erikssons sensor_responseBackend
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127183 of file autoarts.h.

◆ sensorOff()

MRecord ARTS::AgendaMethod::sensorOff ( [[maybe_unused] ] Workspace ws)
inline

Sets sensor WSVs to obtain monochromatic pencil beam values.

The variables are set as follows: mblock_dlos_grid : One row with zero(s). sensor_response* : As returned by sensor_responseInit.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 126435 of file autoarts.h.

◆ SetNumberOfThreads()

MRecord ARTS::AgendaMethod::SetNumberOfThreads ( [[maybe_unused] ] Workspace ws,
const Var::Index  nthreads 
)
inline

Change the number of threads used by ARTS.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]nthreads- Number of threads.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127205 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ Sleep()

MRecord ARTS::AgendaMethod::Sleep ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  time 
)
inline

Sleeps for a number of seconds

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]time- Time to sleep for in seconds

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127232 of file autoarts.h.

References ARTS::Var::Time::islast(), ARTS::Var::Time::pos(), and ARTS::Var::time().

◆ SparseMatrixIdentity()

MRecord ARTS::AgendaMethod::SparseMatrixIdentity ( [[maybe_unused] ] Workspace ws,
Var::Sparse  out,
const Var::Index  n,
const Var::Numeric value = {} 
)
inline

Returns a sparse dentity matrix.

The size of the matrix created is n x n. Default is to return a true identity matrix (I), but you can also select another value along the diagonal be setting value. That is, the output is value*I.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Sparse output matrix
[in]n- Size of the matrix
[in]value- The value along the diagonal. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127324 of file autoarts.h.

◆ SparseSparseMultiply()

MRecord ARTS::AgendaMethod::SparseSparseMultiply ( [[maybe_unused] ] Workspace ws,
Var::Sparse  out,
const Var::Sparse  m1,
const Var::Sparse  m2 
)
inline

Multiplies a Sparse with another Sparse, result stored in Sparse.

Makes the calculation: out = m1 * m2

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Product, can be same variable as any of the inputs.
[in]m1- Left sparse matrix.
[in]m2- Right sparse matrix.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127284 of file autoarts.h.

References ARTS::Var::Sparse::islast(), and ARTS::Var::Sparse::pos().

◆ spectral_irradiance_fieldFromSpectralRadianceField()

MRecord ARTS::AgendaMethod::spectral_irradiance_fieldFromSpectralRadianceField ( [[maybe_unused] ] Workspace ws)
inline

Calculates the spectral irradiance from spectral_radiance_field . by integrating over the angular grids according to the grids set by AngularGridsSetFluxCalc See AngularGridsSetFluxCalc to set za_grid, aa_grid, and za_grid_weights

Author
Manfred Brath
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127363 of file autoarts.h.

◆ spectral_radiance_fieldClearskyPlaneParallel()

MRecord ARTS::AgendaMethod::spectral_radiance_fieldClearskyPlaneParallel ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  trans_field,
const Var::Index use_parallel_iy = {} 
)
inline

Clear-sky radiance field of a plane parallel atmosphere.

The method assumes a 1D flat planet. Radiances along each direction given by za_grid are calculated using ppathPlaneParallel and iyEmissionStandard.

Surface properties are defined by iy_surface_agenda, i.e. there is no restriction to e.g. specular surfaces.

Note that the variable ppath_lmax is considered, and that it can be critical for the accuracy for zenith angles close to 90 degrees. That is, using ppath_lmax=-1 is not recommended for this function.

Information on transmission is also provided by the GOUT trans_field. For up-welling radiation (scat_za > 90), this variable holds the transmission to space, for considered position and propagation direction. For down-welling radiation, trans_field holds instead the transmission down to the surface.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]trans_field- Dimensions: [f_grid,p_grid,za_grid]. See further above.
[in]use_parallel_iy- 0: Parallelize over zenith angles 1: Use more memory intensiv iyEmissionStandardParallel* (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127404 of file autoarts.h.

◆ spectral_radiance_fieldCopyCloudboxField()

MRecord ARTS::AgendaMethod::spectral_radiance_fieldCopyCloudboxField ( [[maybe_unused] ] Workspace ws)
inline

Set spectral_radiance_field to be a copy of cloudbox_field.

This method can only be used for 1D atmospheres and if the cloud box covers the complete atmosphere. For such case, the two fields cover the same atmospheric volume and a direct copying can be made.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127440 of file autoarts.h.

◆ spectral_radiance_fieldExpandCloudboxField()

MRecord ARTS::AgendaMethod::spectral_radiance_fieldExpandCloudboxField ( [[maybe_unused] ] Workspace ws,
const Var::Index use_parallel_iy = {} 
)
inline

Uses and expands cloudbox_field to set spectral_radiance_field.

The method demands that cloudbox_field starts at the first pressure level (i.e. cloudbox_limits[0] is 0). The method copies cloudbox_field to fill spectral_radiance_field up to the top of the cloudbox.

To fill the remaning part of spectral_radiance_field, clear-sky calculations are performed largely in the same maner as done by spectral_radiance_fieldClearskyPlaneParallel*. That is, clear-sky calculations are done for the upper part of the atmosphere, assuming a flat planet.

Note that the cloud box constitutes the lower boundary for the later calculations, and iy_cloudbox_agenda must be set to perform an interpolation of the cloudbox field.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]use_parallel_iy- 0: Parallelize over zenith angles 1: Use more memory intensiv iyEmissionStandardParallel* (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127477 of file autoarts.h.

◆ specular_losCalc()

MRecord ARTS::AgendaMethod::specular_losCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index ignore_surface_slope = {} 
)
inline

Calculates the specular direction of surface reflections.

A help method to set up the surface properties. This method calculates specular_los, that is required in several methods to convert zenith angles to incidence angles.

The method also returns the line-of-sight matching the surface normal.

The default is to consider the surface slope when calculating the specular direction. That is, the variation of z_surface (as well as the geoid radius) is considered and the specular direction is calculated including the specified topography. This part can be deactivated by setting ignore_surface_slope to 1. In this case, the zenith angle of the specular direction is simply 180-rtp_los[0]. ignore_surface_slope has only an effect for 2D and 3D, as 1D implies a constant radius of the surface (i.e. no topography).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]ignore_surface_slope- Flag to control if surface slope is consdered or not. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127522 of file autoarts.h.

◆ specular_losCalcNoTopography()

MRecord ARTS::AgendaMethod::specular_losCalcNoTopography ( [[maybe_unused] ] Workspace ws)
inline

Calculates the specular direction of surface reflections for horisontal surfaces.

In contrast to specular_losCalc, this method ignores the topography implied by z_surface. That is, any slope of the surface is ignored.

The typical application of this WSM should be water surfaces (lakes and oceans).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127558 of file autoarts.h.

◆ StringJoin()

MRecord ARTS::AgendaMethod::StringJoin ( [[maybe_unused] ] Workspace ws,
Var::String  out,
const Var::String  in1,
const Var::String  in2,
const Var::String in3 = {},
const Var::String in4 = {},
const Var::String in5 = {},
const Var::String in6 = {},
const Var::String in7 = {},
const Var::String in8 = {},
const Var::String in9 = {},
const Var::String in10 = {} 
)
inline

Concatenate two or more strings.

The output string is overwritten, but is allowed to appear in the input list. Up to 10 strings can be concatenated at once.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Concatenated string.
[in]in1- Input text string.
[in]in2- Input text string.
[in]in3- Input text string. (default: "")
[in]in4- Input text string. (default: "")
[in]in5- Input text string. (default: "")
[in]in6- Input text string. (default: "")
[in]in7- Input text string. (default: "")
[in]in8- Input text string. (default: "")
[in]in9- Input text string. (default: "")
[in]in10- Input text string. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127593 of file autoarts.h.

◆ StringSet()

MRecord ARTS::AgendaMethod::StringSet ( [[maybe_unused] ] Workspace ws,
Var::String  out,
const Var::String  text 
)
inline

Sets a String to the given text string.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]text- Input text string.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127675 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::String::pos(), and ARTS::Var::String::value().

◆ surface_complex_refr_indexFromGriddedField5()

MRecord ARTS::AgendaMethod::surface_complex_refr_indexFromGriddedField5 ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField5  complex_refr_index_field 
)
inline

Extracts complex refractive index from a field of such data.

The method allows to obtain surface_complex_refr_index by interpolation of a geographical field of such data. The position for which refraction shall be extracted is given by rtp_pos. The refractive index field is expected to be stored as: GriddedField5: Vector f_grid[N_f] Vector T_grid[N_T] ArrayOfString Complex[2] Vector "Latitude" [N_lat] Vector "Longitude" [N_lon] Tensor5 data[N_f][N_T][2][N_lat][N_lon]

Definition and treatment of the three first dimensions follows complex_refr_index*, e.g. the temperature grid is allowed to have length 1. The grids for latitude and longitude must have a length of >= 2 (ie. no automatic expansion).

Hence, this method performs an interpolation only in the lat and lon dimensions, to a single point. The remaining GriddedField3 is simply returned as surface_complex_refr_index.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]complex_refr_index_field- A field of complex refractive index.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128298 of file autoarts.h.

References ARTS::Var::GriddedField5::islast(), and ARTS::Var::GriddedField5::pos().

◆ surface_reflectivityFromGriddedField6()

MRecord ARTS::AgendaMethod::surface_reflectivityFromGriddedField6 ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField6  r_field 
)
inline

Extracts surface reflectivities from a field of such data.

This method allows to specify a field of surface reflectivity for automatic interpolation to points of interest. The position and direction for which the reflectivity shall be extracted are given by rtp_pos and rtp_los. The reflectivity field is expected to be stored as: GriddedField6: Vector "Frequency" [N_f] Vector "Stokes element" [N_s1] Vector "Stokes_element" [N_s2] Vector "Incidence angle" [N_ia] Vector "Latitude" [N_lat] Vector "Longitude" [N_lon] Tensor6 data[N_f][N_s1][N_s2][N_ia][N_lat][N_lon]

Grids for incidence angle, latitude and longitude must have a length of >= 2 (ie. no automatic expansion). If the frequency grid has length 1, this is taken as that the reflectivity is constant, following the definition of surface_scalar_reflectivity. The data can cover higher Stokes dimensionalities than set by stokes_dim*. Data for non-used Stokes elements are just cropped. The order between the two Stokes dimensions is the same as in surface_reflectivity* and surface_rmatrix*.

The interpolation is done in steps: 1: Linear interpolation for lat and lon (std. extrapolation). 2: Interpolation in incidence angle (std. extrapolation). If the grid has a length of >= 4, cubic interpolation is applied. Otherwise linear interpolation.

  1. Linear interpolation in frequency (if input data have more than one frequency).
Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]r_field- A field of surface reflectivities

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128356 of file autoarts.h.

References ARTS::Var::GriddedField6::islast(), and ARTS::Var::GriddedField6::pos().

◆ surface_rtpropCallAgendaX()

MRecord ARTS::AgendaMethod::surface_rtpropCallAgendaX ( [[maybe_unused] ] Workspace ws)
inline

Switch between the elements of surface_rtprop_agenda_array.

This method simply calls the agenda matching surface_type and returns the results. That is, the agenda in surface_rtprop_agenda_array with index surface_type (0-based) is called.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128386 of file autoarts.h.

◆ surface_scalar_reflectivityFromGriddedField4()

MRecord ARTS::AgendaMethod::surface_scalar_reflectivityFromGriddedField4 ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField4  r_field 
)
inline

Extracts scalar surface reflectivities from a field of such data.

This method allows to specify a field of surface reflectivity for automatic interpolation to points of interest. The position and direction for which the reflectivity shall be extracted are given by rtp_pos and rtp_los. The reflectivity field is expected to be stored as: GriddedField4: Vector "Frequency" [N_f] Vector "Incidence angle" [N_ia] Vector "Latitude" [N_lat] Vector "Longitude" [N_lon] Tensor4 data[N_f][N_ia][N_lat][N_lon]

Grids for incidence angle, latitude and longitude must have a length of >= 2 (ie. no automatic expansion). If the frequency grid has length 1, this is taken as the reflectivity is constant, following the definition of surface_scalar_reflectivity.

The interpolation is done in steps: 1: Linear interpolation for lat and lon (std. extrapolation). 2: Interpolation in incidence angle (std. extrapolation). If the grid has a length of >= 4, cubic interpolation is applied. Otherwise linear interpolation.

  1. Linear interpolation if frequency (if input data have more than one frequency).
Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]r_field- A field of scalar surface reflectivities

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128433 of file autoarts.h.

References ARTS::Var::GriddedField4::islast(), and ARTS::Var::GriddedField4::pos().

◆ surface_scalar_reflectivityFromSurface_rmatrix()

MRecord ARTS::AgendaMethod::surface_scalar_reflectivityFromSurface_rmatrix ( [[maybe_unused] ] Workspace ws)
inline

Sets surface_scalar_reflectivity based on surface_rmatrix.

For each frequency f, surface_scalar_reflectivity is set to the sum of surface_rmatrix(joker,f,0,0).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128462 of file autoarts.h.

◆ surface_typeInterpTypeMask()

MRecord ARTS::AgendaMethod::surface_typeInterpTypeMask ( [[maybe_unused] ] Workspace ws)
inline

Closest neighbour interpolation of surface type mask.

The method determines the surface type at the position of concern (rtp_pos) from the provided type mask (surface_type_mask). The closest point in the mask is selected. The surface type is set to the integer part of the value at the found point, while surface_type_aux* is set to the reminder. For example, if the mask value at closest point is 2.23, surface_type is set to 2 surface_type_aux* becomes 0.23.

The altitude in rtp_pos is ignored.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128493 of file autoarts.h.

◆ surfaceBlackbody()

MRecord ARTS::AgendaMethod::surfaceBlackbody ( [[maybe_unused] ] Workspace ws)
inline

Creates variables to mimic a blackbody surface.

This method sets up surface_los, surface_rmatrix and surface_emission* for surface_rtprop_agenda. Here, surface_los and surface_rmatrix are set to be empty, and surface_emission to hold blackbody radiation for a temperature of surface_skin_t.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127780 of file autoarts.h.

◆ SurfaceDummy()

MRecord ARTS::AgendaMethod::SurfaceDummy ( [[maybe_unused] ] Workspace ws)
inline

Dummy method for iy_surface_agenda.

If you don't make use of surface_props_data and associated variables, include this method iy_surface_agenda. The method just checks that the variables of concern are set to be empty, and you don't need to include calls of Ignore and Touch in the agenda.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128520 of file autoarts.h.

◆ surfaceFastem()

MRecord ARTS::AgendaMethod::surfaceFastem ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  wind_speed,
const Var::Vector  transmittance,
const Var::Numeric salinity = {},
const Var::Numeric wind_direction = {},
const Var::Index fastem_version = {} 
)
inline

Usage of FASTEM together with MC and DOIT.

The recommended way to use FASTEM is by iySurfaceFastem, but that is not always possible, such as when using MC and DOIT. This is the case as those scattering methods use surface_rtprop_agenda, while iySurfaceFastem fits with iy_surface_agenda. This WSM solves this by allowing FASTEM to be used inside surface_rtprop_agenda.

However, FASTEM is here used in an approximative way. For a correct usage of FASTEM, the atmospheric transmittance shall be calculated for the position and direction of concern, but this is not possible together with DOIT and MC. Instead, the transmittance is an input to the method, and must either be pre-calculated or set to a representative value.

See iySurfaceFastem, for further details on the special input arguments.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]salinity- Salinity, 0-1. That is, 3% is given as 0.03. (default: 0.035)
[in]wind_speed- Wind speed.
[in]wind_direction- Wind direction. See futher above. (default: 0)
[in]transmittance- Transmittance along path of downwelling radiation. A vector with the same length as f_grid.
[in]fastem_version- The version of FASTEM to use. (default: 6)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127822 of file autoarts.h.

◆ SurfaceFastem()

MRecord ARTS::AgendaMethod::SurfaceFastem ( [[maybe_unused] ] Workspace ws,
const Var::Vector  transmittance,
const Var::Index fastem_version = {} 
)
inline

FASTEM sea surface microwave emissivity parametrization.

The variable surface_props_data must contain these data: "Water skin temperature" "Wind speed" "Wind direction" "Salinity"

For some details and comments see FastemStandAlone and surfaceFastem.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]transmittance- Transmittance along path of downwelling radiation. A vector with the same length as f_grid.
[in]fastem_version- The version of FASTEM to use. (default: 6)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128551 of file autoarts.h.

◆ surfaceFlatReflectivity()

MRecord ARTS::AgendaMethod::surfaceFlatReflectivity ( [[maybe_unused] ] Workspace ws)
inline

Creates variables to mimic specular reflection by a (flat) surface where surface_reflectivity is specified.

Works basically as surfaceFlatScalarReflectivity but is more general as vector radiative transfer is more properly handled. See the ARTS theory document (ATD) for details around how surface_emission* is determined. In the nomenclature of ATD, surface_reflectivity* gives R.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128029 of file autoarts.h.

◆ surfaceFlatRefractiveIndex()

MRecord ARTS::AgendaMethod::surfaceFlatRefractiveIndex ( [[maybe_unused] ] Workspace ws)
inline

Creates variables to mimic specular reflection by a (flat) surface where the complex refractive index is specified.

The dielectric properties of the surface are described by surface_complex_refr_index*. The Fresnel equations are used to calculate amplitude reflection coefficients. The method can thus result in that the reflection properties differ between frequencies and polarisations.

Local thermodynamic equilibrium is assumed, which corresponds to that the reflection and emission coefficients add up to 1.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128001 of file autoarts.h.

◆ surfaceFlatRvRh()

MRecord ARTS::AgendaMethod::surfaceFlatRvRh ( [[maybe_unused] ] Workspace ws)
inline

Creates variables to mimic specular reflection by a (flat) surface where surface_rv_rh is specified.

This method assumes that the reflection at vertical and horizontal polarisation differs. As power reflection coefficients are provided there is no information at hand on phase shifts between polarisations, and they are simply assumed to be zero. These assumptions result in that surface_emission is set to zero for positions corresponding to U and V, and that all diagonal elementsof surface_rmatrix are equal (the mean of rv and rh). Further, all off-diagonal elements of surface_rmatrix* are all zero except for (0,1) and (1,0).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128060 of file autoarts.h.

◆ surfaceFlatScalarReflectivity()

MRecord ARTS::AgendaMethod::surfaceFlatScalarReflectivity ( [[maybe_unused] ] Workspace ws)
inline

Creates variables to mimic specular reflection by a (flat) surface where surface_scalar_reflectivity is specified.

This method assumes that the reflection at vertical and horizontal polarisation is identical. This assumption includes that there is no phase shift between polarisations. These assumptions result in that surface_emission* is set to zero for positions corresponding to Q, U and V, and that surface_rmatrix becomes a diagonal matrix (with all elements on the diagonal equal to the specified reflectivity).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128089 of file autoarts.h.

◆ surfaceLambertianSimple()

MRecord ARTS::AgendaMethod::surfaceLambertianSimple ( [[maybe_unused] ] Workspace ws,
const Var::Index lambertian_nza = {},
const Var::Numeric za_pos = {} 
)
inline

Creates variables to mimic a Lambertian surface.

A Lambertian surface can be characterised solely by its reflectivity, here taken from surface_scalar_reflectivity.

The down-welling radiation field is estimated by making calculations for lambertian_nza directions. The range of zenith angles ([0,90]) is divided in an equidistant manner for 1D. For 2D and 3D see below. The values for surface_rmatrix are assuming a constant radiance over each zenith angle range. See AUG.

Default is to select the zenith angles for sensor_los to be placed centrally in the grid ranges. For example, if lambertian_nza is set to 9, down-welling radiation will be calculated for zenith angles = 5, 15, ..., 85. The position of these angles can be shifted by za_pos*. This variable specifies the fractional distance inside the ranges. For example, a za_pos of 0.7 (np still 9) gives the angles 7, 17, ..., 87.

Only upper-left diagonal element of the surface_rmatrix is non-zero. That is, the upwelling radiation is always unpolarised.

Local thermodynamic equilibrium is assumed, which corresponds to that the reflection and emission coefficients "add up to 1".

For 2D and 3D, the down-welling directions are placed along the the viewing direction, e.g. for 3D the azimuth angle is kept constant. In 2D and 3D surface topography can exist, and to avoid getting views going directly into the surface, angels are not distributed over 90 deg, but 90-abs(surface_normal[0]).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]lambertian_nza- Number of downwelling streams. (default: 9)
[in]za_pos- Position of angle in surface_los inside ranges of zenith angle grid. See above. (default: 0.5)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128141 of file autoarts.h.

◆ surfaceSemiSpecularBy3beams()

MRecord ARTS::AgendaMethod::surfaceSemiSpecularBy3beams ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  specular_factor,
const Var::Numeric  dza 
)
inline

A simplistic treatment of semi-specular surfaces.

This method has no strong physical basis but could be used for simpler testing or as starting point for more advanced methods.

This method assumes that the surface can be treated to have three facets, all lacking surface roughness. One facet is assumed to give standard specular reflection, while the two other facets are tilted with +dza and -dza, respectively. The tilt is assumed to only affect the zenith angle of the reflected direction (azimuth same as for specular direction). The area ratio of the non-tilted facet is set by specular_factor. That is, the specular beam is given weight w, while the other two beams each get weight (1-w)/2.

If a facet tilts away from the viewing direction in such way that the surface is observed from below, the tilt of the facet is decreased in steps of 1 degree until a successful calculation is obtained. If this turns out to require a tilt of zero, this facete is merged with the specular direction.

The pure specular properties of the surface shall be described by surface_rtprop_sub_agenda*. That is, if you have specular surface described and you want to make it semi-specular by this method, you move the content of the existing surface_rtprop_agenda to surface_rtprop_sub_agenda* and instead fill surface_rtprop_agenda with this method.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]specular_factor- The weight given to the specular direction. Denoted as w above. A value between 1/3 and 1.
[in]dza- Zenith angle seperation to each secondary direction. A between 0 and 45 degrees.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128203 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ surfaceSplitSpecularTo3beams()

MRecord ARTS::AgendaMethod::surfaceSplitSpecularTo3beams ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  specular_factor,
const Var::Numeric  dza 
)
inline

A very simple approximation of a semi-specular surface.

This method has no direct physical basis but could be used for simpler testing or as starting point for more advanced methods.

The method requires that the surface RT properties (e.g. surface_los) have been set up to mimic a specular surface. This method splits the down- welling radiation into three directions. The specular direction is given weight w, while the other two beams each get weight (1-w)/2. The basic polarised reflectivity from the specular calculations is maintained for each beam. The beams are just separated in zenith angle, with a separation of dza. The lowermost beam is not allowed to be closer to the surface than 1 degree. If there is no room for the lowermost beam, it is merged with the main beam.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]specular_factor- The weight given to the specular direction. Denoted as w above. A value between 1/3 and 1.
[in]dza- Zenith angle seperation to each secondary direction. A between 0 and 45 degrees.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128247 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ surfaceTelsem()

MRecord ARTS::AgendaMethod::surfaceTelsem ( [[maybe_unused] ] Workspace ws,
const Var::TelsemAtlas  atlas,
const Var::Numeric r_min = {},
const Var::Numeric r_max = {},
const Var::Numeric d_max = {} 
)
inline

Compute surface emissivities using the TELSEM 2 model.

This method uses second version of the TELSEM model for calculating land surface emissivities (F. Aires et al, "A Tool to Estimate Land‐Surface Emissivities at Microwave frequencies (TELSEM) for use in numerical weather prediction" Quarterly Journal of the Royal Meteorological Society, vol. 137, (656), pp. 690-699, 2011.) This methods computes land surface emissivities for a given pencil beam using a given TELSEM2 atlas. The input must satisfy the following conditions, otherwise an error is thrown:

  • The input frequencies (f_grid) must be within the range [5 GHz, 900 GHz]
  • The skin temperature (surface_skin_t) must be within the range [180 K, 360 K]

A TELSEM atlas contains only suface emissivities for locations that are classified as land. By default this WSM will throw an error if the pencil beam hits the surface at a position that is not contained in the given atlas.

The above behavior can be avoided by setting d_max to a positive value. This enables nearest neighbor interpolation, which assigns the emissivities of the nearest found cell in the atlas to the given position. In this case, an error is only thrown if the distance of the found neighbor is higher than the provided value of *d_max.

You can limit the final reflectivity applied by setting r_min and r_max.

To extract a land-sea mask from a given telsem atlas see the WSM telsemSurfaceTypeLandSea*.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]atlas- The Telsem atlas to use for the emissivity calculation.
[in]r_min- Minimum allowed value for reflectivity to apply. (default: 0)
[in]r_max- Maximum allowed value for reflectivity to apply. (default: 1)
[in]d_max- Maximum allowed distance in meters for nearest neighbor interpolation in meters. Set to a negative value or zero to disable interpolation. (default: -1.0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127947 of file autoarts.h.

◆ SurfaceTessem()

MRecord ARTS::AgendaMethod::SurfaceTessem ( [[maybe_unused] ] Workspace ws)
inline

TESSEM sea surface microwave emissivity parametrization.

The variable surface_props_data must contain these data: "Water skin temperature" "Wind speed" "Salinity"

This method computes surface emissivity and reflectivity matrices for ocean surfaces using the TESSEM emissivity model: Prigent, C., et al. Sea-surface emissivity parametrization from microwaves to millimetre waves, QJRMS, 2017, 143.702: 596-605.

The validity range of the parametrization of is 10 to 700 GHz, but for some extra flexibility frequencies between 5 and 900 GHz are accepted. The accepted temperaute range for water skin temperature is [260.0 K, 373.0 K]. Salinity shall be in the range [0,1]. That is, a salinity of 3% is given as 0.03.

The model itself is represented by the neural networks in tessem_neth* and tessem_netv.

Author
Simon Pfreundschuh
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128603 of file autoarts.h.

◆ surfaceTessem()

MRecord ARTS::AgendaMethod::surfaceTessem ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  wind_speed,
const Var::Numeric salinity = {} 
)
inline

TESSEM sea surface microwave emissivity parametrization.

This method computes surface emissivity and reflectivity matrices for ocean surfaces using the TESSEM emissivity model: Prigent, C., et al. Sea‐surface emissivity parametrization from microwaves to millimetre waves, QJRMS, 2017, 143.702: 596-605.

The validity range of the parametrization of is 10 to 700 GHz, but for some extra flexibility frequencies between 5 and 900 GHz are accepted. The accepted temperaute range for surface_skin_t is [260.0 K, 373.0 K]

The model itself is represented by the neural networks in tessem_neth* and tessem_netv.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]salinity- Salinity, 0-1. That is, 3% is given as 0.03. (default: 0.035)
[in]wind_speed- Wind speed.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127883 of file autoarts.h.

◆ TangentPointExtract()

MRecord ARTS::AgendaMethod::TangentPointExtract ( [[maybe_unused] ] Workspace ws,
Var::Vector  tan_pos 
)
inline

Finds the tangent point of a propagation path.

The tangent point is here defined as the point with the lowest altitude (which differes from the definition used in the code where it is the point with the lowest radius, or equally the point with a zenith angle of 90 deg.)

The tangent point is returned as a vector, with columns matching e.g. rte_pos. If the propagation path has no tangent point, the vector is set to NaN.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]tan_pos- The position vector of the tangent point.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128634 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ TangentPointPrint()

MRecord ARTS::AgendaMethod::TangentPointPrint ( [[maybe_unused] ] Workspace ws,
const Var::Index level = {} 
)
inline

Prints information about the tangent point of a propagation path.

The tangent point is here defined as the point with the lowest altitude (which differes from the definition used in the code where it is the point with the lowest radius, or equally the point with a zenith angle of 90 deg.)

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]level- Output level to use. (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128666 of file autoarts.h.

◆ telsem_atlasesReadAscii()

MRecord ARTS::AgendaMethod::telsem_atlasesReadAscii ( [[maybe_unused] ] Workspace ws,
const Var::String  directory,
const Var::String filename_pattern = {} 
)
inline

Reads TELSEM atlas files.

'directory' needs to contain the original 12 Telsem atlas files and the correlations file. The whole data is combined into the WSV telsem_atlases

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]directory- Directory with TELSEM 2 SSMI atlas files.
[in]filename_pattern- Filename pattern (@MM@ gets replaced by month number) (default: "ssmi_mean_emis_climato_@MM@_cov_interpol_M2")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128892 of file autoarts.h.

◆ telsem_atlasReadAscii()

MRecord ARTS::AgendaMethod::telsem_atlasReadAscii ( [[maybe_unused] ] Workspace ws,
Var::TelsemAtlas  atlas,
const Var::String  directory,
const Var::Index  month,
const Var::String filename_pattern = {} 
)
inline

Reads single TELSEM atlas.

'directory' needs to contain the original 12 Telsem atlas files and the correlations file. This WSM reads the atlas for the specified month and stores the result in the provided output atlas.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]atlas- The atlas into which to store the loaded atlas.
[in]directory- Directory with TELSEM 2 SSMI atlas files.
[in]month- The month for which the atlas should be read.
[in]filename_pattern- Filename pattern (@MM@ gets replaced by month number) (default: "ssmi_mean_emis_climato_@MM@_cov_interpol_M2")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128848 of file autoarts.h.

◆ telsemAtlasLookup()

MRecord ARTS::AgendaMethod::telsemAtlasLookup ( [[maybe_unused] ] Workspace ws,
Var::Vector  emissivities,
const Var::Numeric  lat,
const Var::Numeric  lon,
const Var::TelsemAtlas  atlas 
)
inline

Lookup SSMI emissivities from Telsem Atlas.

This returns the emissivities (indices [0,..,6]) for the SSMI channels that are contained in the Telsem atlas.

If given latitude and longitude are not in the atlas an empty vector is returned.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]emissivities- The SSMI emissivities from the atlas
[in]lat- The latitude for which to compute the emissivities.
[in]lon- The latitude for which to compute the emissivities.
[in]atlas- The Telsem atlas to use.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128771 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::TelsemAtlas::islast(), ARTS::Var::Vector::islast(), ARTS::Var::lat(), ARTS::Var::lon(), ARTS::Var::Numeric::pos(), ARTS::Var::TelsemAtlas::pos(), and ARTS::Var::Vector::pos().

◆ telsemStandalone()

MRecord ARTS::AgendaMethod::telsemStandalone ( [[maybe_unused] ] Workspace ws,
Var::Matrix  emissivities,
const Var::Numeric  lat,
const Var::Numeric  lon,
const Var::Numeric  theta,
const Var::Vector  f,
const Var::TelsemAtlas  ta,
const Var::Numeric d_max = {} 
)
inline

Stand-alone evaluation of the Telsem model.

This evaluates the Telsem land surface emissivity model using the data from the provided atlas.

Since TELSEM atlases do not contain data for all locations this function allows for nearest neighbor interpolation, which can be enabled by setting the d_max GIN to a positive value.

This WSM throws a runtime error if the queried location is not contained in the atlas or the distance of the neighboring cell exceeds the given d_max value.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]emissivities- The computed h and v emissivites
[in]lat- The latitude for which to compute the emissivities.
[in]lon- The latitude for which to compute the emissivities.
[in]theta- The incidence angle.
[in]f- The frequencies for which to compute the emissivities.
[in]ta- The Telsem atlas to use.
[in]d_max- The maximum allowed distance for nearest neighbor interpolation in meters. (default: -1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128713 of file autoarts.h.

◆ telsemSurfaceTypeLandSea()

MRecord ARTS::AgendaMethod::telsemSurfaceTypeLandSea ( [[maybe_unused] ] Workspace ws,
const Var::TelsemAtlas  atlas 
)
inline

TELSEM based land sea mask.

This method determines whether the position in rtp_pos is of type ocean or land depending on whether a corresponding cell is contained in the provided TELSEM atlas. In combination with the WSM surface_rtpropCallAgendaX this can be used to used different methods to compute surface radiative properties.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[in]atlas- The telsem atlas from which to lookup the surface type.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128814 of file autoarts.h.

References ARTS::Var::TelsemAtlas::islast(), and ARTS::Var::TelsemAtlas::pos().

◆ Tensor3AddScalar()

MRecord ARTS::AgendaMethod::Tensor3AddScalar ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::Tensor3  in,
const Var::Numeric  value 
)
inline

Adds a scalar value to all elements of a tensor3.

The result can either be stored in the same or another variable.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output tensor.
[in]in- Input tensor.
[in]value- The value to be added to the tensor.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128930 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor3::pos().

◆ Tensor3ExtractFromTensor4()

MRecord ARTS::AgendaMethod::Tensor3ExtractFromTensor4 ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::Tensor4  in,
const Var::Index  i,
const Var::String  direction 
)
inline

Extracts a Tensor3 from a Tensor4.

Copies book, page, row or column with given Index from input Tensor4 variable to output Tensor3. Higher order equivalent of VectorExtractFromMatrix.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Extracted tensor.
[in]in- Input Tensor4.
[in]i- Index of book, page, row or column to extract.
[in]direction- Direction. "book" or "page" or "row" or "column".

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 128970 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::String::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::Index::pos(), ARTS::Var::String::pos(), ARTS::Var::Tensor3::pos(), and ARTS::Var::Tensor4::pos().

◆ Tensor3Scale()

MRecord ARTS::AgendaMethod::Tensor3Scale ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::Tensor3  in,
const Var::Numeric  value 
)
inline

Scales all elements of a tensor with the specified value.

The result can either be stored in the same or another variable.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output tensor.
[in]in- Input tensor.
[in]value- The value to be multiplied with the tensor.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129011 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor3::pos().

◆ Tensor3SetConstant()

MRecord ARTS::AgendaMethod::Tensor3SetConstant ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  out,
const Var::Numeric  value 
)
inline

Creates a tensor and sets all elements to the specified value.

The size is determined by ncols, nrows etc.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- Tensor value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129047 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor3::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor3::pos().

◆ Tensor4AddScalar()

MRecord ARTS::AgendaMethod::Tensor4AddScalar ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::Tensor4  in,
const Var::Numeric  value 
)
inline

Adds a scalar value to all elements of a tensor4.

The result can either be stored in the same or another variable.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output tensor.
[in]in- Input tensor.
[in]value- The value to be added to the tensor.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129082 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor4::pos().

◆ Tensor4Scale()

MRecord ARTS::AgendaMethod::Tensor4Scale ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::Tensor4  in,
const Var::Numeric  value 
)
inline

Scales all elements of a tensor with the specified value.

The result can either be stored in the same or another variable.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output tensor.
[in]in- Input tensor.
[in]value- The value to be multiplied with the tensor.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129120 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor4::pos().

◆ Tensor4SetConstant()

MRecord ARTS::AgendaMethod::Tensor4SetConstant ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  out,
const Var::Numeric  value 
)
inline

Creates a tensor and sets all elements to the specified value.

The size is determined by ncols, nrows etc.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- Tensor value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129156 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor4::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor4::pos().

◆ Tensor5Scale()

MRecord ARTS::AgendaMethod::Tensor5Scale ( [[maybe_unused] ] Workspace ws,
Var::Tensor5  out,
const Var::Tensor5  in,
const Var::Numeric  value 
)
inline

Scales all elements of a tensor with the specified value.

The result can either be stored in the same or another variable.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output tensor.
[in]in- Input tensor.
[in]value- The value to be multiplied with the tensor.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129191 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor5::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor5::pos().

◆ Tensor5SetConstant()

MRecord ARTS::AgendaMethod::Tensor5SetConstant ( [[maybe_unused] ] Workspace ws,
Var::Tensor5  out,
const Var::Numeric  value 
)
inline

Creates a tensor and sets all elements to the specified value.

The size is determined by ncols, nrows etc.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- Tensor value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129227 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor5::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor5::pos().

◆ Tensor6Scale()

MRecord ARTS::AgendaMethod::Tensor6Scale ( [[maybe_unused] ] Workspace ws,
Var::Tensor6  out,
const Var::Tensor6  in,
const Var::Numeric  value 
)
inline

Scales all elements of a tensor with the specified value.

The result can either be stored in the same or another variable.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output tensor.
[in]in- Input tensor.
[in]value- The value to be multiplied with the tensor.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129262 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor6::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor6::pos().

◆ Tensor6SetConstant()

MRecord ARTS::AgendaMethod::Tensor6SetConstant ( [[maybe_unused] ] Workspace ws,
Var::Tensor6  out,
const Var::Numeric  value 
)
inline

Creates a tensor and sets all elements to the specified value.

The size is determined by ncols, nrows etc.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- Tensor value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129298 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor6::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor6::pos().

◆ Tensor7Scale()

MRecord ARTS::AgendaMethod::Tensor7Scale ( [[maybe_unused] ] Workspace ws,
Var::Tensor7  out,
const Var::Tensor7  in,
const Var::Numeric  value 
)
inline

Scales all elements of a tensor with the specified value.

The result can either be stored in the same or another variable.

Author
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output tensor.
[in]in- Input tensor.
[in]value- The value to be multiplied with the tensor.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129333 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor7::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor7::pos().

◆ Tensor7SetConstant()

MRecord ARTS::AgendaMethod::Tensor7SetConstant ( [[maybe_unused] ] Workspace ws,
Var::Tensor7  out,
const Var::Numeric  value 
)
inline

Creates a tensor and sets all elements to the specified value.

The size is determined by ncols, nrows etc.

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- Tensor value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129369 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Tensor7::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Tensor7::pos().

◆ TessemNNReadAscii()

MRecord ARTS::AgendaMethod::TessemNNReadAscii ( [[maybe_unused] ] Workspace ws,
Var::TessemNN  tessem_nn,
const Var::String  filename 
)
inline

Reads the initialization data for the TESSEM NeuralNet from an ASCII file.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]tessem_nn- Tessem NeuralNet configuration.
[in]filename- NeuralNet parameters file as provided in the TESSEM 2 distribution.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129430 of file autoarts.h.

References ARTS::Var::String::islast(), ARTS::Var::TessemNN::islast(), ARTS::Var::String::pos(), and ARTS::Var::TessemNN::pos().

◆ Test()

MRecord ARTS::AgendaMethod::Test ( [[maybe_unused] ] Workspace ws)
inline

A dummy method that can be used for test purposes.

This method can be used by ARTS developers to quickly test stuff. The implementation is in file m_general.cc. This just saves you the trouble of adding a dummy method everytime you want to try something out quickly.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129509 of file autoarts.h.

◆ TestArrayOfAgenda()

MRecord ARTS::AgendaMethod::TestArrayOfAgenda ( [[maybe_unused] ] Workspace ws,
const Var::Index index = {} 
)
inline

A method that is used for the TestArrayOfAgenda test case.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]index- Index of agenda in array to execute. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129399 of file autoarts.h.

◆ TestTessem()

MRecord ARTS::AgendaMethod::TestTessem ( [[maybe_unused] ] Workspace ws,
Var::Vector  outvalues,
const Var::TessemNN  net,
const Var::Vector  invalues 
)
inline

Example method for TESSEM2.

When using the default neural network parameter files from the Tessem 2 distribution, the input Vector should contain 5 elements:

  • Frequency (10-700) in GHz.
  • Theta (0-90) Incidence angle in degrees.
  • Windspeed (0-25) at 10m (m/s) Higher wind speed can be used, but without garantee.
  • Surface skin temperature (270-310) in K.
  • Salinity (0-0.04) in kg/kg
Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]outvalues- Tessem output emissivity.
[in]net- Tessem NeuralNet parameters.
[in]invalues- Input data.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129472 of file autoarts.h.

References ARTS::Var::TessemNN::islast(), ARTS::Var::Vector::islast(), ARTS::Var::TessemNN::pos(), and ARTS::Var::Vector::pos().

◆ time_gridOffset()

MRecord ARTS::AgendaMethod::time_gridOffset ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  dt 
)
inline

Offsets a time grid by some seconds.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]dt- Time in seconds to add

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129531 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ time_stampsSort() [1/2]

MRecord ARTS::AgendaMethod::time_stampsSort ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTime  out,
const Var::ArrayOfTime  in 
)
inline

Sort in by time_stamps into out.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Array sorted by time
[in]in- Array to sort of same size as time_stamps

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129609 of file autoarts.h.

References ARTS::Var::ArrayOfTime::islast(), and ARTS::Var::ArrayOfTime::pos().

◆ time_stampsSort() [2/2]

MRecord ARTS::AgendaMethod::time_stampsSort ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfVector  out,
const Var::ArrayOfVector  in 
)
inline

Sort in by time_stamps into out.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Array sorted by time
[in]in- Array to sort of same size as time_stamps

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129640 of file autoarts.h.

References ARTS::Var::ArrayOfVector::islast(), and ARTS::Var::ArrayOfVector::pos().

◆ timeNow()

MRecord ARTS::AgendaMethod::timeNow ( [[maybe_unused] ] Workspace ws)
inline

Sets time to system_clock::now().

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103891 of file autoarts.h.

◆ timeOffset()

MRecord ARTS::AgendaMethod::timeOffset ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  offset 
)
inline

Offsets time for some seconds

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]offset- Time in seconds

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 103913 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ timerStart()

MRecord ARTS::AgendaMethod::timerStart ( [[maybe_unused] ] Workspace ws)
inline

Initializes the CPU timer. Use timerStop to stop the timer.

Usage example: timerStart ReadXML(f_grid,"frequencies.xml") timerStop Print(timer)

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129564 of file autoarts.h.

◆ timerStop()

MRecord ARTS::AgendaMethod::timerStop ( [[maybe_unused] ] Workspace ws)
inline

Stops the CPU timer. See timerStart for example usage.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129586 of file autoarts.h.

◆ timeSleep()

MRecord ARTS::AgendaMethod::timeSleep ( [[maybe_unused] ] Workspace ws)
inline

Sleeps until time has been reached.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127258 of file autoarts.h.

◆ TMatrixTest()

MRecord ARTS::AgendaMethod::TMatrixTest ( [[maybe_unused] ] Workspace ws)
inline

T-Matrix validation test.

Executes the standard test included with the T-Matrix Fortran code. Should give the same as running the tmatrix_lp executable in 3rdparty/tmatrix/.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129673 of file autoarts.h.

◆ Touch() [1/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::AbsorptionLines  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129702 of file autoarts.h.

References ARTS::Var::AbsorptionLines::islast(), and ARTS::Var::AbsorptionLines::pos().

◆ Touch() [2/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Agenda  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129736 of file autoarts.h.

References ARTS::Var::Agenda::islast(), and ARTS::Var::Agenda::pos().

◆ Touch() [3/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAbsorptionLines  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129770 of file autoarts.h.

References ARTS::Var::ArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfAbsorptionLines::pos().

◆ Touch() [4/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfAgenda  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129838 of file autoarts.h.

References ARTS::Var::ArrayOfAgenda::islast(), and ARTS::Var::ArrayOfAgenda::pos().

◆ Touch() [5/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfAbsorptionLines  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129804 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfAbsorptionLines::islast(), and ARTS::Var::ArrayOfArrayOfAbsorptionLines::pos().

◆ Touch() [6/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField1  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129872 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField1::pos().

◆ Touch() [7/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField2  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129906 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField2::pos().

◆ Touch() [8/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfGriddedField3  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129940 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfArrayOfGriddedField3::pos().

◆ Touch() [9/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfIndex  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 129974 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfIndex::islast(), and ARTS::Var::ArrayOfArrayOfIndex::pos().

◆ Touch() [10/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfMatrix  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130008 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfMatrix::islast(), and ARTS::Var::ArrayOfArrayOfMatrix::pos().

◆ Touch() [11/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfPropagationMatrix  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130076 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfArrayOfPropagationMatrix::pos().

◆ Touch() [12/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfRadiationVector  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130110 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfArrayOfRadiationVector::pos().

◆ Touch() [13/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfScatteringMetaData  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130144 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfArrayOfScatteringMetaData::pos().

◆ Touch() [14/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSingleScatteringData  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130178 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfArrayOfSingleScatteringData::pos().

◆ Touch() [15/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfSpeciesTag  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130212 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfSpeciesTag::islast(), and ARTS::Var::ArrayOfArrayOfSpeciesTag::pos().

◆ Touch() [16/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfStokesVector  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130246 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfArrayOfStokesVector::pos().

◆ Touch() [17/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfString  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130280 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfString::islast(), and ARTS::Var::ArrayOfArrayOfString::pos().

◆ Touch() [18/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor3  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130314 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor3::islast(), and ARTS::Var::ArrayOfArrayOfTensor3::pos().

◆ Touch() [19/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTensor6  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130348 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTensor6::islast(), and ARTS::Var::ArrayOfArrayOfTensor6::pos().

◆ Touch() [20/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTime  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130382 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTime::islast(), and ARTS::Var::ArrayOfArrayOfTime::pos().

◆ Touch() [21/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfTransmissionMatrix  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130416 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfArrayOfTransmissionMatrix::pos().

◆ Touch() [22/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfArrayOfVector  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130450 of file autoarts.h.

References ARTS::Var::ArrayOfArrayOfVector::islast(), and ARTS::Var::ArrayOfArrayOfVector::pos().

◆ Touch() [23/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfCIARecord  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130484 of file autoarts.h.

References ARTS::Var::ArrayOfCIARecord::islast(), and ARTS::Var::ArrayOfCIARecord::pos().

◆ Touch() [24/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField1  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130518 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField1::islast(), and ARTS::Var::ArrayOfGriddedField1::pos().

◆ Touch() [25/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField2  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130552 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField2::islast(), and ARTS::Var::ArrayOfGriddedField2::pos().

◆ Touch() [26/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField3  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130586 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField3::islast(), and ARTS::Var::ArrayOfGriddedField3::pos().

◆ Touch() [27/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfGriddedField4  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130620 of file autoarts.h.

References ARTS::Var::ArrayOfGriddedField4::islast(), and ARTS::Var::ArrayOfGriddedField4::pos().

◆ Touch() [28/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfIndex  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130654 of file autoarts.h.

References ARTS::Var::ArrayOfIndex::islast(), and ARTS::Var::ArrayOfIndex::pos().

◆ Touch() [29/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfMatrix  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130688 of file autoarts.h.

References ARTS::Var::ArrayOfMatrix::islast(), and ARTS::Var::ArrayOfMatrix::pos().

◆ Touch() [30/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPpath  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130042 of file autoarts.h.

References ARTS::Var::ArrayOfPpath::islast(), and ARTS::Var::ArrayOfPpath::pos().

◆ Touch() [31/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfPropagationMatrix  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130722 of file autoarts.h.

References ARTS::Var::ArrayOfPropagationMatrix::islast(), and ARTS::Var::ArrayOfPropagationMatrix::pos().

◆ Touch() [32/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfQuantumIdentifier  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130756 of file autoarts.h.

References ARTS::Var::ArrayOfQuantumIdentifier::islast(), and ARTS::Var::ArrayOfQuantumIdentifier::pos().

◆ Touch() [33/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRadiationVector  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130790 of file autoarts.h.

References ARTS::Var::ArrayOfRadiationVector::islast(), and ARTS::Var::ArrayOfRadiationVector::pos().

◆ Touch() [34/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfRetrievalQuantity  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130824 of file autoarts.h.

References ARTS::Var::ArrayOfRetrievalQuantity::islast(), and ARTS::Var::ArrayOfRetrievalQuantity::pos().

◆ Touch() [35/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfScatteringMetaData  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130858 of file autoarts.h.

References ARTS::Var::ArrayOfScatteringMetaData::islast(), and ARTS::Var::ArrayOfScatteringMetaData::pos().

◆ Touch() [36/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSingleScatteringData  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130892 of file autoarts.h.

References ARTS::Var::ArrayOfSingleScatteringData::islast(), and ARTS::Var::ArrayOfSingleScatteringData::pos().

◆ Touch() [37/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfSparse  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130926 of file autoarts.h.

References ARTS::Var::ArrayOfSparse::islast(), and ARTS::Var::ArrayOfSparse::pos().

◆ Touch() [38/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfStokesVector  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130960 of file autoarts.h.

References ARTS::Var::ArrayOfStokesVector::islast(), and ARTS::Var::ArrayOfStokesVector::pos().

◆ Touch() [39/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfString  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 130994 of file autoarts.h.

References ARTS::Var::ArrayOfString::islast(), and ARTS::Var::ArrayOfString::pos().

◆ Touch() [40/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTelsemAtlas  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131028 of file autoarts.h.

References ARTS::Var::ArrayOfTelsemAtlas::islast(), and ARTS::Var::ArrayOfTelsemAtlas::pos().

◆ Touch() [41/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor3  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131062 of file autoarts.h.

References ARTS::Var::ArrayOfTensor3::islast(), and ARTS::Var::ArrayOfTensor3::pos().

◆ Touch() [42/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor4  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131096 of file autoarts.h.

References ARTS::Var::ArrayOfTensor4::islast(), and ARTS::Var::ArrayOfTensor4::pos().

◆ Touch() [43/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor5  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131130 of file autoarts.h.

References ARTS::Var::ArrayOfTensor5::islast(), and ARTS::Var::ArrayOfTensor5::pos().

◆ Touch() [44/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor6  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131164 of file autoarts.h.

References ARTS::Var::ArrayOfTensor6::islast(), and ARTS::Var::ArrayOfTensor6::pos().

◆ Touch() [45/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTensor7  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131198 of file autoarts.h.

References ARTS::Var::ArrayOfTensor7::islast(), and ARTS::Var::ArrayOfTensor7::pos().

◆ Touch() [46/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTime  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131232 of file autoarts.h.

References ARTS::Var::ArrayOfTime::islast(), and ARTS::Var::ArrayOfTime::pos().

◆ Touch() [47/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfTransmissionMatrix  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131266 of file autoarts.h.

References ARTS::Var::ArrayOfTransmissionMatrix::islast(), and ARTS::Var::ArrayOfTransmissionMatrix::pos().

◆ Touch() [48/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfVector  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131300 of file autoarts.h.

References ARTS::Var::ArrayOfVector::islast(), and ARTS::Var::ArrayOfVector::pos().

◆ Touch() [49/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ArrayOfXsecRecord  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131334 of file autoarts.h.

References ARTS::Var::ArrayOfXsecRecord::islast(), and ARTS::Var::ArrayOfXsecRecord::pos().

◆ Touch() [50/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::CIARecord  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131368 of file autoarts.h.

References ARTS::Var::CIARecord::islast(), and ARTS::Var::CIARecord::pos().

◆ Touch() [51/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::CovarianceMatrix  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131402 of file autoarts.h.

References ARTS::Var::CovarianceMatrix::islast(), and ARTS::Var::CovarianceMatrix::pos().

◆ Touch() [52/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::EnergyLevelMap  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131436 of file autoarts.h.

References ARTS::Var::EnergyLevelMap::islast(), and ARTS::Var::EnergyLevelMap::pos().

◆ Touch() [53/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::GasAbsLookup  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131470 of file autoarts.h.

References ARTS::Var::GasAbsLookup::islast(), and ARTS::Var::GasAbsLookup::pos().

◆ Touch() [54/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::GriddedField1  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131538 of file autoarts.h.

References ARTS::Var::GriddedField1::islast(), and ARTS::Var::GriddedField1::pos().

◆ Touch() [55/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::GriddedField2  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131572 of file autoarts.h.

References ARTS::Var::GriddedField2::islast(), and ARTS::Var::GriddedField2::pos().

◆ Touch() [56/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::GriddedField3  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131606 of file autoarts.h.

References ARTS::Var::GriddedField3::islast(), and ARTS::Var::GriddedField3::pos().

◆ Touch() [57/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::GriddedField4  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131640 of file autoarts.h.

References ARTS::Var::GriddedField4::islast(), and ARTS::Var::GriddedField4::pos().

◆ Touch() [58/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::GriddedField5  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131674 of file autoarts.h.

References ARTS::Var::GriddedField5::islast(), and ARTS::Var::GriddedField5::pos().

◆ Touch() [59/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::GriddedField6  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131708 of file autoarts.h.

References ARTS::Var::GriddedField6::islast(), and ARTS::Var::GriddedField6::pos().

◆ Touch() [60/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::GridPos  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131504 of file autoarts.h.

References ARTS::Var::GridPos::islast(), and ARTS::Var::GridPos::pos().

◆ Touch() [61/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::HitranRelaxationMatrixData  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131742 of file autoarts.h.

References ARTS::Var::HitranRelaxationMatrixData::islast(), and ARTS::Var::HitranRelaxationMatrixData::pos().

◆ Touch() [62/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Index  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131776 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ Touch() [63/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Matrix  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131844 of file autoarts.h.

References ARTS::Var::Matrix::islast(), and ARTS::Var::Matrix::pos().

◆ Touch() [64/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::MCAntenna  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131810 of file autoarts.h.

References ARTS::Var::MCAntenna::islast(), and ARTS::Var::MCAntenna::pos().

◆ Touch() [65/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Numeric  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131878 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ Touch() [66/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Ppath  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131912 of file autoarts.h.

References ARTS::Var::Ppath::islast(), and ARTS::Var::Ppath::pos().

◆ Touch() [67/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::PropagationMatrix  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131946 of file autoarts.h.

References ARTS::Var::PropagationMatrix::islast(), and ARTS::Var::PropagationMatrix::pos().

◆ Touch() [68/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::QuantumIdentifier  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 131980 of file autoarts.h.

References ARTS::Var::QuantumIdentifier::islast(), and ARTS::Var::QuantumIdentifier::pos().

◆ Touch() [69/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::RadiationVector  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132014 of file autoarts.h.

References ARTS::Var::RadiationVector::islast(), and ARTS::Var::RadiationVector::pos().

◆ Touch() [70/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Rational  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132048 of file autoarts.h.

References ARTS::Var::Rational::islast(), and ARTS::Var::Rational::pos().

◆ Touch() [71/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::ScatteringMetaData  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132082 of file autoarts.h.

References ARTS::Var::ScatteringMetaData::islast(), and ARTS::Var::ScatteringMetaData::pos().

◆ Touch() [72/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::SingleScatteringData  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132116 of file autoarts.h.

References ARTS::Var::SingleScatteringData::islast(), and ARTS::Var::SingleScatteringData::pos().

◆ Touch() [73/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Sparse  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132150 of file autoarts.h.

References ARTS::Var::Sparse::islast(), and ARTS::Var::Sparse::pos().

◆ Touch() [74/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::SpeciesAuxData  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132184 of file autoarts.h.

References ARTS::Var::SpeciesAuxData::islast(), and ARTS::Var::SpeciesAuxData::pos().

◆ Touch() [75/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::StokesVector  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132218 of file autoarts.h.

References ARTS::Var::StokesVector::islast(), and ARTS::Var::StokesVector::pos().

◆ Touch() [76/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::String  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132252 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ Touch() [77/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::TelsemAtlas  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132286 of file autoarts.h.

References ARTS::Var::TelsemAtlas::islast(), and ARTS::Var::TelsemAtlas::pos().

◆ Touch() [78/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Tensor3  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132320 of file autoarts.h.

References ARTS::Var::Tensor3::islast(), and ARTS::Var::Tensor3::pos().

◆ Touch() [79/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Tensor4  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132354 of file autoarts.h.

References ARTS::Var::Tensor4::islast(), and ARTS::Var::Tensor4::pos().

◆ Touch() [80/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Tensor5  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132388 of file autoarts.h.

References ARTS::Var::Tensor5::islast(), and ARTS::Var::Tensor5::pos().

◆ Touch() [81/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Tensor6  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132422 of file autoarts.h.

References ARTS::Var::Tensor6::islast(), and ARTS::Var::Tensor6::pos().

◆ Touch() [82/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Tensor7  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132456 of file autoarts.h.

References ARTS::Var::Tensor7::islast(), and ARTS::Var::Tensor7::pos().

◆ Touch() [83/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::TessemNN  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132558 of file autoarts.h.

References ARTS::Var::TessemNN::islast(), and ARTS::Var::TessemNN::pos().

◆ Touch() [84/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Time  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132524 of file autoarts.h.

References ARTS::Var::Time::islast(), and ARTS::Var::Time::pos().

◆ Touch() [85/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Timer  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132490 of file autoarts.h.

References ARTS::Var::Timer::islast(), and ARTS::Var::Timer::pos().

◆ Touch() [86/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::TransmissionMatrix  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132592 of file autoarts.h.

References ARTS::Var::TransmissionMatrix::islast(), and ARTS::Var::TransmissionMatrix::pos().

◆ Touch() [87/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Vector  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132626 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ Touch() [88/88]

MRecord ARTS::AgendaMethod::Touch ( [[maybe_unused] ] Workspace ws,
Var::Verbosity  in 
)
inline

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about not-produced output workspace variables.

What it does, in case the variable is initialized already, is: Nothing! In case the variable is not yet initialized, it is set to NaN.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[out]in- Variable to do nothing with.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132660 of file autoarts.h.

References ARTS::Var::Verbosity::islast(), and ARTS::Var::Verbosity::pos().

◆ transmittanceFromIy_aux()

MRecord ARTS::AgendaMethod::transmittanceFromIy_aux ( [[maybe_unused] ] Workspace ws,
Var::Vector  transmittance 
)
inline

Creates a vector of transmittance values.

The transmittances are set based on optical depths in iy_aux. That is, one of the quantities in iy_aux must be "Optical depth".

The created vector has a length matching f_grid and can e.g. be used as input to some of the FASTEM methods.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]transmittance- Created vector of transmittance values.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132693 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ VectorAddScalar()

MRecord ARTS::AgendaMethod::VectorAddScalar ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Vector  in,
const Var::Numeric  value 
)
inline

Adds a scalar to all elements of a vector.

The result can either be stored in the same or another vector.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output vector
[in]in- Input vector.
[in]value- The value to be added to the vector.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132724 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Vector::pos().

◆ VectorAddVector()

MRecord ARTS::AgendaMethod::VectorAddVector ( [[maybe_unused] ] Workspace ws,
Var::Vector  c,
const Var::Vector  a,
const Var::Vector  b 
)
inline

Element-wise addition of two vectors.

The method calculates c = a + b.

The variable b is allowed to have length 1, for any length of a*. This single value in b is then added to every element of a.

The vectors a and c can be the same WSV, while b can not be the same WSV as any of the the other vector.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]c- Output vector
[in]a- Input vector.
[in]b- Vector to be added.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132767 of file autoarts.h.

◆ VectorCrop()

MRecord ARTS::AgendaMethod::VectorCrop ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Vector  in,
const Var::Numeric min_value = {},
const Var::Numeric max_value = {} 
)
inline

Keeps only values of a vector inside the specified range.

All values outside the range [min_value,max-value] are removed. Note the default values, that basically should act as -+Inf.

The result can either be stored in the same or another vector.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Cropped vector
[in]in- Original vector
[in]min_value- Minimum value to keep (default: -99e99)
[in]max_value- Maximum value to keep (default: 99e99)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132808 of file autoarts.h.

◆ VectorExtractFromMatrix()

MRecord ARTS::AgendaMethod::VectorExtractFromMatrix ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Matrix  in,
const Var::Index  i,
const Var::String  direction 
)
inline

Extracts a Vector from a Matrix.

Copies row or column with given Index from input Matrix variable to create output Vector.

Author
Patrick Eriksson, Oliver Lemke, Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Extracted vector.
[in]in- Input matrix.
[in]i- Index of row or column.
[in]direction- Direction. "row" or "column".

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132856 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::Matrix::islast(), ARTS::Var::String::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Index::pos(), ARTS::Var::Matrix::pos(), ARTS::Var::String::pos(), and ARTS::Var::Vector::pos().

◆ VectorFlip()

MRecord ARTS::AgendaMethod::VectorFlip ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Vector  in 
)
inline

Flips a vector.

The output is the input vector in reversed order. The result can either be stored in the same or another vector.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output vector.
[in]in- Input vector.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132896 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ VectorInsertGridPoints()

MRecord ARTS::AgendaMethod::VectorInsertGridPoints ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Vector  in,
const Var::Vector  points 
)
inline

Insert some additional points into a grid.

This method can for example be used to add line center frequencies to a regular frequency grid. If the original grid is [1,2,3], and the additional points are [2.2,2.4], the result will be [1,2,2.2,2.4,3].

It is assumed that the original grid is sorted, otherwise a runtime error is thrown. The vector with the points to insert does not have to be sorted. If some of the input points are already in the grid, these points are not inserted again. New points outside the original grid are appended at the appropriate end. Input vector and output vector can be the same.

Generic output: Vector : The new grid vector.

Generic input: Vector : The original grid vector. Vector : The points to insert.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The new grid vector
[in]in- The original grid vector
[in]points- The points to insert

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132946 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ VectorLinSpace()

MRecord ARTS::AgendaMethod::VectorLinSpace ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Numeric  start,
const Var::Numeric  stop,
const Var::Numeric  step 
)
inline

Initializes a vector with linear spacing.

The first element equals always the start value, and the spacing equals always the step value, but the last value can deviate from the stop value. step can be both positive and negative.

The created vector is [start, start+step, start+2*step, ...]

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output vector.
[in]start- Start value.
[in]stop- Maximum/minimum value of the end value
[in]step- Spacing of the vector.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 132988 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Numeric::pos(), ARTS::Var::Vector::pos(), and Zeeman::start().

◆ VectorLogSpace()

MRecord ARTS::AgendaMethod::VectorLogSpace ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Numeric  start,
const Var::Numeric  stop,
const Var::Numeric  step 
)
inline

Initializes a vector with logarithmic spacing.

The first element equals always the start value, and the spacing equals always the step value, but note that the last value can deviate from the stop value. The keyword step can be both positive and negative.

Note, that although start has to be given in direct coordinates, step has to be given in log coordinates.

Explicitly, the vector is: exp([ln(start), ln(start)+step, ln(start)+2*step, ...])

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]start- The start value. (Direct coordinates!)
[in]stop- The maximum value of the end value. (Direct coordinates!)
[in]step- The spacing of the vector. (Log coordinates!)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133038 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Numeric::pos(), ARTS::Var::Vector::pos(), and Zeeman::start().

◆ VectorMatrixMultiply()

MRecord ARTS::AgendaMethod::VectorMatrixMultiply ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Matrix  m,
const Var::Vector  v 
)
inline

Multiply a Vector with a Matrix and store the result in another Vector.

This just computes the normal Matrix-Vector product, y=M*x. It is ok if input and output Vector are the same. This function is handy for multiplying the H Matrix to spectra.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The result of the multiplication (dimension m).
[in]m- The Matrix to multiply (dimension mxn).
[in]v- The original Vector (dimension n).

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133081 of file autoarts.h.

References ARTS::Var::Matrix::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Matrix::pos(), and ARTS::Var::Vector::pos().

◆ VectorNLinSpace()

MRecord ARTS::AgendaMethod::VectorNLinSpace ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Numeric  start,
const Var::Numeric  stop 
)
inline

Creates a vector with length nelem, equally spaced between the given end values.

The length (nelem) must be larger than 1.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]start- Start value.
[in]stop- End value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133119 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Numeric::pos(), ARTS::Var::Vector::pos(), and Zeeman::start().

◆ VectorNLogSpace()

MRecord ARTS::AgendaMethod::VectorNLogSpace ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Numeric  start,
const Var::Numeric  stop 
)
inline

Creates a vector with length nelem, equally logarithmically spaced between the given end values.

The length (nelem) must be larger than 1.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]start- Start value.
[in]stop- End value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133157 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Numeric::pos(), ARTS::Var::Vector::pos(), and Zeeman::start().

◆ VectorReshapeMatrix()

MRecord ARTS::AgendaMethod::VectorReshapeMatrix ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Matrix  in,
const Var::String direction = {} 
)
inline

Converts a Matrix to a Vector.

The matrix is reshaped into a vector. That is, all elements of the matrix are kept. The elements can be extracted both in column (default) and row order. The ouput vector has the same length for both options.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Created vector.
[in]in- Input matrix.
[in]direction- Direction. "row" or "column". (default: "column")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133196 of file autoarts.h.

◆ VectorScale()

MRecord ARTS::AgendaMethod::VectorScale ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Vector  in,
const Var::Numeric  value 
)
inline

Scales all elements of a vector with the same value.

The result can either be stored in the same or another vector.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Output vector.
[in]in- Input vector.
[in]value- Scaling value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133236 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Vector::pos().

◆ VectorSet()

MRecord ARTS::AgendaMethod::VectorSet ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Vector  value 
)
inline

Create a vector from the given list of numbers.

VectorSet(p_grid, [1000, 100, 10] ) Will create a p_grid vector with these three elements.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- The vector elements.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133306 of file autoarts.h.

References ARTS::Var::Vector::islast(), ARTS::Var::Vector::pos(), and ARTS::Var::Vector::value().

◆ VectorSetConstant()

MRecord ARTS::AgendaMethod::VectorSetConstant ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Numeric  value 
)
inline

Creates a vector and sets all elements to the specified value.

The vector length is determined by nelem.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- Variable to initialize.
[in]value- Vector value.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133272 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::Vector::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::Vector::pos().

◆ VectorSubtractVector()

MRecord ARTS::AgendaMethod::VectorSubtractVector ( [[maybe_unused] ] Workspace ws,
Var::Vector  c,
const Var::Vector  a,
const Var::Vector  b 
)
inline

Element-wise subtraction of two vectors.

The method calculates c = a - b.

The variable b is allowed to have length 1, for any length of a*. This single value in b is then added to every element of a.

The vectors a and c can be the same WSV, while b can not be the same WSV as any of the the other vector.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[out]c- Output vector
[in]a- Input vector.
[in]b- Vector to be subtracted.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133346 of file autoarts.h.

◆ VectorVectorMultiply()

MRecord ARTS::AgendaMethod::VectorVectorMultiply ( [[maybe_unused] ] Workspace ws,
Var::Vector  out,
const Var::Vector  v1,
const Var::Vector  v2 
)
inline

Multiply a Vector with another Vector and store result in a third one.

This is an element-wise multiplication. It is ok if output Vector is the same as any of the input Vectors.

Author
Jana Mendrok
Parameters
[in,out]Workspacews - An ARTS workspace
[out]out- The result of the multiplication (dimension m).
[in]v1- Original Vector #1 (dimension m).
[in]v2- Original Vector #2 (dimension m).

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133384 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ VectorZtanToZa1D()

MRecord ARTS::AgendaMethod::VectorZtanToZa1D ( [[maybe_unused] ] Workspace ws,
Var::Vector  v_za,
const Var::Vector  v_ztan 
)
inline

Converts a set of geometrical tangent altitudes to zenith angles.

The tangent altitudes are given to the function as a vector, which are converted to a generic vector of zenith angles. The position of the sensor is given by the WSV sensor_pos. The function works only for 1D. The zenith angles are always set to be positive.

Author
Patrick Eriksson
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]v_za- Vector with zenith angles.
[in]v_ztan- Vector with tangent altitudes.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133461 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ VectorZtanToZaRefr1D()

MRecord ARTS::AgendaMethod::VectorZtanToZaRefr1D ( [[maybe_unused] ] Workspace ws,
Var::Vector  v_za,
const Var::Vector  v_ztan 
)
inline

Converts a set of true tangent altitudes to zenith angles.

The tangent altitudes are given to the function as a vector, which are converted to a generic vector of zenith angles. The position of the sensor is given by the WSV sensor_pos. The function works only for 1D. The zenith angles are always set to be positive.

Author
Patrick Eriksson
Mattias Ekstrom
Parameters
[in,out]Workspacews - An ARTS workspace
[out]v_za- Vector with zenith angles.
[in]v_ztan- Vector with tangent altitudes.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133424 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ verbosityInit()

MRecord ARTS::AgendaMethod::verbosityInit ( [[maybe_unused] ] Workspace ws)
inline

Initializes the verbosity levels.

Sets verbosity to defaults or the levels specified by -r on the command line.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133492 of file autoarts.h.

◆ verbositySet()

MRecord ARTS::AgendaMethod::verbositySet ( [[maybe_unused] ] Workspace ws,
const Var::Index  agenda,
const Var::Index  screen,
const Var::Index  file 
)
inline

Sets the verbosity levels.

Sets the reporting level for agenda calls, screen and file. All reporting levels can reach from 0 (only error messages) to 3 (everything). The agenda setting applies in addition to both screen and file output.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]agenda- Agenda verbosity level
[in]screen- Screen verbosity level
[in]file- Report file verbosity level

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133521 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ verbositySetAgenda()

MRecord ARTS::AgendaMethod::verbositySetAgenda ( [[maybe_unused] ] Workspace ws,
const Var::Index  level 
)
inline

Sets the verbosity level for agenda output.

See verbositySet

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]level- Agenda verbosity level

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133556 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ verbositySetFile()

MRecord ARTS::AgendaMethod::verbositySetFile ( [[maybe_unused] ] Workspace ws,
const Var::Index  level 
)
inline

Sets the verbosity level for report file output.

See verbositySet

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]level- Report file verbosity level

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133585 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ verbositySetScreen()

MRecord ARTS::AgendaMethod::verbositySetScreen ( [[maybe_unused] ] Workspace ws,
const Var::Index  level 
)
inline

Sets the verbosity level for screen output.

See verbositySet

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]level- Screen verbosity level

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133614 of file autoarts.h.

References ARTS::Var::Index::islast(), and ARTS::Var::Index::pos().

◆ vmr_fieldClip()

MRecord ARTS::AgendaMethod::vmr_fieldClip ( [[maybe_unused] ] Workspace ws,
const Var::String  species,
const Var::Numeric limit_low = {},
const Var::Numeric limit_high = {} 
)
inline

Clipping of vmr_field.

The method allows you to apply hard limits the values of vmr_field. All values, of the species selected, below limit_low, are simply set to limit_low. And the same is performed with respect to limit_high*. That is, the data in x for the retrieval quantity are forced to be inside the range [limit_low,limit_high].

Setting species="ALL", is a shortcut for applying the limits on all species.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]species- Name of species to consider, or "ALL".
[in]limit_low- Lower limit for clipping. (default: -std::numeric_limits<Numeric>::infinity())
[in]limit_high- Upper limit for clipping. (default: std::numeric_limits<Numeric>::infinity())

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133652 of file autoarts.h.

◆ vmr_fieldPerturb()

MRecord ARTS::AgendaMethod::vmr_fieldPerturb ( [[maybe_unused] ] Workspace ws,
const Var::String  species,
const Var::Vector  p_ret_grid,
const Var::Vector  lat_ret_grid,
const Var::Vector  lon_ret_grid,
const Var::Index  pert_index,
const Var::Numeric  pert_size,
const Var::String pert_mode = {} 
)
inline

Adds a perturbation to vmr_field.

Works as AtmFieldPerturb but acts on vmr_field.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]species- Name of species to perturb.
[in]p_ret_grid- Pressure retrieval grid.
[in]lat_ret_grid- Latitude retrieval grid.
[in]lon_ret_grid- Longitude retrieval grid.
[in]pert_index- Index of position where the perturbation shall be performed.
[in]pert_size- Size of perturbation.
[in]pert_mode- Type of perturbation, ansolute or relative. (default: "absolute")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133699 of file autoarts.h.

◆ vmr_fieldPerturbAtmGrids()

MRecord ARTS::AgendaMethod::vmr_fieldPerturbAtmGrids ( [[maybe_unused] ] Workspace ws,
const Var::String  species,
const Var::Index  pert_index,
const Var::Numeric  pert_size,
const Var::String pert_mode = {} 
)
inline

Adds a perturbation to vmr_field.

Works as AtmFieldPerturbAtmGrids but acts on vmr_field.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]species- Name of species to perturb.
[in]pert_index- Index of position where the perturbation shall be performed.
[in]pert_size- Size of perturbation.
[in]pert_mode- Type of perturbation, ansolute or relative. (default: "absolute")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133752 of file autoarts.h.

◆ vmr_fieldSetAllConstant()

MRecord ARTS::AgendaMethod::vmr_fieldSetAllConstant ( [[maybe_unused] ] Workspace ws,
const Var::Vector  vmr_values 
)
inline

Sets the VMR of all species to a select constant value.

The vmr_field WSM must have a correct size before calling this method. The length of vmr_values and of abs_species must match.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]vmr_values- VMR value to apply for each abs_species.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133794 of file autoarts.h.

References ARTS::Var::Vector::islast(), and ARTS::Var::Vector::pos().

◆ vmr_fieldSetConstant()

MRecord ARTS::AgendaMethod::vmr_fieldSetConstant ( [[maybe_unused] ] Workspace ws,
const Var::String  species,
const Var::Numeric  vmr_value 
)
inline

Sets the VMR of a species to a constant value.

The vmr_field WSM must have a correct size before calling this method.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]species- Species to set.
[in]vmr_value- VMR value to apply for the selected species.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133854 of file autoarts.h.

References ARTS::Var::Numeric::islast(), ARTS::Var::String::islast(), ARTS::Var::Numeric::pos(), and ARTS::Var::String::pos().

◆ water_p_eq_fieldMK05()

MRecord ARTS::AgendaMethod::water_p_eq_fieldMK05 ( [[maybe_unused] ] Workspace ws)
inline

Calculates water_p_eq_field according to Murphy and Koop, 2005.

The saturation pressure is set to the one with respect to water at temperatures >= 0C, and to the one with respect to ice for <0C.

The saturation pressure with respect to liquid and ice water is calculated according to Eq. 10 and 7, respectively, of: Murphy, D. M., & Koop, T. (2005). Review of the vapour pressures of ice and supercooled water for atmospheric applications. Quarterly Journal of the Royal Meteorological Society, 131(608), 1539-1565.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133829 of file autoarts.h.

◆ Wigner3Init()

MRecord ARTS::AgendaMethod::Wigner3Init ( [[maybe_unused] ] Workspace ws,
const Var::Index fast_wigner_stored_symbols = {},
const Var::Index largest_wigner_symbol_parameter = {} 
)
inline

Initialize the wigner 3 tables

The default values take about 400 Mb memory.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]fast_wigner_stored_symbols- Number of stored symbols possible before replacements (default: 20000000)
[in]largest_wigner_symbol_parameter- Largest symbol used for initializing factorials (e.g., largest J or L) (default: 250)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133926 of file autoarts.h.

◆ Wigner3Unload()

MRecord ARTS::AgendaMethod::Wigner3Unload ( [[maybe_unused] ] Workspace ws)
inline

Unloads the wigner 3 tables

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133982 of file autoarts.h.

◆ Wigner6Init()

MRecord ARTS::AgendaMethod::Wigner6Init ( [[maybe_unused] ] Workspace ws,
const Var::Index fast_wigner_stored_symbols = {},
const Var::Index largest_wigner_symbol_parameter = {} 
)
inline

Initialize the wigner 3 and 6 tables

The default values take about 1 Gb memory.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]fast_wigner_stored_symbols- Number of stored symbols possible before replacements (default: 20000000)
[in]largest_wigner_symbol_parameter- Largest symbol used for initializing factorials (e.g., largest J or L) (default: 250)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133887 of file autoarts.h.

◆ Wigner6Unload()

MRecord ARTS::AgendaMethod::Wigner6Unload ( [[maybe_unused] ] Workspace ws)
inline

Unloads the wigner 3 and 6 tables

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 133961 of file autoarts.h.

◆ WignerFastInfoPrint()

MRecord ARTS::AgendaMethod::WignerFastInfoPrint ( [[maybe_unused] ] Workspace ws)
inline

Prints the fast wigner table information if compiled with this option

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134003 of file autoarts.h.

◆ wind_u_fieldIncludePlanetRotation()

MRecord ARTS::AgendaMethod::wind_u_fieldIncludePlanetRotation ( [[maybe_unused] ] Workspace ws)
inline

Maps the planet's rotation to an imaginary wind.

This method is of relevance if the observation platform is not following the planet's rotation, and Doppler effects must be considered. Examples include full disk observations from another planet or a satellite not in orbit of the observed planet.

The rotation of the planet is not causing any Doppler shift for 1D and 2D simulations, and the method can only be used for 3D.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134137 of file autoarts.h.

◆ WindFieldsCalc()

MRecord ARTS::AgendaMethod::WindFieldsCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index interp_order = {} 
)
inline

Interpolation of raw wind fields to calculation grids. Heritage from AtmFieldsCalc

Internally, WindFieldsCalc applies GriddedFieldPRegrid and GriddedFieldLatLonRegrid*. Generally, 'half-grid-step' extrapolation is allowed and applied.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]interp_order- Interpolation order (1=linear interpolation). (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134030 of file autoarts.h.

◆ WindFieldsCalcExpand1D()

MRecord ARTS::AgendaMethod::WindFieldsCalcExpand1D ( [[maybe_unused] ] Workspace ws,
const Var::Index interp_order = {} 
)
inline

Interpolation of 1D raw atmospheric fields to create 2D or 3D homogeneous wind fields. Derived from AtmFieldsCalcExpand1D

The method works as WindFieldsCalc, but accepts only raw 1D wind fields. The raw data is interpolated to p_grid and the obtained values are applied for all latitudes, and also longitudes for 3D, to create a homogeneous atmosphere.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]interp_order- Interpolation order (1=linear interpolation). (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134066 of file autoarts.h.

◆ WindRawRead()

MRecord ARTS::AgendaMethod::WindRawRead ( [[maybe_unused] ] Workspace ws,
const Var::String  basename 
)
inline

Reads wind field data from a scenario.

A full set of field components is read (NOTE: fails if scenario only contains selected field components). The files can be anywhere, but must all be in the same directory specified by 'basename'. Naming convention for the field component files is basename.wind_u.xml for the u-component, v- and w-components accordingly.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]basename- Name of scenario, probably including the full path. For example: "/data/wind_field"

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134103 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ WMRFSelectChannels()

MRecord ARTS::AgendaMethod::WMRFSelectChannels ( [[maybe_unused] ] Workspace ws)
inline

Select some channels for WMRF calculation.

The HIRS fast setup consists of a precalculated frequency grid covering all HIRS channels, and associated weights for each channel, stored in a weight matrix. (A sensor_response matrix.)

If not all channels are requested for simulation, then this method can be used to remove the unwanted channels. It changes a number of variables in consistent fashion:

  • Unwanted channels are removed from f_backend.
  • Unwanted channels are removed from wmrf_weights.
  • Unnecessary frequencies are removed from f_grid.
  • Unnecessary frequencies are removed from wmrf_weights.
Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134171 of file autoarts.h.

◆ WriteMolTau()

MRecord ARTS::AgendaMethod::WriteMolTau ( [[maybe_unused] ] Workspace ws,
const Var::String  filename 
)
inline

Writes a 'molecular_tau_file' as required for libRadtran.

The libRadtran (www.libradtran.org) radiative transfer package is a comprehensive package for various applications, it can be used to compute radiances, irradiances, actinic fluxes, ... for the solar and the thermal spectral ranges. Absorption is usually treated using k-distributions or other parameterizations. For calculations with high spectral resolution it requires absorption coefficients from an external line-by-line model. Using this method, arts generates a file that can be used by libRadtran (option molecular_tau_file).

Author
Claudia Emde
Parameters
[in,out]Workspacews - An ARTS workspace
[in]filename- Name of the molecular_tau_file.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134202 of file autoarts.h.

References ARTS::Var::String::islast(), and ARTS::Var::String::pos().

◆ WriteNetCDF() [1/8]

MRecord ARTS::AgendaMethod::WriteNetCDF ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  in,
const Var::String filename = {} 
)
inline

Writes a workspace variable to a NetCDF file.

This method can write variables of limited groups.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134469 of file autoarts.h.

◆ WriteNetCDF() [2/8]

MRecord ARTS::AgendaMethod::WriteNetCDF ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfVector  in,
const Var::String filename = {} 
)
inline

Writes a workspace variable to a NetCDF file.

This method can write variables of limited groups.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134430 of file autoarts.h.

◆ WriteNetCDF() [3/8]

MRecord ARTS::AgendaMethod::WriteNetCDF ( [[maybe_unused] ] Workspace ws,
const Var::GasAbsLookup  in,
const Var::String filename = {} 
)
inline

Writes a workspace variable to a NetCDF file.

This method can write variables of limited groups.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134508 of file autoarts.h.

◆ WriteNetCDF() [4/8]

MRecord ARTS::AgendaMethod::WriteNetCDF ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  in,
const Var::String filename = {} 
)
inline

Writes a workspace variable to a NetCDF file.

This method can write variables of limited groups.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134274 of file autoarts.h.

◆ WriteNetCDF() [5/8]

MRecord ARTS::AgendaMethod::WriteNetCDF ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  in,
const Var::String filename = {} 
)
inline

Writes a workspace variable to a NetCDF file.

This method can write variables of limited groups.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134313 of file autoarts.h.

◆ WriteNetCDF() [6/8]

MRecord ARTS::AgendaMethod::WriteNetCDF ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  in,
const Var::String filename = {} 
)
inline

Writes a workspace variable to a NetCDF file.

This method can write variables of limited groups.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134352 of file autoarts.h.

◆ WriteNetCDF() [7/8]

MRecord ARTS::AgendaMethod::WriteNetCDF ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  in,
const Var::String filename = {} 
)
inline

Writes a workspace variable to a NetCDF file.

This method can write variables of limited groups.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134391 of file autoarts.h.

◆ WriteNetCDF() [8/8]

MRecord ARTS::AgendaMethod::WriteNetCDF ( [[maybe_unused] ] Workspace ws,
const Var::Vector  in,
const Var::String filename = {} 
)
inline

Writes a workspace variable to a NetCDF file.

This method can write variables of limited groups.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134235 of file autoarts.h.

◆ WriteNetCDFIndexed() [1/8]

MRecord ARTS::AgendaMethod::WriteNetCDFIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  in,
const Var::String filename = {} 
)
inline

As WriteNetCDF, but creates indexed file names.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134781 of file autoarts.h.

◆ WriteNetCDFIndexed() [2/8]

MRecord ARTS::AgendaMethod::WriteNetCDFIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfVector  in,
const Var::String filename = {} 
)
inline

As WriteNetCDF, but creates indexed file names.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134742 of file autoarts.h.

◆ WriteNetCDFIndexed() [3/8]

MRecord ARTS::AgendaMethod::WriteNetCDFIndexed ( [[maybe_unused] ] Workspace ws,
const Var::GasAbsLookup  in,
const Var::String filename = {} 
)
inline

As WriteNetCDF, but creates indexed file names.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134820 of file autoarts.h.

◆ WriteNetCDFIndexed() [4/8]

MRecord ARTS::AgendaMethod::WriteNetCDFIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  in,
const Var::String filename = {} 
)
inline

As WriteNetCDF, but creates indexed file names.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134586 of file autoarts.h.

◆ WriteNetCDFIndexed() [5/8]

MRecord ARTS::AgendaMethod::WriteNetCDFIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  in,
const Var::String filename = {} 
)
inline

As WriteNetCDF, but creates indexed file names.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134625 of file autoarts.h.

◆ WriteNetCDFIndexed() [6/8]

MRecord ARTS::AgendaMethod::WriteNetCDFIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  in,
const Var::String filename = {} 
)
inline

As WriteNetCDF, but creates indexed file names.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134664 of file autoarts.h.

◆ WriteNetCDFIndexed() [7/8]

MRecord ARTS::AgendaMethod::WriteNetCDFIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  in,
const Var::String filename = {} 
)
inline

As WriteNetCDF, but creates indexed file names.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134703 of file autoarts.h.

◆ WriteNetCDFIndexed() [8/8]

MRecord ARTS::AgendaMethod::WriteNetCDFIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Vector  in,
const Var::String filename = {} 
)
inline

As WriteNetCDF, but creates indexed file names.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.nc.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the NetCDF file. (default: "")

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134547 of file autoarts.h.

◆ WriteXML() [1/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::AbsorptionLines  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134862 of file autoarts.h.

◆ WriteXML() [2/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Agenda  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134910 of file autoarts.h.

◆ WriteXML() [3/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAbsorptionLines  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 134958 of file autoarts.h.

◆ WriteXML() [4/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAgenda  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135054 of file autoarts.h.

◆ WriteXML() [5/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfAbsorptionLines  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135006 of file autoarts.h.

◆ WriteXML() [6/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField1  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135102 of file autoarts.h.

◆ WriteXML() [7/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField2  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135150 of file autoarts.h.

◆ WriteXML() [8/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField3  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135198 of file autoarts.h.

◆ WriteXML() [9/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfIndex  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135246 of file autoarts.h.

◆ WriteXML() [10/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfMatrix  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135294 of file autoarts.h.

◆ WriteXML() [11/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfPropagationMatrix  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135390 of file autoarts.h.

◆ WriteXML() [12/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfRadiationVector  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135438 of file autoarts.h.

◆ WriteXML() [13/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfScatteringMetaData  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135486 of file autoarts.h.

◆ WriteXML() [14/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSingleScatteringData  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135534 of file autoarts.h.

◆ WriteXML() [15/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSpeciesTag  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135582 of file autoarts.h.

◆ WriteXML() [16/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfStokesVector  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135630 of file autoarts.h.

◆ WriteXML() [17/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfString  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135678 of file autoarts.h.

◆ WriteXML() [18/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor3  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135726 of file autoarts.h.

◆ WriteXML() [19/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor6  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135774 of file autoarts.h.

◆ WriteXML() [20/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTime  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135822 of file autoarts.h.

◆ WriteXML() [21/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTransmissionMatrix  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135870 of file autoarts.h.

◆ WriteXML() [22/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfVector  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135918 of file autoarts.h.

◆ WriteXML() [23/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfCIARecord  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135966 of file autoarts.h.

◆ WriteXML() [24/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField1  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136014 of file autoarts.h.

◆ WriteXML() [25/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField2  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136062 of file autoarts.h.

◆ WriteXML() [26/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField3  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136110 of file autoarts.h.

◆ WriteXML() [27/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField4  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136158 of file autoarts.h.

◆ WriteXML() [28/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfIndex  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136206 of file autoarts.h.

◆ WriteXML() [29/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136254 of file autoarts.h.

◆ WriteXML() [30/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPpath  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 135342 of file autoarts.h.

◆ WriteXML() [31/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPropagationMatrix  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136302 of file autoarts.h.

◆ WriteXML() [32/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136350 of file autoarts.h.

◆ WriteXML() [33/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRadiationVector  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136398 of file autoarts.h.

◆ WriteXML() [34/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRetrievalQuantity  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136446 of file autoarts.h.

◆ WriteXML() [35/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfScatteringMetaData  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136494 of file autoarts.h.

◆ WriteXML() [36/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSingleScatteringData  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136542 of file autoarts.h.

◆ WriteXML() [37/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSparse  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136590 of file autoarts.h.

◆ WriteXML() [38/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfStokesVector  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136638 of file autoarts.h.

◆ WriteXML() [39/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136686 of file autoarts.h.

◆ WriteXML() [40/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTelsemAtlas  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136734 of file autoarts.h.

◆ WriteXML() [41/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor3  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136782 of file autoarts.h.

◆ WriteXML() [42/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor4  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136830 of file autoarts.h.

◆ WriteXML() [43/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor5  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136878 of file autoarts.h.

◆ WriteXML() [44/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor6  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136926 of file autoarts.h.

◆ WriteXML() [45/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor7  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 136974 of file autoarts.h.

◆ WriteXML() [46/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTime  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137022 of file autoarts.h.

◆ WriteXML() [47/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTransmissionMatrix  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137070 of file autoarts.h.

◆ WriteXML() [48/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfVector  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137118 of file autoarts.h.

◆ WriteXML() [49/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfXsecRecord  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137166 of file autoarts.h.

◆ WriteXML() [50/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::CIARecord  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137214 of file autoarts.h.

◆ WriteXML() [51/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::CovarianceMatrix  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137262 of file autoarts.h.

◆ WriteXML() [52/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::EnergyLevelMap  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137310 of file autoarts.h.

◆ WriteXML() [53/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::GasAbsLookup  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137358 of file autoarts.h.

◆ WriteXML() [54/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField1  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137454 of file autoarts.h.

◆ WriteXML() [55/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField2  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137502 of file autoarts.h.

◆ WriteXML() [56/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField3  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137550 of file autoarts.h.

◆ WriteXML() [57/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField4  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137598 of file autoarts.h.

◆ WriteXML() [58/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField5  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137646 of file autoarts.h.

◆ WriteXML() [59/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField6  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137694 of file autoarts.h.

◆ WriteXML() [60/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::GridPos  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137406 of file autoarts.h.

◆ WriteXML() [61/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::HitranRelaxationMatrixData  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137742 of file autoarts.h.

◆ WriteXML() [62/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Index  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137790 of file autoarts.h.

◆ WriteXML() [63/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137886 of file autoarts.h.

◆ WriteXML() [64/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::MCAntenna  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137838 of file autoarts.h.

◆ WriteXML() [65/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137934 of file autoarts.h.

◆ WriteXML() [66/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Ppath  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 137982 of file autoarts.h.

◆ WriteXML() [67/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::PropagationMatrix  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138030 of file autoarts.h.

◆ WriteXML() [68/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138078 of file autoarts.h.

◆ WriteXML() [69/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::RadiationVector  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138126 of file autoarts.h.

◆ WriteXML() [70/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Rational  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138174 of file autoarts.h.

◆ WriteXML() [71/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::ScatteringMetaData  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138222 of file autoarts.h.

◆ WriteXML() [72/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::SingleScatteringData  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138270 of file autoarts.h.

◆ WriteXML() [73/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138318 of file autoarts.h.

◆ WriteXML() [74/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::SpeciesAuxData  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138366 of file autoarts.h.

◆ WriteXML() [75/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::StokesVector  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138414 of file autoarts.h.

◆ WriteXML() [76/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::String  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138462 of file autoarts.h.

◆ WriteXML() [77/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::TelsemAtlas  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138510 of file autoarts.h.

◆ WriteXML() [78/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138558 of file autoarts.h.

◆ WriteXML() [79/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138606 of file autoarts.h.

◆ WriteXML() [80/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138654 of file autoarts.h.

◆ WriteXML() [81/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138702 of file autoarts.h.

◆ WriteXML() [82/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138750 of file autoarts.h.

◆ WriteXML() [83/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::TessemNN  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138894 of file autoarts.h.

◆ WriteXML() [84/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Time  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138846 of file autoarts.h.

◆ WriteXML() [85/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Timer  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138798 of file autoarts.h.

◆ WriteXML() [86/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::TransmissionMatrix  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138942 of file autoarts.h.

◆ WriteXML() [87/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Vector  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 138990 of file autoarts.h.

◆ WriteXML() [88/88]

MRecord ARTS::AgendaMethod::WriteXML ( [[maybe_unused] ] Workspace ws,
const Var::Verbosity  in,
const Var::String filename = {},
const Var::Index no_clobber = {} 
)
inline

Writes a workspace variable to an XML file.

This method can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml. If no_clobber is set to 1, an increasing number will be appended to the filename if the file already exists.

Author
Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Variable to be saved.
[in]filename- Name of the XML file. (default: "")
[in]no_clobber- 0: Overwrite existing files, 1: Use unique filenames (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139038 of file autoarts.h.

◆ WriteXMLIndexed() [1/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::AbsorptionLines  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139087 of file autoarts.h.

◆ WriteXMLIndexed() [2/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Agenda  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139136 of file autoarts.h.

◆ WriteXMLIndexed() [3/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAbsorptionLines  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139185 of file autoarts.h.

◆ WriteXMLIndexed() [4/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfAgenda  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139283 of file autoarts.h.

◆ WriteXMLIndexed() [5/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfAbsorptionLines  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139234 of file autoarts.h.

◆ WriteXMLIndexed() [6/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField1  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139332 of file autoarts.h.

◆ WriteXMLIndexed() [7/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField2  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139381 of file autoarts.h.

◆ WriteXMLIndexed() [8/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfGriddedField3  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139430 of file autoarts.h.

◆ WriteXMLIndexed() [9/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfIndex  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139479 of file autoarts.h.

◆ WriteXMLIndexed() [10/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfMatrix  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139528 of file autoarts.h.

◆ WriteXMLIndexed() [11/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfPropagationMatrix  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139626 of file autoarts.h.

◆ WriteXMLIndexed() [12/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfRadiationVector  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139675 of file autoarts.h.

◆ WriteXMLIndexed() [13/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfScatteringMetaData  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139724 of file autoarts.h.

◆ WriteXMLIndexed() [14/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSingleScatteringData  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139773 of file autoarts.h.

◆ WriteXMLIndexed() [15/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfSpeciesTag  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139822 of file autoarts.h.

◆ WriteXMLIndexed() [16/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfStokesVector  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139871 of file autoarts.h.

◆ WriteXMLIndexed() [17/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfString  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139920 of file autoarts.h.

◆ WriteXMLIndexed() [18/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor3  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139969 of file autoarts.h.

◆ WriteXMLIndexed() [19/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTensor6  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140018 of file autoarts.h.

◆ WriteXMLIndexed() [20/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTime  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140067 of file autoarts.h.

◆ WriteXMLIndexed() [21/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfTransmissionMatrix  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140116 of file autoarts.h.

◆ WriteXMLIndexed() [22/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfArrayOfVector  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140165 of file autoarts.h.

◆ WriteXMLIndexed() [23/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfCIARecord  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140214 of file autoarts.h.

◆ WriteXMLIndexed() [24/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField1  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140263 of file autoarts.h.

◆ WriteXMLIndexed() [25/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField2  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140312 of file autoarts.h.

◆ WriteXMLIndexed() [26/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField3  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140361 of file autoarts.h.

◆ WriteXMLIndexed() [27/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfGriddedField4  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140410 of file autoarts.h.

◆ WriteXMLIndexed() [28/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfIndex  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140459 of file autoarts.h.

◆ WriteXMLIndexed() [29/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfMatrix  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140508 of file autoarts.h.

◆ WriteXMLIndexed() [30/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPpath  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 139577 of file autoarts.h.

◆ WriteXMLIndexed() [31/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfPropagationMatrix  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140557 of file autoarts.h.

◆ WriteXMLIndexed() [32/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfQuantumIdentifier  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140606 of file autoarts.h.

◆ WriteXMLIndexed() [33/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRadiationVector  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140655 of file autoarts.h.

◆ WriteXMLIndexed() [34/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRetrievalQuantity  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140704 of file autoarts.h.

◆ WriteXMLIndexed() [35/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfScatteringMetaData  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140753 of file autoarts.h.

◆ WriteXMLIndexed() [36/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSingleScatteringData  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140802 of file autoarts.h.

◆ WriteXMLIndexed() [37/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfSparse  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140851 of file autoarts.h.

◆ WriteXMLIndexed() [38/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfStokesVector  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140900 of file autoarts.h.

◆ WriteXMLIndexed() [39/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfString  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140949 of file autoarts.h.

◆ WriteXMLIndexed() [40/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTelsemAtlas  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 140998 of file autoarts.h.

◆ WriteXMLIndexed() [41/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor3  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141047 of file autoarts.h.

◆ WriteXMLIndexed() [42/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor4  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141096 of file autoarts.h.

◆ WriteXMLIndexed() [43/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor5  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141145 of file autoarts.h.

◆ WriteXMLIndexed() [44/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor6  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141194 of file autoarts.h.

◆ WriteXMLIndexed() [45/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTensor7  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141243 of file autoarts.h.

◆ WriteXMLIndexed() [46/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTime  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141292 of file autoarts.h.

◆ WriteXMLIndexed() [47/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfTransmissionMatrix  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141341 of file autoarts.h.

◆ WriteXMLIndexed() [48/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfVector  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141390 of file autoarts.h.

◆ WriteXMLIndexed() [49/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfXsecRecord  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141439 of file autoarts.h.

◆ WriteXMLIndexed() [50/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::CIARecord  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141488 of file autoarts.h.

◆ WriteXMLIndexed() [51/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::CovarianceMatrix  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141537 of file autoarts.h.

◆ WriteXMLIndexed() [52/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::EnergyLevelMap  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141586 of file autoarts.h.

◆ WriteXMLIndexed() [53/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::GasAbsLookup  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141635 of file autoarts.h.

◆ WriteXMLIndexed() [54/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField1  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141733 of file autoarts.h.

◆ WriteXMLIndexed() [55/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField2  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141782 of file autoarts.h.

◆ WriteXMLIndexed() [56/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField3  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141831 of file autoarts.h.

◆ WriteXMLIndexed() [57/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField4  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141880 of file autoarts.h.

◆ WriteXMLIndexed() [58/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField5  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141929 of file autoarts.h.

◆ WriteXMLIndexed() [59/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::GriddedField6  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141978 of file autoarts.h.

◆ WriteXMLIndexed() [60/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::GridPos  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 141684 of file autoarts.h.

◆ WriteXMLIndexed() [61/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::HitranRelaxationMatrixData  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142027 of file autoarts.h.

◆ WriteXMLIndexed() [62/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Index  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142076 of file autoarts.h.

◆ WriteXMLIndexed() [63/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Matrix  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142174 of file autoarts.h.

◆ WriteXMLIndexed() [64/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::MCAntenna  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142125 of file autoarts.h.

◆ WriteXMLIndexed() [65/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142223 of file autoarts.h.

◆ WriteXMLIndexed() [66/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Ppath  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142272 of file autoarts.h.

◆ WriteXMLIndexed() [67/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::PropagationMatrix  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142321 of file autoarts.h.

◆ WriteXMLIndexed() [68/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::QuantumIdentifier  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142370 of file autoarts.h.

◆ WriteXMLIndexed() [69/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::RadiationVector  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142419 of file autoarts.h.

◆ WriteXMLIndexed() [70/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Rational  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142468 of file autoarts.h.

◆ WriteXMLIndexed() [71/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::ScatteringMetaData  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142517 of file autoarts.h.

◆ WriteXMLIndexed() [72/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::SingleScatteringData  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142566 of file autoarts.h.

◆ WriteXMLIndexed() [73/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Sparse  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142615 of file autoarts.h.

◆ WriteXMLIndexed() [74/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::SpeciesAuxData  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142664 of file autoarts.h.

◆ WriteXMLIndexed() [75/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::StokesVector  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142713 of file autoarts.h.

◆ WriteXMLIndexed() [76/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::String  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142762 of file autoarts.h.

◆ WriteXMLIndexed() [77/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::TelsemAtlas  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142811 of file autoarts.h.

◆ WriteXMLIndexed() [78/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Tensor3  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142860 of file autoarts.h.

◆ WriteXMLIndexed() [79/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Tensor4  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142909 of file autoarts.h.

◆ WriteXMLIndexed() [80/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Tensor5  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 142958 of file autoarts.h.

◆ WriteXMLIndexed() [81/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Tensor6  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143007 of file autoarts.h.

◆ WriteXMLIndexed() [82/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Tensor7  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143056 of file autoarts.h.

◆ WriteXMLIndexed() [83/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::TessemNN  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143203 of file autoarts.h.

◆ WriteXMLIndexed() [84/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Time  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143154 of file autoarts.h.

◆ WriteXMLIndexed() [85/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Timer  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143105 of file autoarts.h.

◆ WriteXMLIndexed() [86/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::TransmissionMatrix  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143252 of file autoarts.h.

◆ WriteXMLIndexed() [87/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Vector  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143301 of file autoarts.h.

◆ WriteXMLIndexed() [88/88]

MRecord ARTS::AgendaMethod::WriteXMLIndexed ( [[maybe_unused] ] Workspace ws,
const Var::Verbosity  in,
const Var::String filename = {},
const Var::Index digits = {} 
)
inline

As WriteXML, but creates indexed file names.

The variable is written to a file with name: <filename>.<file_index>.xml. where <file_index> is the value of file_index.

This means that filename shall here not include the .xml extension. Omitting filename works as for WriteXML.

Author
Patrick Eriksson, Oliver Lemke
Parameters
[in,out]Workspacews - An ARTS workspace
[in]in- Workspace variable to be saved.
[in]filename- File name. See above. (default: "")
[in]digits- Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143350 of file autoarts.h.

◆ x2artsAtmAndSurf()

MRecord ARTS::AgendaMethod::x2artsAtmAndSurf ( [[maybe_unused] ] Workspace ws)
inline

Maps x to atmospheric and surface variables.

Maps OEM's state vector, x, to the matching ARTS variables. This method handles atmospheric and surface variables. If you retrieve other variables, make sure that you also call x2artsSensor and/or x2artsSpectroscopy*.

The following retrieval quantities are handled by this method: Temperature Absorption species Scattering species Winds Surface variables

Should only be used inside inversion_iterate_agenda.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143487 of file autoarts.h.

◆ x2artsSensor()

MRecord ARTS::AgendaMethod::x2artsSensor ( [[maybe_unused] ] Workspace ws)
inline

Maps x to sensor variables.

Maps OEM's state vector, x, to the matching ARTS variables. This method handles variables associated with the sensor. If you retrieve other variables, make sure that you also call x2artsAtmAndSurf and/or x2artsSpectroscopy.

The following retrieval quantities are handled by this method: Pointing Frequency shift and stretch Baseline fits

Should only be used inside inversion_iterate_agenda.

Elements in x representing pointing corrections are mapped to sensor_los*. Elements representing frequency corrections are mapped to f_backend. Baseline variables are mapped to y_baseline.

The sensor response is recalculated if there is any non-zero frequency correction.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143527 of file autoarts.h.

◆ x2artsSpectroscopy()

MRecord ARTS::AgendaMethod::x2artsSpectroscopy ( [[maybe_unused] ] Workspace ws)
inline

Just defined to indicate a future extensiom.

Don't call the method, it will just generate an error.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143550 of file autoarts.h.

◆ xaStandard()

MRecord ARTS::AgendaMethod::xaStandard ( [[maybe_unused] ] Workspace ws)
inline

Standard function for creating xa.

The method creates xa based on jacobian_quantities and the various atmospheric fields. In the case of scattering species, the data are taken from particle_bulkprop_field. The following retrieval quantities are handled: Temperature Absorption species Scattering species Pointing Polynomial baseline fit Sinusoidal baseline fit

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143399 of file autoarts.h.

◆ xClip()

MRecord ARTS::AgendaMethod::xClip ( [[maybe_unused] ] Workspace ws,
const Var::Index  ijq,
const Var::Numeric limit_low = {},
const Var::Numeric limit_high = {} 
)
inline

Clipping of the state vector.

The method allows you to apply hard limits the values of a retrieval quantity. The retrieval quantity is specified by ijq*. All values of the quantity below limit_low, are simply set to limit_low. And the same is performed with respect to limit_high*. That is, the data in x for the retrieval quantity are forced to be inside the range [limit_low,limit_high].

Setting ijq=-1, is a shortcut for applying the limits on all retrieval quantities.

Notice that limits must be specified in the unit used in x.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]ijq- Retrieval quantity index (zero-based)
[in]limit_low- Lower limit for clipping. (default: -std::numeric_limits<Numeric>::infinity())
[in]limit_high- Upper limit for clipping. (default: std::numeric_limits<Numeric>::infinity())

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143435 of file autoarts.h.

◆ yActive()

MRecord ARTS::AgendaMethod::yActive ( [[maybe_unused] ] Workspace ws,
const Var::Numeric ze_tref = {},
const Var::Numeric k2 = {},
const Var::Numeric dbze_min = {} 
)
inline

Replaces yCalc for radar/lidar calculations.

The output format for iy when simulating radars and lidars differs from the standard one, and yCalc can not be used for such simulations. This method works largely as yCalc, but is tailored to handle the output from iyActiveSingleScat.

The method requires additional information about the sensor, regarding its recieving properties. First of all, recieved polarisation states are taken from instrument_pol_array. Note that this WSV allows to define several measured polarisations for each transmitted signal. For example, it is possible to simulate transmission of V and measuring backsacttered V and H.

Secondly, the range averaging is described by range_bins. These bins can either be specified in altitude or two-way travel time. In both case, the edges of the range bins shall be specified. All data (including auxiliary variables) are returned as the average inside the bins. If a bin is totally outside the model atmosphere, NaN is returned.

The options for iy_unit are: "1" : Backscatter coefficient. Unit is 1/(m*sr). At zero attenuation, this equals the scattering matrix value for the backward direction. See further AUG. "Ze" : Equivalent reflectivity. Unit is mm^6/m^3. Conversion formula is given below. "dBZe": 10*log10(Ze/Z0), where Z0 is 1 mm^6/m^3.

The conversion from backscatter coefficient to Ze is: Ze = 1e18 * lambda^4 / (k2 * pi^5) * sum(sigma), where sum(sigma) = 4 * pi * b, and b is the backscatter coefficient.

The reference dielectric factor can either specified directly by the argument k2. For example, to mimic the CloudSat data, k2 shall be set to 0.75 (citaion needed). If k2 is set to be negative (which is defualt), k2 is calculated as: k2 = abs( (n^2-1)/(n^2+2) )^2, where n is the refractive index of liquid water at temperature ze_tref* and the frequency of the radar, calculated by the MPM93 parameterization.

A lower limit for dBZe is applied (dbze_min). The main reason is to handle the fact dBZe is not defined for Ze=0, and dBZe is set to the clip value when Ze < 10^(dbze_min/10).

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]ze_tref- Reference temperature for conversion to Ze. (default: 273.15)
[in]k2- Reference dielectric factor. (default: -1)
[in]dbze_min- Clip value for dBZe. (default: -99)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 144158 of file autoarts.h.

◆ yApplySensorPol()

MRecord ARTS::AgendaMethod::yApplySensorPol ( [[maybe_unused] ] Workspace ws)
inline

Extraction of arbitrary linear polarisation.

This method shall be called after yCalc and then applies sensor_pol on the outout of yCalc. See sensor_pol for definition of the polarisation responses. THe sensor_response give to yCalc can not contain any polarisation response, it must maintain original Stokes elelemnts. The value of stokes_dim muist be >= 3.

The values in sensor_pol are applied on y, and jacobian if relevant. y_pol* is set following the values in sensor_pol but is rounded to an integer value. Remaining data associated with y (e.g. y_pos) are set to the value matching the first Stokes element.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143582 of file autoarts.h.

◆ yApplyUnit()

MRecord ARTS::AgendaMethod::yApplyUnit ( [[maybe_unused] ] Workspace ws)
inline

Conversion of y to other spectral units.

Any conversion to brightness temperature is normally made inside yCalc*. This method makes it possible to also make this conversion after yCalc, but with restrictions for jacobian and with. respect to the n2-law of radiance.

The conversion made inside iyEmissionStandard is mimiced and see that method for constraints and selection of output units. This with the restriction that the n2-law can be ignored. The later is the case if the sensor is placed in space, or if the refractive only devaites slightly from unity.

The method handles y and jacobian in parallel, where the last variable is only considered if it is set. The input data must be in original radiance units. A completely stringent check of this can not be performed.

The method can not be used with jacobian quantities that are not obtained through radiative transfer calculations. One example on quantity that can not be handled is jacobianAddPolyfit. There are no automatic checks warning for incorrect usage!

If you are using this method, iy_unit should be set to "1" when calling yCalc, and be changed before calling this method.

Conversion of y_aux is not supported.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143629 of file autoarts.h.

◆ ybatchCalc()

MRecord ARTS::AgendaMethod::ybatchCalc ( [[maybe_unused] ] Workspace ws,
const Var::Index robust = {} 
)
inline

Performs batch calculations for the measurement vector y.

We perform ybatch_n jobs, starting at index ybatch_start. (Zero based indexing, as usual.) The output array ybatch will have ybatch_n elements. Indices in the output array start with zero, independent of ybatch_start.

The method performs the following:

  1. Sets ybatch_index = ybatch_start.
  2. Performs a-d until ybatch_index* = ybatch_start + ybatch_n. a. Executes ybatch_calc_agenda. b. If ybatch_index = ybatch_start, resizes ybatch based on ybatch_n and length of y. c. Copies y to ybatch_index - ybatch_start of ybatch. d. Adds 1 to ybatch_index.

Beside the ybatch_calc_agenda, the WSVs ybatch_start and ybatch_n must be set before calling this method. Further, ybatch_calc_agenda is expected to produce a spectrum and should accordingly include a call of yCalc (or asimilar method).

The input variable ybatch_start is set to a default of zero in general.arts*.

An agenda that calculates spectra for different temperature profiles could look like this:

AgendaSet(ybatch_calc_agenda){ Extract(t_field,tensor4_1,ybatch_index) yCalc }

Jacobians are also collected, and stored in output variable ybatch_jacobians. (This will be empty if yCalc produces empty Jacobians.)

See the user guide for further practical examples.

Author
Stefan Buehler
Parameters
[in,out]Workspacews - An ARTS workspace
[in]robust- A flag with value 1 or 0. If set to one, the batch calculation will continue, even if individual jobs fail. In that case, a warning message is written to screen and file (out1 output stream), and the y Vector entry for the failed job in ybatch is left empty. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143693 of file autoarts.h.

◆ ybatchMetProfiles()

MRecord ARTS::AgendaMethod::ybatchMetProfiles ( [[maybe_unused] ] Workspace ws,
const Var::Index  nelem_p_grid,
const Var::String  met_profile_path,
const Var::String  met_profile_pnd_path 
)
inline

This method is used for simulating ARTS for metoffice model fields This method reads in met_amsu_data which contains the lat-lon of the metoffice profile files as a Matrix. It then loops over the number of profiles and corresponding to each longitude create the appropriate profile basename. Then, corresponding to each basename we have temperature field, altitude field, humidity field, and particle number density field. The temperature field and altitude field are stored in the same dimensions as t_field_raw and z_field_raw. The oxygen and nitrogen VMRs are set to constant values of 0.209 and 0.782, respectively and are used along with humidity field to generate vmr_field_raw.

The three fields t_field_raw, z_field_raw, and vmr_field_raw are given as input to met_profile_calc_agenda which is called in this method. See documentation of WSM met_profile_calc_agenda for more information on this agenda.

The method also converts satellite zenith angle to appropriate sensor_los*. It also sets the p_grid and cloudbox_limits from the profiles inside the function

Author
Sreerekha T.R.
Parameters
[in,out]Workspacews - An ARTS workspace
[in]nelem_p_grid- FIXME DOC
[in]met_profile_path- FIXME DOC
[in]met_profile_pnd_path- FIXME DOC

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143800 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::String::islast(), ARTS::Var::Index::pos(), and ARTS::Var::String::pos().

◆ ybatchMetProfilesClear()

MRecord ARTS::AgendaMethod::ybatchMetProfilesClear ( [[maybe_unused] ] Workspace ws,
const Var::Index  nelem_p_grid,
const Var::String  met_profile_path 
)
inline

This method is used for simulating ARTS for metoffice model fields for clear sky conditions.

This method reads in met_amsu_data which contains the lat-lon of the metoffice profile files as a Matrix. It then loops over the number of profiles and corresponding to each longitude create the appropriate profile basename. Then, Corresponding to each basename we have temperature field, altitude field, humidity field, and particle number density field. The temperature field and altitude field are stored in the same dimensions as t_field_raw and z_field_raw. The oxygen and nitrogen VMRs are set to constant values of 0.209 and 0.782, respectively and are used along with humidity field to generate vmr_field_raw.

The three fields t_field_raw, z_field_raw, and vmr_field_raw are given as input to met_profile_calc_agenda which is called in this method. See documentation of WSM met_profile_calc_agenda for more information on this agenda.

The method also converts satellite zenith angle to appropriate sensor_los*. It also sets the p_grid and cloudbox_limits from the profiles inside the function

Author
Seerekha T.R.
Parameters
[in,out]Workspacews - An ARTS workspace
[in]nelem_p_grid- FIXME DOC
[in]met_profile_path- FIXME DOC

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143855 of file autoarts.h.

References ARTS::Var::Index::islast(), ARTS::Var::String::islast(), ARTS::Var::Index::pos(), and ARTS::Var::String::pos().

◆ ybatchTimeAveraging()

MRecord ARTS::AgendaMethod::ybatchTimeAveraging ( [[maybe_unused] ] Workspace ws,
const Var::String  time_step,
const Var::Index disregard_first = {},
const Var::Index disregard_last = {} 
)
inline

Time average of ybatch and time_grid

Computes the internal covariance matrix in covmat_sepsbatch, and stores the number of elements per averaging in counts

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]time_step- Time step in the form "INDEX SCALE", where SCALE is "h", "min", or "s" for hours, minutes or seconds
[in]disregard_first- Flag to remove first time step (e.g., if it is an incomplete step) (default: 0)
[in]disregard_last- Flag to remove last time step (e.g., if it is an incomplete step) (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143890 of file autoarts.h.

◆ ybatchTroposphericCorrectionNaiveMedianForward()

MRecord ARTS::AgendaMethod::ybatchTroposphericCorrectionNaiveMedianForward ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfIndex  range,
const Var::Vector  trop_temp,
const Var::Numeric targ_temp = {} 
)
inline

Performs naive tropospheric corrections on ybatch

Sets ybatch_corr to be able to perform the inverse of the corrections, each array-element with 3 entries as [median, part_trans, trop_temp]

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]range- Positions where the median of the baseline is computed, if empty all is used
[in]trop_temp- Radiative temperature of the troposphere
[in]targ_temp- Temperature target of the baseline (default: 2.73)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143934 of file autoarts.h.

◆ ybatchTroposphericCorrectionNaiveMedianInverse()

MRecord ARTS::AgendaMethod::ybatchTroposphericCorrectionNaiveMedianInverse ( [[maybe_unused] ] Workspace ws)
inline

Performs inverse of naive tropospheric corrections on ybatch

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143969 of file autoarts.h.

◆ yCalc()

MRecord ARTS::AgendaMethod::yCalc ( [[maybe_unused] ] Workspace ws)
inline

Calculation of complete measurement vectors (y).

The method performs radiative transfer calculations from a sensor perspective. Radiative transfer calculations are performed for monochromatic pencil beams, following iy_main_agenda and associated agendas. Obtained radiances are weighted together by sensor_response*, to include the characteristics of the sensor. The measurement vector obtained can contain anything from a single frequency value to a series of measurement scans (each consisting of a series of spectra), all depending on the settings. Spectra and jacobians are calculated in parallel.

The frequency, polarisation etc. for each measurement value is given by y_f, y_pol, y_pos and y_los.

The content of y_aux follows iy_aux_vars. See the method selected for *iy_main_agenda for allowed choices.

The geo-positions (y_geo) are set based on sensor_response. When an antenna pattern is considered, there are several pencil beams, and thus also several goe-positions, associated with each value of y. The geo-position assigned to a value in y is the geo_pos of the pencil beam related to the highest value in sensor_response. This means that mblock_dlos_grid* must contain the bore-sight direction (0,0), if you want y_geo to exactly match the bore-sight direction.

The Jacobian provided (jacobian) is adopted to selected retrieval units, but no transformations are applied. Transformations are included by calling jacobianAdjustAndTransform.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 144018 of file autoarts.h.

◆ yCalcAppend()

MRecord ARTS::AgendaMethod::yCalcAppend ( [[maybe_unused] ] Workspace ws,
const Var::ArrayOfRetrievalQuantity  jacobian_quantities_copy,
const Var::Index append_instrument_wfs = {} 
)
inline

Replaces yCalc if a measurement shall be appended to an existing one.

The method works basically as yCalc but appends the results to existing data, instead of creating completely new y and its associated variables. This method is required if your measurement consists of data from two instruments using different observation techniques (corresponding to different iyCalc-methods). One such example is if emission and transmission data are combined into a joint retrieval. The method can also be used to get around the constrain that sensor_response is required to be the same for all data.

The new measurement is simply appended to the input y, and the other output variables are treated correspondingly. Data are appended "blindly" in y_aux. That is, data of different type are appended if iy_aux_vars differs between the two measurements, the data are appended strictly following the order. First variable of second measurement is appended to first variable of first measurement, and so on. The number of auxiliary variables can differ between the measurements. Missing data are set to zero.

The set of retrieval quantities can differ between the two calculations. If an atmospheric quantity is part of both Jacobians, the same retrieval grids must be used in both cases. The treatment of instrument related Jacobians (baseline fits, pointing ...) follows the append_instrument_wfs argument.

A difference to yCalc is that jacobian_quantities is both in- and output variable. The input version shall match the measurement to be calculated, while the output version matches the output y, the combined, measurements. A copies of jacobian_quantities of the first measurement must be made and shall be provided to the method as jacobian_quantities_copy.

As for yCalc Jacobian transformations are not handled, and the the input Jacobian shall not contain transformations. That is jacobianAdjustAndTransform* shall be called after this method, when the complete Jacobian is at hand.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]jacobian_quantities_copy- Copy of jacobian_quantities of first measurement.
[in]append_instrument_wfs- Flag controlling if instrumental weighting functions are appended or treated as different retrieval quantities. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 144079 of file autoarts.h.

◆ yColdAtmHot()

MRecord ARTS::AgendaMethod::yColdAtmHot ( [[maybe_unused] ] Workspace ws,
const Var::Vector  cold,
const Var::Vector  atm,
const Var::Vector  hot,
const Var::Numeric  cold_temp,
const Var::Numeric  hot_temp,
const Var::Index calib = {} 
)
inline

Computes y from input using standard calibration scheme of cold-atm-hot observations

If calib evaluates as true: y = cold_temp + (hot_temp - cold_temp) * (atm - cold) / (hot - cold)

If calib evaluates as false: y = (hot_temp * cold - cold_temp * hot) / (hot - cold)

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]cold- N-elem Vector of cold load linear power
[in]atm- N-elem Vector of atmosphere linear power
[in]hot- N-elem Vector of hot load linear power
[in]cold_temp- Cold load temperature
[in]hot_temp- Hot load temperature
[in]calib- Flag for calibration scheme, false means system temperature is computed (default: 1)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 143734 of file autoarts.h.

◆ ySimpleSpectrometer()

MRecord ARTS::AgendaMethod::ySimpleSpectrometer ( [[maybe_unused] ] Workspace ws,
const Var::Numeric  df 
)
inline

Converts iy to y assuming a fixed frequency resolution.

This is a short-cut, avoiding yCalc, that can be used to convert monochromatic pencil beam data to spectra with a fixed resolution.

The method mimics a spectrometer with rectangular response functions, all having the same width (df). The position of the first spectrometer channel is set to f_grid[0]+df/2. The centre frequency of channels are returned as y_f.

Auxiliary variables and *jacobian*s are not handled.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]df- Selected frequency resolution.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 144210 of file autoarts.h.

References ARTS::Var::Numeric::islast(), and ARTS::Var::Numeric::pos().

◆ z_fieldFromHSE()

MRecord ARTS::AgendaMethod::z_fieldFromHSE ( [[maybe_unused] ] Workspace ws)
inline

Force altitudes to fulfil hydrostatic equilibrium.

The method applies hydrostatic equilibrium. A mixture of "dry air" and water vapour (if present as abs_species tag) is assumed. That is, the air is assumed to be well mixed and its weight, apart from the water vapour, is constant (molarmass_dry_air). In addition, the effect of any particles (including liquid and ice particles) is neglected.

The output is an update of z_field. This variable is expected to contain approximative altitudes when calling the function. The altitude matching p_hse is kept constant. Other input altitudes can basically be arbitrary, but good estimates give quicker calculations.

The calculations are repeated until the change in altitude is below z_hse_accuracy*. An iterative process is needed as gravity varies with altitude.

For 1D and 2D, the geographical position is taken from lat_true and lon_true.

Author
Patrick Eriksson
Parameters
[in,out]Workspacews - An ARTS workspace

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 144255 of file autoarts.h.

◆ z_surfaceConstantAltitude()

MRecord ARTS::AgendaMethod::z_surfaceConstantAltitude ( [[maybe_unused] ] Workspace ws,
const Var::Numeric altitude = {} 
)
inline

Sets the surface altitude to a constant. Defaults to zero.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]altitude- The constant altitude. (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127746 of file autoarts.h.

◆ z_surfaceFromFileAndGrid()

MRecord ARTS::AgendaMethod::z_surfaceFromFileAndGrid ( [[maybe_unused] ] Workspace ws,
const Var::String  filename,
const Var::Index interp_order = {},
const Var::Index set_lowest_altitude_to_zero = {} 
)
inline

Sets the surface altitude for a given latitude and longitude grid.

Author
Richard Larsson
Parameters
[in,out]Workspacews - An ARTS workspace
[in]filename- File of GriddedField2 with surface altitudes gridded
[in]interp_order- Interpolation order (default: 1)
[in]set_lowest_altitude_to_zero- Index that sets the lowest altitude to 0 to ignore sub-surface pressures/altitudes (default: 0)

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 127707 of file autoarts.h.

◆ ZFromPSimple()

MRecord ARTS::AgendaMethod::ZFromPSimple ( [[maybe_unused] ] Workspace ws,
Var::Vector  z_grid,
const Var::Vector  p_grid 
)
inline

Simple conversion from pressure to altitude.

This function converts a vector of pressure values to an approximate vector of corresponding heights. The formula used to convert pressure to height is: z = 16000 * (5.0 - log10(p))That is, a pressure is assumed to decrease by a factor of 10 every 16km.

Note that all pressure values in the vector must be greater than 0.01.

Author
Simon Pfreundschuh
Parameters
[in,out]Workspacews - An ARTS workspace
[out]z_grid- Approximate heights of pressure grid points.
[in]p_grid- Pressure grid.

Use the ARTS documentation to read more on how the workspace is manipulated This interface function has been automatically generated

Returns
MRecord to call this method

Definition at line 108473 of file autoarts.h.

References ARTS::Var::Vector::islast(), ARTS::Var::p_grid(), and ARTS::Var::Vector::pos().