camfi.datamodel.via_region_attributes module

Defines the ViaRegionAttributes BaseModel class.

class camfi.datamodel.via_region_attributes.ViaRegionAttributes(*, score: camfi.datamodel.via_region_attributes.ConstrainedFloatValue = None, best_peak: camfi.datamodel.via_region_attributes.ConstrainedIntValue = None, blur_length: camfi.datamodel.via_region_attributes.ConstrainedFloatValue = None, snr: float = None, wb_freq_up: camfi.datamodel.via_region_attributes.ConstrainedFloatValue = None, wb_freq_down: camfi.datamodel.via_region_attributes.ConstrainedFloatValue = None, et_up: camfi.datamodel.via_region_attributes.ConstrainedFloatValue = None, et_dn: camfi.datamodel.via_region_attributes.ConstrainedFloatValue = None)

Bases: pydantic.main.BaseModel

Contains object annotation (region)-level metadata.

Parameters

  • score (Optional[float]) – Score of annotation. This is only relevant for annotations which have been obtained automatically. Score should not be set for manual annotations.

  • best_peak (Optional[int]) – Period of wingbeat in pixels.

  • blur_length (Optional[float]) – Length of motion blur in pixels.

  • snr (Optional[float]) – Signal-to-noise ratio of best peak.

  • wb_freq_up (Optional[float]) – Wingbeat frequency estimate, assuming upward motion (and zero body-length).

  • wb_freq_down (Optional[float]) – Wingbeat frequency estimate, assuming downward motion (and zero body-length).

  • et_up (Optional[float]) – Corrected moth exposure time, assuming upward motion.

  • et_dn (Optional[float]) – Corrected moth exposure time, assuming downward motion.