ARTS  2.2.66
Functions | Variables
m_sensor.cc File Reference

Workspace functions related to sensor modelling variables. More...

#include <cmath>
#include <stdexcept>
#include <string>
#include "arts.h"
#include "check_input.h"
#include "interpolation_poly.h"
#include "math_funcs.h"
#include "messages.h"
#include "ppath.h"
#include "special_interp.h"
#include "xml_io.h"
#include "sensor.h"
#include "sorting.h"
#include "auto_md.h"
Include dependency graph for m_sensor.cc:

Go to the source code of this file.

Functions

void AntennaConstantGaussian1D (Index &antenna_dim, Vector &mblock_za_grid, Vector &mblock_aa_grid, GriddedField4 &r, Matrix &antenna_los, const Index &n_za_grid, const Numeric &fwhm, const Numeric &xwidth_si, const Numeric &dx_si, const Verbosity &verbosity)
 WORKSPACE METHOD: AntennaConstantGaussian1D. More...
 
void AntennaMultiBeamsToPencilBeams (Matrix &sensor_pos, Matrix &sensor_los, Matrix &antenna_los, Index &antenna_dim, Vector &mblock_za_grid, Vector &mblock_aa_grid, const Index &atmosphere_dim, const Verbosity &verbosity)
 WORKSPACE METHOD: AntennaMultiBeamsToPencilBeams. More...
 
void AntennaOff (Index &antenna_dim, Vector &mblock_za_grid, Vector &mblock_aa_grid, const Verbosity &verbosity)
 WORKSPACE METHOD: AntennaOff. More...
 
void AntennaSet1D (Index &antenna_dim, Vector &mblock_aa_grid, const Verbosity &verbosity)
 WORKSPACE METHOD: AntennaSet1D. More...
 
void AntennaSet2D (Index &antenna_dim, const Index &atmosphere_dim, const Verbosity &verbosity)
 WORKSPACE METHOD: AntennaSet2D. More...
 
void antenna_responseGaussian (GriddedField4 &r, const Numeric &fwhm, const Numeric &xwidth_si, const Numeric &dx_si, const Verbosity &)
 WORKSPACE METHOD: antenna_responseGaussian. More...
 
void antenna_responseVaryingGaussian (GriddedField4 &r, const Numeric &leff, const Numeric &xwidth_si, const Numeric &dx_si, const Index &nf, const Numeric &fstart, const Numeric &fstop, const Verbosity &verbosity)
 WORKSPACE METHOD: antenna_responseVaryingGaussian. More...
 
void backend_channel_responseFlat (ArrayOfGriddedField1 &r, const Numeric &resolution, const Verbosity &)
 WORKSPACE METHOD: backend_channel_responseFlat. More...
 
void backend_channel_responseGaussian (ArrayOfGriddedField1 &r, const Numeric &fwhm, const Numeric &xwidth_si, const Numeric &dx_si, const Verbosity &)
 WORKSPACE METHOD: backend_channel_responseGaussian. More...
 
void f_gridFromSensorAMSU (Vector &f_grid, const Vector &lo, const ArrayOfVector &f_backend, const ArrayOfArrayOfGriddedField1 &backend_channel_response, const Numeric &spacing, const Verbosity &verbosity)
 WORKSPACE METHOD: f_gridFromSensorAMSU. More...
 
void f_gridFromSensorAMSUgeneric (Vector &f_grid, const ArrayOfVector &f_backend_multi, const ArrayOfArrayOfGriddedField1 &backend_channel_response_multi, const Numeric &spacing, const Vector &verbosityVect, const Verbosity &verbosity)
 WORKSPACE METHOD: f_gridFromSensorAMSUgeneric. More...
 
void f_gridFromSensorHIRS (Vector &f_grid, const Vector &f_backend, const ArrayOfGriddedField1 &backend_channel_response, const Numeric &spacing, const Verbosity &verbosity)
 WORKSPACE METHOD: f_gridFromSensorHIRS. More...
 
