Recent Releases of pyOpenRiverCam

pyOpenRiverCam - v0.9.2

[0.9.2] = 2026-01-15

Fixed

  • fixed problems with sample data downloading (403 errors)

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius about 2 months ago

pyOpenRiverCam - v0.9.1

[0.9.1] = 2026-01-13

Fixed

  • fixed python<3.10 compatibility

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius about 2 months ago

pyOpenRiverCam - v0.9.0

[0.9.0] = 2025-12-23

Changed

  • Updated documentation to remove OpenPIV as possible engine for PIV.
  • Updated dependencies to be ready for python >= 3.13

Removed

  • Frames.get_piv(engine="openpiv") has now been removed. Use Frames.get_piv(engine="numba") instead. This is also
    the default engine.

Fixed

  • fixed unnecessary warning in Velocimetry.Mask.variances related to all-NaN slices

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 3 months ago

pyOpenRiverCam - v0.8.12

[0.8.12] = 2025-11-13

Added

  • Added CrossSection.detect_water_level_s2n for signal to noise ratios.

Changed

  • The CLI recipe .yml can now handle lists in water_level.frames_options and usage of a signal to noise acceptance
    threshold in each frames_options to control if a water level is accepted. If the signal to noise is lower than
    set threshold, the next frames_options will be used to attempt resolving a water level with a higher signal to
    noise ratio. This allows for treatment of videos under varying conditions, in which water level detection may
    profit from different video treatments.

Deprecated

Removed

Fixed

  • docstring of masks indentation issue
  • CrossSection docstring Sphinx repetition removed.

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 4 months ago

pyOpenRiverCam - v0.8.11

[0.8.11] = 2025-10-01

Added

  • Derivation of transect properties surface area and wetted perimeter.
  • Added method transect.get_v_surf for average surface velocity, and transect.get_v_bulk for bulk velocity.

Changed

  • Using add_text=True in transect.plot now also displays average surface and bulk velocity.

Removed

  • transect.get_wetted_perspective is no longer required as this can be derived from transect.cross_section.
  • transect.get_xyz_perspective is no longer required as this can be derived from transect.cross_section.

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 5 months ago

pyOpenRiverCam - v0.8.10

[0.8.10] = 2025-09-22

Added

  • option ensemble_corr with frames.get_piv. This performs ensemble correlation averaging on cross-correlation and
    results in a less noisy estimate of surface velocities, albeit only one single time stamp. With this option, also a
    number additional thresholds can be defined:
    • corr_min (default: 0.2): minimum correlation accepted in the cross-correlation results.
    • s2n_min (default: 3): minimum signal=to-noise ratio accepted in the cross-correlation results.
    • count_min (default: 0.2) minimum valid correlation results after masking on corr_min and s2n_min to accept
      results over the interrogation window.

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 6 months ago

pyOpenRiverCam - v0.8.9

[0.8.9] = 2025-08-29

Fixed

  • issue with water level plot on a perfect flat plane. Solved by not plotting water level in this case.

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 6 months ago

pyOpenRiverCam - v0.8.8

[0.8.8] = 2025-07-14

Added

Changed

Deprecated

Removed

Fixed

  • issues with plotting cross sections in edge cases with water levels equal to lowest point or above highest point
  • fixed problem with situations where either the cross section data from a shapefile or the camera configuration
    did not contain CRS information. This is now correctly parsed when creating a CrossSection instance.

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 8 months ago

pyOpenRiverCam - v0.8.7

[0.8.7] = 2025-06-30

Added

  • CLI option --cross_wl
  • A new 3-point bounding box estimation, ideal for selecting a bounding box in strongly oblique cases. First select left
    bank, then right bank, then a point up- or downstream from the selected line for the size of the bounding box.
  • rvec and tvec are written to camera configuration after fitting.

