ARTS 2.5.11 (git: 6827797f)
Public Attributes | Friends | List of all members
Ppath Struct Reference

The structure to describe a propagation path and releated quantities. More...

#include <ppath_struct.h>

Public Attributes

Index dim
 Atmospheric dimensionality.
 
Index np
 Number of points describing the ppath.
 
Numeric constant
 The propagation path constant (only used for 1D)
 
String background
 Radiative background.
 
Vector start_pos
 Start position.
 
Vector start_los
 Start line-of-sight.
 
Numeric start_lstep
 Length between sensor and atmospheric boundary.
 
Matrix pos
 The distance between start pos and the last position in pos.
 
Matrix los
 Line-of-sight at each ppath point.
 
Vector r
 Radius of each ppath point.
 
Vector lstep
 The length between ppath points.
 
Vector end_pos
 End position.
 
Vector end_los
 End line-of-sight.
 
Numeric end_lstep
 The distance between end pos and the first position in pos.
 
Vector nreal
 The real part of the refractive index at each path position.
 
Vector ngroup
 The group index of refraction.
 
ArrayOfGridPos gp_p
 Index position with respect to the pressure grid.
 
ArrayOfGridPos gp_lat
 Index position with respect to the latitude grid.
 
ArrayOfGridPos gp_lon
 Index position with respect to the longitude grid.
 

Friends

std::ostream & operator<< (std::ostream &os, const Ppath &x)
 

Detailed Description

The structure to describe a propagation path and releated quantities.

The fields of the structure are described more in detail inside the ARTS user guide (AUG).

Definition at line 17 of file ppath_struct.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const Ppath &  x 
)
friend

Definition at line 13 of file ppath_struct.cc.

Member Data Documentation

◆ background

String Ppath::background

Radiative background.

Definition at line 25 of file ppath_struct.h.

Referenced by get_iy_of_background(), ppath_append(), ppath_calc(), ppath_copy(), ppath_set_background(), ppath_what_background(), xml_read_from_stream(), and xml_write_to_stream().

◆ constant

Numeric Ppath::constant

The propagation path constant (only used for 1D)

Definition at line 23 of file ppath_struct.h.

Referenced by defocusing_sat2sat(), ppath_calc(), ppath_copy(), ppath_end_1d(), ppath_end_2d(), ppath_end_3d(), ppath_init_structure(), ppath_start_stepping(), ppath_step_geom_1d(), ppath_step_geom_2d(), ppath_step_geom_3d(), ppath_step_refr_1d(), xml_read_from_stream(), and xml_write_to_stream().

◆ dim

Index Ppath::dim

Atmospheric dimensionality.

Definition at line 19 of file ppath_struct.h.

Referenced by bending_angle1d(), cloud_RT_surface(), emission_from_propmat_field(), ppath_append(), ppath_copy(), ppath_init_structure(), xml_read_from_stream(), and xml_write_to_stream().

◆ end_los

Vector Ppath::end_los

End line-of-sight.

Definition at line 43 of file ppath_struct.h.

Referenced by bending_angle1d(), defocusing_sat2sat(), ppath_calc(), ppath_copy(), ppath_init_structure(), ppath_start_stepping(), xml_read_from_stream(), and xml_write_to_stream().

◆ end_lstep

Numeric Ppath::end_lstep

The distance between end pos and the first position in pos.

Definition at line 45 of file ppath_struct.h.

Referenced by defocusing_general(), defocusing_general_sub(), defocusing_sat2sat(), iyIndependentBeamApproximation(), mcPathTraceRadar(), MCRadar(), ppath_calc(), ppath_copy(), ppath_init_structure(), ppath_start_stepping(), rtmethods_unit_conversion(), xml_read_from_stream(), xml_write_to_stream(), and yRadar().

◆ end_pos

Vector Ppath::end_pos

End position.

Definition at line 41 of file ppath_struct.h.

Referenced by bending_angle1d(), defocusing_general(), defocusing_sat2sat(), ppath_calc(), ppath_copy(), ppath_init_structure(), ppath_start_stepping(), xml_read_from_stream(), and xml_write_to_stream().

◆ gp_lat

ArrayOfGridPos Ppath::gp_lat

Index position with respect to the latitude grid.

Definition at line 53 of file ppath_struct.h.

