Skip to main content

Ctrl+K

pyOpenRiverCam 0.8.0

Introduction
Installation
User Guide
Quick start for programmers
API reference

Introduction
Installation
User Guide
Quick start for programmers
API reference

Section Navigation

pyorc.CameraConfig
pyorc.CameraConfig.bbox
pyorc.CameraConfig.shape
pyorc.CameraConfig.transform

pyorc.CameraConfig.set_bbox_from_corners
pyorc.CameraConfig.set_gcps
pyorc.CameraConfig.set_lens_pars
pyorc.CameraConfig.set_intrinsic
pyorc.CameraConfig.set_lens_calibration
pyorc.CameraConfig.set_lens_position

pyorc.CameraConfig.to_dict
pyorc.CameraConfig.to_dict_str
pyorc.CameraConfig.to_file
pyorc.CameraConfig.to_json

pyorc.CameraConfig.estimate_lens_position
pyorc.CameraConfig.get_M
pyorc.CameraConfig.get_bbox
pyorc.CameraConfig.get_dist_shore
pyorc.CameraConfig.get_dist_wall
pyorc.CameraConfig.get_depth
pyorc.CameraConfig.get_z_a
pyorc.CameraConfig.project_grid
pyorc.CameraConfig.project_points
pyorc.CameraConfig.unproject_points
pyorc.CameraConfig.z_to_h
pyorc.CameraConfig.h_to_z
pyorc.CameraConfig.estimate_lens_position

pyorc.CameraConfig.plot
pyorc.CameraConfig.plot_bbox

pyorc.CrossSection
pyorc.CrossSection.cs_points
pyorc.CrossSection.cs_points_sz
pyorc.CrossSection.cs_linestring
pyorc.CrossSection.cs_linestring_sz
pyorc.CrossSection.cs_angle
pyorc.CrossSection.idx_closest_point
pyorc.CrossSection.idx_farthest_point

pyorc.CrossSection.get_cs_waterlevel
pyorc.CrossSection.get_csl_point
pyorc.CrossSection.get_csl_line
pyorc.CrossSection.get_csl_pol
pyorc.CrossSection.get_bottom_surface
pyorc.CrossSection.get_planar_surface
pyorc.CrossSection.get_wetted_surface
pyorc.CrossSection.get_wetted_surface_sz
pyorc.CrossSection.get_line_of_interest

pyorc.CrossSection.plot
pyorc.CrossSection.plot_cs
pyorc.CrossSection.plot_planar_surface
pyorc.CrossSection.plot_bottom_surface
pyorc.CrossSection.plot_wetted_surface

pyorc.CrossSection.detect_water_level

pyorc.Video
pyorc.Video.camera_config
pyorc.Video.end_frame
pyorc.Video.fps
pyorc.Video.frames
pyorc.Video.freq
pyorc.Video.h_a
pyorc.Video.lazy
pyorc.Video.mask
pyorc.Video.rotation
pyorc.Video.stabilize
pyorc.Video.start_frame
pyorc.Video.corners

pyorc.Video.set_mask_from_exterior

pyorc.Video.get_frame
pyorc.Video.get_frames
pyorc.Video.get_frames_chunk
pyorc.Video.get_ms

pyorc.Frames
pyorc.Frames.camera_config
pyorc.Frames.camera_shape
pyorc.Frames.h_a

pyorc.Frames.edge_detect
pyorc.Frames.minmax
pyorc.Frames.normalize
pyorc.Frames.reduce_rolling
pyorc.Frames.smooth
pyorc.Frames.time_diff

pyorc.Frames.project

pyorc.Frames.get_piv

pyorc.Frames.plot
pyorc.Frames.to_ani
pyorc.Frames.to_video

pyorc.Velocimetry
pyorc.Velocimetry.camera_config
pyorc.Velocimetry.camera_shape
pyorc.Velocimetry.h_a
pyorc.Velocimetry.is_velocimetry

pyorc.Velocimetry.mask.minmax
pyorc.Velocimetry.mask.corr
pyorc.Velocimetry.mask.angle
pyorc.Velocimetry.mask.rolling
pyorc.Velocimetry.mask.outliers
pyorc.Velocimetry.mask.variance
pyorc.Velocimetry.mask.count

pyorc.Velocimetry.mask.window_mean
pyorc.Velocimetry.mask.window_nan

pyorc.Velocimetry.mask.window_replace

pyorc.Velocimetry.get_transect
pyorc.Velocimetry.set_encoding

pyorc.Velocimetry.plot
pyorc.Velocimetry.plot.pcolormesh
pyorc.Velocimetry.plot.scatter
pyorc.Velocimetry.plot.streamplot
pyorc.Velocimetry.plot.quiver

pyorc.Transect
pyorc.Transect.camera_config
pyorc.Transect.camera_shape
pyorc.Transect.h_a

pyorc.Transect.vector_to_scalar
pyorc.Transect.get_xyz_perspective
pyorc.Transect.get_depth_perspective
pyorc.Transect.get_bottom_surface_z_perspective
pyorc.Transect.get_transect_perspective
pyorc.Transect.get_wetted_perspective

pyorc.Transect.get_river_flow
pyorc.Transect.get_q

pyorc.Transect.plot
pyorc.Transect.plot.quiver
pyorc.Transect.plot.scatter

API reference
pyorc.Video....

pyorc.Video.end_frame#

property Video.end_frame#

int, last frame considered in analysis

Type:: return

previous

pyorc.Video.camera_config

next

pyorc.Video.fps

On this page

Video.end_frame

© Copyright 2025, Rainbow Sensing.

Created using Sphinx 5.3.0.

Built with the PyData Sphinx Theme 0.15.4.