yCalcAppend

Workspace.yCalcAppend(self: pyarts.arts._Workspace, y: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.y, y_f: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.y_f, y_pol: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfIndex]] = self.y_pol, y_pos: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.y_pos, y_los: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.y_los, y_aux: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfVector]] = self.y_aux, y_geo: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.y_geo, jacobian: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.jacobian, jacobian_quantities: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfRetrievalQuantity]] = self.jacobian_quantities, atmgeom_checked: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.atmgeom_checked, atmfields_checked: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.atmfields_checked, atmosphere_dim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.atmosphere_dim, nlte_field: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.EnergyLevelMap]] = self.nlte_field, cloudbox_on: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.cloudbox_on, cloudbox_checked: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.cloudbox_checked, scat_data_checked: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.scat_data_checked, sensor_checked: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.sensor_checked, stokes_dim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.stokes_dim, f_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.f_grid, sensor_pos: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.sensor_pos, sensor_los: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.sensor_los, transmitter_pos: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.transmitter_pos, mblock_dlos: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.mblock_dlos, sensor_response: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Sparse]] = self.sensor_response, sensor_response_f: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.sensor_response_f, sensor_response_pol: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfIndex]] = self.sensor_response_pol, sensor_response_dlos: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.sensor_response_dlos, iy_unit: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String]] = self.iy_unit, iy_main_agenda: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Agenda]] = self.iy_main_agenda, jacobian_agenda: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Agenda]] = self.jacobian_agenda, jacobian_do: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.jacobian_do, iy_aux_vars: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfString]] = self.iy_aux_vars, jacobian_quantities_copy: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfRetrievalQuantity], append_instrument_wfs: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = 0, verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

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 transmittance 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(s): Patrick Eriksson

Parameters:

• y (Vector, optional) – The measurement vector. See y, defaults to self.y [INOUT]

• y_f (Vector, optional) – The frequencies associated with y. See y_f, defaults to self.y_f [INOUT]

• y_pol (ArrayOfIndex, optional) – The polarisation states associated with y. See y_pol, defaults to self.y_pol [INOUT]

• y_pos (Matrix, optional) – The sensor positions associated with y. See y_pos, defaults to self.y_pos [INOUT]

• y_los (Matrix, optional) – The line-of-sights associated with y. See y_los, defaults to self.y_los [INOUT]

• y_aux (ArrayOfVector, optional) – Data auxilary to y. See y_aux, defaults to self.y_aux [INOUT]

• y_geo (Matrix, optional) – The geo-position assigned to each element of y. See y_geo, defaults to self.y_geo [INOUT]

• jacobian (Matrix, optional) – The Jacobian matrix. See jacobian, defaults to self.jacobian [INOUT]

• jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See jacobian_quantities, defaults to self.jacobian_quantities [INOUT]

• atmgeom_checked (Index, optional) – OK-flag for the geometry of the model atmosphere. See atmgeom_checked, defaults to self.atmgeom_checked [IN]

• atmfields_checked (Index, optional) – OK-flag for atmospheric grids and (physical) fields. See atmfields_checked, defaults to self.atmfields_checked [IN]

• atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See atmosphere_dim, defaults to self.atmosphere_dim [IN]

• nlte_field (EnergyLevelMap, optional) – The field of NLTE temperatures and/or ratios. See nlte_field, defaults to self.nlte_field [IN]

• cloudbox_on (Index, optional) – Flag to activate the cloud box. See cloudbox_on, defaults to self.cloudbox_on [IN]

• cloudbox_checked (Index, optional) – OK-flag for variables associated with the cloudbox. See cloudbox_checked, defaults to self.cloudbox_checked [IN]

• scat_data_checked (Index, optional) – OK-flag for scat_data. See scat_data_checked, defaults to self.scat_data_checked [IN]

• sensor_checked (Index, optional) – OK-flag for sensor related variables. See sensor_checked, defaults to self.sensor_checked [IN]

• stokes_dim (Index, optional) – The dimensionality of the Stokes vector (1-4). See stokes_dim, defaults to self.stokes_dim [IN]

• f_grid (Vector, optional) – The frequency grid for monochromatic pencil beam calculations. See f_grid, defaults to self.f_grid [IN]

• sensor_pos (Matrix, optional) – The sensor position for each measurement block. See sensor_pos, defaults to self.sensor_pos [IN]

• sensor_los (Matrix, optional) – The sensor line-of-sight (LOS) for each measurement block. See sensor_los, defaults to self.sensor_los [IN]

• transmitter_pos (Matrix, optional) – Transmitter positions. See transmitter_pos, defaults to self.transmitter_pos [IN]

• mblock_dlos (Matrix, optional) – The set of angular pencil beam directions for each measurement block. See mblock_dlos, defaults to self.mblock_dlos [IN]

• sensor_response (Sparse, optional) – The matrix modelling the total sensor response. See sensor_response, defaults to self.sensor_response [IN]

• sensor_response_f (Vector, optional) – The frequencies associated with the output of sensor_response. See sensor_response_f, defaults to self.sensor_response_f [IN]

• sensor_response_pol (ArrayOfIndex, optional) – The polarisation states associated with the output of. See sensor_response_pol, defaults to self.sensor_response_pol [IN]

• sensor_response_dlos (Matrix, optional) – The relative zenith and azimuth angles associated with the output of. See sensor_response_dlos, defaults to self.sensor_response_dlos [IN]

• iy_unit (String, optional) – Selection of output unit for radiative transfer methods. See iy_unit, defaults to self.iy_unit [IN]

• iy_main_agenda (Agenda, optional) – Calculation of a single monochromatic pencil beam spectrum. See iy_main_agenda, defaults to self.iy_main_agenda [IN]

• jacobian_agenda (Agenda, optional) – Pure numerical Jacobian calculations. See jacobian_agenda, defaults to self.jacobian_agenda [IN]

• jacobian_do (Index, optional) – Flag to activate (clear-sky) Jacobian calculations. See jacobian_do, defaults to self.jacobian_do [IN]

• iy_aux_vars (ArrayOfString, optional) – Selection of quantities for iy_aux and when applicable also y_aux. See iy_aux_vars, defaults to self.iy_aux_vars [IN]

• jacobian_quantities_copy (ArrayOfRetrievalQuantity) – Copy of jacobian_quantities of first measurement. [IN]

• append_instrument_wfs (Index, optional) – Flag controlling if instrumental weighting functions are appended or treated as different retrieval quantities. Defaults to 0 [IN]

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