ReFRACtor
Python.factory.creator.retrieval.NLLSRetrieval Class Reference
+ Inheritance diagram for Python.factory.creator.retrieval.NLLSRetrieval:
+ Collaboration diagram for Python.factory.creator.retrieval.NLLSRetrieval:

Public Member Functions

def __init__ (self, vargs, kwargs)
 
def __call__ (self, kwargs)
 
def create (self, kwargs)
 
def deregister_to_receive (self, RfType=None)
 
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)
 
 initial_guess = param.Array(dims=1)
 
 retrieval_components = param.Dict()
 
 solver = param.Choice(param.InstanceOf(rf.NLLSSolver), param.InstanceOf(rf.ConnorSolver))
 
 state_vector = param.InstanceOf(rf.StateVector)
 

Detailed Description

Definition at line 33 of file retrieval.py.

Constructor & Destructor Documentation

◆ __init__()

def Python.factory.creator.retrieval.NLLSRetrieval.__init__ (   self,
  vargs,
  kwargs 
)

Definition at line 39 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.

◆ create()

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

Definition at line 42 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.

◆ 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.NLLSRetrieval.a_priori = param.Array(dims=1)
static

Definition at line 35 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.NLLSRetrieval.covariance = param.Array(dims=2)
static

Definition at line 36 of file retrieval.py.

◆ initial_guess

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

Definition at line 15 of file retrieval.py.

◆ parameters

Python.factory.creator.base.Creator.parameters
inherited

Definition at line 76 of file base.py.

◆ retrieval_components

Python.factory.creator.retrieval.RetrievalBaseCreator.retrieval_components = param.Dict()
staticinherited

Definition at line 13 of file retrieval.py.

◆ solver

Python.factory.creator.retrieval.NLLSRetrieval.solver = param.Choice(param.InstanceOf(rf.NLLSSolver), param.InstanceOf(rf.ConnorSolver))
static

Definition at line 37 of file retrieval.py.

◆ state_vector

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

Definition at line 14 of file retrieval.py.


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

Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:14