HarmonicFieldsSetEvaluation Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Evaluation functions for HarmonicFieldSet objects. More...

Public Member Functions
ComplexAmplitude	ExtractFieldSummation (HarmonicFieldsSet hfs, VectorialComponents componentCombination, bool applySqrtOnSummationField)
	Calculates and returns the intensity distribution (or the square roots of it) of a given harmonic fields set and according to a given component combination. The function is parallelized.
	HarmonicFieldsSetEvaluation ()
	Standard constructor.

Static Public Member Functions
static SamplingParameters	AdjustSamplingParameters (HarmonicFieldsSet sf, double dOversamplingFactor)
	The sampling parameters of all complex amplitude members in the HarmonicFieldsSet is made equal to the sampling parameters of smallest sampling distance and the largest field diameter.
static ComplexField	ExtractLineProfile (HarmonicFieldsSet inputField, VectorialComponent component, double accuracyFactor, VectorD StartPosition, VectorD EndPosition)
	returns the line profile through all CAs in the field on a line
static ComplexField	ExtractProfileAtAPoint (HarmonicFieldsSet inputField, VectorialComponent component, double x, double y)
	returns the profile through all CAs in the field at one point
static ComplexFieldArray	ExtractRectangle (HarmonicFieldsSet inputField, VectorialComponent component, VectorD centerPointRectangle, SamplingParameters samplingParametersRectangle)
	static support function to extract a rectangle from a given harmonic fields set with some additional parameters
static List< VectorD >	ExtractWavelengthInformation (HarmonicFieldsSet hfs)
	Extracts all wavelengths from a Harmonic Fields Set.
static List< HarmonicFieldBase >	SplitByWavelength (HarmonicFieldBase harmonicField)
	Splits the given Harmonic Field by wavelength whereas the member fields are not cloned.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Evaluation functions for HarmonicFieldSet objects.

Member Function Documentation

AdjustSamplingParameters()

static SamplingParameters AdjustSamplingParameters ( HarmonicFieldsSet  sf, double  dOversamplingFactor  )

static

The sampling parameters of all complex amplitude members in the HarmonicFieldsSet is made equal to the sampling parameters of smallest sampling distance and the largest field diameter.

Parameters

sf	the harmonic field set
dOversamplingFactor	additional oversampling factor

Returns

the sampling parameter

ExtractFieldSummation()

ComplexAmplitude ExtractFieldSummation	(	HarmonicFieldsSet	hfs,
		VectorialComponents	componentCombination,
		bool	applySqrtOnSummationField
	)

Calculates and returns the intensity distribution (or the square roots of it) of a given harmonic fields set and according to a given component combination. The function is parallelized.

Parameters

hfs	HarmonicFieldsSet from that intensities or square root of intensities are to be calculated
componentCombination	Specifies which of the field components Ex, Ey and Ez shall be considered.
applySqrtOnSummationField	If true, the square root will be applied on the returned array after summation. If false, the returned summation array is equivalent to the intensity distribution of the entire harmonic fields set.

Returns

A ComplexAmplitude object with appropriate sampling containing the field summations.

ExtractLineProfile()

static ComplexField ExtractLineProfile ( HarmonicFieldsSet  inputField, VectorialComponent  component, double  accuracyFactor, VectorD  StartPosition, VectorD  EndPosition  )

static

returns the line profile through all CAs in the field on a line

Parameters

inputField	field to get the profile from
component	the vectorial component which shall be analyzed
accuracyFactor	the accuracy factor with which the profile line shall be evaluated
StartPosition	the start point of the profile line
EndPosition	the end point of the profile line

Returns

the two dimensional

ExtractProfileAtAPoint()

static ComplexField ExtractProfileAtAPoint ( HarmonicFieldsSet  inputField, VectorialComponent  component, double  x, double  y  )

static

returns the profile through all CAs in the field at one point

Parameters

inputField	field to get the profile from
component	the vectorial component which shall be analyzed
x	x-coordinate of the point
y	y-coordinate of the point

Returns

A one-dimensional complex field containing per member field the value at the given position.

ExtractRectangle()

static ComplexFieldArray ExtractRectangle ( HarmonicFieldsSet  inputField, VectorialComponent  component, VectorD  centerPointRectangle, SamplingParameters  samplingParametersRectangle  )

static

static support function to extract a rectangle from a given harmonic fields set with some additional parameters

Parameters

inputField	the input field that should be used for the extraction
component	the vectorial component which shall be extracted
centerPointRectangle	the center point of the rectangle which should be extracted
samplingParametersRectangle	the sampling parameters used for the extraction

Returns

a ComplexFieldArray which represents the extracted rectangle

ExtractWavelengthInformation()

static List< VectorD > ExtractWavelengthInformation ( HarmonicFieldsSet  hfs )

static

Extracts all wavelengths from a Harmonic Fields Set.

Parameters

hfs	The Harmonic Fields Set.

Returns

List of all wavelengths in the Harmonic Fields Set.

SplitByWavelength()

static List< HarmonicFieldBase > SplitByWavelength ( HarmonicFieldBase  harmonicField )

static

Splits the given Harmonic Field by wavelength whereas the member fields are not cloned.

Parameters

harmonicField

The Harmonic Fields Set to split.

Returns

A list of harmonic fields, one per wavelength. If there is only one mode for a certain wavelength, a ComplexAmplitude is stored, else a HarmonicFieldsSet. The resulting list is sorted ascending by wavelength.