aopp_deconv_tool.optimise_compat.PriorParam

class documentation

class PriorParam:

View In Hierarchy

Class that holds parameter information.

name : str
String used to identify the parameter
domain : tuple[float,float]
Range of possible values the parameter can take
is_const : bool
Flag that signals if this parameter is a constant, constant parameters will use const_value
const_value : float
A value to use when const, and for example plots
description : str
A string that describes what this parameter represents
Method __repr__ Undocumented
Method linear_transform_from_domain Returns a function that linearly transforms the parameter's domain to an out_domain
Method linear_transform_to_domain Returns a function that linearly transforms an in_domain to the parameter's domain
Method to_dict Undocumented
Class Variable const_value Undocumented
Class Variable description Undocumented
Class Variable domain Undocumented
Class Variable is_const Undocumented
Class Variable name Undocumented
def __repr__(self):

Undocumented

def linear_transform_from_domain(self, out_domain=(0, 1)):

Returns a function that linearly transforms the parameter's domain to an out_domain

def linear_transform_to_domain(self, in_domain=(0, 1)):

Returns a function that linearly transforms an in_domain to the parameter's domain

def to_dict(self):

Undocumented

const_value: float =

Undocumented

description: str =

Undocumented

domain: tuple[float, float] =

Undocumented

is_const: bool =

Undocumented

name: str =

Undocumented