Python: module mrpt.pymrpt.mrpt.img

mrpt.pymrpt.mrpt.img

index
(built-in)

Bindings for mrpt::img namespace

Classes



mrpt.pymrpt.mrpt.serialization.CSerializable(mrpt.pymrpt.mrpt.rtti.CObject)

CImage(mrpt.pymrpt.mrpt.serialization.CSerializable, CCanvas)
TCamera
TStereoCamera

pybind11_builtins.pybind11_object(builtins.object)

CCanvas

CImage(mrpt.pymrpt.mrpt.serialization.CSerializable, CCanvas)

CExceptionExternalImageNotFound
DistortionModel
PixelDepth
TColor
TColorf
TColormap
TImageChannels
TInterpolationMethod
TPixelCoord
TPixelCoordf
copy_type_t
ctor_CImage_ref_or_gray

class CCanvas(pybind11_builtins.pybind11_object)

    This virtual class defines the interface of any object accepting drawing primitives on it.   A number of text fonts can be selected with CCanvas::selectTextFont(). These are the    implemented font names:   - "6x13"   - "6x13B" (bold)   - "6x13O" (italic)   - "9x15"   - "9x15B" (bold)   - "10x20"   - "18x18ja" (Japanese, UNICODE character values)   For an example of each font check the * href="http://www.mrpt.org/Implemented_2D_Fonts">corresponding wiki page. CImage

Method resolution order:

CCanvas

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__init__(...)
__init__(*args, **kwargs) Overloaded function. 1. __init__(self: mrpt.pymrpt.mrpt.img.CCanvas) -> None 2. __init__(self: mrpt.pymrpt.mrpt.img.CCanvas, arg0: mrpt.pymrpt.mrpt.img.CCanvas) -> None

assign(...)
assign(self: mrpt.pymrpt.mrpt.img.CCanvas, : mrpt.pymrpt.mrpt.img.CCanvas) -> mrpt.pymrpt.mrpt.img.CCanvas C++: mrpt::img::CCanvas::operator=(const class mrpt::img::CCanvas &) --> class mrpt::img::CCanvas &

drawCircle(...)
drawCircle(*args, **kwargs) Overloaded function. 1. drawCircle(self: mrpt.pymrpt.mrpt.img.CCanvas, x: int, y: int, radius: int) -> None 2. drawCircle(self: mrpt.pymrpt.mrpt.img.CCanvas, x: int, y: int, radius: int, color: mrpt.pymrpt.mrpt.img.TColor) -> None 3. drawCircle(self: mrpt.pymrpt.mrpt.img.CCanvas, x: int, y: int, radius: int, color: mrpt.pymrpt.mrpt.img.TColor, width: int) -> None Draws a circle of a given radius. The center - x coordinate in pixels. The center - y coordinate in pixels. The radius - in pixels. The color of the circle. The desired width of the line (this is IGNORED in this virtual class) C++: mrpt::img::CCanvas::drawCircle(int, int, int, const struct mrpt::img::TColor &, unsigned int) --> void

drawImage(...)
drawImage(*args, **kwargs) Overloaded function. 1. drawImage(self: mrpt.pymrpt.mrpt.img.CCanvas, x: int, y: int, img: mrpt::img::CImage) -> None Draws an image as a bitmap at a given position. The top-left corner x coordinates on this canvas where the image is to be drawn The top-left corner y coordinates on this canvas where the image is to be drawn The image to be drawn in this canvas   This method may be redefined in some classes implementing this interface in a more appropiate manner. C++: mrpt::img::CCanvas::drawImage(int, int, const class mrpt::img::CImage &) --> void 2. drawImage(self: mrpt.pymrpt.mrpt.img.CCanvas, x: int, y: int, img: mrpt::img::CImage, rotation: float, scale: float) -> None Draws an image as a bitmap at a given position, with some custom scale and rotation changes. The top-left corner x coordinates on this canvas where the image is to be drawn The top-left corner y coordinates on this canvas where the image is to be drawn The rotation in radians, positive values being anti-clockwise direction, 0 is the normal position. The scale factor, e.g. 2 means twice the original size. The image to be drawn in this canvas   This method may be redefined in some classes implementing this interface in a more appropiate manner. C++: mrpt::img::CCanvas::drawImage(int, int, const class mrpt::img::CImage &, float, float) --> void

drawMark(...)
drawMark(*args, **kwargs) Overloaded function. 1. drawMark(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, color: mrpt.pymrpt.mrpt.img.TColor, type: str) -> None 2. drawMark(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, color: mrpt.pymrpt.mrpt.img.TColor, type: str, size: int) -> None 3. drawMark(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, color: mrpt.pymrpt.mrpt.img.TColor, type: str, size: int, width: int) -> None Draw a mark. The point x coordinate The point y coordinate The color of the cross The size of the cross The cross type. It could be: 'x', '+', ':'(like '+' but clear at the center dot), or 's' (square) The desired width of the cross (this is IGNORED yet) C++: mrpt::img::CCanvas::drawMark(int, int, const struct mrpt::img::TColor, char, int, unsigned int) --> void

ellipseGaussian(...)
ellipseGaussian(*args, **kwargs) Overloaded function. 1. ellipseGaussian(self: mrpt.pymrpt.mrpt.img.CCanvas, cov2D: mrpt::math::CMatrixFixed<double, 2ul, 2ul>, mean_x: float, mean_y: float) -> None 2. ellipseGaussian(self: mrpt.pymrpt.mrpt.img.CCanvas, cov2D: mrpt::math::CMatrixFixed<double, 2ul, 2ul>, mean_x: float, mean_y: float, confIntervalStds: float) -> None 3. ellipseGaussian(self: mrpt.pymrpt.mrpt.img.CCanvas, cov2D: mrpt::math::CMatrixFixed<double, 2ul, 2ul>, mean_x: float, mean_y: float, confIntervalStds: float, color: mrpt.pymrpt.mrpt.img.TColor) -> None 4. ellipseGaussian(self: mrpt.pymrpt.mrpt.img.CCanvas, cov2D: mrpt::math::CMatrixFixed<double, 2ul, 2ul>, mean_x: float, mean_y: float, confIntervalStds: float, color: mrpt.pymrpt.mrpt.img.TColor, width: int) -> None 5. ellipseGaussian(self: mrpt.pymrpt.mrpt.img.CCanvas, cov2D: mrpt::math::CMatrixFixed<double, 2ul, 2ul>, mean_x: float, mean_y: float, confIntervalStds: float, color: mrpt.pymrpt.mrpt.img.TColor, width: int, nEllipsePoints: int) -> None Draws an ellipse representing a given confidence interval of a 2D Gaussian distribution. The x coordinate of the center point of the ellipse. The y coordinate of the center point of the ellipse. A 2x2 covariance matrix. How many "sigmas" for the confidence level (i.e. 2->95%, 3=99.97%,...) The color of the ellipse The desired width of the line (this is IGNORED in this virtual class) The number of points to generate to approximate the ellipse shape. std::exception On an invalid matrix. C++: mrpt::img::CCanvas::ellipseGaussian(const class mrpt::math::CMatrixFixed<double, 2, 2> &, const double, const double, double, const struct mrpt::img::TColor &, unsigned int, int) --> void

filledRectangle(...)
filledRectangle(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor) -> None Draws a filled rectangle. The top-left x coordinate The top-left y coordinate The right-bottom x coordinate The right-bottom y coordinate The color of the rectangle fill   This method may be redefined in some classes implementing this interface in a more appropiate manner. rectangle C++: mrpt::img::CCanvas::filledRectangle(int, int, int, int, const struct mrpt::img::TColor) --> void

getHeight(...)
getHeight(self: mrpt.pymrpt.mrpt.img.CCanvas) -> int Returns the height of the image in pixels C++: mrpt::img::CCanvas::getHeight() const --> size_t

getWidth(...)
getWidth(self: mrpt.pymrpt.mrpt.img.CCanvas) -> int Returns the width of the image in pixels C++: mrpt::img::CCanvas::getWidth() const --> size_t

line(...)
line(*args, **kwargs) Overloaded function. 1. line(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor) -> None 2. line(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor, width: int) -> None 3. line(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor, width: int, penStyle: mrpt.pymrpt.mrpt.img.CCanvas.TPenStyle) -> None Draws a line. The starting point x coordinate The starting point y coordinate The end point x coordinate The end point y coordinate The color of the line The desired width of the line (this is IGNORED in this virtual class)   This method may be redefined in some classes implementing this interface in a more appropiate manner. C++: mrpt::img::CCanvas::line(int, int, int, int, const struct mrpt::img::TColor, unsigned int, enum mrpt::img::CCanvas::TPenStyle) --> void

rectangle(...)
rectangle(*args, **kwargs) Overloaded function. 1. rectangle(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor) -> None 2. rectangle(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor, width: int) -> None Draws a rectangle (an empty rectangle, without filling) The top-left x coordinate The top-left y coordinate The right-bottom x coordinate The right-bottom y coordinate The color of the line The desired width of the line. filledRectangle C++: mrpt::img::CCanvas::rectangle(int, int, int, int, const struct mrpt::img::TColor, unsigned int) --> void

selectTextFont(...)
selectTextFont(self: mrpt.pymrpt.mrpt.img.CCanvas, fontName: str) -> None Select the current font used when drawing text. The name of the font   Valid font names:   - 5x7   - 6x13   - 6x13B   - 6x13O   - 9x15   (Default at start-up)   - 9x15B   - 10x20   - 18x18ja (Asian characters for UTF-8 strings - Only available if MRPT is built with MRPT_HAS_ASIAN_FONTS = true)     textOut, The example in * href="http://www.mrpt.org/Implemented_2D_Fonts">this page. C++: mrpt::img::CCanvas::selectTextFont(const std::string &) --> void

setPixel(...)
setPixel(self: mrpt.pymrpt.mrpt.img.CCanvas, x: int, y: int, color: int) -> None Changes the value of the pixel (x,y).   Pixel coordinates starts at the left-top corner of the image, and start in (0,0).   The meaning of the parameter "color" depends on the implementation: it will usually    be a 24bit RGB value (0x00RRGGBB), but it can also be just a 8bit gray level.   You can also use a TColor() type as input and it will be automatically converted to size_t.   This method must support (x,y) values OUT of the actual image size without neither    raising exceptions, nor leading to memory access errors.           C++: mrpt::img::CCanvas::setPixel(int, int, size_t) --> void

textOut(...)
textOut(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, str: str, color: mrpt.pymrpt.mrpt.img.TColor) -> None Renders 2D text using bitmap fonts. The x coordinates The y coordinates The string to put. If using UNICODE characters, use UTF-8 encoding. The text color selectTextFont C++: mrpt::img::CCanvas::textOut(int, int, const std::string &, const struct mrpt::img::TColor) --> void

triangle(...)
triangle(*args, **kwargs) Overloaded function. 1. triangle(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, size: int, color: mrpt.pymrpt.mrpt.img.TColor) -> None 2. triangle(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, size: int, color: mrpt.pymrpt.mrpt.img.TColor, inferior: bool) -> None 3. triangle(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, size: int, color: mrpt.pymrpt.mrpt.img.TColor, inferior: bool, width: int) -> None Draws a triangle The triangle center x coordinate The triangle center y coordinate The size of the triangle The color of the line          The position of the triangle The desired width of the line. triangle C++: mrpt::img::CCanvas::triangle(int, int, int, const struct mrpt::img::TColor, bool, unsigned int) --> void

Data and other attributes defined here:

TPenStyle = <class 'mrpt.pymrpt.mrpt.img.CCanvas.TPenStyle'>

psDash = <TPenStyle.psDash: 1>

psDashDot = <TPenStyle.psDashDot: 3>

psDashDotDot = <TPenStyle.psDashDotDot: 4>

psDot = <TPenStyle.psDot: 2>

psSolid = <TPenStyle.psSolid: 0>

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class CExceptionExternalImageNotFound(pybind11_builtins.pybind11_object)

    Used in mrpt::img::CImage

Method resolution order:

CExceptionExternalImageNotFound

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__init__(...)
__init__(*args, **kwargs) Overloaded function. 1. __init__(self: mrpt.pymrpt.mrpt.img.CExceptionExternalImageNotFound, s: str) -> None 2. __init__(self: mrpt.pymrpt.mrpt.img.CExceptionExternalImageNotFound, arg0: mrpt.pymrpt.mrpt.img.CExceptionExternalImageNotFound) -> None 3. __init__(self: mrpt.pymrpt.mrpt.img.CExceptionExternalImageNotFound, arg0: mrpt.pymrpt.mrpt.img.CExceptionExternalImageNotFound) -> None