void sensor_responseAntenna (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_za_grid, Vector &sensor_response_aa_grid, const Vector &sensor_response_f_grid, const ArrayOfIndex &sensor_response_pol_grid, const Index &atmosphere_dim, const Index &antenna_dim, const Matrix &antenna_los, const GriddedField4 &antenna_response, const Index &sensor_norm, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseAntenna. More...
 
void sensor_responseBackend (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_f_grid, const ArrayOfIndex &sensor_response_pol_grid, const Vector &sensor_response_za_grid, const Vector &sensor_response_aa_grid, const Vector &f_backend, const ArrayOfGriddedField1 &backend_channel_response, const Index &sensor_norm, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseBackend. More...
 
void sensor_responseBackendFrequencySwitching (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_f_grid, const ArrayOfIndex &sensor_response_pol_grid, const Vector &sensor_response_za_grid, const Vector &sensor_response_aa_grid, const Vector &f_backend, const ArrayOfGriddedField1 &backend_channel_response, const Index &sensor_norm, const Numeric &df1, const Numeric &df2, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseBackendFrequencySwitching. More...
 
void sensor_responseBeamSwitching (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_za_grid, Vector &sensor_response_aa_grid, const Vector &sensor_response_f_grid, const ArrayOfIndex &sensor_response_pol_grid, const Numeric &w1, const Numeric &w2, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseBeamSwitching. More...
 
void sensor_responseFrequencySwitching (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_f_grid, const ArrayOfIndex &sensor_response_pol_grid, const Vector &sensor_response_za_grid, const Vector &sensor_response_aa_grid, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseFrequencySwitching. More...
 
void sensor_responseIF2RF (Vector &sensor_response_f, Vector &sensor_response_f_grid, const Numeric &lo, const String &sideband_mode, const Verbosity &)
 WORKSPACE METHOD: sensor_responseIF2RF. More...
 
void sensor_responseFillFgrid (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_f_grid, const ArrayOfIndex &sensor_response_pol_grid, const Vector &sensor_response_za_grid, const Vector &sensor_response_aa_grid, const Index &polyorder, const Index &nfill, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseFillFgrid. More...
 
void sensor_responseInit (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_f_grid, ArrayOfIndex &sensor_response_pol_grid, Vector &sensor_response_za_grid, Vector &sensor_response_aa_grid, const Vector &f_grid, const Vector &mblock_za_grid, const Vector &mblock_aa_grid, const Index &antenna_dim, const Index &atmosphere_dim, const Index &stokes_dim, const Index &sensor_norm, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseInit. More...
 
void sensorOff (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_f_grid, ArrayOfIndex &sensor_response_pol_grid, Vector &sensor_response_za_grid, Vector &sensor_response_aa_grid, Index &antenna_dim, Vector &mblock_za_grid, Vector &mblock_aa_grid, const Index &stokes_dim, const Vector &f_grid, const Verbosity &verbosity)
 WORKSPACE METHOD: sensorOff. More...
 
void sensor_responseMixer (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_f_grid, const ArrayOfIndex &sensor_response_pol_grid, const Vector &sensor_response_za_grid, const Vector &sensor_response_aa_grid, const Numeric &lo, const GriddedField1 &sideband_response, const Index &sensor_norm, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseMixer. More...
 
void sensor_responseMultiMixerBackend (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_f_grid, const ArrayOfIndex &sensor_response_pol_grid, const Vector &sensor_response_za_grid, const Vector &sensor_response_aa_grid, const Vector &lo_multi, const ArrayOfGriddedField1 &sideband_response_multi, const ArrayOfString &sideband_mode_multi, const ArrayOfVector &f_backend_multi, const ArrayOfArrayOfGriddedField1 &backend_channel_response_multi, const Index &sensor_norm, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseMultiMixerBackend. More...
 
void sensor_responsePolarisation (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, ArrayOfIndex &sensor_response_pol_grid, const Vector &sensor_response_f_grid, const Vector &sensor_response_za_grid, const Vector &sensor_response_aa_grid, const Index &stokes_dim, const String &y_unit, const ArrayOfIndex &sensor_pol, const Verbosity &)
 WORKSPACE METHOD: sensor_responsePolarisation. More...
 
void sensor_responseStokesRotation (Sparse &sensor_response, const Vector &sensor_response_f_grid, const ArrayOfIndex &sensor_response_pol_grid, const Vector &sensor_response_za_grid, const Vector &sensor_response_aa_grid, const Index &stokes_dim, const Matrix &stokes_rotation, const Verbosity &)
 WORKSPACE METHOD: sensor_responseStokesRotation. More...
 
void sensor_responseGenericAMSU (Vector &f_grid, Index &antenna_dim, Vector &mblock_za_grid, Vector &mblock_aa_grid, Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_f_grid, ArrayOfIndex &sensor_response_pol_grid, Vector &sensor_response_za_grid, Vector &sensor_response_aa_grid, Index &sensor_norm, const Index &atmosphere_dim, const Index &stokes_dim, const Matrix &sensor_description_amsu, const Numeric &spacing, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseGenericAMSU. More...
 
void sensor_responseSimpleAMSU (Vector &f_grid, Index &antenna_dim, Vector &mblock_za_grid, Vector &mblock_aa_grid, Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_f_grid, ArrayOfIndex &sensor_response_pol_grid, Vector &sensor_response_za_grid, Vector &sensor_response_aa_grid, Index &sensor_norm, const Index &atmosphere_dim, const Index &stokes_dim, const Matrix &sensor_description_amsu, const Numeric &spacing, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseSimpleAMSU. More...
 
void Select (Vector &needles, const Vector &haystack, const ArrayOfIndex &needleind, const Verbosity &verbosity)
 
template<class T >
void Select (Array< T > &needles, const Array< T > &haystack, const ArrayOfIndex &needleind, const Verbosity &verbosity)
 
void Select (Sparse &needles, const Sparse &haystack, const ArrayOfIndex &needleind, const Verbosity &verbosity)
 
void WMRFSelectChannels (Vector &f_grid, Sparse &wmrf_weights, Vector &f_backend, const ArrayOfIndex &wmrf_channels, const Verbosity &verbosity)
 WORKSPACE METHOD: WMRFSelectChannels. More...
 
void sensor_responseWMRF (Sparse &sensor_response, Vector &sensor_response_f, ArrayOfIndex &sensor_response_pol, Vector &sensor_response_za, Vector &sensor_response_aa, Vector &sensor_response_f_grid, const ArrayOfIndex &sensor_response_pol_grid, const Vector &sensor_response_za_grid, const Vector &sensor_response_aa_grid, const Sparse &wmrf_weights, const Vector &f_backend, const Verbosity &verbosity)
 WORKSPACE METHOD: sensor_responseWMRF. More...
 
void ySimpleSpectrometer (Vector &y, Vector &y_f, const Matrix &iy, const Index &stokes_dim, const Vector &f_grid, const Numeric &df, const Verbosity &verbosity)
 WORKSPACE METHOD: ySimpleSpectrometer. More...
 

Variables

const Numeric PI
 
const Numeric DEG2RAD
 
const Numeric RAD2DEG
 
const Index GFIELD1_F_GRID
 
const Index GFIELD4_FIELD_NAMES
 
const Index GFIELD4_F_GRID
 
const Index GFIELD4_ZA_GRID
 
const Index GFIELD4_AA_GRID
 
const Numeric SPEED_OF_LIGHT
 

Detailed Description

Workspace functions related to sensor modelling variables.

Author
Mattias Ekström/Patrick Eriksson patri.nosp@m.ck.e.nosp@m.rikss.nosp@m.on@c.nosp@m.halme.nosp@m.rs.s.nosp@m.e
Date
2003-02-13

These functions are listed in the doxygen documentation as entries of the file auto_md.h.

Definition in file m_sensor.cc.

Function Documentation

◆ antenna_responseGaussian()

void antenna_responseGaussian ( GriddedField4 &  antenna_response,
const Numeric &  fwhm,
const Numeric &  xwidth_si,
const Numeric &  dx_si,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: antenna_responseGaussian.

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 <br> 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).

Author
Patrick Eriksson
Parameters
[out]antenna_responseWS Output
[in]fwhmGeneric Input
[in]xwidth_siGeneric Input (Default: "3")
[in]dx_siGeneric Input (Default: "0.1")

Definition at line 256 of file m_sensor.cc.

References GriddedField4::data, gaussian_response_autogrid(), joker, ConstVectorView::nelem(), Tensor4::resize(), GriddedField::set_grid(), GriddedField::set_grid_name(), and GriddedField::set_name().

Referenced by antenna_responseGaussian_g(), and AntennaConstantGaussian1D().

◆ antenna_responseVaryingGaussian()

void antenna_responseVaryingGaussian ( GriddedField4 &  antenna_response,
const Numeric &  leff,
const Numeric &  xwidth_si,
const Numeric &  dx_si,
const Index &  nf,
const Numeric &  fstart,
const Numeric &  fstop,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: antenna_responseVaryingGaussian.

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: <br> 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.

Author
Patrick Eriksson
Parameters
[out]antenna_responseWS Output
[in]leffGeneric Input
[in]xwidth_siGeneric Input (Default: "3")
[in]dx_siGeneric Input (Default: "0.1")
[in]nfGeneric Input
[in]fstartGeneric Input
[in]fstopGeneric Input

Definition at line 290 of file m_sensor.cc.

References GriddedField4::data, gaussian_response(), gaussian_response_autogrid(), joker, ConstVectorView::nelem(), RAD2DEG, Tensor4::resize(), GriddedField::set_grid(), GriddedField::set_grid_name(), GriddedField::set_name(), SPEED_OF_LIGHT, and VectorNLogSpace().

Referenced by antenna_responseVaryingGaussian_g().

◆ AntennaConstantGaussian1D()

void AntennaConstantGaussian1D ( Index &  antenna_dim,
Vector &  mblock_za_grid,
Vector &  mblock_aa_grid,
GriddedField4 &  antenna_response,
Matrix &  antenna_los,
const Index &  n_za_grid,
const Numeric &  fwhm,
const Numeric &  xwidth_si,
const Numeric &  dx_si,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: AntennaConstantGaussian1D.

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

As antenna_responseGaussian, but alsp creates mblock_za_grid. For returned antenna response, see antenna_responseGaussian.

The length of mblock_za_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_los is set to 0.

Author
Patrick Eriksson
Parameters
[out]antenna_dimWS Output
[out]mblock_za_gridWS Output
[out]mblock_aa_gridWS Output
[out]antenna_responseWS Output
[out]antenna_losWS Output
[in]n_za_gridGeneric Input
[in]fwhmGeneric Input
[in]xwidth_siGeneric Input (Default: "3")
[in]dx_siGeneric Input (Default: "0.1")

Definition at line 74 of file m_sensor.cc.

References antenna_responseGaussian(), AntennaSet1D(), GriddedField4::data, GriddedField::get_numeric_grid(), GFIELD4_ZA_GRID, gridpos(), interp(), interpweights(), ConstVectorView::nelem(), nlinspace(), Vector::resize(), and Matrix::resize().

Referenced by AntennaConstantGaussian1D_g().

◆ AntennaMultiBeamsToPencilBeams()

void AntennaMultiBeamsToPencilBeams ( Matrix &  sensor_pos,
Matrix &  sensor_los,
Matrix &  antenna_los,
Index &  antenna_dim,
Vector &  mblock_za_grid,
Vector &  mblock_aa_grid,
const Index &  atmosphere_dim,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: AntennaMultiBeamsToPencilBeams.

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

Cases with overlapping beams are most efficiently handled by letting antenna_los 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
[out]sensor_posWS Output
[out]sensor_losWS Output
[out]antenna_losWS Output
[out]antenna_dimWS Output
[out]mblock_za_gridWS Output
[out]mblock_aa_gridWS Output
[in]atmosphere_dimWS Input

Definition at line 120 of file m_sensor.cc.

References AntennaOff(), chk_if_in_range(), joker, ConstMatrixView::ncols(), ConstMatrixView::nrows(), and Matrix::resize().

Referenced by AntennaMultiBeamsToPencilBeams_g().

◆ AntennaOff()

void AntennaOff ( Index &  antenna_dim,
Vector &  mblock_za_grid,
Vector &  mblock_aa_grid,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: AntennaOff.

Sets some antenna related variables

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

Author
Patrick Eriksson
Parameters
[out]antenna_dimWS Output
[out]mblock_za_gridWS Output
[out]mblock_aa_gridWS Output

Definition at line 196 of file m_sensor.cc.

References CREATE_OUT2, and Vector::resize().

Referenced by AntennaMultiBeamsToPencilBeams(), AntennaOff_g(), sensor_responseGenericAMSU(), sensor_responseSimpleAMSU(), sensorOff(), and ySimpleSpectrometer().

◆ AntennaSet1D()

void AntennaSet1D ( Index &  antenna_dim,
Vector &  mblock_aa_grid,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: AntennaSet1D.

Sets the antenna dimension to 1D.

Sets antenna_dim to 1 and sets mblock_aa_grid to be empty.

Author
Patrick Eriksson
Parameters
[out]antenna_dimWS Output
[out]mblock_aa_gridWS Output

Definition at line 218 of file m_sensor.cc.

References CREATE_OUT2, CREATE_OUT3, and Vector::resize().

Referenced by AntennaConstantGaussian1D(), and AntennaSet1D_g().

◆ AntennaSet2D()

void AntennaSet2D ( Index &  antenna_dim,
const Index &  atmosphere_dim,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: AntennaSet2D.

Sets the antenna dimension to 2D.

Sets antenna_dim to 2.

It is only allowed to set antenna_dim to 2 when atmosphere_dim equals 3.

Author
Patrick Eriksson
Parameters
[out]antenna_dimWS Output
[in]atmosphere_dimWS Input

Definition at line 236 of file m_sensor.cc.

References CREATE_OUT2, and CREATE_OUT3.

Referenced by AntennaSet2D_g().

◆ backend_channel_responseFlat()

void backend_channel_responseFlat ( ArrayOfGriddedField1 &  backend_channel_response,
const Numeric &  resolution,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: backend_channel_responseFlat.

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
[out]backend_channel_responseWS Output
[in]resolutionGeneric Input

Definition at line 338 of file m_sensor.cc.

Referenced by backend_channel_responseFlat_g(), and ySimpleSpectrometer().

◆ backend_channel_responseGaussian()

void backend_channel_responseGaussian ( ArrayOfGriddedField1 &  backend_channel_response,
const Numeric &  fwhm,
const Numeric &  xwidth_si,
const Numeric &  dx_si,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: backend_channel_responseGaussian.

Sets up a gaussian backend channel response.

The method assumes that all channels have the same response, and that it can be modelled as gaussian.

The grid generated can be written as <br> 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
Parameters
[out]backend_channel_responseWS Output
[in]fwhmGeneric Input
[in]xwidth_siGeneric Input (Default: "3")
[in]dx_siGeneric Input (Default: "0.1")

Definition at line 360 of file m_sensor.cc.

References gaussian_response_autogrid(), and ConstVectorView::nelem().

Referenced by backend_channel_responseGaussian_g().

◆ f_gridFromSensorAMSU()

void f_gridFromSensorAMSU ( Vector &  f_grid,
const Vector &  lo_multi,
const ArrayOfVector &  f_backend_multi,
const ArrayOfArrayOfGriddedField1 &  backend_channel_response_multi,
const Numeric &  spacing,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: f_gridFromSensorAMSU.

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
[out]f_gridWS Output
[in]lo_multiWS Input
[in]f_backend_multiWS Input
[in]backend_channel_response_multiWS Input
[in]spacingGeneric Input (Default: ".1e9")

Definition at line 385 of file m_sensor.cc.

References CREATE_OUT2, CREATE_OUT3, find_effective_channel_boundaries(), Array< base >::nelem(), ConstVectorView::nelem(), and nlinspace().

Referenced by f_gridFromSensorAMSU_g(), and sensor_responseSimpleAMSU().

◆ f_gridFromSensorAMSUgeneric()

void f_gridFromSensorAMSUgeneric ( Vector &  f_grid,
const ArrayOfVector &  f_backend_multi,
const ArrayOfArrayOfGriddedField1 &  backend_channel_response_multi,
const Numeric &  spacing,
const Vector &  verbosityVect,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: f_gridFromSensorAMSUgeneric.

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
[out]f_gridWS Output
[in]f_backend_multiWS Input
[in]backend_channel_response_multiWS Input
[in]spacingGeneric Input (Default: ".1e9")
[in]verbosityVectGeneric Input (Default: "[]")

Definition at line 522 of file m_sensor.cc.

References CREATE_OUT2, CREATE_OUT3, find_effective_channel_boundaries(), Array< base >::nelem(), and ConstVectorView::nelem().

Referenced by f_gridFromSensorAMSUgeneric_g(), and sensor_responseGenericAMSU().

◆ f_gridFromSensorHIRS()

void f_gridFromSensorHIRS ( Vector &  f_grid,
const Vector &  f_backend,
const ArrayOfGriddedField1 &  backend_channel_response,
const Numeric &  spacing,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: f_gridFromSensorHIRS.

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
[out]f_gridWS Output
[in]f_backendWS Input
[in]backend_channel_responseWS Input
[in]spacingGeneric Input (Default: "5e8")

Definition at line 689 of file m_sensor.cc.

References CREATE_OUT2, CREATE_OUT3, find_effective_channel_boundaries(), Array< base >::nelem(), ConstVectorView::nelem(), and nlinspace().

Referenced by f_gridFromSensorHIRS_g().

◆ Select() [1/3]

void Select ( Vector &  needles,
const Vector &  haystack,
const ArrayOfIndex &  needleind,
const Verbosity &  verbosity 
)

Definition at line 72 of file m_select.h.

References Array< base >::nelem(), and ConstVectorView::nelem().

Referenced by sensor_responseSimpleAMSU(), and WMRFSelectChannels().

◆ Select() [2/3]

template<class T >
void Select ( Array< T > &  needles,
const Array< T > &  haystack,
const ArrayOfIndex &  needleind,
const Verbosity &  verbosity 
)

Definition at line 40 of file m_select.h.

References Array< base >::nelem().

Referenced by Select_sg_ArrayOfArrayOfGriddedField1ArrayOfArrayOfGriddedField1_g(), Select_sg_ArrayOfArrayOfGriddedField2ArrayOfArrayOfGriddedField2_g(), Select_sg_ArrayOfArrayOfGriddedField3ArrayOfArrayOfGriddedField3_g(), Select_sg_ArrayOfArrayOfIndexArrayOfArrayOfIndex_g(), Select_sg_ArrayOfArrayOfLineMixingRecordArrayOfArrayOfLineMixingRecord_g(), Select_sg_ArrayOfArrayOfLineRecordArrayOfArrayOfLineRecord_g(), Select_sg_ArrayOfArrayOfMatrixArrayOfArrayOfMatrix_g(), Select_sg_ArrayOfArrayOfSpeciesTagArrayOfArrayOfSpeciesTag_g(), Select_sg_ArrayOfArrayOfTensor3ArrayOfArrayOfTensor3_g(), Select_sg_ArrayOfArrayOfTensor6ArrayOfArrayOfTensor6_g(), Select_sg_ArrayOfArrayOfVectorArrayOfArrayOfVector_g(), Select_sg_ArrayOfCIARecordArrayOfCIARecord_g(), Select_sg_ArrayOfGriddedField1ArrayOfGriddedField1_g(), Select_sg_ArrayOfGriddedField2ArrayOfGriddedField2_g(), Select_sg_ArrayOfGriddedField3ArrayOfGriddedField3_g(), Select_sg_ArrayOfGriddedField4ArrayOfGriddedField4_g(), Select_sg_ArrayOfIndexArrayOfIndex_g(), Select_sg_ArrayOfLineMixingRecordArrayOfLineMixingRecord_g(), Select_sg_ArrayOfLineRecordArrayOfLineRecord_g(), Select_sg_ArrayOfLineshapeSpecArrayOfLineshapeSpec_g(), Select_sg_ArrayOfMatrixArrayOfMatrix_g(), Select_sg_ArrayOfRetrievalQuantityArrayOfRetrievalQuantity_g(), Select_sg_ArrayOfScatteringMetaDataArrayOfScatteringMetaData_g(), Select_sg_ArrayOfSingleScatteringDataArrayOfSingleScatteringData_g(), Select_sg_ArrayOfSparseArrayOfSparse_g(), Select_sg_ArrayOfStringArrayOfString_g(), Select_sg_ArrayOfTensor3ArrayOfTensor3_g(), Select_sg_ArrayOfTensor4ArrayOfTensor4_g(), Select_sg_ArrayOfTensor6ArrayOfTensor6_g(), Select_sg_ArrayOfTensor7ArrayOfTensor7_g(), Select_sg_ArrayOfVectorArrayOfVector_g(), Select_sg_MatrixMatrix_g(), Select_sg_SparseSparse_g(), and Select_sg_VectorVector_g().

◆ Select() [3/3]

void Select ( Sparse &  needles,
const Sparse &  haystack,
const ArrayOfIndex &  needleind,
const Verbosity &  verbosity 
)

Definition at line 136 of file m_select.h.

References CREATE_OUT3, Sparse::ncols(), Array< base >::nelem(), Sparse::nnz(), and Sparse::nrows().

◆ sensor_responseAntenna()

void sensor_responseAntenna ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_za_grid,
Vector &  sensor_response_aa_grid,
const Vector &  sensor_response_f_grid,
const ArrayOfIndex &  sensor_response_pol_grid,
const Index &  atmosphere_dim,
const Index &  antenna_dim,
const Matrix &  antenna_los,
const GriddedField4 &  antenna_response,
const Index &  sensor_norm,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseAntenna.

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_los and antenna_response for details on how to specify the antenna response.

Author
Mattias Ekstrom
Patrick Eriksson
Parameters
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_za_gridWS Output
[out]sensor_response_aa_gridWS Output
[in]sensor_response_f_gridWS Input
[in]sensor_response_pol_gridWS Input
[in]atmosphere_dimWS Input
[in]antenna_dimWS Input
[in]antenna_losWS Input
[in]antenna_responseWS Input
[in]sensor_normWS Input

Definition at line 763 of file m_sensor.cc.

References antenna1d_matrix(), antenna2d_simplified(), GriddedField4::checksize_strict(), chk_if_bool(), chk_if_in_range(), chk_if_increasing(), CREATE_OUT3, GriddedField::get_numeric_grid(), GriddedField::get_string_grid(), GFIELD4_AA_GRID, GFIELD4_F_GRID, GFIELD4_FIELD_NAMES, GFIELD4_ZA_GRID, joker, last(), max, min, mult(), Sparse::ncols(), ConstMatrixView::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), Sparse::nrows(), Sparse::resize(), and sensor_aux_vectors().

Referenced by sensor_responseAntenna_g().

◆ sensor_responseBackend()

void sensor_responseBackend ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_f_grid,
const ArrayOfIndex &  sensor_response_pol_grid,
const Vector &  sensor_response_za_grid,
const Vector &  sensor_response_aa_grid,
const Vector &  f_backend,
const ArrayOfGriddedField1 &  backend_channel_response,
const Index &  sensor_norm,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseBackend.

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
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_f_gridWS Output
[in]sensor_response_pol_gridWS Input
[in]sensor_response_za_gridWS Input
[in]sensor_response_aa_gridWS Input
[in]f_backendWS Input
[in]backend_channel_responseWS Input
[in]sensor_normWS Input

Definition at line 1032 of file m_sensor.cc.

References CREATE_OUT3, GFIELD1_F_GRID, is_increasing(), last(), max, min, mult(), Sparse::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), Sparse::nrows(), Sparse::resize(), sensor_aux_vectors(), and spectrometer_matrix().

Referenced by sensor_responseBackend_g(), sensor_responseBackendFrequencySwitching(), sensor_responseGenericAMSU(), sensor_responseMultiMixerBackend(), and ySimpleSpectrometer().

◆ sensor_responseBackendFrequencySwitching()

void sensor_responseBackendFrequencySwitching ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_f_grid,
const ArrayOfIndex &  sensor_response_pol_grid,
const Vector &  sensor_response_za_grid,
const Vector &  sensor_response_aa_grid,
const Vector &  f_backend,
const ArrayOfGriddedField1 &  backend_channel_response,
const Index &  sensor_norm,
const Numeric &  df1,
const Numeric &  df2,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseBackendFrequencySwitching.

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
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_f_gridWS Output
[in]sensor_response_pol_gridWS Input
[in]sensor_response_za_gridWS Input
[in]sensor_response_aa_gridWS Input
[in]f_backendWS Input
[in]backend_channel_responseWS Input
[in]sensor_normWS Input
[in]df1Generic Input
[in]df2Generic Input

Definition at line 1201 of file m_sensor.cc.

References sensor_aux_vectors(), sensor_responseBackend(), and sub().

Referenced by sensor_responseBackendFrequencySwitching_g().

◆ sensor_responseBeamSwitching()

void sensor_responseBeamSwitching ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_za_grid,
Vector &  sensor_response_aa_grid,
const Vector &  sensor_response_f_grid,
const ArrayOfIndex &  sensor_response_pol_grid,
const Numeric &  w1,
const Numeric &  w2,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseBeamSwitching.

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
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_za_gridWS Output
[out]sensor_response_aa_gridWS Output
[in]sensor_response_f_gridWS Input
[in]sensor_response_pol_gridWS Input
[in]w1Generic Input (Default: "-1")
[in]w2Generic Input (Default: "1")

Definition at line 1262 of file m_sensor.cc.

References CREATE_OUT3, Sparse::insert_row(), mult(), Sparse::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), Sparse::nrows(), Sparse::resize(), Vector::resize(), and sensor_aux_vectors().

Referenced by sensor_responseBeamSwitching_g().

◆ sensor_responseFillFgrid()

void sensor_responseFillFgrid ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_f_grid,
const ArrayOfIndex &  sensor_response_pol_grid,
const Vector &  sensor_response_za_grid,
const Vector &  sensor_response_aa_grid,
const Index &  polyorder,
const Index &  nfill,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseFillFgrid.

Polynomial frequency interpolation of spectra. z 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
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_f_gridWS Output
[in]sensor_response_pol_gridWS Input
[in]sensor_response_za_gridWS Input
[in]sensor_response_aa_gridWS Input
[in]polyorderGeneric Input (Default: "3")
[in]nfillGeneric Input (Default: "2")

Definition at line 1456 of file m_sensor.cc.

References abs, CREATE_OUT3, gridpos_poly(), Sparse::insert_row(), interpweights(), max, mult(), Sparse::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), nlinspace(), Sparse::nrows(), Sparse::resize(), sensor_aux_vectors(), and w().

Referenced by sensor_responseFillFgrid_g().

◆ sensor_responseFrequencySwitching()

void sensor_responseFrequencySwitching ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_f_grid,
const ArrayOfIndex &  sensor_response_pol_grid,
const Vector &  sensor_response_za_grid,
const Vector &  sensor_response_aa_grid,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseFrequencySwitching.

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 <br> 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
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_f_gridWS Output
[in]sensor_response_pol_gridWS Input
[in]sensor_response_za_gridWS Input
[in]sensor_response_aa_gridWS Input

Definition at line 1337 of file m_sensor.cc.

References CREATE_OUT3, Sparse::insert_row(), is_multiple(), mult(), Sparse::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), Sparse::nrows(), Sparse::resize(), Vector::resize(), and sensor_aux_vectors().

Referenced by sensor_responseFrequencySwitching_g().

◆ sensor_responseGenericAMSU()

void sensor_responseGenericAMSU ( Vector &  f_grid,
Index &  antenna_dim,
Vector &  mblock_za_grid,
Vector &  mblock_aa_grid,
Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_f_grid,
ArrayOfIndex &  sensor_response_pol_grid,
Vector &  sensor_response_za_grid,
Vector &  sensor_response_aa_grid,
Index &  sensor_norm,
const Index &  atmosphere_dim,
const Index &  stokes_dim,
const Matrix &  sensor_description_amsu,
const Numeric &  spacing,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseGenericAMSU.

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
[out]f_gridWS Output
[out]antenna_dimWS Output
[out]mblock_za_gridWS Output
[out]mblock_aa_gridWS Output
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_f_gridWS Output
[out]sensor_response_pol_gridWS Output
[out]sensor_response_za_gridWS Output
[out]sensor_response_aa_gridWS Output
[out]sensor_normWS Output
[in]atmosphere_dimWS Input
[in]stokes_dimWS Input
[in]sensor_description_amsuWS Input
[in]spacingGeneric Input (Default: ".1e9")

Definition at line 2348 of file m_sensor.cc.

References AntennaOff(), GriddedField1::data, f_gridFromSensorAMSUgeneric(), Sparse::insert_row(), joker, ConstMatrixView::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), ConstMatrixView::nrows(), Sparse::resize(), GriddedField1::resize(), Vector::resize(), sensor_aux_vectors(), sensor_responseBackend(), sensor_responseInit(), GriddedField::set_grid(), GriddedField::set_grid_name(), and GriddedField::set_name().

Referenced by sensor_responseGenericAMSU_g().

◆ sensor_responseIF2RF()

void sensor_responseIF2RF ( Vector &  sensor_response_f,
Vector &  sensor_response_f_grid,
const Numeric &  lo,
const String &  sideband_mode,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseIF2RF.

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
[out]sensor_response_fWS Output
[out]sensor_response_f_gridWS Output
[in]loWS Input
[in]sideband_modeWS Input

Definition at line 1414 of file m_sensor.cc.

References max.

Referenced by sensor_responseIF2RF_g(), and sensor_responseMultiMixerBackend().

◆ sensor_responseInit()

void sensor_responseInit ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_f_grid,
ArrayOfIndex &  sensor_response_pol_grid,
Vector &  sensor_response_za_grid,
Vector &  sensor_response_aa_grid,
const Vector &  f_grid,
const Vector &  mblock_za_grid,
const Vector &  mblock_aa_grid,
const Index &  antenna_dim,
const Index &  atmosphere_dim,
const Index &  stokes_dim,
const Index &  sensor_norm,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseInit.

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: <br> sensor_response : Identity matrix, with size matching f_grid, <br> stokes_dim mblock_za_grid and <br> mblock_aa_grid. <br> sensor_response_f : Repeated values of f_grid. <br> sensor_response_pol : Data matching stokes_dim. <br> sensor_response_za : Repeated values of mblock_za_grid. <br> sensor_response_aa : Repeated values of mblock_aa_grid. <br> sensor_response_f_grid : Equal to f_grid. <br> sensor_response_pol_grid: Set to 1:stokes_dim. <br> sensor_response_za_grid : Equal to mblock_za_grid. <br> sensor_response_aa_grid : Equal to mblock_aa_grid.

Author
Mattias Ekstrom
Patrick Eriksson
Parameters
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_f_gridWS Output
[out]sensor_response_pol_gridWS Output
[out]sensor_response_za_gridWS Output
[out]sensor_response_aa_gridWS Output
[in]f_gridWS Input
[in]mblock_za_gridWS Input
[in]mblock_aa_gridWS Input
[in]antenna_dimWS Input
[in]atmosphere_dimWS Input
[in]stokes_dimWS Input
[in]sensor_normWS Input

Definition at line 1596 of file m_sensor.cc.

References chk_if_bool(), chk_if_in_range(), chk_if_increasing(), CREATE_OUT2, CREATE_OUT3, is_decreasing(), is_increasing(), Sparse::make_I(), ConstVectorView::nelem(), and sensor_aux_vectors().

Referenced by sensor_responseGenericAMSU(), sensor_responseInit_g(), sensor_responseSimpleAMSU(), sensorOff(), and ySimpleSpectrometer().

◆ sensor_responseMixer()

void sensor_responseMixer ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_f_grid,
const ArrayOfIndex &  sensor_response_pol_grid,
const Vector &  sensor_response_za_grid,
const Vector &  sensor_response_aa_grid,
const Numeric &  lo,
const GriddedField1 &  sideband_response,
const Index &  sensor_norm,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseMixer.

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
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_f_gridWS Output
[in]sensor_response_pol_gridWS Input
[in]sensor_response_za_gridWS Input
[in]sensor_response_aa_gridWS Input
[in]loWS Input
[in]sideband_responseWS Input
[in]sensor_normWS Input

Definition at line 1730 of file m_sensor.cc.

References CREATE_OUT3, GriddedField1::data, GriddedField::get_numeric_grid(), GFIELD1_F_GRID, is_increasing(), last(), mixer_matrix(), mult(), Sparse::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), Sparse::nrows(), Sparse::resize(), and sensor_aux_vectors().

Referenced by sensor_responseMixer_g(), and sensor_responseMultiMixerBackend().

◆ sensor_responseMultiMixerBackend()

void sensor_responseMultiMixerBackend ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_f_grid,
const ArrayOfIndex &  sensor_response_pol_grid,
const Vector &  sensor_response_za_grid,
const Vector &  sensor_response_aa_grid,
const Vector &  lo_multi,
const ArrayOfGriddedField1 &  sideband_response_multi,
const ArrayOfString &  sideband_mode_multi,
const ArrayOfVector &  f_backend_multi,
const ArrayOfArrayOfGriddedField1 &  backend_channel_response_multi,
const Index &  sensor_norm,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseMultiMixerBackend.

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
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_f_gridWS Output
[in]sensor_response_pol_gridWS Input
[in]sensor_response_za_gridWS Input
[in]sensor_response_aa_gridWS Input
[in]lo_multiWS Input
[in]sideband_response_multiWS Input
[in]sideband_mode_multiWS Input
[in]f_backend_multiWS Input
[in]backend_channel_response_multiWS Input
[in]sensor_normWS Input

Definition at line 1884 of file m_sensor.cc.

References Sparse::insert_row(), Array< base >::nelem(), ConstVectorView::nelem(), Sparse::nrows(), Sparse::resize(), Vector::resize(), sensor_aux_vectors(), sensor_responseBackend(), sensor_responseIF2RF(), and sensor_responseMixer().

Referenced by sensor_responseMultiMixerBackend_g(), and sensor_responseSimpleAMSU().

◆ sensor_responsePolarisation()

void sensor_responsePolarisation ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
ArrayOfIndex &  sensor_response_pol_grid,
const Vector &  sensor_response_f_grid,
const Vector &  sensor_response_za_grid,
const Vector &  sensor_response_aa_grid,
const Index &  stokes_dim,
const String &  iy_unit,
const ArrayOfIndex &  sensor_pol,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responsePolarisation.

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 sensor_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 sensor_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
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_pol_gridWS Output
[in]sensor_response_f_gridWS Input
[in]sensor_response_za_gridWS Input
[in]sensor_response_aa_gridWS Input
[in]stokes_dimWS Input
[in]iy_unitWS Input
[in]sensor_polWS Input

Definition at line 2079 of file m_sensor.cc.

References max, mult(), Sparse::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), Sparse::nrows(), Sparse::resize(), sensor_aux_vectors(), stokes2pol(), and w().

Referenced by sensor_responsePolarisation_g().

◆ sensor_responseSimpleAMSU()

void sensor_responseSimpleAMSU ( Vector &  f_grid,
Index &  antenna_dim,
Vector &  mblock_za_grid,
Vector &  mblock_aa_grid,
Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_f_grid,
ArrayOfIndex &  sensor_response_pol_grid,
Vector &  sensor_response_za_grid,
Vector &  sensor_response_aa_grid,
Index &  sensor_norm,
const Index &  atmosphere_dim,
const Index &  stokes_dim,
const Matrix &  sensor_description_amsu,
const Numeric &  spacing,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseSimpleAMSU.

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
[out]f_gridWS Output
[out]antenna_dimWS Output
[out]mblock_za_gridWS Output
[out]mblock_aa_gridWS Output
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_f_gridWS Output
[out]sensor_response_pol_gridWS Output
[out]sensor_response_za_gridWS Output
[out]sensor_response_aa_gridWS Output
[out]sensor_normWS Output
[in]atmosphere_dimWS Input
[in]stokes_dimWS Input
[in]sensor_description_amsuWS Input
[in]spacingGeneric Input (Default: ".1e9")

Definition at line 2757 of file m_sensor.cc.

References AntennaOff(), GriddedField1::data, f_gridFromSensorAMSU(), joker, ConstMatrixView::ncols(), ConstMatrixView::nrows(), GriddedField1::resize(), Vector::resize(), Select(), sensor_responseInit(), sensor_responseMultiMixerBackend(), GriddedField::set_grid(), GriddedField::set_grid_name(), and GriddedField::set_name().

Referenced by sensor_responseSimpleAMSU_g().

◆ sensor_responseStokesRotation()

void sensor_responseStokesRotation ( Sparse &  sensor_response,
const Vector &  sensor_response_f_grid,
const ArrayOfIndex &  sensor_response_pol_grid,
const Vector &  sensor_response_za_grid,
const Vector &  sensor_response_aa_grid,
const Index &  stokes_dim,
const Matrix &  stokes_rotation,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseStokesRotation.

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
[out]sensor_responseWS Output
[in]sensor_response_f_gridWS Input
[in]sensor_response_pol_gridWS Input
[in]sensor_response_za_gridWS Input
[in]sensor_response_aa_gridWS Input
[in]stokes_dimWS Input
[in]stokes_rotationWS Input

Definition at line 2246 of file m_sensor.cc.

References chk_if_in_range(), DEG2RAD, max, mult(), Sparse::ncols(), ConstMatrixView::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), Sparse::nrows(), ConstMatrixView::nrows(), and Sparse::resize().

Referenced by sensor_responseStokesRotation_g().

◆ sensor_responseWMRF()

void sensor_responseWMRF ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_f_grid,
const ArrayOfIndex &  sensor_response_pol_grid,
const Vector &  sensor_response_za_grid,
const Vector &  sensor_response_aa_grid,
const Sparse &  wmrf_weights,
const Vector &  f_backend,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensor_responseWMRF.

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
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_f_gridWS Output
[in]sensor_response_pol_gridWS Input
[in]sensor_response_za_gridWS Input
[in]sensor_response_aa_gridWS Input
[in]wmrf_weightsWS Input
[in]f_backendWS Input

Definition at line 3047 of file m_sensor.cc.

References CREATE_OUT3, mult(), Sparse::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), Sparse::nrows(), Sparse::resize(), and sensor_aux_vectors().

Referenced by sensor_responseWMRF_g().

◆ sensorOff()

void sensorOff ( Sparse &  sensor_response,
Vector &  sensor_response_f,
ArrayOfIndex &  sensor_response_pol,
Vector &  sensor_response_za,
Vector &  sensor_response_aa,
Vector &  sensor_response_f_grid,
ArrayOfIndex &  sensor_response_pol_grid,
Vector &  sensor_response_za_grid,
Vector &  sensor_response_aa_grid,
Index &  antenna_dim,
Vector &  mblock_za_grid,
Vector &  mblock_aa_grid,
const Index &  stokes_dim,
const Vector &  f_grid,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: sensorOff.

Sets sensor WSVs to obtain monochromatic pencil beam values.

A 1D antenna pattern is assumed. The variables are set as follows: <br> antenna_dim : 1. <br> mblock_za_grid : Length 1, value 0. <br> mblock_aa_grid : Empty. <br> sensor_response* : As returned by sensor_responseInit.

Author
Patrick Eriksson
Parameters
[out]sensor_responseWS Output
[out]sensor_response_fWS Output
[out]sensor_response_polWS Output
[out]sensor_response_zaWS Output
[out]sensor_response_aaWS Output
[out]sensor_response_f_gridWS Output
[out]sensor_response_pol_gridWS Output
[out]sensor_response_za_gridWS Output
[out]sensor_response_aa_gridWS Output
[out]antenna_dimWS Output
[out]mblock_za_gridWS Output
[out]mblock_aa_gridWS Output
[in]stokes_dimWS Input
[in]f_gridWS Input

Definition at line 1693 of file m_sensor.cc.

References AntennaOff(), and sensor_responseInit().

Referenced by sensorOff_g().

◆ WMRFSelectChannels()

void WMRFSelectChannels ( Vector &  f_grid,
Sparse &  wmrf_weights,
Vector &  f_backend,
const ArrayOfIndex &  wmrf_channels,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: WMRFSelectChannels.

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
    [out]f_gridWS Output
    [out]wmrf_weightsWS Output
    [out]f_backendWS Output
    [in]wmrf_channelsWS Input

Definition at line 2914 of file m_sensor.cc.

References chk_if_increasing(), CREATE_OUT2, CREATE_OUT3, max, min, Sparse::ncols(), Array< base >::nelem(), ConstVectorView::nelem(), Sparse::nrows(), Sparse::resize(), Select(), and transpose().

Referenced by WMRFSelectChannels_g().

◆ ySimpleSpectrometer()

void ySimpleSpectrometer ( Vector &  y,
Vector &  y_f,
const Matrix &  iy,
const Index &  stokes_dim,
const Vector &  f_grid,
const Numeric &  df,
const Verbosity &  verbosity 
)

WORKSPACE METHOD: ySimpleSpectrometer.

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
[out]yWS Output
[out]y_fWS Output
[in]iyWS Input
[in]stokes_dimWS Input
[in]f_gridWS Input
[in]dfGeneric Input

Definition at line 3162 of file m_sensor.cc.

References AntennaOff(), backend_channel_responseFlat(), joker, last(), linspace(), mult(), ConstVectorView::nelem(), Sparse::nrows(), Vector::resize(), sensor_responseBackend(), and sensor_responseInit().

Referenced by ySimpleSpectrometer_g().

Variable Documentation

◆ DEG2RAD

const Numeric DEG2RAD

Referenced by sensor_responseStokesRotation().

◆ GFIELD1_F_GRID

const Index GFIELD1_F_GRID

Referenced by sensor_responseBackend(), and sensor_responseMixer().

◆ GFIELD4_AA_GRID

const Index GFIELD4_AA_GRID

Referenced by sensor_responseAntenna().

◆ GFIELD4_F_GRID

const Index GFIELD4_F_GRID

Referenced by sensor_responseAntenna().

◆ GFIELD4_FIELD_NAMES

const Index GFIELD4_FIELD_NAMES

Referenced by sensor_responseAntenna().

◆ GFIELD4_ZA_GRID

const Index GFIELD4_ZA_GRID

Referenced by AntennaConstantGaussian1D(), and sensor_responseAntenna().

◆ PI

const Numeric PI

◆ RAD2DEG

const Numeric RAD2DEG

Referenced by antenna_responseVaryingGaussian().

◆ SPEED_OF_LIGHT

const Numeric SPEED_OF_LIGHT

Referenced by antenna_responseVaryingGaussian().