NASA Logo
Ocean Color Science Software

ocssw V2022
Inheritance diagram for Converter:
[legend]

Public Member Functions

def __init__ (self)
 
def convert (self, field_array)
 

Detailed Description

Base class for all converter objects.

This class is extended to create converters, and users may extend this
class to write their own custom converters.

To write a converter, one must create a subclass and override either the method
`convert(*field_arrays)`. This method implements the conversion for an entire
sequence of decoded packet field values in a single call.

Definition at line 27 of file converters.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self)

Definition at line 38 of file converters.py.

Member Function Documentation

◆ convert()

def convert (   self,
  field_array 
)
Convert a sequence of decoded packet field values.

Parameters
----------
field_array : NumPy array
    decoded packet field values, must have at least one dimension

Returns
-------
converted_field_array : NumPy array
    converted form of the decoded packet field values

Reimplemented in StringifyBytesConverter, EnumConverter, and PolyConverter.

Definition at line 41 of file converters.py.


The documentation for this class was generated from the following file:
  • /gfs-oceanweb/web/ocssw/ocssw_src/src/scripts/telemetry/ccsdspy/converters.py