assign(...)
assign(self: mrpt.pymrpt.mrpt.img.CExceptionExternalImageNotFound, : mrpt.pymrpt.mrpt.img.CExceptionExternalImageNotFound) -> mrpt.pymrpt.mrpt.img.CExceptionExternalImageNotFound C++: mrpt::img::CExceptionExternalImageNotFound::operator=(const class mrpt::img::CExceptionExternalImageNotFound &) --> class mrpt::img::CExceptionExternalImageNotFound &

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class CImage(mrpt.pymrpt.mrpt.serialization.CSerializable, CCanvas)

    A class for storing images as grayscale or RGB bitmaps. I/O is supported as: - Binary dump using the CSerializable interface(<< and >> operators), just as most objects in MRPT. This format is not compatible with any standarized image format but it is fast. - Saving/loading from files of different formats (bmp,jpg,png,...) using the methods CImage::loadFromFile and CImage::saveToFile. See OpenCV for the list of supported formats. - Importing from an XPM array (.xpm file format) using CImage::loadFromXPM() - Importing TGA images. See CImage::loadTGA()   How to create color/grayscale images:    Additional notes: - The OpenCV `cv::Mat` format is used internally for compatibility with all OpenCV functions. Use CImage::asCvMat() to retrieve it. Example: - By default, all images use unsigned 8-bit storage format for pixels (on each channel), but it can be changed by flags in the constructor. - An **external storage mode** can be enabled by calling CImage::setExternalStorage, useful for storing large collections of image objects in memory while loading the image data itself only for the relevant images at any time. See CImage::forceLoad() and CImage::unload(). - Operator = and copy ctor make shallow copies. For deep copies, see CImage::makeDeepCopy() or CImage(const CImage&, copy_type_t), e.g: - If you are interested in a smart pointer to an image, use: - To set a CImage from an OpenCV `cv::Mat` use CImage::CImage(cv::Mat,copy_type_t). Some functions are implemented in MRPT with highly optimized SSE2/SSE3 routines, in suitable platforms and compilers. To see the list of optimizations refer to  falling back to default OpenCV methods where unavailable. For computer vision functions that use CImage as its image data type, see mrpt::vision. mrpt::vision, mrpt::vision::CFeatureExtractor, mrpt::vision::CImagePyramid, CSerializable, CCanvas

Method resolution order:

CImage

mrpt.pymrpt.mrpt.serialization.CSerializable

mrpt.pymrpt.mrpt.rtti.CObject

CCanvas

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

GetRuntimeClass(...)
GetRuntimeClass(self: mrpt.pymrpt.mrpt.img.CImage) -> mrpt.pymrpt.mrpt.rtti.TRuntimeClassId C++: mrpt::img::CImage::GetRuntimeClass() const --> const struct mrpt::rtti::TRuntimeClassId *

KLT_response(...)
KLT_response(self: mrpt.pymrpt.mrpt.img.CImage, x: int, y: int, half_window_size: int) -> float Compute the KLT response at a given pixel (x,y) - Only for grayscale images (for efficiency it avoids converting to grayscale internally).   See KLT_response() for more details on the internal optimizations of this method, but this graph shows a general view:    C++: mrpt::img::CImage::KLT_response(const unsigned int, const unsigned int, const unsigned int) const --> float

__call__(...)
__call__(*args, **kwargs) Overloaded function. 1. __call__(self: mrpt.pymrpt.mrpt.img.CImage, col: int, row: int) -> int 2. __call__(self: mrpt.pymrpt.mrpt.img.CImage, col: int, row: int, channel: int) -> int Returns a pointer to a given pixel information.    The coordinate origin is pixel(0,0)=top-left corner of the image. std::exception On pixel coordinates out of bounds C++: mrpt::img::CImage::operator()(unsigned int, unsigned int, unsigned int) const --> unsigned char *

__init__(...)
__init__(*args, **kwargs) Overloaded function. 1. __init__(self: mrpt.pymrpt.mrpt.img.CImage) -> None 2. __init__(self: mrpt.pymrpt.mrpt.img.CImage, arg0: int, arg1: int) -> None doc 3. __init__(self: mrpt.pymrpt.mrpt.img.CImage, width: int, height: int, nChannels: mrpt.pymrpt.mrpt.img.TImageChannels) -> None 4. __init__(self: mrpt.pymrpt.mrpt.img.CImage, other_img: mrpt.pymrpt.mrpt.img.CImage, : mrpt.pymrpt.mrpt.img.ctor_CImage_ref_or_gray) -> None 5. __init__(self: mrpt.pymrpt.mrpt.img.CImage, img: mrpt.pymrpt.mrpt.img.CImage, copy_type: mrpt.pymrpt.mrpt.img.copy_type_t) -> None 6. __init__(self: mrpt.pymrpt.mrpt.img.CImage, arg0: mrpt.pymrpt.mrpt.img.CImage) -> None 7. __init__(self: mrpt.pymrpt.mrpt.img.CImage, arg0: mrpt.pymrpt.mrpt.img.CImage) -> None

assign(...)
assign(self: mrpt.pymrpt.mrpt.img.CImage, : mrpt.pymrpt.mrpt.img.CImage) -> mrpt.pymrpt.mrpt.img.CImage C++: mrpt::img::CImage::operator=(const class mrpt::img::CImage &) --> class mrpt::img::CImage &

channelCount(...)
channelCount(self: mrpt.pymrpt.mrpt.img.CImage) -> int Returns 1 (grayscale), 3 (RGB) or 4 (RGBA) [New in MRPT 2.1.1] C++: mrpt::img::CImage::channelCount() const --> int

clear(...)
clear(self: mrpt.pymrpt.mrpt.img.CImage) -> None Resets the image to the state after a default ctor. Accessing the image after will throw an exception, unless it is formerly initialized somehow: loading an image from disk, calling rezize(), etc. C++: mrpt::img::CImage::clear() --> void

clone(...)
clone(self: mrpt.pymrpt.mrpt.img.CImage) -> mrpt.pymrpt.mrpt.rtti.CObject C++: mrpt::img::CImage::clone() const --> class mrpt::rtti::CObject *

colorImage(...)
colorImage(*args, **kwargs) Overloaded function. 1. colorImage(self: mrpt.pymrpt.mrpt.img.CImage) -> mrpt.pymrpt.mrpt.img.CImage Returns a color (RGB) version of the grayscale image, or a shallow copy of itself if it is already a color image. grayscale C++: mrpt::img::CImage::colorImage() const --> class mrpt::img::CImage 2. colorImage(self: mrpt.pymrpt.mrpt.img.CImage, ret: mrpt.pymrpt.mrpt.img.CImage) -> None In-place is supported by setting `ret=*this`. C++: mrpt::img::CImage::colorImage(class mrpt::img::CImage &) const --> void

copyFromForceLoad(...)
copyFromForceLoad(self: mrpt.pymrpt.mrpt.img.CImage, o: mrpt.pymrpt.mrpt.img.CImage) -> None Copies from another image (shallow copy), and, if it is externally stored, the image file will be actually loaded into memory in "this" object. operator = CExceptionExternalImageNotFound If the external image couldn't be loaded. C++: mrpt::img::CImage::copyFromForceLoad(const class mrpt::img::CImage &) --> void

correlate(...)
correlate(*args, **kwargs) Overloaded function. 1. correlate(self: mrpt.pymrpt.mrpt.img.CImage, img2int: mrpt.pymrpt.mrpt.img.CImage) -> float 2. correlate(self: mrpt.pymrpt.mrpt.img.CImage, img2int: mrpt.pymrpt.mrpt.img.CImage, width_init: int) -> float 3. correlate(self: mrpt.pymrpt.mrpt.img.CImage, img2int: mrpt.pymrpt.mrpt.img.CImage, width_init: int, height_init: int) -> float Computes the correlation coefficient (returned as val), between two images         This function use grayscale images only         img1, img2 must be same size (by AJOGD @ DEC-2006) C++: mrpt::img::CImage::correlate(const class mrpt::img::CImage &, int, int) const --> float

cross_correlation_FFT(...)
cross_correlation_FFT(*args, **kwargs) Overloaded function. 1. cross_correlation_FFT(self: mrpt.pymrpt.mrpt.img.CImage, in_img: mrpt.pymrpt.mrpt.img.CImage, out_corr: mrpt::math::CMatrixDynamic<float>) -> None 2. cross_correlation_FFT(self: mrpt.pymrpt.mrpt.img.CImage, in_img: mrpt.pymrpt.mrpt.img.CImage, out_corr: mrpt::math::CMatrixDynamic<float>, u_search_ini: int) -> None 3. cross_correlation_FFT(self: mrpt.pymrpt.mrpt.img.CImage, in_img: mrpt.pymrpt.mrpt.img.CImage, out_corr: mrpt::math::CMatrixDynamic<float>, u_search_ini: int, v_search_ini: int) -> None 4. cross_correlation_FFT(self: mrpt.pymrpt.mrpt.img.CImage, in_img: mrpt.pymrpt.mrpt.img.CImage, out_corr: mrpt::math::CMatrixDynamic<float>, u_search_ini: int, v_search_ini: int, u_search_size: int) -> None 5. cross_correlation_FFT(self: mrpt.pymrpt.mrpt.img.CImage, in_img: mrpt.pymrpt.mrpt.img.CImage, out_corr: mrpt::math::CMatrixDynamic<float>, u_search_ini: int, v_search_ini: int, u_search_size: int, v_search_size: int) -> None 6. cross_correlation_FFT(self: mrpt.pymrpt.mrpt.img.CImage, in_img: mrpt.pymrpt.mrpt.img.CImage, out_corr: mrpt::math::CMatrixDynamic<float>, u_search_ini: int, v_search_ini: int, u_search_size: int, v_search_size: int, biasThisImg: float) -> None 7. cross_correlation_FFT(self: mrpt.pymrpt.mrpt.img.CImage, in_img: mrpt.pymrpt.mrpt.img.CImage, out_corr: mrpt::math::CMatrixDynamic<float>, u_search_ini: int, v_search_ini: int, u_search_size: int, v_search_size: int, biasThisImg: float, biasInImg: float) -> None         Computes the correlation matrix between this image and another one.    This implementation uses the 2D FFT for achieving reduced computation time. The "patch" image, which must be equal, or smaller than "this" image. This function supports gray-scale (1 channel only) images. The "x" coordinate of the search window. The "y" coordinate of the search window. The width of the search window. The height of the search window. The output for the correlation matrix, which will be "u_search_size" x "v_search_size" This optional parameter is a fixed "bias" value to be substracted to the pixels of "this" image before performing correlation. This optional parameter is a fixed "bias" value to be substracted to the pixels of "in_img" image before performing correlation. Note: By default, the search area is the whole (this) image. (by JLBC @ JAN-2006) cross_correlation C++: mrpt::img::CImage::cross_correlation_FFT(const class mrpt::img::CImage &, class mrpt::math::CMatrixDynamic<float> &, int, int, int, int, float, float) const --> void

drawCircle(...)
drawCircle(*args, **kwargs) Overloaded function. 1. drawCircle(self: mrpt.pymrpt.mrpt.img.CImage, x: int, y: int, radius: int) -> None 2. drawCircle(self: mrpt.pymrpt.mrpt.img.CImage, x: int, y: int, radius: int, color: mrpt.pymrpt.mrpt.img.TColor) -> None 3. drawCircle(self: mrpt.pymrpt.mrpt.img.CImage, x: int, y: int, radius: int, color: mrpt.pymrpt.mrpt.img.TColor, width: int) -> None C++: mrpt::img::CImage::drawCircle(int, int, int, const struct mrpt::img::TColor &, unsigned int) --> void

drawImage(...)
drawImage(self: mrpt.pymrpt.mrpt.img.CImage, x: int, y: int, img: mrpt.pymrpt.mrpt.img.CImage) -> None C++: mrpt::img::CImage::drawImage(int, int, const class mrpt::img::CImage &) --> void

equalizeHist(...)
equalizeHist(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage) -> None Equalize the image histogram, saving the new image in the given output object.   RGB images are first converted to HSV color space, then equalized for brightness (V) C++: mrpt::img::CImage::equalizeHist(class mrpt::img::CImage &) const --> void

extract_patch(...)
extract_patch(*args, **kwargs) Overloaded function. 1. extract_patch(self: mrpt.pymrpt.mrpt.img.CImage, patch: mrpt.pymrpt.mrpt.img.CImage) -> None 2. extract_patch(self: mrpt.pymrpt.mrpt.img.CImage, patch: mrpt.pymrpt.mrpt.img.CImage, col: int) -> None 3. extract_patch(self: mrpt.pymrpt.mrpt.img.CImage, patch: mrpt.pymrpt.mrpt.img.CImage, col: int, row: int) -> None 4. extract_patch(self: mrpt.pymrpt.mrpt.img.CImage, patch: mrpt.pymrpt.mrpt.img.CImage, col: int, row: int, width: int) -> None 5. extract_patch(self: mrpt.pymrpt.mrpt.img.CImage, patch: mrpt.pymrpt.mrpt.img.CImage, col: int, row: int, width: int, height: int) -> None Extract a patch from this image, saveing it into "patch" (its previous contents will be overwritten).   The patch to extract starts at (col,row) and has the given dimensions. update_patch C++: mrpt::img::CImage::extract_patch(class mrpt::img::CImage &, const unsigned int, const unsigned int, const unsigned int, const unsigned int) const --> void

