![]() |
retinify 0.1.7
Real-Time AI Stereo Vision Library
|
Classes | |
| struct | CalibrationParameters |
| Stereo camera calibration parameters. More... | |
| struct | Distortion |
| Rational distortion model with 8 coefficients: (k1, k2, p1, p2, k3, k4, k5, k6) More... | |
| struct | Intrinsics |
| Camera intrinsic parameters with focal lengths, principal point, and skew. More... | |
| class | NoCopyMove |
| Base class that disables copy and move operations for derived classes. More... | |
| class | Pipeline |
A retinify::Pipeline provides an interface for running a stereo matching. More... | |
| struct | Rect2 |
| Rectangle structure. More... | |
| class | Status |
| This class represents the status of an operation in the retinify library. More... | |
Typedefs | |
| using | Vec2d = std::array< double, 2 > |
| 2D vector (double) | |
| using | Vec3d = std::array< double, 3 > |
| 3D vector (double) | |
| using | Point2d = std::array< double, 2 > |
| 2D point (double) | |
| using | Point3d = std::array< double, 3 > |
| 3D point (double) | |
| using | Mat3x3d = std::array< std::array< double, 3 >, 3 > |
| 3x3 matrix (double, row-major) | |
| using | Mat3x4d = std::array< std::array< double, 4 >, 3 > |
| 3x4 matrix (double, row-major) | |
| using | Mat4x4d = std::array< std::array< double, 4 >, 4 > |
| 4x4 matrix (double, row-major) | |
| using | Rect2d = Rect2< double > |
| 2D rectangle (double) | |
Enumerations | |
| enum class | LogLevel : std::uint8_t { DEBUG , INFO , WARN , ERROR , FATAL , OFF } |
| Logging verbosity levels. More... | |
| enum class | LogLocation : std::uint8_t { NONE , FUNCTION } |
| Logging source location options. More... | |
| enum class | PixelFormat : std::uint8_t { GRAY8 , RGB8 } |
| The pixel format options for input images. More... | |
| enum class | DepthMode : std::uint8_t { FAST , BALANCED , ACCURATE } |
| The depth mode options for stereo matching pipeline. More... | |
| enum class | StatusCategory : std::uint8_t { NONE , RETINIFY , SYSTEM , CUDA , USER } |
| Status categories used by retinify. More... | |
| enum class | StatusCode : std::uint8_t { OK , FAIL , INVALID_ARGUMENT } |
| Status codes returned by retinify operations. More... | |
Functions | |
| RETINIFY_API auto | ColorizeDisparity (const float *src, std::size_t srcStride, std::uint8_t *dst, std::size_t dstStride, std::uint32_t imageWidth, std::uint32_t imageHeight, float maxDisparity) noexcept -> Status |
| Applies the colormap to the disparity map. | |
| RETINIFY_API auto | ColorizeDepth (const float *src, std::size_t srcStride, std::uint8_t *dst, std::size_t dstStride, std::uint32_t imageWidth, std::uint32_t imageHeight, float maxDepth) noexcept -> Status |
| Applies the colormap to the depth map. | |
| RETINIFY_API auto | Identity () noexcept -> Mat3x3d |
| Create a 3x3 identity matrix. | |
| RETINIFY_API auto | Determinant (const Mat3x3d &mat) noexcept -> double |
| Compute the determinant of a 3x3 matrix. | |
| RETINIFY_API auto | Transpose (const Mat3x3d &mat) noexcept -> Mat3x3d |
| Transpose a 3x3 matrix. | |
| RETINIFY_API auto | Add (const Mat3x3d &mat1, const Mat3x3d &mat2) noexcept -> Mat3x3d |
| Add two 3x3 matrices. | |
| RETINIFY_API auto | Multiply (const Mat3x3d &mat, const Vec3d &vec) noexcept -> Vec3d |
| Multiply a 3x3 matrix and a 3D vector. | |
| RETINIFY_API auto | Multiply (const Mat3x3d &mat1, const Mat3x3d &mat2) noexcept -> Mat3x3d |
| Multiply two 3x3 matrices. | |
| RETINIFY_API auto | Multiply (const Mat3x3d &mat, double scale) noexcept -> Mat3x3d |
| Multiply a 3x3 matrix by a scalar value. | |
| RETINIFY_API auto | Multiply (const Vec3d &vec, double scale) noexcept -> Vec3d |
| Multiply a 3D vector by a scalar value. | |
| RETINIFY_API auto | Length (const Vec3d &vec) noexcept -> double |
| Compute the length (magnitude) of a 3D vector. | |
| RETINIFY_API auto | Normalize (const Vec3d &vec) noexcept -> Vec3d |
| Normalize a 3D vector to unit length. | |
| RETINIFY_API auto | Dot (const Vec3d &vec1, const Vec3d &vec2) noexcept -> double |
| Compute the dot product of two 3D vectors. | |
| RETINIFY_API auto | Cross (const Vec3d &vec1, const Vec3d &vec2) noexcept -> Vec3d |
| Compute the cross product of two 3D vectors. | |
| RETINIFY_API auto | Hat (const Vec3d &vec) noexcept -> Mat3x3d |
| Create a 3x3 skew-symmetric matrix from a 3D rotation vector. | |
| RETINIFY_API auto | Vee (const Mat3x3d &mat) noexcept -> Vec3d |
| Convert a 3x3 skew-symmetric matrix to a 3D rotation vector. | |
| RETINIFY_API auto | Exp (const Vec3d &vec) noexcept -> Mat3x3d |
| Compute the matrix exponential of a 3D rotation vector. | |
| RETINIFY_API auto | Log (const Mat3x3d &mat) noexcept -> Vec3d |
| Compute the matrix logarithm of a 3x3 rotation matrix. | |
| RETINIFY_API auto | UndistortPoint (const Intrinsics &intrinsics, const Distortion &distortion, const Point2d &point) noexcept -> Point2d |
| Undistort a 2D point using the given camera intrinsics and distortion parameters. | |
| RETINIFY_API auto | DistortPoint (const Intrinsics &intrinsics, const Distortion &distortion, const Point2d &point) noexcept -> Point2d |
| Distort a normalized 2D point using the given camera intrinsics and distortion parameters. | |
| RETINIFY_API auto | StereoRectify (const Intrinsics &intrinsics1, const Distortion &distortion1, const Intrinsics &intrinsics2, const Distortion &distortion2, const Mat3x3d &rotation, const Vec3d &translation, std::uint32_t imageWidth, std::uint32_t imageHeight, Mat3x3d &rotation1, Mat3x3d &rotation2, Mat3x4d &projectionMatrix1, Mat3x4d &projectionMatrix2, Mat4x4d &reprojectionMatrix, double alpha) noexcept -> Status |
| Perform stereo rectification for a pair of cameras. | |
| RETINIFY_API auto | InitUndistortRectifyMap (const Intrinsics &intrinsics, const Distortion &distortion, const Mat3x3d &rotation, const Mat3x4d &projectionMatrix, std::uint32_t imageWidth, std::uint32_t imageHeight, float *mapX, std::size_t mapXStride, float *mapY, std::size_t mapYStride) noexcept -> Status |
| Initialize undistort and rectify maps for image remapping. | |
| RETINIFY_API auto | InitIdentityMap (float *mapX, std::size_t mapXStride, float *mapY, std::size_t mapYStride, std::size_t imageWidth, std::size_t imageHeight) noexcept -> Status |
| Initialize identity maps for undistortion/rectification. | |
| RETINIFY_API auto | SaveCalibrationParameters (const char *filename, const CalibrationParameters ¶meters) noexcept -> Status |
| Save stereo calibration parameters. | |
| RETINIFY_API auto | LoadCalibrationParameters (const char *filename, CalibrationParameters ¶meters) noexcept -> Status |
| Load stereo calibration parameters. | |
| RETINIFY_API auto | GetLogLevel () noexcept -> LogLevel |
| Returns the current log level. | |
| RETINIFY_API void | SetLogLevel (LogLevel level) noexcept |
| Sets the log level. | |
| RETINIFY_API auto | GetLogLocation () noexcept -> LogLocation |
| Returns the current log location setting. | |
| RETINIFY_API void | SetLogLocation (LogLocation location) noexcept |
| Sets the log location setting. | |
| RETINIFY_API void | LogDebug (const char *message, std::source_location location=std::source_location::current()) noexcept |
| Logs a debug message. | |
| RETINIFY_API void | LogInfo (const char *message, std::source_location location=std::source_location::current()) noexcept |
| Logs an informational message. | |
| RETINIFY_API void | LogWarn (const char *message, std::source_location location=std::source_location::current()) noexcept |
| Logs a warning message. | |
| RETINIFY_API void | LogError (const char *message, std::source_location location=std::source_location::current()) noexcept |
| Logs an error message. | |
| RETINIFY_API void | LogFatal (const char *message, std::source_location location=std::source_location::current()) noexcept |
| Logs a fatal error message. | |
| template<typename Function > | |
| auto | NoThrow (Function &&function) noexcept -> Status |
| Executes a function and converts any exception into a Status. | |
| RETINIFY_API auto | HomeDirectoryPath (std::filesystem::path &path) noexcept -> Status |
| Returns the current user’s home directory path. | |
| RETINIFY_API auto | ConfigDirectoryPath (std::filesystem::path &path) noexcept -> Status |
| Returns the configuration directory path for retinify. | |
| RETINIFY_API auto | CacheDirectoryPath (std::filesystem::path &path) noexcept -> Status |
| Returns the cache directory path for retinify. | |
| RETINIFY_API auto | DataDirectoryPath (std::filesystem::path &path) noexcept -> Status |
| Returns the data directory path for retinify. | |
| RETINIFY_API auto | StateDirectoryPath (std::filesystem::path &path) noexcept -> Status |
| Returns the state directory path for retinify. | |
| RETINIFY_API auto | Version () noexcept -> const char * |
| Returns the retinify library version in semantic versioning format. | |
| using retinify::Mat3x3d = typedef std::array<std::array<double, 3>, 3> |
3x3 matrix (double, row-major)
| using retinify::Mat3x4d = typedef std::array<std::array<double, 4>, 3> |
3x4 matrix (double, row-major)
| using retinify::Mat4x4d = typedef std::array<std::array<double, 4>, 4> |
4x4 matrix (double, row-major)
| using retinify::Point2d = typedef std::array<double, 2> |
2D point (double)
| using retinify::Point3d = typedef std::array<double, 3> |
3D point (double)
| using retinify::Rect2d = typedef Rect2<double> |
2D rectangle (double)
| using retinify::Vec2d = typedef std::array<double, 2> |
2D vector (double)
| using retinify::Vec3d = typedef std::array<double, 3> |
3D vector (double)
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Status categories used by retinify.
| Enumerator | |
|---|---|
| NONE | No category. |
| RETINIFY | Retinify-internal category. |
| SYSTEM | System-related category. |
| CUDA | CUDA-related category. |
| USER | User-originated category. |
|
strong |
Status codes returned by retinify operations.
| Enumerator | |
|---|---|
| OK | Operation succeeded. |
| FAIL | Operation failed. |
| INVALID_ARGUMENT | Invalid argument provided. |
|
noexcept |
Add two 3x3 matrices.
| mat1 | First 3x3 matrix |
| mat2 | Second 3x3 matrix |
|
noexcept |
Returns the cache directory path for retinify.
| path | Output cache directory path |
|
noexcept |
Applies the colormap to the depth map.
| src | Input depth map (32-bit float) |
| srcStride | Stride of the input depth map (in bytes) |
| dst | Output colored depth map (8-bit 3-channel RGB) |
| dstStride | Stride of the output colored depth map (in bytes) |
| imageWidth | Width of the input and output depth maps (in pixels) |
| imageHeight | Height of the input and output depth maps (in pixels) |
| maxDepth | Maximum depth value |
|
noexcept |
Applies the colormap to the disparity map.
| src | Input disparity map (32-bit float) |
| srcStride | Stride of the input disparity map (in bytes) |
| dst | Output colored disparity map (8-bit 3-channel RGB) |
| dstStride | Stride of the output colored disparity map (in bytes) |
| imageWidth | Width of the input and output disparity maps (in pixels) |
| imageHeight | Height of the input and output disparity maps (in pixels) |
| maxDisparity | Maximum disparity value |
|
noexcept |
Returns the configuration directory path for retinify.
| path | Output configuration directory path |
|
noexcept |
Compute the cross product of two 3D vectors.
| vec1 | First 3D vector |
| vec2 | Second 3D vector |
|
noexcept |
Returns the data directory path for retinify.
| path | Output data directory path |
|
noexcept |
Compute the determinant of a 3x3 matrix.
| mat | 3x3 matrix |
|
noexcept |
Distort a normalized 2D point using the given camera intrinsics and distortion parameters.
| intrinsics | Camera intrinsic parameters |
| distortion | Distortion parameters |
| point | Undistorted 2D point (normalized image coordinates) |
|
noexcept |
Compute the dot product of two 3D vectors.
| vec1 | First 3D vector |
| vec2 | Second 3D vector |
|
noexcept |
Compute the matrix exponential of a 3D rotation vector.
| vec | 3D rotation vector |
|
noexcept |
Returns the current log level.
|
noexcept |
Returns the current log location setting.
|
noexcept |
Create a 3x3 skew-symmetric matrix from a 3D rotation vector.
| vec | 3D rotation vector |
|
noexcept |
Returns the current user’s home directory path.
| path | Output home directory path |
|
noexcept |
Create a 3x3 identity matrix.
|
noexcept |
Initialize identity maps for undistortion/rectification.
| mapX | Output map for x-coordinates |
| mapXStride | Stride of a row in mapX (in bytes) |
| mapY | Output map for y-coordinates |
| mapYStride | Stride of a row in mapY (in bytes) |
| imageWidth | Image width (in pixels) |
| imageHeight | Image height (in pixels) |
|
noexcept |
Initialize undistort and rectify maps for image remapping.
| intrinsics | Camera intrinsics |
| distortion | Distortion parameters |
| rotation | Rectification rotation |
| projectionMatrix | Projection matrix |
| imageWidth | Image width (in pixels) |
| imageHeight | Image height (in pixels) |
| mapX | Output map for x-coordinates |
| mapXStride | Stride of a row in mapX (in bytes) |
| mapY | Output map for y-coordinates |
| mapYStride | Stride of a row in mapY (in bytes) |
|
noexcept |
Compute the length (magnitude) of a 3D vector.
| vec | 3D vector |
|
noexcept |
Load stereo calibration parameters.
| filename | Path to the input file |
| parameters | Calibration parameters to load into |
|
noexcept |
Compute the matrix logarithm of a 3x3 rotation matrix.
| mat | 3x3 rotation matrix |
|
noexcept |
Logs a debug message.
| message | The message to log |
| location | The source location of the log call (defaults to the call site) |
|
noexcept |
Logs an error message.
| message | The message to log |
| location | The source location of the log call (defaults to the call site) |
|
noexcept |
Logs a fatal error message.
| message | The message to log |
| location | The source location of the log call (defaults to the call site) |
|
noexcept |
Logs an informational message.
| message | The message to log |
| location | The source location of the log call (defaults to the call site) |
|
noexcept |
Logs a warning message.
| message | The message to log |
| location | The source location of the log call (defaults to the call site) |
|
noexcept |
Multiply a 3x3 matrix and a 3D vector.
| mat | 3x3 matrix |
| vec | 3D vector |
|
noexcept |
Multiply a 3x3 matrix by a scalar value.
| mat | 3x3 matrix |
| scale | Scalar value |
|
noexcept |
Multiply two 3x3 matrices.
| mat1 | First 3x3 matrix |
| mat2 | Second 3x3 matrix |
|
noexcept |
Multiply a 3D vector by a scalar value.
| vec | 3D vector |
| scale | Scalar value |
|
noexcept |
Normalize a 3D vector to unit length.
| vec | 3D vector |
|
noexcept |
|
noexcept |
Save stereo calibration parameters.
| filename | Path to the output file |
| parameters | Calibration parameters to save |
|
noexcept |
Sets the log level.
| level | The new log level to apply |
|
noexcept |
Sets the log location setting.
| location | The new log location setting to apply |
|
noexcept |
Returns the state directory path for retinify.
| path | Output state directory path |
|
noexcept |
Perform stereo rectification for a pair of cameras.
| intrinsics1 | First camera intrinsics |
| distortion1 | First camera distortion |
| intrinsics2 | Second camera intrinsics |
| distortion2 | Second camera distortion |
| rotation | Rotation from the first to the second camera |
| translation | Translation from the first to the second camera |
| imageWidth | Image width (in pixels) |
| imageHeight | Image height (in pixels) |
| rotation1 | Output rectification rotation for the first camera |
| rotation2 | Output rectification rotation for the second camera |
| projectionMatrix1 | Output projection matrix for the first camera |
| projectionMatrix2 | Output projection matrix for the second camera |
| reprojectionMatrix | Output reprojection matrix |
| alpha | A free scaling parameter that controls cropping after rectification: 0 keeps only valid pixels (no black borders), 1 preserves the full original image (black borders included), values between 0 and 1 yield intermediate results, and -1 applies the default behavior |
|
noexcept |
Transpose a 3x3 matrix.
| mat | 3x3 matrix |
|
noexcept |
Undistort a 2D point using the given camera intrinsics and distortion parameters.
| intrinsics | Camera intrinsic parameters |
| distortion | Distortion parameters |
| point | Distorted 2D point (in pixel coordinates) |
|
noexcept |
Convert a 3x3 skew-symmetric matrix to a 3D rotation vector.
| mat | 3x3 skew-symmetric matrix |
|
noexcept |
Returns the retinify library version in semantic versioning format.