Changed

  • CLI option --cross_wl now replaces --cross for optical water level estimation. --cross is only used for
    discharge calculation
  • Plotting in camera objective is accelerated
  • water level detection with CrossSection.detect_water_level can now consume either min_z and max_z (for levels
    in the original coordinate system) or min_h and max_h (for levels using the local h_ref datum if provided).
    These minimum and maximum levels can be used to pre-condition the level range that the algoithm will seek in.
  • Pose fitting can now be performed with a pre-defined camera matrix and set of distortion coefficients. This is very
    useful when a user has already pre-calibrated these parameters. It will improve the fit of the rvec and tvec,
    i.e. rotation and translation vectors.
  • Changed code coverage reporting from Codecov to sonarqube for code coverage reports. Codecov caused issues with
    numba code.

Deprecated

Removed

Fixed

  • incorrect estimation of optical water level if bank="near" was used. This resulted in only a smaller portion of the
    cross section being used. Now the full nearby side is used.

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 8 months ago

pyOpenRiverCam - v0.8.6

This release allows for pre-fixing camera lens parameter including focal length and the k1 and k2 radial distortion. When these parameters are provided on command line, the camera matrix and distortion coefficients are not optimized but fixed instead. If only one or two parameters, or none at all are provided, the remainder parameters will be estimated through optimization.

A small bug fix was also made in the reading of geojsons without CRS. This is now possible without resulting in any errors.

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.8.5...v0.8.6

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 10 months ago

pyOpenRiverCam - v0.8.5

What's Changed

  • Small bug fix in plotting in camera mode. This resulted in swapped coordinates over the left-to-right bank direction
  • Service level calling of CLI can now also be done with the new --cross method.

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.8.4...v0.8.5

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 12 months ago

pyOpenRiverCam - v0.8.4

What's Changed

  • much faster `Frames.project(method="numpy")
  • method="numpy" is now the default projection.

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.8.3...v0.8.4

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 12 months ago

pyOpenRiverCam - v0.8.3

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 12 months ago

pyOpenRiverCam - v0.8.2

What's Changed

  • 211 bug fix in plotting in camera perspective in shallow angles.

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.8.1...v0.8.2

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 12 months ago

pyOpenRiverCam - v0.8.1

What's Changed

  • allow for use of single image in camera calibration CLI
  • small fixes and bugs water level CrossSection plotting
  • backwards compatibility py3.9

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.8.0...v0.8.1

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 12 months ago

pyOpenRiverCam - v0.8.0

What's Changed

  • a new cross section class CrossSection is introduced
  • the CrossSection class can be used to measure optical water level in a provided single-channel image using pure-computer vision methods
  • 3d plotting functionalities are introduced for both CrossSection and CameraConfig classes
  • Particle Image Velocimetry is now by default performed using the new numba engine. OpenPIV is still available but deprecated. A huge thanks for the OpenPIV team for the past years.

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.7.2...v0.8.0

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius 12 months ago

pyOpenRiverCam - v0.7.2

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.7.1...v0.7.2

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius about 1 year ago

pyOpenRiverCam - v0.7.1

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.7.0...v0.7.1

  • last frame in a video is now properly read, even if stabilization is used.
  • writing of frames to video is now very fast.

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius about 1 year ago

pyOpenRiverCam - v0.7.0

What's Changed

With this release the entire workflow for velocimetry estimation is accelerated significantly. Typical videos may take about a factor 4-5 less time to process with exactly the same results. Exact speed-up is dependent on available CPU and memory resources.

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.6.1...v0.7.0

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius about 1 year ago

pyOpenRiverCam - v0.6.1

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.6.0...v0.6.1

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius over 1 year ago

pyOpenRiverCam - v0.6.0

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.5.5...v0.6.0

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius over 1 year ago

pyOpenRiverCam - v0.5.5

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.5.4...v0.5.5

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius almost 2 years ago

pyOpenRiverCam - v0.5.4

What's Changed

  • fixed a difficult to interpret CLI error #155
  • updated CI actions as OpenCV dependencies changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.5.3...v0.5.4

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius almost 2 years ago

pyOpenRiverCam - v0.5.3

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.5.2...v0.5.3

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius over 2 years ago

pyOpenRiverCam - v0.5.2

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.5.1...v0.5.2

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius over 2 years ago

pyOpenRiverCam - v0.5.1

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.5.0...v0.5.1

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius over 2 years ago

pyOpenRiverCam - v0.5.0

What's Changed

Several large updates were made to:

  • make it a lot easier to get well-calibrated ground control and lens parameters at the same time. we now do this by optimizing the lens' focal length and (if enough ground control is provided) barrel distortion whilst fitting the perspective to the user-provided ground control points
  • provide the fitted ground control points in the interface so that the user can immediately see if the ground control points are well fitted or if anything seems to be wrong with one or more control points.
  • get much-improved stabilization for non-stable videos
  • feature stabilization on command line which consequently provided user-interfacing to select non-moving areas by pointing and clicking.

The following issues are the major issues describing these major improvements.

The stabilization is arranged slightly differently on the API and can now already be set in camera configuration. This is a change in API requiring a medior version bump.

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.4.3...v0.5.0

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius almost 3 years ago

pyOpenRiverCam - v0.4.3

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.4.2...v0.4.3

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius almost 3 years ago

pyOpenRiverCam - v0.4.2

Hot fix for entry points cli

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius almost 3 years ago

pyOpenRiverCam - v0.4.1

Hot fix of setup.py dependency error

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius almost 3 years ago

pyOpenRiverCam - v0.4.0

Added

The most notable change is that the code now includes an automatically installed command-line interface. This
will facilitate a much easier use by a large user group. Also the documentation is fully updated to include all
functionalities for both command-line users and API users. In detail we have the following additions:

  • First release of a command-line interface for the entire process of camera configuration, processing and preparing
    outputs and figures.
  • Service layer that makes it easy for developers to connect pyorc to apps such as GUIs or dashboards.
  • Full user guide with description of both the command-line interface and API.

Changed

  • Small modifications and additions in the API to accomodate the command-line interface building.

Deprecated

Removed

Fixed

  • Bug fixes in the video objects causing videos to sometimes not open properly because of missing frames

Security

Pull requests are below:

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.3.4...v0.4.0

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius about 3 years ago

pyOpenRiverCam - v0.3.4

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.3.3...v0.3.4

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius about 3 years ago

pyOpenRiverCam - v0.3.3

What's Changed

  • entirely new and future proof subclass for masking velocimetry values using several masking methods (deprecates any methods starting with pyorc.Velocimetry.filter (fixes issue #101)
  • Documentation added on velocimetry and masking of velocimetry in a new User Guide chapter
  • Small bug fixes

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.3.2...v0.3.3

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius about 3 years ago

pyOpenRiverCam - v0.3.2

  • fixes #102 scipy 1.10.0 was released on 2023-01-04 and caused a bug in the xr.Dataset.interp functionality of xarray. This has for now been resolved by altering datatypes of all variables in velocimetry results into np.float64.

  • adds functionality to pyorc.Velocimetry.get_transect that allows altering the window of selection into different strides in x and y direction.

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.3.1...v0.3.2

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius about 3 years ago

pyOpenRiverCam - v0.3.1

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.3.0...v0.3.1

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius over 3 years ago

pyOpenRiverCam - v0.3.0

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.2.4...v0.3.0

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius over 3 years ago

pyOpenRiverCam - v0.2.4

Stabilization added and documented, ideal and essential for drone operators or users with smart phones

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.2.3...v0.2.4

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius over 3 years ago

pyOpenRiverCam - v0.2.3

What's Changed

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.2.2...v0.2.3

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius over 3 years ago

pyOpenRiverCam - v0.2.2

What's Changed

New Contributors

Full Changelog: https://github.com/localdevices/pyorc/compare/v0.2.1...v0.2.2

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius over 3 years ago

pyOpenRiverCam - pyorc API

What's Changed

New Contributors

Full Changelog: https://github.com/localdevices/pyorc/compare/0.1.0...v0.2.0

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius almost 4 years ago

pyOpenRiverCam - v0.1.0

[0.1.0] - 2022-01-21

Added

  • First release

Hydrosphere - Freshwater and Hydrology - Python
Published by hcwinsemius about 4 years ago