filledRectangle(...)
filledRectangle(self: mrpt.pymrpt.mrpt.img.CImage, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor) -> None C++: mrpt::img::CImage::filledRectangle(int, int, int, int, const struct mrpt::img::TColor) --> void

filterGaussian(...)
filterGaussian(*args, **kwargs) Overloaded function. 1. filterGaussian(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage) -> None 2. filterGaussian(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage, W: int) -> None 3. filterGaussian(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage, W: int, H: int) -> None 4. filterGaussian(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage, W: int, H: int, sigma: float) -> None Filter the image with a Gaussian filter with a window size WxH, replacing "this" image by the filtered one. For inplace operation, set out_img to this. C++: mrpt::img::CImage::filterGaussian(class mrpt::img::CImage &, int, int, double) const --> void

filterMedian(...)
filterMedian(*args, **kwargs) Overloaded function. 1. filterMedian(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage) -> None 2. filterMedian(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage, W: int) -> None Filter the image with a Median filter with a window size WxW, returning the filtered image in out_img. For inplace operation, set out_img to this. C++: mrpt::img::CImage::filterMedian(class mrpt::img::CImage &, int) const --> void

flipHorizontal(...)
flipHorizontal(self: mrpt.pymrpt.mrpt.img.CImage) -> None Flips the image horizontally swapRB(), flipVertical() C++: mrpt::img::CImage::flipHorizontal() --> void

flipVertical(...)
flipVertical(self: mrpt.pymrpt.mrpt.img.CImage) -> None Flips the image vertically. swapRB(), flipHorizontal() C++: mrpt::img::CImage::flipVertical() --> void

forceLoad(...)
forceLoad(self: mrpt.pymrpt.mrpt.img.CImage) -> None For external storage image objects only, this method makes sure the image is loaded in memory. Note that usually images are loaded on-the-fly on first access and there's no need to call this. C++: mrpt::img::CImage::forceLoad() const --> void

getAsFloat(...)
getAsFloat(*args, **kwargs) Overloaded function. 1. getAsFloat(self: mrpt.pymrpt.mrpt.img.CImage, col: int, row: int, channel: int) -> float Returns the contents of a given pixel at the desired channel, in float format: [0,255]->[0,1]    The coordinate origin is pixel(0,0)=top-left corner of the image. std::exception On pixel coordinates out of bounds operator() C++: mrpt::img::CImage::getAsFloat(unsigned int, unsigned int, unsigned int) const --> float 2. getAsFloat(self: mrpt.pymrpt.mrpt.img.CImage, col: int, row: int) -> float Returns the contents of a given pixel (for gray-scale images, in color images the gray scale equivalent is computed for the pixel), in float format: [0,255]->[0,1]    The coordinate origin is pixel(0,0)=top-left corner of the image. std::exception On pixel coordinates out of bounds operator() C++: mrpt::img::CImage::getAsFloat(unsigned int, unsigned int) const --> float

getAsMatrix(...)
getAsMatrix(*args, **kwargs) Overloaded function. 1. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<float>) -> None 2. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<float>, doResize: bool) -> None 3. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<float>, doResize: bool, x_min: int) -> None 4. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<float>, doResize: bool, x_min: int, y_min: int) -> None 5. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<float>, doResize: bool, x_min: int, y_min: int, x_max: int) -> None 6. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<float>, doResize: bool, x_min: int, y_min: int, x_max: int, y_max: int) -> None 7. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<float>, doResize: bool, x_min: int, y_min: int, x_max: int, y_max: int, normalize_01: bool) -> None         Returns the image as a matrix with pixel grayscale values in the range [0,1]. Matrix indexes in this order: M(row,column)    If set to true (default), the output matrix will be always the size of the image at output. If set to false, the matrix will be enlarged to the size of the image, but it will not be cropped if it has room enough (useful for FFT2D,...)    The starting "x" coordinate to extract (default=0=the first column)    The starting "y" coordinate to extract (default=0=the first row)    The final "x" coordinate (inclusive) to extract (default=-1=the last column)    The final "y" coordinate (inclusive) to extract (default=-1=the last row) Normalize the image values such that they fall in the range [0,1] (default: true). If set to false, the matrix will hold numbers in the range [0,255]. setFromMatrix C++: mrpt::img::CImage::getAsMatrix(class mrpt::math::CMatrixDynamic<float> &, bool, int, int, int, int, bool) const --> void 8. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<unsigned char>) -> None 9. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<unsigned char>, doResize: bool) -> None 10. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<unsigned char>, doResize: bool, x_min: int) -> None 11. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<unsigned char>, doResize: bool, x_min: int, y_min: int) -> None 12. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<unsigned char>, doResize: bool, x_min: int, y_min: int, x_max: int) -> None 13. getAsMatrix(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<unsigned char>, doResize: bool, x_min: int, y_min: int, x_max: int, y_max: int) -> None C++: mrpt::img::CImage::getAsMatrix(class mrpt::math::CMatrixDynamic<unsigned char> &, bool, int, int, int, int) const --> void

getAsMatrixTiled(...)
getAsMatrixTiled(self: mrpt.pymrpt.mrpt.img.CImage, outMatrix: mrpt::math::CMatrixDynamic<float>) -> None         Returns the image as a matrix, where the image is "tiled" (repeated) the required number of times to fill the entire size of the matrix on input. C++: mrpt::img::CImage::getAsMatrixTiled(class mrpt::math::CMatrixDynamic<float> &) const --> void

getAsRGBMatrices(...)
getAsRGBMatrices(*args, **kwargs) Overloaded function. 1. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<float>, outMatrixG: mrpt::math::CMatrixDynamic<float>, outMatrixB: mrpt::math::CMatrixDynamic<float>) -> None 2. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<float>, outMatrixG: mrpt::math::CMatrixDynamic<float>, outMatrixB: mrpt::math::CMatrixDynamic<float>, doResize: bool) -> None 3. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<float>, outMatrixG: mrpt::math::CMatrixDynamic<float>, outMatrixB: mrpt::math::CMatrixDynamic<float>, doResize: bool, x_min: int) -> None 4. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<float>, outMatrixG: mrpt::math::CMatrixDynamic<float>, outMatrixB: mrpt::math::CMatrixDynamic<float>, doResize: bool, x_min: int, y_min: int) -> None 5. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<float>, outMatrixG: mrpt::math::CMatrixDynamic<float>, outMatrixB: mrpt::math::CMatrixDynamic<float>, doResize: bool, x_min: int, y_min: int, x_max: int) -> None 6. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<float>, outMatrixG: mrpt::math::CMatrixDynamic<float>, outMatrixB: mrpt::math::CMatrixDynamic<float>, doResize: bool, x_min: int, y_min: int, x_max: int, y_max: int) -> None         Returns the image as RGB matrices with pixel values in the range [0,1]. Matrix indexes in this order: M(row,column)    If set to true (default), the output matrix will be always the size of the image at output. If set to false, the matrix will be enlarged to the size of the image, but it will not be cropped if it has room enough (useful for FFT2D,...)    The starting "x" coordinate to extract (default=0=the first column)    The starting "y" coordinate to extract (default=0=the first row)    The final "x" coordinate (inclusive) to extract (default=-1=the last column)    The final "y" coordinate (inclusive) to extract (default=-1=the last row) setFromRGBMatrices C++: mrpt::img::CImage::getAsRGBMatrices(class mrpt::math::CMatrixDynamic<float> &, class mrpt::math::CMatrixDynamic<float> &, class mrpt::math::CMatrixDynamic<float> &, bool, int, int, int, int) const --> void 7. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixG: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixB: mrpt::math::CMatrixDynamic<unsigned char>) -> None 8. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixG: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixB: mrpt::math::CMatrixDynamic<unsigned char>, doResize: bool) -> None 9. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixG: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixB: mrpt::math::CMatrixDynamic<unsigned char>, doResize: bool, x_min: int) -> None 10. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixG: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixB: mrpt::math::CMatrixDynamic<unsigned char>, doResize: bool, x_min: int, y_min: int) -> None 11. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixG: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixB: mrpt::math::CMatrixDynamic<unsigned char>, doResize: bool, x_min: int, y_min: int, x_max: int) -> None 12. getAsRGBMatrices(self: mrpt.pymrpt.mrpt.img.CImage, outMatrixR: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixG: mrpt::math::CMatrixDynamic<unsigned char>, outMatrixB: mrpt::math::CMatrixDynamic<unsigned char>, doResize: bool, x_min: int, y_min: int, x_max: int, y_max: int) -> None C++: mrpt::img::CImage::getAsRGBMatrices(class mrpt::math::CMatrixDynamic<unsigned char> &, class mrpt::math::CMatrixDynamic<unsigned char> &, class mrpt::math::CMatrixDynamic<unsigned char> &, bool, int, int, int, int) const --> void

getChannelCount(...)
getChannelCount(self: mrpt.pymrpt.mrpt.img.CImage) -> mrpt.pymrpt.mrpt.img.TImageChannels Returns the number of channels, typically 1 (GRAY) or 3 (RGB) isColor C++: mrpt::img::CImage::getChannelCount() const --> enum mrpt::img::TImageChannels

getChannelsOrder(...)
getChannelsOrder(self: mrpt.pymrpt.mrpt.img.CImage) -> str As of mrpt 2.0.0, this returns either "GRAY" or "BGR". C++: mrpt::img::CImage::getChannelsOrder() const --> std::string

getExternalStorageFile(...)
getExternalStorageFile(self: mrpt.pymrpt.mrpt.img.CImage) -> str Only if isExternallyStored() returns true. getExternalStorageFileAbsolutePath C++: mrpt::img::CImage::getExternalStorageFile() const --> std::string

getExternalStorageFileAbsolutePath(...)
getExternalStorageFileAbsolutePath(*args, **kwargs) Overloaded function. 1. getExternalStorageFileAbsolutePath(self: mrpt.pymrpt.mrpt.img.CImage, out_path: str) -> None Only if isExternallyStored() returns true. getExternalStorageFile C++: mrpt::img::CImage::getExternalStorageFileAbsolutePath(std::string &) const --> void 2. getExternalStorageFileAbsolutePath(self: mrpt.pymrpt.mrpt.img.CImage) -> str Only if isExternallyStored() returns true. getExternalStorageFile C++: mrpt::img::CImage::getExternalStorageFileAbsolutePath() const --> std::string

getHeight(...)
getHeight(self: mrpt.pymrpt.mrpt.img.CImage) -> int Returns the height of the image in pixels getSize C++: mrpt::img::CImage::getHeight() const --> size_t

getMaxAsFloat(...)
getMaxAsFloat(self: mrpt.pymrpt.mrpt.img.CImage) -> float Return the maximum pixel value of the image, as a float value in the range [0,1] getAsFloat C++: mrpt::img::CImage::getMaxAsFloat() const --> float

getPixelDepth(...)
getPixelDepth(self: mrpt.pymrpt.mrpt.img.CImage) -> mrpt.pymrpt.mrpt.img.PixelDepth C++: mrpt::img::CImage::getPixelDepth() const --> enum mrpt::img::PixelDepth

getRowStride(...)
getRowStride(self: mrpt.pymrpt.mrpt.img.CImage) -> int Returns the row stride of the image: this is the number of *bytes* between two consecutive rows. You can access the pointer to the first row with ptrLine(0) getSize, as, ptr, ptrLine C++: mrpt::img::CImage::getRowStride() const --> size_t

getSize(...)
getSize(*args, **kwargs) Overloaded function. 1. getSize(self: mrpt.pymrpt.mrpt.img.CImage, s: mrpt.pymrpt.mrpt.img.TPixelCoord) -> None Return the size of the image getWidth, getHeight C++: mrpt::img::CImage::getSize(struct mrpt::img::TPixelCoord &) const --> void 2. getSize(self: mrpt.pymrpt.mrpt.img.CImage) -> mrpt.pymrpt.mrpt.img.TPixelCoord Return the size of the image getWidth, getHeight C++: mrpt::img::CImage::getSize() const --> struct mrpt::img::TPixelCoord

getWidth(...)
getWidth(self: mrpt.pymrpt.mrpt.img.CImage) -> int Returns the width of the image in pixels getSize C++: mrpt::img::CImage::getWidth() const --> size_t

grayscale(...)
grayscale(*args, **kwargs) Overloaded function. 1. grayscale(self: mrpt.pymrpt.mrpt.img.CImage) -> mrpt.pymrpt.mrpt.img.CImage Returns a grayscale version of the image, or a shallow copy of itself if it is already a grayscale image. C++: mrpt::img::CImage::grayscale() const --> class mrpt::img::CImage 2. grayscale(self: mrpt.pymrpt.mrpt.img.CImage, ret: mrpt.pymrpt.mrpt.img.CImage) -> bool In-place is supported by setting `ret=*this`. true if SSE2 version has been run (or if the image was already grayscale) C++: mrpt::img::CImage::grayscale(class mrpt::img::CImage &) const --> bool

isColor(...)
isColor(self: mrpt.pymrpt.mrpt.img.CImage) -> bool Returns true if the image is RGB or RGBA, false if it is grayscale C++: mrpt::img::CImage::isColor() const --> bool

isEmpty(...)
isEmpty(self: mrpt.pymrpt.mrpt.img.CImage) -> bool Returns true if the object is in the state after default constructor. Returns false for delay-loaded images, disregarding whether the image is actually on disk or memory. C++: mrpt::img::CImage::isEmpty() const --> bool

isExternallyStored(...)
isExternallyStored(self: mrpt.pymrpt.mrpt.img.CImage) -> bool See setExternalStorage(). C++: mrpt::img::CImage::isExternallyStored() const --> bool

isOriginTopLeft(...)
isOriginTopLeft(self: mrpt.pymrpt.mrpt.img.CImage) -> bool Returns true (as of MRPT v2.0.0, it's fixed) C++: mrpt::img::CImage::isOriginTopLeft() const --> bool

joinImagesHorz(...)
joinImagesHorz(self: mrpt.pymrpt.mrpt.img.CImage, im1: mrpt.pymrpt.mrpt.img.CImage, im2: mrpt.pymrpt.mrpt.img.CImage) -> None Joins two images side-by-side horizontally. Both images must have the same number of rows and be of the same type (i.e. depth and color mode) [IN] The first image. [IN] The other image. C++: mrpt::img::CImage::joinImagesHorz(const class mrpt::img::CImage &, const class mrpt::img::CImage &) --> void

line(...)
line(*args, **kwargs) Overloaded function. 1. line(self: mrpt.pymrpt.mrpt.img.CImage, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor) -> None 2. line(self: mrpt.pymrpt.mrpt.img.CImage, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor, width: int) -> None 3. line(self: mrpt.pymrpt.mrpt.img.CImage, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor, width: int, penStyle: mrpt.pymrpt.mrpt.img.CCanvas.TPenStyle) -> None C++: mrpt::img::CImage::line(int, int, int, int, const struct mrpt::img::TColor, unsigned int, enum mrpt::img::CCanvas::TPenStyle) --> void

loadFromFile(...)
loadFromFile(*args, **kwargs) Overloaded function. 1. loadFromFile(self: mrpt.pymrpt.mrpt.img.CImage, fileName: str) -> bool 2. loadFromFile(self: mrpt.pymrpt.mrpt.img.CImage, fileName: str, isColor: int) -> bool Load image from a file, whose format is determined from the extension (internally uses OpenCV). The file to read from. Specifies colorness of the loaded image:   - if ==1, the loaded image is forced to be color 3-channel image;   - if ==0, the loaded image is forced to be grayscale;   - if ==-1, the loaded image will be loaded as is (with number of channels depends on the file). The supported formats are: - Windows bitmaps - BMP, DIB; - JPEG files - JPEG, JPG, JPE; - Portable Network Graphics - PNG; - Portable image format - PBM, PGM, PPM; - Sun rasters - SR, RAS; - TIFF files - TIFF, TIF. MRPT also provides the special loaders loadFromXPM() and loadTGA(). Note that this function uses cv::imdecode() internally to reuse the memory buffer used by the image already loaded into this CImage, if possible, minimizing the number of memory allocations. False on any error saveToFile, setExternalStorage,loadFromXPM, loadTGA C++: mrpt::img::CImage::loadFromFile(const std::string &, int) --> bool

loadFromMemoryBuffer(...)
loadFromMemoryBuffer(*args, **kwargs) Overloaded function. 1. loadFromMemoryBuffer(self: mrpt.pymrpt.mrpt.img.CImage, width: int, height: int, color: bool, rawpixels: int) -> None 2. loadFromMemoryBuffer(self: mrpt.pymrpt.mrpt.img.CImage, width: int, height: int, color: bool, rawpixels: int, swapRedBlue: bool) -> None Reads the image from raw pixels buffer in memory. C++: mrpt::img::CImage::loadFromMemoryBuffer(unsigned int, unsigned int, bool, unsigned char *, bool) --> void 3. loadFromMemoryBuffer(self: mrpt.pymrpt.mrpt.img.CImage, width: int, height: int, bytesPerRow: int, red: int, green: int, blue: int) -> None Reads a color image from three raw pixels buffers in memory. bytesPerRow is the number of bytes per row per channel, i.e. the row increment. C++: mrpt::img::CImage::loadFromMemoryBuffer(unsigned int, unsigned int, unsigned int, unsigned char *, unsigned char *, unsigned char *) --> void

loadFromStreamAsJPEG(...)
loadFromStreamAsJPEG(self: mrpt.pymrpt.mrpt.img.CImage, in: mrpt.pymrpt.mrpt.io.CStream) -> None Reads the image from a binary stream containing a binary jpeg file. std::exception On pixel coordinates out of bounds C++: mrpt::img::CImage::loadFromStreamAsJPEG(class mrpt::io::CStream &) --> void

makeDeepCopy(...)
makeDeepCopy(self: mrpt.pymrpt.mrpt.img.CImage) -> mrpt.pymrpt.mrpt.img.CImage Returns a deep copy of this image. If the image is externally-stored, there is no difference with a shallow copy. makeShallowCopy() C++: mrpt::img::CImage::makeDeepCopy() const --> class mrpt::img::CImage

makeShallowCopy(...)
makeShallowCopy(self: mrpt.pymrpt.mrpt.img.CImage) -> mrpt.pymrpt.mrpt.img.CImage Returns a shallow copy of the original image C++: mrpt::img::CImage::makeShallowCopy() const --> class mrpt::img::CImage

normalize(...)
normalize(self: mrpt.pymrpt.mrpt.img.CImage) -> None Optimize the brightness range of an image without using histogram Only for one channel images. equalizeHist C++: mrpt::img::CImage::normalize() --> void

ptrLine(...)
ptrLine(*args, **kwargs) Overloaded function. 1. ptrLine(self: mrpt.pymrpt.mrpt.img.CImage, row: int) -> int C++: mrpt::img::CImage::ptrLine(unsigned int) const --> const unsigned char * 2. ptrLine(self: mrpt.pymrpt.mrpt.img.CImage, row: int) -> int C++: mrpt::img::CImage::ptrLine(unsigned int) --> unsigned char *

rectifyImageInPlace(...)
rectifyImageInPlace(self: mrpt.pymrpt.mrpt.img.CImage, mapX: capsule, mapY: capsule) -> None Rectify an image (undistorts and rectification) from a stereo pair according to a pair of precomputed rectification maps mapY   [IN] The pre-computed maps of the rectification (should be computed beforehand) mrpt::vision::CStereoRectifyMap, mrpt::vision::computeStereoRectificationMaps C++: mrpt::img::CImage::rectifyImageInPlace(void *, void *) --> void

resize(...)
resize(*args, **kwargs) Overloaded function. 1. resize(self: mrpt.pymrpt.mrpt.img.CImage, width: int, height: int, nChannels: mrpt.pymrpt.mrpt.img.TImageChannels) -> None 2. resize(self: mrpt.pymrpt.mrpt.img.CImage, width: int, height: int, nChannels: mrpt.pymrpt.mrpt.img.TImageChannels, depth: mrpt.pymrpt.mrpt.img.PixelDepth) -> None Changes the size of the image, erasing previous contents (does NOT scale its current content, for that, see scaleImage).   - nChannels: Can be 3 for RGB images or 1 for grayscale images. scaleImage C++: mrpt::img::CImage::resize(std::size_t, std::size_t, enum mrpt::img::TImageChannels, enum mrpt::img::PixelDepth) --> void

rotateImage(...)
rotateImage(*args, **kwargs) Overloaded function. 1. rotateImage(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage, ang: float, cx: int, cy: int) -> None 2. rotateImage(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage, ang: float, cx: int, cy: int, scale: float) -> None Rotates the image by the given angle around the given center point, with an optional scale factor. resize, scaleImage C++: mrpt::img::CImage::rotateImage(class mrpt::img::CImage &, double, unsigned int, unsigned int, double) const --> void

saveToFile(...)
saveToFile(*args, **kwargs) Overloaded function. 1. saveToFile(self: mrpt.pymrpt.mrpt.img.CImage, fileName: str) -> bool 2. saveToFile(self: mrpt.pymrpt.mrpt.img.CImage, fileName: str, jpeg_quality: int) -> bool Save the image to a file, whose format is determined from the extension (internally uses OpenCV). The file to write to. The supported formats are: - Windows bitmaps - BMP, DIB; - JPEG files - JPEG, JPG, JPE; - Portable Network Graphics - PNG; - Portable image format - PBM, PGM, PPM; - Sun rasters - SR, RAS; - TIFF files - TIFF, TIF. Only for JPEG files, the quality of the compression in the range [0-100]. Larger is better quality but slower. jpeg_quality is only effective if MRPT is compiled against OpenCV 1.1.0 or newer. False on any error loadFromFile C++: mrpt::img::CImage::saveToFile(const std::string &, int) const --> bool

saveToStreamAsJPEG(...)
saveToStreamAsJPEG(*args, **kwargs) Overloaded function. 1. saveToStreamAsJPEG(self: mrpt.pymrpt.mrpt.img.CImage, out: mrpt.pymrpt.mrpt.io.CStream) -> None 2. saveToStreamAsJPEG(self: mrpt.pymrpt.mrpt.img.CImage, out: mrpt.pymrpt.mrpt.io.CStream, jpeg_quality: int) -> None Save image to binary stream as a JPEG (.jpg) compressed format. std::exception On number of rows or cols equal to zero or other errors. saveToJPEG C++: mrpt::img::CImage::saveToStreamAsJPEG(class mrpt::io::CStream &, const int) const --> void

scaleDouble(...)
scaleDouble(*args, **kwargs) Overloaded function. 1. scaleDouble(self: mrpt.pymrpt.mrpt.img.CImage, interp: mrpt.pymrpt.mrpt.img.TInterpolationMethod) -> mrpt.pymrpt.mrpt.img.CImage Returns a new image scaled up to double its original size. std::exception On odd size scaleHalf, scaleImage C++: mrpt::img::CImage::scaleDouble(enum mrpt::img::TInterpolationMethod) const --> class mrpt::img::CImage 2. scaleDouble(self: mrpt.pymrpt.mrpt.img.CImage, out_image: mrpt.pymrpt.mrpt.img.CImage, interp: mrpt.pymrpt.mrpt.img.TInterpolationMethod) -> None C++: mrpt::img::CImage::scaleDouble(class mrpt::img::CImage &, enum mrpt::img::TInterpolationMethod) const --> void

scaleHalf(...)
scaleHalf(*args, **kwargs) Overloaded function. 1. scaleHalf(self: mrpt.pymrpt.mrpt.img.CImage, interp: mrpt.pymrpt.mrpt.img.TInterpolationMethod) -> mrpt.pymrpt.mrpt.img.CImage Returns a new image scaled down to half its original size std::exception On odd size scaleDouble, scaleImage, scaleHalfSmooth C++: mrpt::img::CImage::scaleHalf(enum mrpt::img::TInterpolationMethod) const --> class mrpt::img::CImage 2. scaleHalf(self: mrpt.pymrpt.mrpt.img.CImage, out_image: mrpt.pymrpt.mrpt.img.CImage, interp: mrpt.pymrpt.mrpt.img.TInterpolationMethod) -> bool true if an optimized SSE2/SSE3 version could be used. C++: mrpt::img::CImage::scaleHalf(class mrpt::img::CImage &, enum mrpt::img::TInterpolationMethod) const --> bool

scaleImage(...)
scaleImage(*args, **kwargs) Overloaded function. 1. scaleImage(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage, width: int, height: int) -> None 2. scaleImage(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage, width: int, height: int, interp: mrpt.pymrpt.mrpt.img.TInterpolationMethod) -> None Scales this image to a new size, interpolating as needed, saving the new image in a different output object, or operating in-place if `out_img==this`. resize, rotateImage C++: mrpt::img::CImage::scaleImage(class mrpt::img::CImage &, unsigned int, unsigned int, enum mrpt::img::TInterpolationMethod) const --> void

setExternalStorage(...)
setExternalStorage(self: mrpt.pymrpt.mrpt.img.CImage, fileName: str) -> None By using this method the image is marked as referenced to an external file, which will be loaded only under demand.    A CImage with external storage does not consume memory until some method trying to access the image is invoked (e.g. getWidth(), isColor(),...)    At any moment, the image can be unloaded from memory again by invoking unload.    An image becomes of type "external storage" only through calling setExternalStorage. This property remains after serializing the object.    File names can be absolute, or relative to the CImage::getImagesPathBase() directory. Filenames staring with "X:\" or "/" are considered absolute paths.    By calling this method the current contents of the image are NOT saved to that file, because this method can be also called     to let the object know where to load the image in case its contents are required. Thus, for saving images in this format (not when loading)     the proper order of commands should be:         Modifications to the memory copy of the image are not automatically saved to disk.    unload, isExternallyStored C++: mrpt::img::CImage::setExternalStorage(const std::string &) --> void

setPixel(...)
setPixel(self: mrpt.pymrpt.mrpt.img.CImage, x: int, y: int, color: int) -> None Changes the value of the pixel (x,y).   Pixel coordinates starts at the left-top corner of the image, and start in (0,0).   The meaning of the parameter "color" depends on the implementation: it will usually    be a 24bit RGB value (0x00RRGGBB), but it can also be just a 8bit gray level.   This method must support (x,y) values OUT of the actual image size without neither    raising exceptions, nor leading to memory access errors. at, ptr C++: mrpt::img::CImage::setPixel(int, int, size_t) --> void

swap(...)
swap(self: mrpt.pymrpt.mrpt.img.CImage, o: mrpt.pymrpt.mrpt.img.CImage) -> None Efficiently swap of two images C++: mrpt::img::CImage::swap(class mrpt::img::CImage &) --> void

swapRB(...)
swapRB(self: mrpt.pymrpt.mrpt.img.CImage) -> None Swaps red and blue channels. C++: mrpt::img::CImage::swapRB() --> void

undistort(...)
undistort(self: mrpt.pymrpt.mrpt.img.CImage, out_img: mrpt.pymrpt.mrpt.img.CImage, cameraParams: mrpt.pymrpt.mrpt.img.TCamera) -> None Undistort the image according to some camera parameters, and returns an output undistorted image. The output undistorted image The input camera params (containing the intrinsic and distortion parameters of the camera) The intrinsic parameters (fx,fy,cx,cy) of the output image are the same than in the input image. mrpt::vision::CUndistortMap C++: mrpt::img::CImage::undistort(class mrpt::img::CImage &, const class mrpt::img::TCamera &) const --> void

unload(...)
unload(self: mrpt.pymrpt.mrpt.img.CImage) -> None For external storage image objects only, this method unloads the image from memory (or does nothing if already unloaded).   It does not need to be called explicitly, unless the user wants to save memory for images that will not be used often.   If called for an image without the flag "external storage", it is simply ignored. setExternalStorage, forceLoad C++: mrpt::img::CImage::unload() const --> void

update_patch(...)
update_patch(self: mrpt.pymrpt.mrpt.img.CImage, patch: mrpt.pymrpt.mrpt.img.CImage, col: int, row: int) -> None Update a part of this image with the "patch" given as argument. The "patch" will be "pasted" at the (col,row) coordinates of this image. std::exception if patch pasted on the pixel (_row, _column) jut out of the image. extract_patch C++: mrpt::img::CImage::update_patch(const class mrpt::img::CImage &, const unsigned int, const unsigned int) --> void

Static methods defined here:

CreateObject(...) from builtins.PyCapsule
CreateObject() -> mrpt.pymrpt.mrpt.rtti.CObject C++: mrpt::img::CImage::CreateObject() --> class std::shared_ptr<class mrpt::rtti::CObject>

DISABLE_JPEG_COMPRESSION(...) from builtins.PyCapsule
DISABLE_JPEG_COMPRESSION(*args, **kwargs) Overloaded function. 1. DISABLE_JPEG_COMPRESSION(val: bool) -> None By default, when storing images through the CSerializable interface, RGB images are JPEG-compressed to save space. If for some reason you prefer storing RAW image data, disable this feature by setting this flag to true.   (Default = true) C++: mrpt::img::CImage::DISABLE_JPEG_COMPRESSION(bool) --> void 2. DISABLE_JPEG_COMPRESSION() -> bool C++: mrpt::img::CImage::DISABLE_JPEG_COMPRESSION() --> bool

GetRuntimeClassIdStatic(...) from builtins.PyCapsule
GetRuntimeClassIdStatic() -> mrpt.pymrpt.mrpt.rtti.TRuntimeClassId C++: mrpt::img::CImage::GetRuntimeClassIdStatic() --> const struct mrpt::rtti::TRuntimeClassId &

LoadFromFile(...) from builtins.PyCapsule
LoadFromFile(*args, **kwargs) Overloaded function. 1. LoadFromFile(fileName: str) -> mrpt.pymrpt.mrpt.img.CImage 2. LoadFromFile(fileName: str, isColor: int) -> mrpt.pymrpt.mrpt.img.CImage Static method to construct an CImage object from a file. See CImage::loadFromFile() for meaning of parameters. std::exception On load error. New in MRPT 2.4.2 C++: mrpt::img::CImage::LoadFromFile(const std::string &, int) --> class mrpt::img::CImage

SERIALIZATION_JPEG_QUALITY(...) from builtins.PyCapsule
SERIALIZATION_JPEG_QUALITY(*args, **kwargs) Overloaded function. 1. SERIALIZATION_JPEG_QUALITY(q: int) -> None Unless DISABLE_JPEG_COMPRESSION=true, this sets the JPEG quality (range 1-100) of serialized RGB images.   (Default = 95) C++: mrpt::img::CImage::SERIALIZATION_JPEG_QUALITY(int) --> void 2. SERIALIZATION_JPEG_QUALITY() -> int C++: mrpt::img::CImage::SERIALIZATION_JPEG_QUALITY() --> int

getImagesPathBase(...) from builtins.PyCapsule
getImagesPathBase() -> str By default, "."   setExternalStorage    Since MRPT 2.3.3 this is a synonym         with mrpt::io::getLazyLoadPathBase() C++: mrpt::img::CImage::getImagesPathBase() --> const std::string &

loadTGA(...) from builtins.PyCapsule
loadTGA(fileName: str, out_RGB: mrpt.pymrpt.mrpt.img.CImage, out_alpha: mrpt.pymrpt.mrpt.img.CImage) -> bool Loads a TGA true-color RGBA image as two CImage objects, one for the RGB channels plus a separate gray-level image with A channel. true on success C++: mrpt::img::CImage::loadTGA(const std::string &, class mrpt::img::CImage &, class mrpt::img::CImage &) --> bool

setImagesPathBase(...) from builtins.PyCapsule
setImagesPathBase(path: str) -> None Since MRPT 2.3.3 this is a synonym         with mrpt::io::setLazyLoadPathBase() C++: mrpt::img::CImage::setImagesPathBase(const std::string &) --> void

Methods inherited from mrpt.pymrpt.mrpt.rtti.CObject:

duplicateGetSmartPtr(...)
duplicateGetSmartPtr(self: mrpt.pymrpt.mrpt.rtti.CObject) -> mrpt.pymrpt.mrpt.rtti.CObject Makes a deep copy of the object and returns a smart pointer to it C++: mrpt::rtti::CObject::duplicateGetSmartPtr() const --> class std::shared_ptr<class mrpt::rtti::CObject>

Methods inherited from CCanvas:

drawMark(...)
drawMark(*args, **kwargs) Overloaded function. 1. drawMark(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, color: mrpt.pymrpt.mrpt.img.TColor, type: str) -> None 2. drawMark(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, color: mrpt.pymrpt.mrpt.img.TColor, type: str, size: int) -> None 3. drawMark(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, color: mrpt.pymrpt.mrpt.img.TColor, type: str, size: int, width: int) -> None Draw a mark. The point x coordinate The point y coordinate The color of the cross The size of the cross The cross type. It could be: 'x', '+', ':'(like '+' but clear at the center dot), or 's' (square) The desired width of the cross (this is IGNORED yet) C++: mrpt::img::CCanvas::drawMark(int, int, const struct mrpt::img::TColor, char, int, unsigned int) --> void

ellipseGaussian(...)
ellipseGaussian(*args, **kwargs) Overloaded function. 1. ellipseGaussian(self: mrpt.pymrpt.mrpt.img.CCanvas, cov2D: mrpt::math::CMatrixFixed<double, 2ul, 2ul>, mean_x: float, mean_y: float) -> None 2. ellipseGaussian(self: mrpt.pymrpt.mrpt.img.CCanvas, cov2D: mrpt::math::CMatrixFixed<double, 2ul, 2ul>, mean_x: float, mean_y: float, confIntervalStds: float) -> None 3. ellipseGaussian(self: mrpt.pymrpt.mrpt.img.CCanvas, cov2D: mrpt::math::CMatrixFixed<double, 2ul, 2ul>, mean_x: float, mean_y: float, confIntervalStds: float, color: mrpt.pymrpt.mrpt.img.TColor) -> None 4. ellipseGaussian(self: mrpt.pymrpt.mrpt.img.CCanvas, cov2D: mrpt::math::CMatrixFixed<double, 2ul, 2ul>, mean_x: float, mean_y: float, confIntervalStds: float, color: mrpt.pymrpt.mrpt.img.TColor, width: int) -> None 5. ellipseGaussian(self: mrpt.pymrpt.mrpt.img.CCanvas, cov2D: mrpt::math::CMatrixFixed<double, 2ul, 2ul>, mean_x: float, mean_y: float, confIntervalStds: float, color: mrpt.pymrpt.mrpt.img.TColor, width: int, nEllipsePoints: int) -> None Draws an ellipse representing a given confidence interval of a 2D Gaussian distribution. The x coordinate of the center point of the ellipse. The y coordinate of the center point of the ellipse. A 2x2 covariance matrix. How many "sigmas" for the confidence level (i.e. 2->95%, 3=99.97%,...) The color of the ellipse The desired width of the line (this is IGNORED in this virtual class) The number of points to generate to approximate the ellipse shape. std::exception On an invalid matrix. C++: mrpt::img::CCanvas::ellipseGaussian(const class mrpt::math::CMatrixFixed<double, 2, 2> &, const double, const double, double, const struct mrpt::img::TColor &, unsigned int, int) --> void

rectangle(...)
rectangle(*args, **kwargs) Overloaded function. 1. rectangle(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor) -> None 2. rectangle(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, x1: int, y1: int, color: mrpt.pymrpt.mrpt.img.TColor, width: int) -> None Draws a rectangle (an empty rectangle, without filling) The top-left x coordinate The top-left y coordinate The right-bottom x coordinate The right-bottom y coordinate The color of the line The desired width of the line. filledRectangle C++: mrpt::img::CCanvas::rectangle(int, int, int, int, const struct mrpt::img::TColor, unsigned int) --> void

selectTextFont(...)
selectTextFont(self: mrpt.pymrpt.mrpt.img.CCanvas, fontName: str) -> None Select the current font used when drawing text. The name of the font   Valid font names:   - 5x7   - 6x13   - 6x13B   - 6x13O   - 9x15   (Default at start-up)   - 9x15B   - 10x20   - 18x18ja (Asian characters for UTF-8 strings - Only available if MRPT is built with MRPT_HAS_ASIAN_FONTS = true)     textOut, The example in * href="http://www.mrpt.org/Implemented_2D_Fonts">this page. C++: mrpt::img::CCanvas::selectTextFont(const std::string &) --> void

textOut(...)
textOut(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, str: str, color: mrpt.pymrpt.mrpt.img.TColor) -> None Renders 2D text using bitmap fonts. The x coordinates The y coordinates The string to put. If using UNICODE characters, use UTF-8 encoding. The text color selectTextFont C++: mrpt::img::CCanvas::textOut(int, int, const std::string &, const struct mrpt::img::TColor) --> void

triangle(...)
triangle(*args, **kwargs) Overloaded function. 1. triangle(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, size: int, color: mrpt.pymrpt.mrpt.img.TColor) -> None 2. triangle(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, size: int, color: mrpt.pymrpt.mrpt.img.TColor, inferior: bool) -> None 3. triangle(self: mrpt.pymrpt.mrpt.img.CCanvas, x0: int, y0: int, size: int, color: mrpt.pymrpt.mrpt.img.TColor, inferior: bool, width: int) -> None Draws a triangle The triangle center x coordinate The triangle center y coordinate The size of the triangle The color of the line          The position of the triangle The desired width of the line. triangle C++: mrpt::img::CCanvas::triangle(int, int, int, const struct mrpt::img::TColor, bool, unsigned int) --> void

Data and other attributes inherited from CCanvas:

TPenStyle = <class 'mrpt.pymrpt.mrpt.img.CCanvas.TPenStyle'>

psDash = <TPenStyle.psDash: 1>

psDashDot = <TPenStyle.psDashDot: 3>

psDashDotDot = <TPenStyle.psDashDotDot: 4>

psDot = <TPenStyle.psDot: 2>

psSolid = <TPenStyle.psSolid: 0>

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class DistortionModel(pybind11_builtins.pybind11_object)


Method resolution order:

DistortionModel

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__eq__(...)
__eq__(self: object, other: object) -> bool

__getstate__(...)
__getstate__(self: object) -> int

__hash__(...)
__hash__(self: object) -> int

__index__(...)
__index__(self: mrpt.pymrpt.mrpt.img.DistortionModel) -> int

__init__(...)
__init__(self: mrpt.pymrpt.mrpt.img.DistortionModel, value: int) -> None

__int__(...)
__int__(self: mrpt.pymrpt.mrpt.img.DistortionModel) -> int

__ne__(...)
__ne__(self: object, other: object) -> bool

__repr__(...)
__repr__(self: object) -> str

__setstate__(...)
__setstate__(self: mrpt.pymrpt.mrpt.img.DistortionModel, state: int) -> None

__str__ = name(...)
name(self: handle) -> str

Readonly properties defined here:

__members__

name

name(self: handle) -> str

value

Data and other attributes defined here:

kannala_brandt = <DistortionModel.kannala_brandt: 2>

none = <DistortionModel.none: 0>

plumb_bob = <DistortionModel.plumb_bob: 1>

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class PixelDepth(pybind11_builtins.pybind11_object)


Method resolution order:

PixelDepth

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__eq__(...)
__eq__(self: object, other: object) -> bool

__getstate__(...)
__getstate__(self: object) -> int

__hash__(...)
__hash__(self: object) -> int

__index__(...)
__index__(self: mrpt.pymrpt.mrpt.img.PixelDepth) -> int

__init__(...)
__init__(self: mrpt.pymrpt.mrpt.img.PixelDepth, value: int) -> None

__int__(...)
__int__(self: mrpt.pymrpt.mrpt.img.PixelDepth) -> int

__ne__(...)
__ne__(self: object, other: object) -> bool

__repr__(...)
__repr__(self: object) -> str

__setstate__(...)
__setstate__(self: mrpt.pymrpt.mrpt.img.PixelDepth, state: int) -> None

__str__ = name(...)
name(self: handle) -> str

Readonly properties defined here:

__members__

name

name(self: handle) -> str

value

Data and other attributes defined here:

D16S = <PixelDepth.D16S: 3>

D16U = <PixelDepth.D16U: 2>

D32F = <PixelDepth.D32F: 5>

D32S = <PixelDepth.D32S: 4>

D64F = <PixelDepth.D64F: 6>

D8S = <PixelDepth.D8S: 1>

D8U = <PixelDepth.D8U: 0>

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class TCamera(mrpt.pymrpt.mrpt.serialization.CSerializable)

    Intrinsic parameters for a pinhole or fisheye camera model, plus its associated lens distortion model. The type of camera distortion is defined by the  field. Parameters for one camera resolution can be used for any other resolutions by means of the method TCamera::scaleToResolution() The application camera-calib-gui for calibrating a camera

Method resolution order:

TCamera

mrpt.pymrpt.mrpt.serialization.CSerializable

mrpt.pymrpt.mrpt.rtti.CObject

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

GetRuntimeClass(...)
GetRuntimeClass(self: mrpt.pymrpt.mrpt.img.TCamera) -> mrpt.pymrpt.mrpt.rtti.TRuntimeClassId C++: mrpt::img::TCamera::GetRuntimeClass() const --> const struct mrpt::rtti::TRuntimeClassId *

__init__(...)
__init__(*args, **kwargs) Overloaded function. 1. __init__(self: mrpt.pymrpt.mrpt.img.TCamera) -> None 2. __init__(self: mrpt.pymrpt.mrpt.img.TCamera, arg0: mrpt.pymrpt.mrpt.img.TCamera) -> None 3. __init__(self: mrpt.pymrpt.mrpt.img.TCamera, arg0: mrpt.pymrpt.mrpt.img.TCamera) -> None

asYAML(...)
asYAML(self: mrpt.pymrpt.mrpt.img.TCamera) -> mrpt.pymrpt.mrpt.containers.yaml Stores as yaml, in OpenCV calibration model. Refer to [this example](http://wiki.ros.org/camera_calibration_parsers#YAML). C++: mrpt::img::TCamera::asYAML() const --> class mrpt::containers::yaml

assign(...)
assign(self: mrpt.pymrpt.mrpt.img.TCamera, : mrpt.pymrpt.mrpt.img.TCamera) -> mrpt.pymrpt.mrpt.img.TCamera C++: mrpt::img::TCamera::operator=(const class mrpt::img::TCamera &) --> class mrpt::img::TCamera &

clone(...)
clone(self: mrpt.pymrpt.mrpt.img.TCamera) -> mrpt.pymrpt.mrpt.rtti.CObject C++: mrpt::img::TCamera::clone() const --> class mrpt::rtti::CObject *

cx(...)
cx(*args, **kwargs) Overloaded function. 1. cx(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the principal point x-coordinate (in pixels). C++: mrpt::img::TCamera::cx() const --> double 2. cx(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the principal point x-coordinate (in pixels). C++: mrpt::img::TCamera::cx(double) --> void

cy(...)
cy(*args, **kwargs) Overloaded function. 1. cy(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the principal point y-coordinate  (in pixels). C++: mrpt::img::TCamera::cy() const --> double 2. cy(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the principal point y-coordinate  (in pixels). C++: mrpt::img::TCamera::cy(double) --> void

dumpAsText(...)
dumpAsText(self: mrpt.pymrpt.mrpt.img.TCamera) -> str Returns all parameters as a text block in the INI-file format.    asYAML() C++: mrpt::img::TCamera::dumpAsText() const --> std::string

fx(...)
fx(*args, **kwargs) Overloaded function. 1. fx(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the focal length x-value (in pixels). C++: mrpt::img::TCamera::fx() const --> double 2. fx(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the focal length x-value (in pixels). C++: mrpt::img::TCamera::fx(double) --> void

fy(...)
fy(*args, **kwargs) Overloaded function. 1. fy(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the focal length y-value (in pixels). C++: mrpt::img::TCamera::fy() const --> double 2. fy(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the focal length y-value (in pixels). C++: mrpt::img::TCamera::fy(double) --> void

getDistortionParamsAsRowVector(...)
getDistortionParamsAsRowVector(self: mrpt.pymrpt.mrpt.img.TCamera) -> mrpt::math::CMatrixDynamic<double> Equivalent to getDistortionParamsAsVector()   C++: mrpt::img::TCamera::getDistortionParamsAsRowVector() const --> class mrpt::math::CMatrixDynamic<double>

k1(...)
k1(*args, **kwargs) Overloaded function. 1. k1(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the k1 distortion parameter.   C++: mrpt::img::TCamera::k1() const --> double 2. k1(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the k1 distortion parameter.   C++: mrpt::img::TCamera::k1(double) --> void

k2(...)
k2(*args, **kwargs) Overloaded function. 1. k2(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the k2 distortion parameter.   C++: mrpt::img::TCamera::k2() const --> double 2. k2(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the k2 distortion parameter.   C++: mrpt::img::TCamera::k2(double) --> void

k3(...)
k3(*args, **kwargs) Overloaded function. 1. k3(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the k3 distortion parameter.   C++: mrpt::img::TCamera::k3() const --> double 2. k3(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the k3 distortion parameter.   C++: mrpt::img::TCamera::k3(double) --> void

k4(...)
k4(*args, **kwargs) Overloaded function. 1. k4(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the k4 distortion parameter.   C++: mrpt::img::TCamera::k4() const --> double 2. k4(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the k4 distortion parameter.   C++: mrpt::img::TCamera::k4(double) --> void

k5(...)
k5(*args, **kwargs) Overloaded function. 1. k5(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the k5 distortion parameter.   C++: mrpt::img::TCamera::k5() const --> double 2. k5(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the k5 distortion parameter.   C++: mrpt::img::TCamera::k5(double) --> void

k6(...)
k6(*args, **kwargs) Overloaded function. 1. k6(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the k6 distortion parameter.   C++: mrpt::img::TCamera::k6() const --> double 2. k6(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the k6 distortion parameter.   C++: mrpt::img::TCamera::k6(double) --> void

loadFromConfigFile(...)
loadFromConfigFile(*args, **kwargs) Overloaded function. 1. loadFromConfigFile(self: mrpt.pymrpt.mrpt.img.TCamera, section: str, cfg: mrpt.pymrpt.mrpt.config.CConfigFileBase) -> None Load all the params from a config source, in the format used in saveToConfigFile(), that is:       std::exception on missing fields C++: mrpt::img::TCamera::loadFromConfigFile(const std::string &, const class mrpt::config::CConfigFileBase &) --> void 2. loadFromConfigFile(self: mrpt.pymrpt.mrpt.img.TCamera, cfg: mrpt.pymrpt.mrpt.config.CConfigFileBase, section: str) -> None overload This signature is consistent with the rest of MRPT APIs C++: mrpt::img::TCamera::loadFromConfigFile(const class mrpt::config::CConfigFileBase &, const std::string &) --> void

p1(...)
p1(*args, **kwargs) Overloaded function. 1. p1(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the p1 distortion parameter.   C++: mrpt::img::TCamera::p1() const --> double 2. p1(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the p1 distortion parameter.   C++: mrpt::img::TCamera::p1(double) --> void

p2(...)
p2(*args, **kwargs) Overloaded function. 1. p2(self: mrpt.pymrpt.mrpt.img.TCamera) -> float Get the value of the p2 distortion parameter.   C++: mrpt::img::TCamera::p2() const --> double 2. p2(self: mrpt.pymrpt.mrpt.img.TCamera, val: float) -> None Set the value of the p2 distortion parameter.   C++: mrpt::img::TCamera::p2(double) --> void

saveToConfigFile(...)
saveToConfigFile(self: mrpt.pymrpt.mrpt.img.TCamera, section: str, cfg: mrpt.pymrpt.mrpt.config.CConfigFileBase) -> None Save as a config block:              C++: mrpt::img::TCamera::saveToConfigFile(const std::string &, class mrpt::config::CConfigFileBase &) const --> void

scaleToResolution(...)
scaleToResolution(self: mrpt.pymrpt.mrpt.img.TCamera, new_ncols: int, new_nrows: int) -> None Rescale all the parameters for a new camera resolution (it raises an exception if the aspect ratio is modified, which is not permitted). C++: mrpt::img::TCamera::scaleToResolution(unsigned int, unsigned int) --> void

setDistortionKannalaBrandt(...)
setDistortionKannalaBrandt(self: mrpt.pymrpt.mrpt.img.TCamera, k1_: float, k2_: float, k3_: float, k4_: float) -> None Defines the distortion model and its parameters, in one call. C++: mrpt::img::TCamera::setDistortionKannalaBrandt(double, double, double, double) --> void

setDistortionPlumbBob(...)
setDistortionPlumbBob(*args, **kwargs) Overloaded function. 1. setDistortionPlumbBob(self: mrpt.pymrpt.mrpt.img.TCamera, k1_: float, k2_: float, p1_: float, p2_: float) -> None 2. setDistortionPlumbBob(self: mrpt.pymrpt.mrpt.img.TCamera, k1_: float, k2_: float, p1_: float, p2_: float, k3_: float) -> None Defines the distortion model and its parameters, in one call. C++: mrpt::img::TCamera::setDistortionPlumbBob(double, double, double, double, double) --> void

setIntrinsicParamsFromValues(...)
setIntrinsicParamsFromValues(self: mrpt.pymrpt.mrpt.img.TCamera, fx: float, fy: float, cx: float, cy: float) -> None Set the matrix of intrinsic params of the camera from the individual values of focal length and principal point coordinates (in pixels) C++: mrpt::img::TCamera::setIntrinsicParamsFromValues(double, double, double, double) --> void

Static methods defined here:

CreateObject(...) from builtins.PyCapsule
CreateObject() -> mrpt.pymrpt.mrpt.rtti.CObject C++: mrpt::img::TCamera::CreateObject() --> class std::shared_ptr<class mrpt::rtti::CObject>

FromYAML(...) from builtins.PyCapsule
FromYAML(params: mrpt.pymrpt.mrpt.containers.yaml) -> mrpt.pymrpt.mrpt.img.TCamera Parse from yaml, in OpenCV calibration model. Refer to [this example](https://wiki.ros.org/camera_calibration_parsers#YAML). For known distortion models see mrpt::img::DistortionModel           C++: mrpt::img::TCamera::FromYAML(const class mrpt::containers::yaml &) --> class mrpt::img::TCamera

GetRuntimeClassIdStatic(...) from builtins.PyCapsule
GetRuntimeClassIdStatic() -> mrpt.pymrpt.mrpt.rtti.TRuntimeClassId C++: mrpt::img::TCamera::GetRuntimeClassIdStatic() --> const struct mrpt::rtti::TRuntimeClassId &

Data descriptors defined here:

cameraName

dist

distortion

focalLengthMeters

intrinsicParams

ncols

nrows

Methods inherited from mrpt.pymrpt.mrpt.rtti.CObject:

duplicateGetSmartPtr(...)
duplicateGetSmartPtr(self: mrpt.pymrpt.mrpt.rtti.CObject) -> mrpt.pymrpt.mrpt.rtti.CObject Makes a deep copy of the object and returns a smart pointer to it C++: mrpt::rtti::CObject::duplicateGetSmartPtr() const --> class std::shared_ptr<class mrpt::rtti::CObject>

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class TColor(pybind11_builtins.pybind11_object)

    A RGB color - 8bit. Struct pack=1 is ensured.

Method resolution order:

TColor

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__iadd__(...)
__iadd__(self: mrpt.pymrpt.mrpt.img.TColor, other: mrpt.pymrpt.mrpt.img.TColor) -> mrpt.pymrpt.mrpt.img.TColor C++: mrpt::img::TColor::operator+=(const struct mrpt::img::TColor &) --> struct mrpt::img::TColor &

__init__(...)
__init__(*args, **kwargs) Overloaded function. 1. __init__(self: mrpt.pymrpt.mrpt.img.TColor) -> None 2. __init__(self: mrpt.pymrpt.mrpt.img.TColor, r: int, g: int, b: int) -> None doc 3. __init__(self: mrpt.pymrpt.mrpt.img.TColor, r: int, g: int, b: int, alpha: int) -> None 4. __init__(self: mrpt.pymrpt.mrpt.img.TColor, color_RGB_24bit: int) -> None 5. __init__(self: mrpt.pymrpt.mrpt.img.TColor, color_RGB_24bit: int, alpha: int) -> None 6. __init__(self: mrpt.pymrpt.mrpt.img.TColor, arg0: mrpt.pymrpt.mrpt.img.TColor) -> None

__isub__(...)
__isub__(self: mrpt.pymrpt.mrpt.img.TColor, other: mrpt.pymrpt.mrpt.img.TColor) -> mrpt.pymrpt.mrpt.img.TColor C++: mrpt::img::TColor::operator-=(const struct mrpt::img::TColor &) --> struct mrpt::img::TColor &

__str__(...)
__str__(self: mrpt.pymrpt.mrpt.img.TColor) -> str

assign(...)
assign(self: mrpt.pymrpt.mrpt.img.TColor, other: mrpt.pymrpt.mrpt.img.TColor) -> mrpt.pymrpt.mrpt.img.TColor C++: mrpt::img::TColor::operator=(const struct mrpt::img::TColor &) --> struct mrpt::img::TColor &

Static methods defined here:

black(...) from builtins.PyCapsule
black() -> mrpt.pymrpt.mrpt.img.TColor C++: mrpt::img::TColor::black() --> struct mrpt::img::TColor

blue(...) from builtins.PyCapsule
blue() -> mrpt.pymrpt.mrpt.img.TColor C++: mrpt::img::TColor::blue() --> struct mrpt::img::TColor

gray(...) from builtins.PyCapsule
gray() -> mrpt.pymrpt.mrpt.img.TColor C++: mrpt::img::TColor::gray() --> struct mrpt::img::TColor

green(...) from builtins.PyCapsule
green() -> mrpt.pymrpt.mrpt.img.TColor C++: mrpt::img::TColor::green() --> struct mrpt::img::TColor

red(...) from builtins.PyCapsule
red() -> mrpt.pymrpt.mrpt.img.TColor Predefined colors C++: mrpt::img::TColor::red() --> struct mrpt::img::TColor

white(...) from builtins.PyCapsule
white() -> mrpt.pymrpt.mrpt.img.TColor C++: mrpt::img::TColor::white() --> struct mrpt::img::TColor

Data descriptors defined here:

A

B

G

R

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class TColorf(pybind11_builtins.pybind11_object)

    An RGBA color - floats in the range [0,1]

Method resolution order:

TColorf

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__init__(...)
__init__(*args, **kwargs) Overloaded function. 1. __init__(self: mrpt.pymrpt.mrpt.img.TColorf) -> None 2. __init__(self: mrpt.pymrpt.mrpt.img.TColorf, r: float, g: float, b: float) -> None doc 3. __init__(self: mrpt.pymrpt.mrpt.img.TColorf, r: float, g: float, b: float, alpha: float) -> None 4. __init__(self: mrpt.pymrpt.mrpt.img.TColorf, col: mrpt.pymrpt.mrpt.img.TColor) -> None 5. __init__(self: mrpt.pymrpt.mrpt.img.TColorf, arg0: mrpt.pymrpt.mrpt.img.TColorf) -> None

__str__(...)
__str__(self: mrpt.pymrpt.mrpt.img.TColorf) -> str

asTColor(...)
asTColor(self: mrpt.pymrpt.mrpt.img.TColorf) -> mrpt.pymrpt.mrpt.img.TColor Returns the 0-255 integer version of this color: RGBA_u8   C++: mrpt::img::TColorf::asTColor() const --> struct mrpt::img::TColor

assign(...)
assign(self: mrpt.pymrpt.mrpt.img.TColorf, : mrpt.pymrpt.mrpt.img.TColorf) -> mrpt.pymrpt.mrpt.img.TColorf C++: mrpt::img::TColorf::operator=(const struct mrpt::img::TColorf &) --> struct mrpt::img::TColorf &

Data descriptors defined here:

A

B

G

R

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class TColormap(pybind11_builtins.pybind11_object)


Method resolution order:

TColormap

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__and__(...)
__and__(self: object, other: object) -> object

__eq__(...)
__eq__(self: object, other: object) -> bool

__ge__(...)
__ge__(self: object, other: object) -> bool

__getstate__(...)
__getstate__(self: object) -> int

__gt__(...)
__gt__(self: object, other: object) -> bool

__hash__(...)
__hash__(self: object) -> int

__index__(...)
__index__(self: mrpt.pymrpt.mrpt.img.TColormap) -> int

__init__(...)
__init__(self: mrpt.pymrpt.mrpt.img.TColormap, value: int) -> None

__int__(...)
__int__(self: mrpt.pymrpt.mrpt.img.TColormap) -> int

__invert__(...)
__invert__(self: object) -> object

__le__(...)
__le__(self: object, other: object) -> bool

__lt__(...)
__lt__(self: object, other: object) -> bool

__ne__(...)
__ne__(self: object, other: object) -> bool

__or__(...)
__or__(self: object, other: object) -> object

__rand__(...)
__rand__(self: object, other: object) -> object

__repr__(...)
__repr__(self: object) -> str

__ror__(...)
__ror__(self: object, other: object) -> object

__rxor__(...)
__rxor__(self: object, other: object) -> object

__setstate__(...)
__setstate__(self: mrpt.pymrpt.mrpt.img.TColormap, state: int) -> None

__str__ = name(...)
name(self: handle) -> str

__xor__(...)
__xor__(self: object, other: object) -> object

Readonly properties defined here:

__members__

name

name(self: handle) -> str

value

Data and other attributes defined here:

cmGRAYSCALE = <TColormap.cmGRAYSCALE: 0>

cmHOT = <TColormap.cmHOT: 2>

cmJET = <TColormap.cmJET: 1>

cmNONE = <TColormap.cmNONE: -1>

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class TImageChannels(pybind11_builtins.pybind11_object)


Method resolution order:

TImageChannels

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__and__(...)
__and__(self: object, other: object) -> object

__eq__(...)
__eq__(self: object, other: object) -> bool

__ge__(...)
__ge__(self: object, other: object) -> bool

__getstate__(...)
__getstate__(self: object) -> int

__gt__(...)
__gt__(self: object, other: object) -> bool

__hash__(...)
__hash__(self: object) -> int

__index__(...)
__index__(self: mrpt.pymrpt.mrpt.img.TImageChannels) -> int

__init__(...)
__init__(self: mrpt.pymrpt.mrpt.img.TImageChannels, value: int) -> None

__int__(...)
__int__(self: mrpt.pymrpt.mrpt.img.TImageChannels) -> int

__invert__(...)
__invert__(self: object) -> object

__le__(...)
__le__(self: object, other: object) -> bool

__lt__(...)
__lt__(self: object, other: object) -> bool

__ne__(...)
__ne__(self: object, other: object) -> bool

__or__(...)
__or__(self: object, other: object) -> object

__rand__(...)
__rand__(self: object, other: object) -> object

__repr__(...)
__repr__(self: object) -> str

__ror__(...)
__ror__(self: object, other: object) -> object

__rxor__(...)
__rxor__(self: object, other: object) -> object

__setstate__(...)
__setstate__(self: mrpt.pymrpt.mrpt.img.TImageChannels, state: int) -> None

__str__ = name(...)
name(self: handle) -> str

__xor__(...)
__xor__(self: object, other: object) -> object

Readonly properties defined here:

__members__

name

name(self: handle) -> str

value

Data and other attributes defined here:

CH_GRAY = <TImageChannels.CH_GRAY: 1>

CH_RGB = <TImageChannels.CH_RGB: 3>

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class TInterpolationMethod(pybind11_builtins.pybind11_object)


Method resolution order:

TInterpolationMethod

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__and__(...)
__and__(self: object, other: object) -> object

__eq__(...)
__eq__(self: object, other: object) -> bool

__ge__(...)
__ge__(self: object, other: object) -> bool

__getstate__(...)
__getstate__(self: object) -> int

__gt__(...)
__gt__(self: object, other: object) -> bool

__hash__(...)
__hash__(self: object) -> int

__index__(...)
__index__(self: mrpt.pymrpt.mrpt.img.TInterpolationMethod) -> int

__init__(...)
__init__(self: mrpt.pymrpt.mrpt.img.TInterpolationMethod, value: int) -> None

__int__(...)
__int__(self: mrpt.pymrpt.mrpt.img.TInterpolationMethod) -> int

__invert__(...)
__invert__(self: object) -> object

__le__(...)
__le__(self: object, other: object) -> bool

__lt__(...)
__lt__(self: object, other: object) -> bool

__ne__(...)
__ne__(self: object, other: object) -> bool

__or__(...)
__or__(self: object, other: object) -> object

__rand__(...)
__rand__(self: object, other: object) -> object

__repr__(...)
__repr__(self: object) -> str

__ror__(...)
__ror__(self: object, other: object) -> object

__rxor__(...)
__rxor__(self: object, other: object) -> object

__setstate__(...)
__setstate__(self: mrpt.pymrpt.mrpt.img.TInterpolationMethod, state: int) -> None

__str__ = name(...)
name(self: handle) -> str

__xor__(...)
__xor__(self: object, other: object) -> object

Readonly properties defined here:

__members__

name

name(self: handle) -> str

value

Data and other attributes defined here:

IMG_INTERP_AREA = <TInterpolationMethod.IMG_INTERP_AREA: 3>

IMG_INTERP_CUBIC = <TInterpolationMethod.IMG_INTERP_CUBIC: 2>

IMG_INTERP_LINEAR = <TInterpolationMethod.IMG_INTERP_LINEAR: 1>

IMG_INTERP_NN = <TInterpolationMethod.IMG_INTERP_NN: 0>

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class TPixelCoord(pybind11_builtins.pybind11_object)

    A pair (x,y) of pixel coordinates (integer resolution).

Method resolution order:

TPixelCoord

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__eq__(...)
__eq__(self: mrpt.pymrpt.mrpt.img.TPixelCoord, o: mrpt.pymrpt.mrpt.img.TPixelCoord) -> bool C++: mrpt::img::TPixelCoord::operator==(const struct mrpt::img::TPixelCoord &) --> bool

__init__(...)
__init__(*args, **kwargs) Overloaded function. 1. __init__(self: mrpt.pymrpt.mrpt.img.TPixelCoord) -> None 2. __init__(self: mrpt.pymrpt.mrpt.img.TPixelCoord, _x: int, _y: int) -> None 3. __init__(self: mrpt.pymrpt.mrpt.img.TPixelCoord, arg0: mrpt.pymrpt.mrpt.img.TPixelCoord) -> None

__str__(...)
__str__(self: mrpt.pymrpt.mrpt.img.TPixelCoord) -> str

assign(...)
assign(self: mrpt.pymrpt.mrpt.img.TPixelCoord, : mrpt.pymrpt.mrpt.img.TPixelCoord) -> mrpt.pymrpt.mrpt.img.TPixelCoord C++: mrpt::img::TPixelCoord::operator=(const struct mrpt::img::TPixelCoord &) --> struct mrpt::img::TPixelCoord &

Data descriptors defined here:

x

y

Data and other attributes defined here:

__hash__ = None

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class TPixelCoordf(pybind11_builtins.pybind11_object)

    A pair (x,y) of pixel coordinates (subpixel resolution). mrpt_img_grp

Method resolution order:

TPixelCoordf

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__init__(...)
__init__(*args, **kwargs) Overloaded function. 1. __init__(self: mrpt.pymrpt.mrpt.img.TPixelCoordf) -> None 2. __init__(self: mrpt.pymrpt.mrpt.img.TPixelCoordf, _x: float, _y: float) -> None 3. __init__(self: mrpt.pymrpt.mrpt.img.TPixelCoordf, arg0: mrpt.pymrpt.mrpt.img.TPixelCoordf) -> None

__str__(...)
__str__(self: mrpt.pymrpt.mrpt.img.TPixelCoordf) -> str

assign(...)
assign(self: mrpt.pymrpt.mrpt.img.TPixelCoordf, : mrpt.pymrpt.mrpt.img.TPixelCoordf) -> mrpt.pymrpt.mrpt.img.TPixelCoordf C++: mrpt::img::TPixelCoordf::operator=(const struct mrpt::img::TPixelCoordf &) --> struct mrpt::img::TPixelCoordf &

Data descriptors defined here:

x

y

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class TStereoCamera(mrpt.pymrpt.mrpt.serialization.CSerializable)

    Structure to hold the parameters of a pinhole stereo camera model. The parameters obtained for one camera resolution can be used for any other resolution by means of the method TStereoCamera::scaleToResolution() mrpt::vision, the application stereo-calib-gui for calibrating a stereo camera

Method resolution order:

TStereoCamera

mrpt.pymrpt.mrpt.serialization.CSerializable

mrpt.pymrpt.mrpt.rtti.CObject

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

GetRuntimeClass(...)
GetRuntimeClass(self: mrpt.pymrpt.mrpt.img.TStereoCamera) -> mrpt.pymrpt.mrpt.rtti.TRuntimeClassId C++: mrpt::img::TStereoCamera::GetRuntimeClass() const --> const struct mrpt::rtti::TRuntimeClassId *

__init__(...)
__init__(*args, **kwargs) Overloaded function. 1. __init__(self: mrpt.pymrpt.mrpt.img.TStereoCamera, arg0: mrpt.pymrpt.mrpt.img.TStereoCamera) -> None 2. __init__(self: mrpt.pymrpt.mrpt.img.TStereoCamera, arg0: mrpt.pymrpt.mrpt.img.TStereoCamera) -> None 3. __init__(self: mrpt.pymrpt.mrpt.img.TStereoCamera) -> None

assign(...)
assign(self: mrpt.pymrpt.mrpt.img.TStereoCamera, : mrpt.pymrpt.mrpt.img.TStereoCamera) -> mrpt.pymrpt.mrpt.img.TStereoCamera C++: mrpt::img::TStereoCamera::operator=(const class mrpt::img::TStereoCamera &) --> class mrpt::img::TStereoCamera &

clone(...)
clone(self: mrpt.pymrpt.mrpt.img.TStereoCamera) -> mrpt.pymrpt.mrpt.rtti.CObject C++: mrpt::img::TStereoCamera::clone() const --> class mrpt::rtti::CObject *

dumpAsText(...)
dumpAsText(self: mrpt.pymrpt.mrpt.img.TStereoCamera) -> str Dumps all the parameters as a multi-line string, with the same format than    saveToConfigFile C++: mrpt::img::TStereoCamera::dumpAsText() const --> std::string

loadFromConfigFile(...)
loadFromConfigFile(*args, **kwargs) Overloaded function. 1. loadFromConfigFile(self: mrpt.pymrpt.mrpt.img.TStereoCamera, section: str, cfg: mrpt.pymrpt.mrpt.config.CConfigFileBase) -> None Load all the params from a config source, in the same format that used in saveToConfigFile().    Notice that 3 different sections are read, of which "section" is only the prefix.    std::exception on missing fields C++: mrpt::img::TStereoCamera::loadFromConfigFile(const std::string &, const class mrpt::config::CConfigFileBase &) --> void 2. loadFromConfigFile(self: mrpt.pymrpt.mrpt.img.TStereoCamera, cfg: mrpt.pymrpt.mrpt.config.CConfigFileBase, section: str) -> None overload This signature is consistent with the rest of MRPT APIs C++: mrpt::img::TStereoCamera::loadFromConfigFile(const class mrpt::config::CConfigFileBase &, const std::string &) --> void

saveToConfigFile(...)
saveToConfigFile(self: mrpt.pymrpt.mrpt.img.TStereoCamera, section: str, cfg: mrpt.pymrpt.mrpt.config.CConfigFileBase) -> None Save all params to a plain text config file in this format:       Notice that 3 different sections are read, of which "section" is only the prefix. C++: mrpt::img::TStereoCamera::saveToConfigFile(const std::string &, class mrpt::config::CConfigFileBase &) const --> void

scaleToResolution(...)
scaleToResolution(self: mrpt.pymrpt.mrpt.img.TStereoCamera, new_ncols: int, new_nrows: int) -> None Rescale all the parameters for a new camera resolution (it raises an exception if the aspect ratio is modified, which is not permitted). C++: mrpt::img::TStereoCamera::scaleToResolution(unsigned int, unsigned int) --> void

Static methods defined here:

CreateObject(...) from builtins.PyCapsule
CreateObject() -> mrpt.pymrpt.mrpt.rtti.CObject C++: mrpt::img::TStereoCamera::CreateObject() --> class std::shared_ptr<class mrpt::rtti::CObject>

GetRuntimeClassIdStatic(...) from builtins.PyCapsule
GetRuntimeClassIdStatic() -> mrpt.pymrpt.mrpt.rtti.TRuntimeClassId C++: mrpt::img::TStereoCamera::GetRuntimeClassIdStatic() --> const struct mrpt::rtti::TRuntimeClassId &

Data descriptors defined here:

leftCamera

rightCamera

rightCameraPose

Methods inherited from mrpt.pymrpt.mrpt.rtti.CObject:

duplicateGetSmartPtr(...)
duplicateGetSmartPtr(self: mrpt.pymrpt.mrpt.rtti.CObject) -> mrpt.pymrpt.mrpt.rtti.CObject Makes a deep copy of the object and returns a smart pointer to it C++: mrpt::rtti::CObject::duplicateGetSmartPtr() const --> class std::shared_ptr<class mrpt::rtti::CObject>

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class copy_type_t(pybind11_builtins.pybind11_object)


Method resolution order:

copy_type_t

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__and__(...)
__and__(self: object, other: object) -> object

__eq__(...)
__eq__(self: object, other: object) -> bool

__ge__(...)
__ge__(self: object, other: object) -> bool

__getstate__(...)
__getstate__(self: object) -> int

__gt__(...)
__gt__(self: object, other: object) -> bool

__hash__(...)
__hash__(self: object) -> int

__index__(...)
__index__(self: mrpt.pymrpt.mrpt.img.copy_type_t) -> int

__init__(...)
__init__(self: mrpt.pymrpt.mrpt.img.copy_type_t, value: int) -> None

__int__(...)
__int__(self: mrpt.pymrpt.mrpt.img.copy_type_t) -> int

__invert__(...)
__invert__(self: object) -> object

__le__(...)
__le__(self: object, other: object) -> bool

__lt__(...)
__lt__(self: object, other: object) -> bool

__ne__(...)
__ne__(self: object, other: object) -> bool

__or__(...)
__or__(self: object, other: object) -> object

__rand__(...)
__rand__(self: object, other: object) -> object

__repr__(...)
__repr__(self: object) -> str

__ror__(...)
__ror__(self: object, other: object) -> object

__rxor__(...)
__rxor__(self: object, other: object) -> object

__setstate__(...)
__setstate__(self: mrpt.pymrpt.mrpt.img.copy_type_t, state: int) -> None

__str__ = name(...)
name(self: handle) -> str

__xor__(...)
__xor__(self: object, other: object) -> object

Readonly properties defined here:

__members__

name

name(self: handle) -> str

value

Data and other attributes defined here:

DEEP_COPY = <copy_type_t.DEEP_COPY: 1>

SHALLOW_COPY = <copy_type_t.SHALLOW_COPY: 0>

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

class ctor_CImage_ref_or_gray(pybind11_builtins.pybind11_object)


Method resolution order:

ctor_CImage_ref_or_gray

pybind11_builtins.pybind11_object

builtins.object

Methods defined here:

__and__(...)
__and__(self: object, other: object) -> object

__eq__(...)
__eq__(self: object, other: object) -> bool

__ge__(...)
__ge__(self: object, other: object) -> bool

__getstate__(...)
__getstate__(self: object) -> int

__gt__(...)
__gt__(self: object, other: object) -> bool

__hash__(...)
__hash__(self: object) -> int

__index__(...)
__index__(self: mrpt.pymrpt.mrpt.img.ctor_CImage_ref_or_gray) -> int

__init__(...)
__init__(self: mrpt.pymrpt.mrpt.img.ctor_CImage_ref_or_gray, value: int) -> None

__int__(...)
__int__(self: mrpt.pymrpt.mrpt.img.ctor_CImage_ref_or_gray) -> int

__invert__(...)
__invert__(self: object) -> object

__le__(...)
__le__(self: object, other: object) -> bool

__lt__(...)
__lt__(self: object, other: object) -> bool

__ne__(...)
__ne__(self: object, other: object) -> bool

__or__(...)
__or__(self: object, other: object) -> object

__rand__(...)
__rand__(self: object, other: object) -> object

__repr__(...)
__repr__(self: object) -> str

__ror__(...)
__ror__(self: object, other: object) -> object

__rxor__(...)
__rxor__(self: object, other: object) -> object

__setstate__(...)
__setstate__(self: mrpt.pymrpt.mrpt.img.ctor_CImage_ref_or_gray, state: int) -> None

__str__ = name(...)
name(self: handle) -> str

__xor__(...)
__xor__(self: object, other: object) -> object

Readonly properties defined here:

__members__

name

name(self: handle) -> str

value

Data and other attributes defined here:

FAST_REF_OR_CONVERT_TO_GRAY = <ctor_CImage_ref_or_gray.FAST_REF_OR_CONVERT_TO_GRAY: 1>

Static methods inherited from pybind11_builtins.pybind11_object:

__new__(*args, **kwargs) from pybind11_builtins.pybind11_type
Create and return a new object.  See help(type) for accurate signature.

Functions


colormap(...) method of builtins.PyCapsule instance
colormap(*args, **kwargs) Overloaded function. 1. colormap(color_map: mrpt.pymrpt.mrpt.img.TColormap, color_index: float, r: float, g: float, b: float) -> None Transform a float number in the range [0,1] into RGB components. Different colormaps are available. C++: mrpt::img::colormap(const enum mrpt::img::TColormap &, const float, float &, float &, float &) --> void 2. colormap(color_map: mrpt.pymrpt.mrpt.img.TColormap, color_index: float) -> mrpt.pymrpt.mrpt.img.TColor C++: mrpt::img::colormap(const enum mrpt::img::TColormap &, const float) --> struct mrpt::img::TColor

hot2rgb(...) method of builtins.PyCapsule instance
hot2rgb(color_index: float, r: float, g: float, b: float) -> None Computes the RGB color components (range [0,1]) for the corresponding color index in the range [0,1] using the MATLAB 'hot' colormap.   colormap   C++: mrpt::img::hot2rgb(const float, float &, float &, float &) --> void

hsv2rgb(...) method of builtins.PyCapsule instance
hsv2rgb(h: float, s: float, v: float, r: float, g: float, b: float) -> None Transform HSV color components to RGB, all of them in the range [0,1]   rgb2hsv C++: mrpt::img::hsv2rgb(float, float, float, float &, float &, float &) --> void

jet2rgb(...) method of builtins.PyCapsule instance
jet2rgb(color_index: float, r: float, g: float, b: float) -> None Computes the RGB color components (range [0,1]) for the corresponding color index in the range [0,1] using the MATLAB 'jet' colormap.   colormap   C++: mrpt::img::jet2rgb(const float, float &, float &, float &) --> void

rgb2hsv(...) method of builtins.PyCapsule instance
rgb2hsv(r: float, g: float, b: float, h: float, s: float, v: float) -> None Transform RGB color components to HSV, all of them in the range [0,1] hsv2rgb C++: mrpt::img::rgb2hsv(float, float, float, float &, float &, float &) --> void

Data

CH_GRAY = <TImageChannels.CH_GRAY: 1>
CH_RGB = <TImageChannels.CH_RGB: 3>
DEEP_COPY = <copy_type_t.DEEP_COPY: 1>
FAST_REF_OR_CONVERT_TO_GRAY = <ctor_CImage_ref_or_gray.FAST_REF_OR_CONVERT_TO_GRAY: 1>
IMG_INTERP_AREA = <TInterpolationMethod.IMG_INTERP_AREA: 3>
IMG_INTERP_CUBIC = <TInterpolationMethod.IMG_INTERP_CUBIC: 2>
IMG_INTERP_LINEAR = <TInterpolationMethod.IMG_INTERP_LINEAR: 1>
IMG_INTERP_NN = <TInterpolationMethod.IMG_INTERP_NN: 0>
SHALLOW_COPY = <copy_type_t.SHALLOW_COPY: 0>
cmGRAYSCALE = <TColormap.cmGRAYSCALE: 0>
cmHOT = <TColormap.cmHOT: 2>
cmJET = <TColormap.cmJET: 1>
cmNONE = <TColormap.cmNONE: -1>

Data
		CH_GRAY = <TImageChannels.CH_GRAY: 1> CH_RGB = <TImageChannels.CH_RGB: 3> DEEP_COPY = <copy_type_t.DEEP_COPY: 1> FAST_REF_OR_CONVERT_TO_GRAY = <ctor_CImage_ref_or_gray.FAST_REF_OR_CONVERT_TO_GRAY: 1> IMG_INTERP_AREA = <TInterpolationMethod.IMG_INTERP_AREA: 3> IMG_INTERP_CUBIC = <TInterpolationMethod.IMG_INTERP_CUBIC: 2> IMG_INTERP_LINEAR = <TInterpolationMethod.IMG_INTERP_LINEAR: 1> IMG_INTERP_NN = <TInterpolationMethod.IMG_INTERP_NN: 0> SHALLOW_COPY = <copy_type_t.SHALLOW_COPY: 0> cmGRAYSCALE = <TColormap.cmGRAYSCALE: 0> cmHOT = <TColormap.cmHOT: 2> cmJET = <TColormap.cmJET: 1> cmNONE = <TColormap.cmNONE: -1>