rl_TransmissionCoefPOD Class Reference

#include <rl_TransmissionCoefPOD.h>

List of all members.

Public Member Functions

void init ()
void init (rl_Traits::complex &para, rl_Traits::complex &perp)
double transmission (double polarization_factor=0.0) const
rl_Traits::complex para () const
rl_Traits::complexpara ()
rl_Traits::complex perp () const
rl_Traits::complexperp ()
std::ostream & print_on (std::ostream &os, char const pre[]="", char const pst[]="") const
void cprint_on (std::FILE *of, char const pre[]="", char const pst[]="") const


Detailed Description

A Plain Ol' Data class representing complex reflection coefficients.

Definition at line 75 of file rl_TransmissionCoefPOD.h.


Member Function Documentation

void rl_TransmissionCoefPOD::init (  )  [inline]

Initialize perpendicular (s) and parallel (p) transmission coefficients to zero.

Definition at line 171 of file rl_TransmissionCoefPOD.h.

void rl_TransmissionCoefPOD::init ( rl_Traits::complex para,
rl_Traits::complex perp 
) [inline]

Iinitialize perpendicular (s) and parallel (p) transmission coefficients.

Parameters:
para parallel transmission coefficient
perp perpendicular transmission coefficient

Definition at line 178 of file rl_TransmissionCoefPOD.h.

double rl_TransmissionCoefPOD::transmission ( double  polarization_factor = 0.0  )  const [inline]

Transmission factor.

Parameters:
polarization_factor polarization factor; it must be a value between -1 and 1. The polarization factor is related to parallel (p) and perpendicular (s) polarization by:

\[ \mathtt{polarization\_factor} = {(I_\perp - I_\parallel) \over (I_\perp + I_\parallel)} \]

or

\[ \mathtt{polarization\_factor} = {(I_\mathit{s} - I_\mathit{p}) \over (I_\mathit{s} + I_\mathit{p})} \]

where $I_\perp$ and $I_\parallel$ are the perpendicular and parallel E-field intensities, respectively. Thus,

  • -1: pure parallel (p) polarization.
  • 0: completely unpolarized.
  • +1: pure perpendicular (s) polarization.
Returns:
transmission factor

Definition at line 202 of file rl_TransmissionCoefPOD.h.

rl_Traits::complex rl_TransmissionCoefPOD::para (  )  const [inline]

Returns:
parallel (p) transmission coefficient.

Definition at line 186 of file rl_TransmissionCoefPOD.h.

Referenced by rl_DielectricLayer::cprint_constraints_on(), and rl_DielectricLayer::reflect_amp().

rl_Traits::complex & rl_TransmissionCoefPOD::para (  )  [inline]

Returns:
parallel (p) transmission coefficient (read/write access).

Definition at line 194 of file rl_TransmissionCoefPOD.h.

rl_Traits::complex rl_TransmissionCoefPOD::perp (  )  const [inline]

Returns:
perpendicular (s) transmission coefficient.

Definition at line 190 of file rl_TransmissionCoefPOD.h.

Referenced by rl_DielectricLayer::cprint_constraints_on(), and rl_DielectricLayer::reflect_amp().

rl_Traits::complex & rl_TransmissionCoefPOD::perp (  )  [inline]

Returns:
perpendicular (s) transmission coefficient (read/write access).

Definition at line 198 of file rl_TransmissionCoefPOD.h.

std::ostream & rl_TransmissionCoefPOD::print_on ( std::ostream &  os,
char const   pre[] = "",
char const   pst[] = "" 
) const [inline]

Print reflectivity information to output stream.

Parameters:
os output stream.
pre optional prefix (char*) string.
pst optional postfix (char*) string.

Definition at line 209 of file rl_TransmissionCoefPOD.h.

void rl_TransmissionCoefPOD::cprint_on ( std::FILE *  of,
char const   pre[] = "",
char const   pst[] = "" 
) const [inline]

Print reflectivity information to output FILE* stream.

Parameters:
of output FILE* stream.
pre optional prefix (char*) string.
pst optional postfix (char*) string.

Definition at line 218 of file rl_TransmissionCoefPOD.h.


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

Generated on Mon Nov 3 18:15:05 2008 for rl_raylib by  doxygen 1.5.6