Referenced by cloud_ppath_update3D(), get_ppath_atmvars(), get_ppath_cloudvars(), get_ppath_transmat(), is_inside_cloudbox(), iyIndependentBeamApproximation(), MCGeneral(), mcPathTraceGeneral(), mcPathTraceRadar(), ppath_append(), ppath_calc(), ppath_copy(), ppath_end_2d(), ppath_end_3d(), ppath_init_structure(), ppath_start_2d(), ppath_start_3d(), ppath_start_stepping(), xml_read_from_stream(), and xml_write_to_stream().

◆ gp_lon

ArrayOfGridPos Ppath::gp_lon

Index position with respect to the longitude grid.

Definition at line 55 of file ppath_struct.h.

Referenced by cloud_ppath_update3D(), get_ppath_atmvars(), get_ppath_cloudvars(), get_ppath_transmat(), is_inside_cloudbox(), iyIndependentBeamApproximation(), MCGeneral(), mcPathTraceGeneral(), mcPathTraceRadar(), ppath_append(), ppath_calc(), ppath_copy(), ppath_end_3d(), ppath_init_structure(), ppath_start_3d(), ppath_start_stepping(), xml_read_from_stream(), and xml_write_to_stream().

◆ gp_p

ArrayOfGridPos Ppath::gp_p

Index position with respect to the pressure grid.

Definition at line 51 of file ppath_struct.h.

Referenced by cloud_ppath_update1D(), cloud_ppath_update1D_noseq(), cloud_ppath_update3D(), emission_from_propmat_field(), get_ppath_atmvars(), get_ppath_cloudvars(), get_ppath_transmat(), interp_cloud_coeff1D(), is_inside_cloudbox(), iyEmissionHybrid(), iyIndependentBeamApproximation(), line_irradianceCalcForSingleSpeciesNonOverlappingLinesPseudo2D(), MCGeneral(), mcPathTraceGeneral(), mcPathTraceRadar(), ppath_append(), ppath_calc(), ppath_copy(), ppath_end_1d(), ppath_end_2d(), ppath_end_3d(), ppath_init_structure(), ppath_start_1d(), ppath_start_2d(), ppath_start_3d(), ppath_start_stepping(), spectral_radiance_fieldClearskyPlaneParallel(), spectral_radiance_fieldExpandCloudboxField(), xml_read_from_stream(), and xml_write_to_stream().

◆ los

Matrix Ppath::los

Line-of-sight at each ppath point.

Definition at line 35 of file ppath_struct.h.

Referenced by cloud_ppath_update1D(), cloud_ppath_update1D_noseq(), cloud_ppath_update3D(), cloud_RT_surface(), defocusing_general_sub(), get_iy_of_background(), get_ppath_f(), get_ppath_transmat(), get_sun_background(), interp_cloud_coeff1D(), iyClearsky(), iyEmissionHybrid(), iyEmissionStandard(), iyRadarSingleScat(), iyTransmissionStandard(), mcPathTraceGeneral(), mcPathTraceRadar(), ppath_append(), ppath_calc(), ppath_copy(), ppath_end_1d(), ppath_end_2d(), ppath_end_3d(), ppath_init_structure(), ppath_start_1d(), ppath_start_2d(), ppath_start_3d(), ppath_start_stepping(), xml_read_from_stream(), and xml_write_to_stream().

◆ lstep

Vector Ppath::lstep

The length between ppath points.

Definition at line 39 of file ppath_struct.h.

Referenced by cloud_RT_no_background(), defocusing_general(), defocusing_general_sub(), defocusing_sat2sat(), emission_from_propmat_field(), get_ppath_transmat(), iyClearsky(), iyEmissionHybrid(), iyEmissionStandard(), iyRadarSingleScat(), iyTransmissionStandard(), mcPathTraceGeneral(), mcPathTraceRadar(), MCRadar(), ppath_append(), ppath_calc(), ppath_copy(), ppath_end_1d(), ppath_end_2d(), ppath_end_3d(), ppath_init_structure(), xml_read_from_stream(), xml_write_to_stream(), and yRadar().

◆ ngroup

Vector Ppath::ngroup

The group index of refraction.

Definition at line 49 of file ppath_struct.h.

Referenced by mcPathTraceRadar(), MCRadar(), ppath_append(), ppath_calc(), ppath_copy(), ppath_end_1d(), ppath_end_2d(), ppath_end_3d(), ppath_init_structure(), ppath_start_stepping(), xml_read_from_stream(), xml_write_to_stream(), and yRadar().

◆ np

Index Ppath::np

Number of points describing the ppath.

Definition at line 21 of file ppath_struct.h.

