RAVE
Lib.gadjust.obsmatcher.obsmatcher Class Reference

Class for extracting relevant observations that are covered by the provided area. More...

Inheritance diagram for Lib.gadjust.obsmatcher.obsmatcher:

Public Member Functions

 __init__ (self, domdb)
 
 match (self, image, acc_period=12, quantity="ACRR", how_task="se.smhi.composite.distance.radar", offset_hours=0)
 Extract pixel values matching the location of each point in a composite.
 

Public Attributes

 db = domdb
 

Detailed Description

Class for extracting relevant observations that are covered by the provided area.

Member Function Documentation

◆ match()

Lib.gadjust.obsmatcher.obsmatcher.match ( self,
image,
acc_period = 12,
quantity = "ACRR",
how_task = "se.smhi.composite.distance.radar",
offset_hours = 0 )

Extract pixel values matching the location of each point in a composite.

Parameters
pointslist of point instances
imagecomposite Cartesian instance. TODO: generalize?
quantitystring quantity, most often "ACRR"
image_idxint index of the image to read, should be 0
how_taskstring task identifier of the distance quality field

Extract observations that are covered by the provided image. The image must have a distance quality field and a relevant quantity (for example ACRR).

Parameters
image- the cartesian image.
acc_period- the hours back in time we are interested of
quantity- the quantity we want to use, default is ACRR
how_task- the name of the distance field. Default is se.smhi.composite.distance.radar
offset_hours- as default matching is performed from nominal time until now, if offset_hours > 0 then matching is performed between nominal time and nominal time + offset_hours

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