IVALab Python Libraries
Collection of code for computer vision and robotics with specific API.
All Classes Namespaces Files Functions Variables Modules Pages
Public Member Functions | Public Attributes | List of all members
Progress Class Reference

A simple interface class for progress monitoring a perceived scene. More...

Inheritance diagram for Progress:
Inheritance graph
[legend]
Collaboration diagram for Progress:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, theParams, thePerceiver, theComparator)
 Constructor for the perceiver.monitor class. More...
 
def adapt (self)
 Adapt parts of the process based on measurements and corrections. More...
 
def correct (self)
 Correct the estimated level based on measured and predicted. More...
 
def displayDebug (self, fh, dbState)
 
def displayState (self, dState=None)
 
def emptyState (self)
 Returns an empty activity state structure. More...
 
def free (self)
 Destructor. More...
 
def getState (self)
 Returns the current activity state structure. More...
 
def info (self)
 Return the information structure used for saving or otherwise determining the tracker setup for reproducibility. More...
 
def measure (self, I)
 Measure progress level from raw scene input. More...
 
def predict (self)
 Predict next measurement, if applicable. More...
 
def process (self, I)
 Run perceive + progress estimation pipeline for one step/image measurement. More...
 
def setState (self, nstate)
 Sets the state of the tracker. More...
 

Public Attributes

 comparator
 State comparison. More...
 
 haveObs
 
 params
 
 perceiver
 Perceiver instance. More...
 
 pLevel
 progress level. More...
 

Detailed Description

A simple interface class for progress monitoring a perceived scene.

A Progress monitor tacks on some form of state comparison to make interpret the perceiver information.

The Progress monitoring class is independent of the Perceiver class (i.e., not a derived class of it). Rather it contains a Perceiver instance from which to snags the signals needed. This construction permits flexibility regarding how the actual implementation operates. Progress monitoring is in the perceiver package based on the implicit messaging of the "perceiver" name and the consequence of progress monitoring.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  theParams,
  thePerceiver,
  theComparator 
)

Constructor for the perceiver.monitor class.

Parameters
[in]theParamsOption set of paramters.
[in]thePerceiverPerceiver instance (or possibly not).
[in]theComparatorState comparator instance.

Member Function Documentation

◆ adapt()

def adapt (   self)

Adapt parts of the process based on measurements and corrections.

Currently the perceiver and comparator have already run their version of adapt by this point. Overload this class should that not be the case.

◆ correct()

def correct (   self)

Correct the estimated level based on measured and predicted.

Currently the perceiver and comparator have already run their version of correct by this point. Overload this class should that not be the case.

◆ displayDebug()

def displayDebug (   self,
  fh,
  dbState 
)

◆ displayState()

def displayState (   self,
  dState = None 
)

◆ emptyState()

def emptyState (   self)

Returns an empty activity state structure.

Returns
Empty activity state structure.

◆ free()

def free (   self)

Destructor.

Just in case other stuff needs to be done.

◆ getState()

def getState (   self)

Returns the current activity state structure.

Parameters
cstateThe current state structure.

◆ info()

def info (   self)

Return the information structure used for saving or otherwise determining the tracker setup for reproducibility.

Parameters
[out]tinfoThe tracking configuration information structure.

◆ measure()

def measure (   self,
  I 
)

Measure progress level from raw scene input.

◆ predict()

def predict (   self)

Predict next measurement, if applicable.

Todo:
Is this proper way to conceive of progress monitor predict?

◆ process()

def process (   self,
  I 
)

Run perceive + progress estimation pipeline for one step/image measurement.

◆ setState()

def setState (   self,
  nstate 
)

Sets the state of the tracker.

Dangerous to override if inconsistent with scene.

Parameters
[in]nstateThe new state structure.

Member Data Documentation

◆ comparator

comparator

State comparison.

◆ haveObs

haveObs

◆ params

params

◆ perceiver

perceiver

Perceiver instance.

◆ pLevel

pLevel

progress level.


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