petitRADTRANS.retrieval.parameter
Module Contents
Classes
Parameter |
- class petitRADTRANS.retrieval.parameter.Parameter(name, is_free_parameter, value=None, transform_prior_cube_coordinate=None, plot_in_corner=False, corner_ranges=None, corner_transform=None, corner_label=None)
Parameter This class allows easy translation between the pyMultinest hypercube and the physical unit space. Each parameter includes a name, which can be used as a reference in the model function, a value, a flag of whether it’s a free parameter, and if it’s free, a function that translates the unit hypercube into physical space. The remainder of the arguments deal with the corner plots.
- Args:
- namestring
The name of the parameter. Must match the name used in the model function.
- is_free_parameterbool
True if the parameter should be sampled in the retrieval
- valuefloat
The value of the parameter. Set using set_param.
- transform_prior_cube_coordinatemethod
Transform the unit interval [0,1] to the physical space of the parameter.
- plot_in_cornerbool
True if this parameter should be included in the output corner plot
- corner_rangesTuple(float,float)
The axis range of the parameter in the corner plot
- corner_transformmethod
A function to scale or transform the value of the parameter for prettier plotting.
- corner_labelstring
The axis label for the parameter, defaults to name.
- get_param_uniform(cube)
- set_param(value)