ContentsIndexReferenceHome
PreviousUpNext
ParamStruct
MATLAB
P = ParamStruct(lambda,TxD,RxD)
P = ParamStruct(XMLFile)
Description

Return a basic parameter structure, as from SourceParams or RelayParams in SHaRE, with ideal system parameter settings.

Parameters
Parameters 
Description 
lambda [scalar] 
Wavelength of laser (m). Leave empty to return parameters for a relay system. 
TxD [scalar] 
(Optional) Diameter of system transmitter (m). Defaults to 1.0 m 
RxD [scalar] 
(Optional) Diameter of system receiver (m). If lambda is empty, defaults to value of TxD if not input or input as empty. 
XMLFile [string] 
Name of xml file. System parameters will be imported from the specified xml file as saved by APIstruct.struct2xml. The default xml file location is the directory returned from ParamPath
Return Values
Return Values 
Description 
P [struct] 
System parameter structure as from either SourceParams or RelayParams depending on lambda. 
P.name [string] 
Name of relay system 
P.HEL [struct] 
Structure containing HEL parameters. If lambda is empty, P.HEL is empty indicating a relay system. 
P.Tx [struct] 
Structure containing transmit parameters 
P.Rx [struct] 
Structure containing receiver parameters. If lambda is not empty, P.Rx is empty indicating a laser source system. 
Examples

>> P = ParamStruct(1e-6,0.5); 

  • Parameter structure for a source at 1 micron and 50 cm transmitter
>> P = ParamStruct([],0.5); 

  • Parameter structure for a relay with 50 cm transmitter and receiver
 

See Also

CaseStruct, SourceParams, RelayParams, APIstruct

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