Commits

Kazuhiko Shimada authored 86e414260d6
PIPE-1588: modified a docstring
No tags

pipeline/hsd/heuristics/baselineparamconfig.py

Modified
124 124 field_id: Field ID to process
125 125 spw_id: Spw ID to process
126 126 fit_order: Fiting order ('automatic' or number)
127 127 edge: Number of edge channels to be excluded from the heuristics
128 128 (format: [L, R])
129 129 deviation_mask: Deviation mask
130 130 blparam: Name of the BLParam file
131 131 File contents will be updated by this heuristics
132 132
133 133 Note:
134 - In the method, The boundaries of channel ranges are indicated by a list [start, end].
134 + In this method, the boundaries of channel ranges are indicated by a list [start, end].
135 135 Basically, the treatment of pythonic range is [start, end+1], but it is not intuitive for
136 - dealing with channels and masks of MeasurementSet. so these are written as [start, end]
136 + dealing with channels and masks of MeasurementSet. Therefore these are written as [start, end]
137 137 in this source. Pythonic range-lists as boundaries for MS are only used in local processing
138 - scopes like a local function or loop block. Outer of these scopes, we should write
139 - the channel/mask range [start, end].
138 + scopes like a local function or loop block. Other than these scopes, we should write
139 + the channel/mask range as [start, end].
140 140
141 141 Returns:
142 142 Name of the BLParam file
143 143 """
144 144 LOG.debug('Starting BaselineFitParamConfig')
145 145 fragmentation_heuristic = fragmentation.FragmentationHeuristics()
146 146
147 147 # fitting order
148 148 if fit_order == 'automatic':
149 149 # fit order heuristics

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut