Python.factory.creator.retrieval.NLLSSolverLM Class Reference

Inheritance diagram for Python.factory.creator.retrieval.NLLSSolverLM:

Collaboration diagram for Python.factory.creator.retrieval.NLLSSolverLM:

Public Member Functions
def	__call__ (self, kwargs)
def	attach_logging (self, solver)
def	create (self, kwargs)
def	deregister_to_receive (self, RfType=None)
def	init_state_vector (self)
def	opt_problem (self)
def	param (self, param_name, kwargs)
def	receive (self, rf_obj)
def	register_parameter (self, param_name, param_def)
def	register_to_receive (self, RfType)

Public Attributes
	common_store
	config_def
	parameters

Static Public Attributes
	a_priori = param.Array(dims=1)
	covariance = param.Array(dims=2)
	cr_ratio_tol = param.Scalar(float, required=False)
	dx_tol_abs = param.Scalar(float, default=1e-6)
	dx_tol_rel = param.Scalar(float, default=1e-6)
	forward_model = param.InstanceOf(rf.ForwardModel)
	g_tol_abs = param.Scalar(float, default=1e-6)
	g_tol_rel = param.Scalar(float, default=1e-6)
	initial_guess = param.Array(dims=1)
	instrument = param.InstanceOf(rf.Instrument)
	l1b = param.InstanceOf(rf.Level1b)
	max_cost_function_calls = param.Scalar(int)
	max_iteration = param.Scalar(int)
	min_W = param.Scalar(float, required=False)
	state_vector = param.InstanceOf(rf.StateVector)
	tr_rad = param.Scalar(float, required=False)
	tr_rad_tol = param.Scalar(float, required=False)

Detailed Description

Definition at line 369 of file retrieval.py.

Member Function Documentation

__call__()

def Python.factory.creator.base.Creator.__call__ (   self,   kwargs  )

inherited

Turns creators into callables so that they can be evaluated by ConfigParam as any other callable without it
needing to know any details of this class.

Definition at line 164 of file base.py.

attach_logging()

def Python.factory.creator.retrieval.MaxAPosterioriBase.attach_logging (   self,   solver  )

inherited

Definition at line 326 of file retrieval.py.

create()

def Python.factory.creator.retrieval.NLLSSolverLM.create	(		self,
			kwargs
	)

Definition at line 383 of file retrieval.py.

deregister_to_receive()

def Python.factory.creator.base.Creator.deregister_to_receive (   self,   RfType = None  )

inherited

Definition at line 127 of file base.py.

init_state_vector()

def Python.factory.creator.retrieval.MaxAPosterioriBase.init_state_vector (   self )

inherited

Definition at line 308 of file retrieval.py.

opt_problem()

def Python.factory.creator.retrieval.MaxAPosterioriBase.opt_problem (   self )

inherited

Definition at line 312 of file retrieval.py.

param()

def Python.factory.creator.base.Creator.param (   self,   param_name,   kwargs  )

inherited

Definition at line 111 of file base.py.

receive()

def Python.factory.creator.base.Creator.receive (   self,   rf_obj  )

inherited

Definition at line 156 of file base.py.

register_parameter()

def Python.factory.creator.base.Creator.register_parameter (   self,   param_name,   param_def  )

inherited

Definition at line 95 of file base.py.

register_to_receive()

def Python.factory.creator.base.Creator.register_to_receive (   self,   RfType  )

inherited

Definition at line 122 of file base.py.

Member Data Documentation

a_priori

Python.factory.creator.retrieval.MaxAPosterioriBase.a_priori = param.Array(dims=1)

staticinherited

Definition at line 303 of file retrieval.py.

common_store

Python.factory.creator.base.Creator.common_store

inherited

Definition at line 65 of file base.py.

config_def

Python.factory.creator.base.Creator.config_def

inherited

Definition at line 71 of file base.py.

covariance

Python.factory.creator.retrieval.MaxAPosterioriBase.covariance = param.Array(dims=2)

staticinherited

Definition at line 304 of file retrieval.py.

cr_ratio_tol

Python.factory.creator.retrieval.NLLSSolverLM.cr_ratio_tol = param.Scalar(float, required=False)

static

Definition at line 381 of file retrieval.py.

dx_tol_abs

Python.factory.creator.retrieval.NLLSSolverLM.dx_tol_abs = param.Scalar(float, default=1e-6)

static

Definition at line 373 of file retrieval.py.

dx_tol_rel

Python.factory.creator.retrieval.NLLSSolverLM.dx_tol_rel = param.Scalar(float, default=1e-6)

static

Definition at line 374 of file retrieval.py.

forward_model

Python.factory.creator.retrieval.MaxAPosterioriBase.forward_model = param.InstanceOf(rf.ForwardModel)

staticinherited

Definition at line 298 of file retrieval.py.

g_tol_abs

Python.factory.creator.retrieval.NLLSSolverLM.g_tol_abs = param.Scalar(float, default=1e-6)

static

Definition at line 375 of file retrieval.py.

g_tol_rel

Python.factory.creator.retrieval.NLLSSolverLM.g_tol_rel = param.Scalar(float, default=1e-6)

static

Definition at line 376 of file retrieval.py.

initial_guess

Python.factory.creator.retrieval.MaxAPosterioriBase.initial_guess = param.Array(dims=1)

staticinherited

Definition at line 302 of file retrieval.py.

instrument

Python.factory.creator.retrieval.MaxAPosterioriBase.instrument = param.InstanceOf(rf.Instrument)

staticinherited

Definition at line 297 of file retrieval.py.

l1b

Python.factory.creator.retrieval.MaxAPosterioriBase.l1b = param.InstanceOf(rf.Level1b)

staticinherited

Definition at line 296 of file retrieval.py.

max_cost_function_calls

Python.factory.creator.retrieval.MaxAPosterioriBase.max_cost_function_calls = param.Scalar(int)

staticinherited

Definition at line 306 of file retrieval.py.

max_iteration

Python.factory.creator.retrieval.NLLSSolverLM.max_iteration = param.Scalar(int)

static

Definition at line 371 of file retrieval.py.

min_W

Python.factory.creator.retrieval.NLLSSolverLM.min_W = param.Scalar(float, required=False)

static

Definition at line 378 of file retrieval.py.

parameters

Python.factory.creator.base.Creator.parameters

inherited

Definition at line 76 of file base.py.

state_vector

Python.factory.creator.retrieval.MaxAPosterioriBase.state_vector = param.InstanceOf(rf.StateVector)

staticinherited

Definition at line 300 of file retrieval.py.

tr_rad

Python.factory.creator.retrieval.NLLSSolverLM.tr_rad = param.Scalar(float, required=False)

static

Definition at line 380 of file retrieval.py.

tr_rad_tol

Python.factory.creator.retrieval.NLLSSolverLM.tr_rad_tol = param.Scalar(float, required=False)

static

Definition at line 379 of file retrieval.py.

---

The documentation for this class was generated from the following file:

• Python/factory/creator/retrieval.py