kalmanFilter.deviations
Specify whether to return ensemble deviations
Syntax
Description
obj = obj.deviations(returnDeviations)obj = obj.deviations(“return”|”r”|true)obj = obj.deviations(“discard”|”d”|false)
Indicate whether to return updated ensemble deviations in the output of “kalmanFilter.run”. If “return”|”r”|true, returns the deviations in the output as the field named “Adev”. If “discard”|”d”|false, does not return the ensemble deviations in the output. By default, kalmanFilter objects do not return ensemble deviations.
When assimilating large state vectors over many ensemble members or time steps, the updated deviations can overwhelm computer memory. If this occurs, consider using the “kalmanFilter.percentiles” method to return a smaller subset of the posterior, the “kalmanFilter.variance” method to assess the spread of the posterior, or the “kalmanFilter.index” method to calculate climate indices from the updated posterior without needing to save the full posterior as output.
returnDeviations = obj.deviations
Return whether the current Kalman filter will return the ensemble deviations of the posterior.
Input Arguments
returnDeviations
[“return”|”r”|true]: Returns the updated ensemble deviations in the output
[“discard”|”d”|false (default)]: Does not return the updated deviations