ReFRACtor
Python.factory.creator.instrument.DispersionPolynomial Class Reference
+ Inheritance diagram for Python.factory.creator.instrument.DispersionPolynomial:
+ Collaboration diagram for Python.factory.creator.instrument.DispersionPolynomial:

Public Member Functions

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)
 
def retrieval_flag (self, kwargs)
 
def retrieval_flag (self)
 

Public Attributes

 common_store
 
 config_def
 
 parameters
 

Static Public Attributes

 desc_band_name = param.Iterable(str)
 
 is_one_based = param.Scalar(bool, default=False)
 
 num_channels = param.Scalar(int)
 
 num_parameters = param.Scalar(int, default=2)
 
 number_samples = param.Array(dims=1)
 
 retrieved = param.Iterable(required=False)
 
 spec_win = param.InstanceOf(rf.SpectralWindow)
 
 value = param.Choice(param.Array(dims=2), param.ArrayWithUnit(dims=2))
 

Detailed Description

Definition at line 26 of file instrument.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.instrument.DispersionPolynomial.create (   self,
  kwargs 
)

Definition at line 41 of file instrument.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.

◆ retrieval_flag() [1/2]

def Python.factory.creator.value.CreatorFlaggedValueMultiChannel.retrieval_flag (   self,
  kwargs 
)
inherited

Definition at line 34 of file value.py.

◆ retrieval_flag() [2/2]

def Python.factory.creator.instrument.DispersionPolynomial.retrieval_flag (   self)

Definition at line 35 of file instrument.py.

Member Data Documentation

◆ 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.

◆ desc_band_name

Python.factory.creator.instrument.DispersionPolynomial.desc_band_name = param.Iterable(str)
static

Definition at line 31 of file instrument.py.

◆ is_one_based

Python.factory.creator.instrument.DispersionPolynomial.is_one_based = param.Scalar(bool, default=False)
static

Definition at line 29 of file instrument.py.

◆ num_channels

Python.factory.creator.instrument.DispersionPolynomial.num_channels = param.Scalar(int)
static

Definition at line 32 of file instrument.py.

◆ num_parameters

Python.factory.creator.instrument.DispersionPolynomial.num_parameters = param.Scalar(int, default=2)
static

Definition at line 30 of file instrument.py.

◆ number_samples

Python.factory.creator.instrument.DispersionPolynomial.number_samples = param.Array(dims=1)
static

Definition at line 28 of file instrument.py.

◆ parameters

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

Definition at line 76 of file base.py.

◆ retrieved

Python.factory.creator.value.CreatorFlaggedValueMultiChannel.retrieved = param.Iterable(required=False)
staticinherited

Definition at line 32 of file value.py.

◆ spec_win

Python.factory.creator.instrument.DispersionPolynomial.spec_win = param.InstanceOf(rf.SpectralWindow)
static

Definition at line 33 of file instrument.py.

◆ value

Python.factory.creator.value.CreatorFlaggedValueMultiChannel.value = param.Choice(param.Array(dims=2), param.ArrayWithUnit(dims=2))
staticinherited

Definition at line 31 of file value.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