Referenced by cloud_ppath_update1D(), cloud_ppath_update1D_noseq(), cloud_ppath_update3D(), cloud_RT_no_background(), cloud_RT_surface(), defocusing_general(), defocusing_general_sub(), defocusing_sat2sat(), diy_from_path_to_rgrids(), emission_from_propmat_field(), error_if_limb_ppath(), find_tanpoint(), first_pos_before_altitude(), get_iy_of_background(), get_ppath_atmvars(), get_ppath_cloudvars(), get_ppath_f(), get_ppath_transmat(), get_sun_background(), get_sun_ppaths(), interp_cloud_coeff1D(), is_inside_cloudbox(), iyClearsky(), iyEmissionHybrid(), iyEmissionStandard(), iyIndependentBeamApproximation(), iyRadarSingleScat(), iyTransmissionStandard(), line_irradianceCalcForSingleSpeciesNonOverlappingLinesPseudo2D(), MCGeneral(), mcPathTraceGeneral(), mcPathTraceRadar(), MCRadar(), ppath_append(), ppath_calc(), ppath_copy(), ppath_init_structure(), ppath_start_1d(), ppath_start_2d(), ppath_start_3d(), rtmethods_unit_conversion(), spectral_radiance_fieldClearskyPlaneParallel(), spectral_radiance_fieldExpandCloudboxField(), xml_read_from_stream(), xml_write_to_stream(), and yRadar().

◆ nreal

Vector Ppath::nreal

The real part of the refractive index at each path position.

Definition at line 47 of file ppath_struct.h.

Referenced by defocusing_general(), defocusing_general_sub(), ppath_append(), ppath_calc(), ppath_copy(), ppath_end_1d(), ppath_end_2d(), ppath_end_3d(), ppath_init_structure(), ppath_start_stepping(), rtmethods_unit_conversion(), xml_read_from_stream(), and xml_write_to_stream().

◆ pos

Matrix Ppath::pos

The distance between start pos and the last position in pos.

Definition at line 33 of file ppath_struct.h.

Referenced by cloud_ppath_update1D(), cloud_ppath_update1D_noseq(), cloud_ppath_update3D(), cloud_RT_surface(), defocusing_general_sub(), diy_from_path_to_rgrids(), error_if_limb_ppath(), find_tanpoint(), first_pos_before_altitude(), get_iy_of_background(), get_sun_background(), iyClearsky(), iyIndependentBeamApproximation(), mcPathTraceGeneral(), mcPathTraceRadar(), ppath_append(), ppath_calc(), ppath_copy(), ppath_end_1d(), ppath_end_2d(), ppath_end_3d(), ppath_init_structure(), ppath_start_1d(), ppath_start_2d(), ppath_start_3d(), ppath_start_stepping(), xml_read_from_stream(), xml_write_to_stream(), and yRadar().

◆ r

Vector Ppath::r

Radius of each ppath point.

Definition at line 37 of file ppath_struct.h.

Referenced by cloud_ppath_update1D(), cloud_ppath_update1D_noseq(), cloud_ppath_update3D(), defocusing_general_sub(), ppath_append(), ppath_calc(), ppath_copy(), ppath_end_1d(), ppath_end_2d(), ppath_end_3d(), ppath_init_structure(), ppath_start_1d(), ppath_start_2d(), ppath_start_3d(), ppath_start_stepping(), xml_read_from_stream(), and xml_write_to_stream().

◆ start_los

Vector Ppath::start_los

Start line-of-sight.

Definition at line 29 of file ppath_struct.h.

Referenced by bending_angle1d(), defocusing_general(), defocusing_sat2sat(), ppath_append(), ppath_calc(), ppath_copy(), ppath_init_structure(), xml_read_from_stream(), and xml_write_to_stream().

◆ start_lstep

Numeric Ppath::start_lstep

Length between sensor and atmospheric boundary.

Definition at line 31 of file ppath_struct.h.

Referenced by defocusing_general(), defocusing_sat2sat(), ppath_append(), ppath_calc(), ppath_copy(), ppath_init_structure(), xml_read_from_stream(), and xml_write_to_stream().

◆ start_pos

Vector Ppath::start_pos

Start position.

Definition at line 27 of file ppath_struct.h.

Referenced by bending_angle1d(), defocusing_general(), ppath_append(), ppath_calc(), ppath_copy(), ppath_init_structure(), xml_read_from_stream(), and xml_write_to_stream().

The documentation for this struct was generated from the following file: