-
Notifications
You must be signed in to change notification settings - Fork 53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Explanations of parameters #45
Comments
I suppose we can use the diagrams in @mheikenfeld 's GMD paper to explain these parameters, like @w-k-jones has done for the Feature detection section. |
Thanks for your comments! Explanation of units should be part of the documentation, for sure! This needs to be integrated into the respective rst files. Gaussian Filter: The filter width just determines how fast the weights for the convolution decay. sigma < 1 is therefore no problem. |
@zxdawn a +1 of thanks from me, as I needed this just now. Also, I would say the docstring for |
@deeplycloudy You're welcome. Glad it's useful ;) Which |
Sorry, I meant |
Ah, maybe a candidate for removal in v. 2.0, then! Or at least deprecation. And thanks for the clarification on |
I suppose if there're n_1 features at t_1 and n_2 features at t_2, and the n_min is between n_1 and n_2, then that may cause the missing features at t_2, so the tracking won't work correctly. |
Looking at the default heuristic for |
@deeplycloudy Yes, you're right. Because we usually use |
@freemansw1 It's fine to me except for the clarification of the unit. Leave the review on that PR now ;) |
Now that #138 is in, I'm going to close this issue. There is still room for improvement on the docs, but I think we have addressed this specific issue. |
Here're some explanations of basic parameters. Most are copied from the codes.
My questions and unfamiliar parts are in bold.
Feature identification
To identify features use
tobac.themes.tobac_v1.feature_detection_multithreshold
method.Tobac allows getting features by checking data above/below one threshold or multiple thresholds (recommended).
target
Flag to determine if tracking is targeting minima or maxima in the data. Default is 'maximum'.
position_threshold
It sets the method to determine the position from the region. Default is 'center'.
Four options are available:
center
,extreme
,weighted_diff
orweighted_abs
.center
geometrical center of identified region
extreme
max/min position inside the identified region
weighted_diff
center of identified region, weighted by difference from the threshold
weighted_abs
center of identified region, weighted by absolute values of the field
sigma_threshold
Standard deviation for intial filtering step. Default is 0.5
I'm not quite sure of the definition above ...
Here's my opinion: That is how many pixels are used to apply a Gaussian filter. How could 0.5 is used to smooth the data. Shouldn't it larger than 1 at least?
n_erosion_threshold
Number of pixel by which to erode the identified features. Default is 0 which means keep the mask as clear as it is.
n_min_threshold
Minimum number of identified features. Default is 0.
If the number of pixel in masked region is less than n_min_threshold, the region is deleted.
min_distance
Minimum distance between detected features. Default is 0.
Remove features that are closer together than min_distance and keep larger one (higher threshold). if threshold is same, keep the larger area.
This is an example to track the minimum TBB:
Segmentation
threshold
Threshold for the watershedding field to be used for the mask. Default is 3e-3.
The algorithm fills the area (2-D) or volume (3-D) based on the input field starting from the weighted mean centers until reaching the threshold.
target
Flag to determine if tracking is targeting minima or maxima in the data. Default is 'maximum'.
This can be different from the target in parameters_features.
level
Levels at which to seed the cells for the watershedding algorithm. Default is None.
I'm not familiar with iris. So not sure the meaning of level
max_distance
Maximum distance from a marker allowed to be classified as belonging to that cell. Default is None. Unit is m which is as same as dxy
Continue the example:
Linking
dt
Time resolution of tracked features. Unit: s
d_max
Maximum search range Default is None.
d_min
Variations in the shape of the regions used to determine the positions of the features can lead to quasi-instantaneous shifts of the position of the feature by one or two grid cells even for a very high temporal resolution of the input data, potentially jeopardising the tracking procedure. To prevent this, tobac uses an additional minimum radius of the search range.
Default is None. Unit: m
v_max
Speed at which features are allowed to move. Default is None. Unit: m/s
memory
Number of output timesteps features allowed to vanish for to be still considered tracked. Default is 0.
.. warning :: This parameter should be used with caution, as it can lead to erroneous trajectory linking, especially for data with low time resolution.
stubs
Minimum number of timesteps of a tracked cell to be reported. Default is 1.
time_cell_min
Minimum length in time of tracked cell to be reported in minutes. Default is None.
extrapolate
Number or timesteps to extrapolate trajectories. Default is 0.
This allows for the inclusion of both the initiation of the cell and the decaying later stages in the
analysis of the cloud life cycle.
method_linking {'random', 'predict'}
Flag choosing method used for trajectory linking. Default is 'random'.
predict is useful for cloud and fluid tracking.
adaptive_step
Reduce search range by multiplying it by this factor.
adaptive_stop
If not None, when encountering an oversize subnet, retry by progressively reducing search_range until the subnet is solvable.
If search_range becomes <= adaptive_stop, give up and raise a SubnetOversizeException. Default is None
cell_number_start
Cell number for first tracked cell. Default is 1.
Example:
Result
It looks good for tracking deep convections using 10 min TBB data:
The text was updated successfully, but these errors were encountered: