ATMTools User Guide (.pdf)
ContentsIndexReferenceHome
PreviousUpNext
Lookup getAlpha in User's Guide
getAlpha
Collapse All
MATLAB
alpha = getAlpha(Atm,[ModelName])
Description

Given a structure or array of structures from AtmStruct, returns a vector of multipliers applied to the base model function for the specified effect.

Parameters
Parameters 
Description 
Atm [struct] 
Structure or array of structures from AtmStruct 
ModelName [string] 
(Optional) Name of effect in Atm for which to extract the multiplier. Defaults to 'Cn2' 
Return Values
Return Values 
Description 
alpha [vector] 
Vector of multipliers for ModelName 
Examples

>> alpha = getAlpha(AtmStruct) 

  • Get the multiplier on Cn2 from the input Atm struct
>> Atm = ChangeAtm(AtmStruct,'Wind',{'Bufton';'4*Bufton';'10*Bufton'}); 

>> alpha = getAlpha(Atm,'Wind'); 

  • Return the multiplier applied to the Bufton model for wind speed.
 

See Also

AtmStruct, ChangeAtm

Group

General Utility Functions

Made with Doc-O-Matic.
Copyright (c) 2009. All rights reserved.
Contents | Index | Reference | Home
What do you think about this topic? Send feedback!