Skip to content

Commit

Permalink
refine the docstr
Browse files Browse the repository at this point in the history
  • Loading branch information
zihaoxu98 committed Nov 13, 2023
1 parent e149328 commit 61c1dc8
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions appletree/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -280,11 +280,12 @@ def pdf_to_cdf(self, x, pdf):
class SigmaMap(Config):
"""Maps with uncertainty.
Default value is a list whose order is:
[median, lower, upper, (parameter)]
Each map is assigned as attribute of SigmaMap.
If the last element in the list is the required parameter.
The value of a SigmaMap can be:
* a list with four elements, which are the file names of median, lower, upper maps and the name of the scaler.
* a list with three elements, which are the file names of median, lower and upper maps. The name of the scaler is the default one f"{self.name}_sigma".
* a string, which is the file name of the median map.
In the first and second case, the name of the scaler will appear in component.needed_parameters.
"""

def build(self, llh_name: Optional[str] = None):
Expand Down

0 comments on commit 61c1dc8

Please sign in to comment.