Flucut: Difference between revisions
Jump to navigation
Jump to search
imported>Scott (Created page with " ===Purpose=== Remove scatter from fluorescence EEM data. ===Synopsis=== :code here ===Description=== FLUCUT inserts a mixture of NaN and 0 values outside the data area of i...") |
imported>Scott No edit summary |
||
| Line 1: | Line 1: | ||
===Purpose=== | ===Purpose=== | ||
| Line 22: | Line 21: | ||
'''NOTE''': In general, for all the above, setting the input to NaN, implies that the functionality is not imposed. | '''NOTE''': In general, for all the above, setting the input to NaN, implies that the functionality is not imposed. | ||
'''NOTE''': The following inputs govern how data are set to missing and zero. | |||
: '''LowZero''' and '''LowMiss''' are used to account for Rayleigh scatter, and | : '''LowZero''' and '''LowMiss''' are used to account for Rayleigh scatter, and | ||
: '''TopZero''' and '''TopMiss''' are used to accound for 2nd order scatter. | : '''TopZero''' and '''TopMiss''' are used to accound for 2nd order scatter. | ||
| Line 44: | Line 42: | ||
===See Also=== | ===See Also=== | ||
[[ | [[parafac]] | ||
Revision as of 14:37, 27 September 2011
Purpose
Remove scatter from fluorescence EEM data.
Synopsis
- code here
Description
FLUCUT inserts a mixture of NaN and 0 values outside the data area of interest in an EEM (Excitation-Emission Matrix). FLUCUT may also be used to generate weights that can be used for deweighting scatter areas.
Inputs
- first = first input is this.
- X = X-array of EEMs. X is size IxJxK, where I is number of samples, J emissions and K excitations. X has to be a DataSet object where the axisscales contain wavelengths where X.axisscale{2} corresponds to emissions (emi) in nm and X.axisscale{3} corresponds to excitations (exci) in nm.
- LowZero = Wavelength (nm): X(emi < exci-LowZero) are set to zero. Zeros here are good for speeding up, but can lead to artifacts if the zeros are too close to the emi==exci line. Use LowMiss.
- LowMiss = Wavelength (nm): the region where emi <= exci+LowMiss(1) are set to missing (i.e., NaN) to remove scatter. If LowMiss is a 2 element vector, then only the region down to emi >= exci-LowMiss(2) are also set to missing. However, the zeros set by LowZero supercede the missing setting.
- TopZero = nm above emi==2*exci which is set to zero {default is NaN meaning no zeros (to avoid second order signal to be biased to be zero)}.
- TopMiss = Similar to LowMiss but for emi==2*exci.
NOTE: In general, for all the above, setting the input to NaN, implies that the functionality is not imposed. NOTE: The following inputs govern how data are set to missing and zero.
- LowZero and LowMiss are used to account for Rayleigh scatter, and
- TopZero and TopMiss are used to accound for 2nd order scatter.
Optional Inputs
- MakeWts = If 0 or [] empty, no weights are calculated. Otherwise, weights will be given that can be used to downweight areas of scatter e.g., in PARAFAC models. The weights will be held in the output dataset field 'userdata'. {default = 0, do not make weights}
- plots = governs plotting. If 0 not plots are made, default == 1.
Outputs
- Xnew = New X-array with inserted NaN (for missing) and 0-values. Columns with only missing values are removed.
Example
load dorrit Xnew = flucut(EEM,20,[20 20],NaN,NaN,0);