WriteXMLIndexed

Workspace.WriteXMLIndexed(self: pyarts.arts._Workspace, output_file_format: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String]] = self.output_file_format, file_index: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.file_index, input: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.AbsorptionLines, pyarts.arts.Agenda, pyarts.arts.ArrayOfAbsorptionLines, pyarts.arts.ArrayOfAgenda, pyarts.arts.ArrayOfArrayOfAbsorptionLines, pyarts.arts.ArrayOfArrayOfGriddedField1, pyarts.arts.ArrayOfArrayOfGriddedField2, pyarts.arts.ArrayOfArrayOfGriddedField3, pyarts.arts.ArrayOfArrayOfIndex, pyarts.arts.ArrayOfArrayOfMatrix, pyarts.arts.ArrayOfArrayOfPropagationMatrix, pyarts.arts.ArrayOfArrayOfRadiationVector, pyarts.arts.ArrayOfArrayOfScatteringMetaData, pyarts.arts.ArrayOfArrayOfSingleScatteringData, pyarts.arts.ArrayOfArrayOfSpeciesTag, pyarts.arts.ArrayOfArrayOfStokesVector, pyarts.arts.ArrayOfArrayOfString, pyarts.arts.ArrayOfArrayOfTensor3, pyarts.arts.ArrayOfArrayOfTensor6, pyarts.arts.ArrayOfArrayOfTime, pyarts.arts.ArrayOfArrayOfTransmissionMatrix, pyarts.arts.ArrayOfArrayOfVector, pyarts.arts.ArrayOfCIARecord, pyarts.arts.ArrayOfGriddedField1, pyarts.arts.ArrayOfGriddedField2, pyarts.arts.ArrayOfGriddedField3, pyarts.arts.ArrayOfGriddedField4, pyarts.arts.ArrayOfIndex, pyarts.arts.ArrayOfJacobianTarget, pyarts.arts.ArrayOfMatrix, pyarts.arts.ArrayOfPpath, pyarts.arts.ArrayOfPropagationMatrix, pyarts.arts.ArrayOfQuantumIdentifier, pyarts.arts.ArrayOfRadiationVector, pyarts.arts.ArrayOfRetrievalQuantity, pyarts.arts.ArrayOfScatteringMetaData, pyarts.arts.ArrayOfSingleScatteringData, pyarts.arts.ArrayOfSparse, pyarts.arts.ArrayOfSpeciesTag, pyarts.arts.ArrayOfStokesVector, pyarts.arts.ArrayOfString, pyarts.arts.ArrayOfSun, pyarts.arts.ArrayOfTelsemAtlas, pyarts.arts.ArrayOfTensor3, pyarts.arts.ArrayOfTensor4, pyarts.arts.ArrayOfTensor5, pyarts.arts.ArrayOfTensor6, pyarts.arts.ArrayOfTensor7, pyarts.arts.ArrayOfTime, pyarts.arts.ArrayOfTransmissionMatrix, pyarts.arts.ArrayOfVector, pyarts.arts.ArrayOfXsecRecord, pyarts.arts.CIARecord, pyarts.arts.CallbackFunction, pyarts.arts.CovarianceMatrix, pyarts.arts.EnergyLevelMap, pyarts.arts.GasAbsLookup, pyarts.arts.GridPos, pyarts.arts.GriddedField1, pyarts.arts.GriddedField2, pyarts.arts.GriddedField3, pyarts.arts.GriddedField4, pyarts.arts.GriddedField5, pyarts.arts.GriddedField6, pyarts.arts.HitranRelaxationMatrixData, pyarts.arts.Index, pyarts.arts.JacobianTarget, pyarts.arts.MCAntenna, pyarts.arts.MapOfErrorCorrectedSuddenData, pyarts.arts.Matrix, pyarts.arts.Numeric, pyarts.arts.Ppath, pyarts.arts.PredefinedModelData, pyarts.arts.PropagationMatrix, pyarts.arts.QuantumIdentifier, pyarts.arts.RadiationVector, pyarts.arts.Rational, pyarts.arts.ScatteringMetaData, pyarts.arts.SingleScatteringData, pyarts.arts.Sparse, pyarts.arts.SpeciesIsotopologueRatios, pyarts.arts.SpectralRadianceProfileOperator, pyarts.arts.StokesVector, pyarts.arts.String, pyarts.arts.TelsemAtlas, pyarts.arts.Tensor3, pyarts.arts.Tensor4, pyarts.arts.Tensor5, pyarts.arts.Tensor6, pyarts.arts.Tensor7, pyarts.arts.TessemNN, pyarts.arts.Time, pyarts.arts.Timer, pyarts.arts.TransmissionMatrix, pyarts.arts.Vector, pyarts.arts.Verbosity], filename: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String]] = "", digits: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = 0, verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) None

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(s): Patrick Eriksson, Oliver Lemke

Parameters:
  • output_file_format (String, optional) – Output file format. See output_file_format, defaults to self.output_file_format [IN]

  • file_index (Index, optional) – Index number for files. See file_index, defaults to self.file_index [IN]

  • input (Any) – Workspace variable to be saved. [IN]

  • filename (String, optional) – File name. See above. Defaults to "" [IN]

  • digits (Index, optional) – Equalize the widths of all numbers by padding with zeros as necessary. 0 means no padding (default). Defaults to 0 [IN]

  • verbosity (Verbosity) – ARTS verbosity. See verbosity, defaults to self.verbosity [IN]