Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
R
radler
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Jira
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ResearchAndDevelopment
radler
Commits
24bc8dc4
Commit
24bc8dc4
authored
2 years ago
by
Maik Nijhuis
Browse files
Options
Downloads
Patches
Plain Diff
Review comments: Update documentation
parent
8e588f31
No related branches found
Branches containing commit
No related tags found
1 merge request
!23
AST-831 Describe auto_*_sigma settings and use std::optional
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
cpp/settings.h
+9
-13
9 additions, 13 deletions
cpp/settings.h
with
9 additions
and
13 deletions
cpp/settings.h
+
9
−
13
View file @
24bc8dc4
...
...
@@ -3,6 +3,7 @@
#ifndef RADLER_DECONVOLUTION_SETTINGS_H_
#define RADLER_DECONVOLUTION_SETTINGS_H_
#include
<optional>
#include
<set>
#include
<string>
#include
<vector>
...
...
@@ -86,11 +87,11 @@ struct Settings {
* @brief Sigma value for automatically setting the cleaning threshold.
*
* If set, Radler will calculate the standard deviation of the residual image
* before the start of every major deconvolution iteration, and c
lean up to
*
this sigma value times the found no
is
e
s
tandard deviation. The standard
*
deviation is calculated using the medium absolute deviation, which is a
*
robust estimator that is not very sensitive to source structure still
* present in the image.
* before the start of every major deconvolution iteration, and c
ontinue
*
deconvolving until the peak flux density is below th
is s
igma value times
*
the noise standard deviation. The standard deviation is calculated using
*
the medium absolute deviation, which is a robust estimator that is not very
*
sensitive to source structure still
present in the image.
*
* If unset, automatic thresholding is not used.
*/
...
...
@@ -102,17 +103,12 @@ struct Settings {
* If set, Radler performs these steps:
* # Radler starts cleaning towards a threshold of the given sigma value.
* # Once the sigma level is reached, Radler generates a mask using the
* positions and
scale of each component
(when using multi-scale cleaning).
* positions and (when using multi-scale cleaning)
scale of each component
.
* # Cleaning then continues until the final threshold value, as set using the
* @ref threshold or @ref auto_threshold_sigma values. During this final
step,
* the generated mask constrains the cleaning.
* @ref threshold or @ref auto_threshold_sigma values. During this final
*
deconvolution stage,
the generated mask constrains the cleaning.
*
* If unset, automatic masking is not used.
*
* Using auto masking has two advantages:
* - Radler generates and applies mask images in a single run.
* - Radler maintains scale-dependent masks, which improves multi-scale
* cleaning.
*/
std
::
optional
<
double
>
auto_mask_sigma
=
std
::
nullopt
;
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment