Image package: Difference between revisions

From Octave
Jump to navigation Jump to search
(→‎Development: add a roadmap (targets that I want for the next image release))
(→‎Open Bugs: cleanup)
 
(209 intermediate revisions by 12 users not shown)
Line 1: Line 1:
The {{Forge|image|image package}} is part of the octave-forge project.
The {{Forge|image|image package}} is part of the Octave Forge project. See its {{Forge|image|homepage}} for the latest release.
 
<div class="tocinline">__TOC__</div>


== Development ==
== Development ==


Follows an incomplete list of stuff missing in the image package to be matlab compatible. Bugs are not listed here, [https://savannah.gnu.org/bugs/?func=search&group=octave search] and [https://savannah.gnu.org/bugs/?func=additem&group=octave report] them on the bug tracker instead.
Follows an incomplete list of stuff missing in the image package to be matlab compatible. Bugs are not listed here, [https://savannah.gnu.org/bugs/?func=search&group=octave search] and [https://savannah.gnu.org/bugs/?func=additem&group=octave report] them on the bug tracker instead.
=== Roadmap ===
The following are missing targets for the next minor release of the image package (version 2.4.0).  Small bug fixes, build fixes, and regressions may still be released before in a patch release (next would be version 2.2.3).
* add ellipse properties to {{codeline|regionprops}} (see bug {{bug|44100}})
* speed up {{codeline|regionprops}} for large images with many small objects (probably work around for loop with {{codeline|labeled == labelid}}
* support passing {{codeline|bwconncomp}} output to {{codeline|regionprops}} (and then fix {{codeline|bwpropfilt}} to use that instead of a labeled image)
* ND support on {{codeline|imfilter}}
* check if {{codeline|normxcorr2}} is Matlab compatible and investigate making use of {{codeline|fftconvn}} since it's likely to receive large input
* investigate implementing the missing deconvolution functions (see patch {{patch|8571}}
* fix imadjust for other image types (only works for double on the [0 1] range at the moment)
* anything else that is done or submitted before the above are done


=== Missing functions ===
=== Missing functions ===
Line 24: Line 13:
* activecontour
* activecontour
* adapthisteq
* adapthisteq
* affine2d
* affine3d
* applycform
* applycform
* axes2pix
* bwconvhull
* bwconvhull
* bwdistgeodesic
* bwdistgeodesic
* bwlookup
* bwlookup
* bwpack
* bwtraceboundary
* bwtraceboundary
* bwulterode
* bwulterode
* bwunpack
* chromadapt
* colorcloud
* convmtx2
* convmtx2
* corner
* corner
Line 46: Line 32:
* deconvlucy
* deconvlucy
* deconvreg
* deconvreg
* deconvwnr
* decorrstretch
* decorrstretch
* demosaic
* [https://savannah.gnu.org/patch/?9593 demosaic]
* dicomanon
* dicomanon
* dicomdisp
* dicomuid
* dicomuid
* edgetaper
* dpxinfo
* dpxread
* fan2para
* fan2para
* fanbeam
* fanbeam
Line 60: Line 47:
* fwind1
* fwind1
* fwind2
* fwind2
* gabor
* getimage
* getimage
* getimagemodel
* getimagemodel
Line 66: Line 54:
* getrect
* getrect
* gradientweight
* gradientweight
* grayconnected
* graycoprops
* graycoprops
* graydiffweight
* graydiffweight
* hdrread
* hdrread
* hdrwrite
* hdrwrite
* hough -- (see hough_circle)
* houghlines -- (see hough_line)
* houghpeaks
* iccfind
* iccfind
* iccread
* iccread
Line 79: Line 65:
* idct2
* idct2
* ifanbeam
* ifanbeam
* illumgray
* illumpca
* illumwhite
* im2java2d
* im2java2d
* ImageAdapter
* ImageAdapter
* imageinfo
* imageinfo
* imapplymatrix
* imapprox
* imapprox
* imbinarize
* imboxfilt
* imboxfilt3
* imcolormaptool
* imcolormaptool
* imcontour
* imcontour
Line 90: Line 81:
* imdistline
* imdistline
* imellipse
* imellipse
* imextendedmax
* imextendedmin
* imfill -- (see bwfill)
* imfindcircles
* imfreehand
* imfreehand
* imfuse
* imgaborfilt
* imgaussfilt
* imgaussfilt3
* imgca
* imgca
* imgcf
* imgcf
* imgetfile
* imguidedfilter
* imguidedfilter
* imhandles
* imhandles
* imhistmatch
* imhistmatch
* imhmax
* imhmin
* imimposemin
* imline
* imline
* immagbox
* immagbox
Line 110: Line 95:
* imoverview
* imoverview
* imoverviewpanel
* imoverviewpanel
* impixelinfo
* [https://savannah.gnu.org/patch/?8722 impixelinfo]
* impixelinfoval
* [https://savannah.gnu.org/patch/?8722 impixelinfoval]
* impixelregion
* impixelregionpanel
* impixelregionpanel
* impixelregion
* immse
* implay
* implay
* impoint
* impoint
* impoly
* impoly
* improfile
* improfile
* impyramid
* imquantize
* imrect
* imrect
* imref2d
* imreducehaze
* imref3d
* imregconfig
* imregconfig
* imregcorr
* imregcorr
Line 132: Line 113:
* imscrollpanel
* imscrollpanel
* imsegfmm
* imsegfmm
* imsharpen
* imseggeodesic
* imshowpair
* imtool
* imtool
* imwarp
* imwarp
* integralBoxFilter
* integralBoxFilter3
* interfileinfo
* interfileinfo
* interfileread
* interfileread
Line 152: Line 134:
* isicc
* isicc
* isrset
* isrset
* lab2double
* [https://savannah.gnu.org/patch/?9600 lin2rgb]
* lab2rgb
* lab2uint16
* lab2uint8
* lab2xyz
* makecform
* makecform
* makeConstrainToRectFcn
* makeConstrainToRectFcn
* makehdr
* makehdr
* makeresampler
* makeresampler
* multithresh
* [https://savannah.gnu.org/patch/?9602 multithresh]
* nitfinfo
* nitfinfo
* nitfread
* nitfread
Line 167: Line 145:
* para2fan
* para2fan
* projective2d
* projective2d
* regionfill
* rgb2lin
* roifill
* roifill
* rgb2lab
* rgb2xyz
* roifilt2
* roifilt2
* roipoly
* [https://savannah.gnu.org/patch/?9509 roipoly]
* rsetwrite
* rsetwrite
* ssim
* ssim
Line 177: Line 155:
* tonemap
* tonemap
* truesize
* truesize
* viscircles
* visboundaries
* warp
* warp
* watershed
* [https://savannah.gnu.org/patch/?8060 whitepoint]
* whitepoint
* [https://savannah.gnu.org/patch/?9603 xyz2double]
* wiener2
* [https://savannah.gnu.org/patch/?9603 xyz2uint16]
* xyz2double
* xyz2lab
* xyz2rgb
* xyz2uint16
</div>
</div>


Line 206: Line 180:
* imcrop
* imcrop
** messing around with alternative coordinate systems (XData and YData) are not yet implemented.
** messing around with alternative coordinate systems (XData and YData) are not yet implemented.
* imwrap
** no supports for SmoothEdges option
* hough
** no RhoResolution option


=== Contributing ===
=== Contributing ===
* It'd help to group the missing functions above, as per [http://www.mathworks.com/help/images/functionlist.html] (similar to what was done in the [[signal package]] wiki page); please keep the original alphabetical list intact.
* It'd help to group the missing functions above, as per [http://www.mathworks.com/help/images/functionlist.html] (similar to what was done in the [[signal package]] wiki page); please keep the original alphabetical list intact.


[[Category:Octave-Forge]]
=== Open Bugs ===
 
{| class="wikitable"
|-
! bug !! bug title !! status
|-
| {{bug|38087}}|| image package: graycomatrix incompatibilities with matlab  || None
|-
| {{bug|43218}}|| image package: imshear causes more signal spread than expected and inconsistent vertical offset || None
|-
| {{bug|44396}}|| image package: bwmorph shrink does not preserve Euler number || Confirmed
|-
| {{bug|44831}}|| image package: imrotate - different dimensions of output matrix || Confirmed
|-
| {{bug|45088}}|| image package: rangefilt requires domain and image to have equal number of dimensions || In Progress
|-
| {{bug|48529}}|| image package: compilation warnings under Mac OSX|| None
|-
| {{bug|49452}}|| [Octave forge] (image) missing MATLAB function corner and undistortImage|| Confirmed
|-
| {{bug|50151}}|| image package: normxcorr2 is not compatible with Matlab|| None
|-
| {{bug|50188}}|| image package: poly2mask does incompatible rounding|| None
|-
| {{bug|50257}}|| image package: imtranslate is not Matlab compatible|| Confirmed
|-
| {{bug|50341}}|| Missing Function imrect in image package|| None
|-
| {{bug|50429}}|| image package: xyz2lab changed slightly in Matlab (and other color conversion functions)|| None
|-
| {{bug|50554}}|| [octave forge] (image) cp2tform missing 'piecewise linear' and 'lwm' support|| None
|-
| {{bug|50656}}|| image package: bwerode does not return right size when there's more dimensions on conn || None
|-
| {{bug|50708}}|| image package: add demosaic.m || Patch Submitted
|-
| {{bug|50732}} || Image package: infinite error loop when assigning a strel (class) object to a vector|| Confirmed
|-
| {{bug|51420}} || [octave forge] (image) imrotate is less tolerant to missing argument than Matlab || None
|-
| {{bug|51719}} || [octave forge] (image) watershed unit test failure || None
|-
| {{bug|51884}} || [octave forge] (image) bwmorph(blackNwhiteMatrix, "thicken", 1) returns negated result (+ strange behavior at border) || None
|-
| {{bug|51979}} || [octave forge] (image) Failing unit test for impyramid || None
|-
| {{bug|51980}} || [octave forge] (image) Failing unit test for edge|| None
|-
| {{bug|52006}} || [octave forge] (image) 'makecform' feature request || Confirmed
|-
| {{bug|52119}} || [octave forge] (image) Add 'reflect' padding option to imfilter || None
|-
| {{bug|52715}} || [octave forge] (image) Add full data range option to ycbcrfunc conversions || None
|-
| {{bug|52959}} || [octave forge] (image) histeq is not compatible with Matlab || None
|-
| {{bug|55059}} || [octave forge] (image) Failing unit test for grayslice || In Progress
|-
| {{bug|55438}} ||  [octave forge] (image) Binary input image for edge || None
|-
| {{bug|55521}} || [octave forge] (image) Unit tests for bwpack and bwunpack fail on big endian architectures|| None
|-
| {{bug|56958}} || [Octave-Forge] (image) Implementation of insertText  || Confirmed
|-
| {{bug|57822}} || [octave forge] (image) test failures on macOS - imadjust, immse, mean2 || In progress
|-
| {{bug|58684}} || [octave forge] (image) imtranslate produces nonsense for fractional shifts || Confirmed
|-
| {{bug|59773}} || [octave forge] (image) iradon is not Matlab compatible when using filter || None
|-
| {{bug|62099}} || [octave forge] (image) imresize - lanczos* is not implemented || None
|-
| {{bug|62452}} || [octave forge] (image) bwmorph spur produces wrong result || None
|-
|}
 
=== Patches ===
 
* {{patch|8059}}: [new function for image package] ranktf.m
* {{patch|8060}}: [image package new function] whitepoint.m
* {{patch|8722}}: implement impixelinfo and impixelinfoval
* {{patch|8813}}: image package: Extended image I/O for Analyze 7.5 format to handle big-endian images
* {{patch|8571}}: image package: three deconvolution routines (Wiener, RL, RLTV)
* {{patch|9509}}: Image package: simple implementation of roipoly function
* {{patch|9593}}: [Octave Forge] (Image) New function demosaic.m from bug #50708
* {{patch|9600}}: [Octave Forge] (Image) New functions: lin2rgb.m and lrgb2lin.m
* {{patch|9602}}: [octave forge] (image) multithresh
* {{patch|9603}}: [Octave Forge] (Image) New functions: xyz2double.m, xyz2single.m, xyz2uint16.m
* {{patch|9729}}: [octave forge] (image) -- rgb2xyz conversion with adapted whitepoint
* {{patch|9853}}: [octave forge] (image) implement niftiread, niftiwrite, niftiinfo
* {{patch|9957}}: Nonlinear filter for image package (colfilt2)
 
== Image Processing Functions ==
 
{{Note| This section is still under construction so the list is incomplete.}}
 
This is a list of Image Processing functions by topic including: missing functions, related bugs and patches, and some alternatives.
 
Note: 
 
=== Basic Read and Write Image Files ===
 
{| class="wikitable" style="text-align: center"
|-
! Function !! Octave Package Version !! Related Bugs and Patches !! Alternatives !! Notes
|-
| imfinfo || function is in Octave core || || ||
|-
| imread|| function is in Octave core || || [http://kyamagu.github.io/mexopencv/matlab/imread.html cv.imread] from [https://github.com/kyamagu/mexopencv mexopencv] ||
in case of color image, the color order of Octave is RGB/RGBA while OpenCV color order is BGR/BGRA
|-
| imwrite|| function is in Octave core || || [http://kyamagu.github.io/mexopencv/matlab/imread.html cv.imwrite] from [https://github.com/kyamagu/mexopencv mexopencv] ||
in case of color image, the color order of Octave is RGB/RGBA while OpenCV color order is BGR/BGRA
|-
|}
 
'''Missing:''' ''dicomanon, dicomdisp, dicomuid, dpxinfo, dpxread, interfileinfo, interfileread, nitfinfo, nitfread
''
 
=== High Dynamic Range Images - ''Not implemented'' ===
 
=== Large Image Files - ''Not implemented'' ===
 
=== Type Conversion  ===
 
{| class="wikitable" style="text-align: center"
|-
! Function !! Octave Package Version !! Related Bugs and Patches !! Alternatives || Notes
|-
| adaptthresh || - || ||  [http://kyamagu.github.io/mexopencv/matlab/adaptiveThreshold.html cv.adaptiveThreshold] from [https://github.com/kyamagu/mexopencv mexopencv]||
|-
| demosaic || - || {{bug|50708}} {{patch|9593}}|| [http://kyamagu.github.io/mexopencv/matlab/demosaicing.html cv.demosaicing] from [https://github.com/kyamagu/mexopencv mexopencv] ||
|-
| gray2ind || function is in Octave core || || ||
|-
| grayslice || < 1.0.0 || ||  ||
|-
| graythresh || 1.0.0 || || || Octave version has more methods
|-
| im2double || 1.0.0 || || ||
|-
| im2int16  || 2.0.0 || || ||
|-
| im2java2d ||  -    || || ||
|-
| im2single || 2.0.0 || || ||
|-
| im2uint16 || 1.0.0 || || ||
|-
| im2uint8  || 1.0.0 || || ||
|-
| imbinarize || - || || imbinarize (I) is equivalent to im2bw(I, graythresh(I)),
another option is [http://kyamagu.github.io/mexopencv/matlab/threshold.html cv.threshold]  from [https://github.com/kyamagu/mexopencv mexopencv]
||
|-
| imcast    || 2.4.0 || || || Octave Only
|-
| imquantize || 2.6.0 || ||  ||
|-
| ind2gray  ||  function is in Octave core || || ||
|-
| ind2rgb  || function is in Octave core || || ||
|-
| label2rgb || 1.0.0 || || ||
|-
| mat2gray || < 1.0.0 || || ||
|-
| multithresh || - || {{patch|9602}} || ||
|-
| otsuthresh || 2.10.0 ||  || ||
|-
| rgb2gray || function is in Octave core  || {{bug|53654}} || || Octave version 4.4.0 and above
|-
| rgb2ind  || function is in Octave core  || || ||
|-
|}
 
=== Color ===
 
{| class="wikitable" style="text-align: center"
|-
! Function !! Octave Package Version !! Related Bugs and Patches !! Alternatives || Notes
|-
| colorangle || 2.10.0 || || ||
|-
| lab2double || 2.6.0 || || ||
|-
| lab2rgb || 2.6.0 || || ||
|-
| lab2uint16 ||  2.6.0  || || ||
|-
| lab2uint8 ||  2.6.0  || || ||
|-
| lab2xyz ||  2.6.0  || || ||
|-
| lin2rgb || - || {{patch|9600}} || ||
|-
| ntsc2rgb || 2.8.0 || || ||
|-
| rgb2lab ||  2.6.0  || || ||
|-
| rgb2lin || - || {{patch|9600}} || ||
|-
| rgb2ntsc || 2.8.0 || || ||
|-
| rgb2xyz ||  2.6.0  || || ||
|-
| rgb2ycbcr ||  < 1.0.0|| || ||
|-
| whitepoint || - || {{patch|8060}} || ||
|-
| xyz2double || - || {{patch|9603}} || ||
|-
| xyz2lab ||  2.6.0  || || ||
|-
| xyz2rgb ||  2.6.0  || || ||
|-
| xyz2uint16 || - || {{patch|9603}} || ||
|-
| ycbcr2rgb ||  2.2.0|| || ||
|-
|}
 
'''Missing:''' ''applycform, chromadapt, colorcloud, iccfind, iccread, iccroot, iccwrite, illumgray, illumpca, illumwhite, imapprox, isicc, makecform''
 
=== Synthetic Images ===
 
{| class="wikitable" style="text-align: center"
|-
! Function !! Octave Package Version !! Related Bugs and Patches !! Alternatives || Notes
|-
| checkerboard ||  2.2.0 || || ||
|-
| imnoise ||  2.2.2  || || ||
|-
| phantom ||  2.6.2  || || ||
|-
|}
 
=== Basic Display ===
 
{| class="wikitable" style="text-align: center"
|-
! Function !! Octave Package Version !! Related Bugs and Patches !! Alternatives || Notes
|-
| imshow || function is in Octave core || || ||
|-
| montage || 2.2.0 || || ||
|-
| imfuse || 2.14.0 || || ||
|-
| imshowpair || 2.14.0 || || ||
|-
|}
 
'''Missing:''' '' immovie, implay, iptgetpref, iptprefs, iptsetpref, warp''
 
=== Geometric Transformations ===
 
{| class="wikitable" style="text-align: center"
|-
! Function !! Octave Package Version !! Related Bugs and Patches !! Alternatives || Notes
|-
| affine2d || 2.14.0 || || ||
|-
| affine3d || 2.14.0 || || ||
|-
| cp2tform || 2.2.0 || || ||
|-
| imcrop || 2.0.0 || || ||
|-
| impyramid || 2.6.0 || || ||
|-
| imref2d || 2.12.0 || || ||
|-
| imref3d || 2.12.0 || || ||
|-
| imrotate || <1.0.0 || || ||
|-
| imtranslate || <1.0.0 || || || incompatible to Matlab's imtranslate
|-
| maketform || 2.2.0 || || ||
|-
| tformfwd || 2.2.0 || || ||
|-
| tforminv || 2.2.0 || || ||
|-
 
|}
 
'''Missing:''' '' imwarp''
 
=== Image Filtering ===
 
{| class="wikitable" style="text-align: center"
|-
! Function !! Octave Package Version !! Related Bugs and Patches !! Alternatives || Notes
|-
| bwareafilt|| 2.4.0  || || ||
|-
| bwpropfilt || 2.4.0  || || ||
|-
| convmtx2 || -  || || ||
|-
| entropyfilt ||  1.0.9  ||  || ||
|-
| fibermetric ||-  || || ||
|-
| freqz2 ||  -|| || ||
|-
| fsamp2 || - || || ||
|-
| fspecial || 1.0.0  || || ||
|-
| ftrans2 ||  - || || ||
|-
| fwind1 || - || || ||
|-
| fwind2 || - || || ||
|-
| gabor || - || || ||
|-
| imboxfilt || - || || ||
|-
| imboxfilt3 || - || || ||
|-
| imfilter || 1.0.5  || || ||
|-
| imgaborfilt || -  || || ||
|-
| imgaussfilt || -  || || ||
|-
| imgaussfilt3 ||  - || || ||
|-
| imguidedfilter ||  - || || ||
|-
| imsmooth|| 1.0.5 || || || Octave only
|-
| integralBoxFilter ||  - || || ||
|-
| integralBoxFilter3 ||- || || ||
|-
| integralImage || 2.12.0 ||  ||  ||
|-
| integralImage3 ||  2.12.0  || || ||
|-
| medfilt2 || < 1.0.0  || || ||
|-
| medfilt3 || - || || ||
|-
| nlfilter || < 1.0.0 || || ||
|-
| normxcorr2 || 2.0.0 ||  {{bug|50151}} || ||
|-
| ordfilt2 || 1.0.9 ||  || ||
|-
| padarray || < 1.0.0 || || ||
|-
| rangefilt || 1.0.9 || {{bug|45088}} || ||
|-
| stdfilt ||  1.0.9 ||  || ||
|-
| wiener2 ||  2.8.0|| || ||
|-
|}
 
=== Image Arithmetic ===
 
{| class="wikitable" style="text-align: center"
|-
! Function !! Octave Package Version !! Related Bugs and Patches !! Alternatives || Notes
|-
| imabsdiff || 2.0.0  || || ||
|-
| imadd         || 2.0.0  || || ||
|-
| imapplymatrix || 2.14.0  || || ||
|-
| imcomplement || 1.0.6  || || ||
|-
| imdivide || 2.0.0  || || ||
|-
| imlincomb || 2.0.0  || || ||
|-
|  immultiply || 2.0.0  || || ||
|-
| imsubtract    || 2.0.0  || || ||
|-
|}
 
=== Morphological Operations ===
 
{| class="wikitable" style="text-align: center"
|-
! Function !! Octave Package Version !! Related Bugs and Patches !! Alternatives || Notes
|-
| applylut  ||  < 1.0.0    || || ||
|-
| bwareaopen ||  2.2.0      || || ||
|-
|  bwhitmiss ||  < 1.0.0      || || ||
|-
|  bwlookup ||    --  || || ||
|-
|  bwmorph || < 1.0.0        ||  {{bug|51884}} || ||
|-
|  bwpack ||  2.10.0    || || ||
|-
|  bwunpack ||  2.10.0    || || ||
|-
|  bwulterode ||  --    || || ||
|-
| conndef  ||    < 1.0.0    || || ||
|-
|  imbothat ||  2.0.0    || || ||
|-
| imclearborder ||  2.4.0      || || ||
|-
| imclose ||  < 1.0.0      || || ||
|-
|  imdilate ||  < 1.0.0    || || ||
|-
|  imerode ||  < 1.0.0      || || ||
|-
| imextendedmax ||    2.8.0 ||  || ||
|-
|  imextendedmin ||    2.8.0 ||  || ||
|-
| imfill ||  2.6.0      || || ||
|-
| imhmax ||    2.8.0 ||  || ||
|-
| imhmin ||    2.8.0 ||  || ||
|-
|  imimposemin ||    2.8.0 ||  || ||
|-
|  imopen ||  < 1.0.0      || || ||
|-
| imreconstruct ||  2.4.0      || || ||
|-
| imregionalmax ||  2.4.0      || || ||
|-
| imregionalmin ||  2.4.0    || || ||
|-
| imtophat ||  < 1.0.0    || || ||
|-
| iptcheckconn ||  2.0.0      || || ||
|-
| offsetstrel ||    --  || || ||
|-
| strel ||    2.2.0    || {{bug|50732}} || ||
|-
| watershed ||  2.6.0    || || ||
|-
|}
 
=== Image Transforms ===
 
{| class="wikitable" style="text-align: center"
|-
! Function !! Octave Package Version !! Related Bugs and Patches !! Alternatives || Notes
|-
| dct2 ||  - || || ||
|-
| dctmtx || -  || || ||
|-
| fanbeam || -  || || ||
|-
| fan2para ||  - || || ||
|-
| fftshift|| part of core Octave  || || ||
|-
| fft2  || part of core Octave  || || ||
|-
| hough || 2.8.0  || || ||
|-
| houghlines || 2.10.0  || || ||
|-
| houghpeaks || 2.10.0  || || ||
|-
|idct2 ||  - || || ||
|-
|ifftshift|| part of core Octave  || || ||
|-
|ifft2|| part of core Octave  || || ||
|-
|iradon|| <1.0.0  || || ||
|-
|para2fan|| - || || ||
|-
|radon|| <1.0.0  || || ||
|-
|}
 
=== Graphical Interface Interaction ===
 
{| class="wikitable" style="text-align: center"
|-
! Function !! Octave Package Version !! Related Bugs and Patches !! Alternatives || Notes
|-
| imellipse ||  -  || || ||
|-
| imfreehand ||  -  || || ||
|-
| imline ||  -  || || ||
|-
| immagbox ||  -  || || ||
|-
| imoverview ||  -  || || ||
|-
| imoverviewpanel ||  -  || || ||
|-
| impixelinfo ||  -  || {{patch|8722}} || ||
|-
| impixelinfoval ||  -  || {{patch|8722}} || ||
|-
| impixelregion ||  -  || || ||
|-
| impixelregionpanel ||  -  || || ||
|-
| implay ||  -  || || ||
|-
| impoint ||  -  || || ||
|-
| impoly ||  -  || || ||
|-
| imrect ||  -  || || ||
|-
| imscrollpanel ||  -  || || ||
|-
| iptgetpref ||  -  || || ||
|-
| iptprefs ||  -  || || ||
|-
| iptsetpref ||  -  || || ||
|-
|}
* Obs: implay, iptgetpref, iptprefs, iptsetpref functions are on Basic Display section too...
 
[[Category:Octave Forge]]
[[Category:Missing functions]]

Latest revision as of 05:23, 22 August 2022

The image package is part of the Octave Forge project. See its homepage for the latest release.

Development[edit]

Follows an incomplete list of stuff missing in the image package to be matlab compatible. Bugs are not listed here, search and report them on the bug tracker instead.

Missing functions[edit]

Info icon.svg
this entire section is about the current development version. If a Matlab function is missing from the list and does not appear on the current release of the package, confirm that is also missing in the development sources before adding it.
  • activecontour
  • adapthisteq
  • applycform
  • bwconvhull
  • bwdistgeodesic
  • bwlookup
  • bwtraceboundary
  • bwulterode
  • chromadapt
  • colorcloud
  • convmtx2
  • corner
  • cornermetric
  • cpcorr
  • cpselect
  • cpstruct2pairs
  • dct2
  • dctmtx
  • deconvblind
  • deconvlucy
  • deconvreg
  • decorrstretch
  • demosaic
  • dicomanon
  • dicomdisp
  • dicomuid
  • dpxinfo
  • dpxread
  • fan2para
  • fanbeam
  • fliptform
  • freqz2
  • fsamp2
  • ftrans2
  • fwind1
  • fwind2
  • gabor
  • getimage
  • getimagemodel
  • getline
  • getpts
  • getrect
  • gradientweight
  • grayconnected
  • graycoprops
  • graydiffweight
  • hdrread
  • hdrwrite
  • iccfind
  • iccread
  • iccroot
  • iccwrite
  • idct2
  • ifanbeam
  • illumgray
  • illumpca
  • illumwhite
  • im2java2d
  • ImageAdapter
  • imageinfo
  • imapprox
  • imbinarize
  • imboxfilt
  • imboxfilt3
  • imcolormaptool
  • imcontour
  • imcontrast
  • imdisplayrange
  • imdistline
  • imellipse
  • imfreehand
  • imgaborfilt
  • imgaussfilt
  • imgaussfilt3
  • imgca
  • imgcf
  • imguidedfilter
  • imhandles
  • imhistmatch
  • imline
  • immagbox
  • immovie
  • imoverview
  • imoverviewpanel
  • impixelinfo
  • impixelinfoval
  • impixelregion
  • impixelregionpanel
  • implay
  • impoint
  • impoly
  • improfile
  • imrect
  • imreducehaze
  • imregconfig
  • imregcorr
  • imregdemons
  • imregister
  • imregtform
  • imroi
  • imscrollpanel
  • imsegfmm
  • imseggeodesic
  • imtool
  • imwarp
  • integralBoxFilter
  • integralBoxFilter3
  • interfileinfo
  • interfileread
  • iptaddcallback
  • iptcheckhandle
  • iptgetapi
  • iptGetPointerBehavior
  • iptgetpref
  • ipticondir
  • iptPointerManager
  • iptprefs
  • iptremovecallback
  • iptSetPointerBehavior
  • iptsetpref
  • iptwindowalign
  • isicc
  • isrset
  • lin2rgb
  • makecform
  • makeConstrainToRectFcn
  • makehdr
  • makeresampler
  • multithresh
  • nitfinfo
  • nitfread
  • openrset
  • para2fan
  • projective2d
  • regionfill
  • rgb2lin
  • roifill
  • roifilt2
  • roipoly
  • rsetwrite
  • ssim
  • tformarray
  • tonemap
  • truesize
  • visboundaries
  • warp
  • whitepoint
  • xyz2double
  • xyz2uint16

Different functions[edit]

  • with version 2014a, Matlab introduced a new function imtranslate. This function was part of Octave's package since 2002 but Matlab version is completely different. It needs to be rewritten for Matlab compatibility.

Missing options[edit]

  • @strel
    • missing SE decomposition for the diamond shape
    • approximation argument for the ball and disk shapes are not implemented
    • the translate method is not yet implemented
  • blockproc
    • The name-value input arguments have not yet been implemented.
  • colfilt
    • the option to split the image in smaller blocks before performing the im2col and filtering is ignored. Since that option only allows to use less memory and has no effect on the output is only important for sliding filtering with big blocks size.
  • impixel
    • interactive selection of points (less than 2 input arguments) is not yet implemented. Ability to create such UIs needs to be implemented in Octave core first.
  • imcrop
    • messing around with alternative coordinate systems (XData and YData) are not yet implemented.
  • imwrap
    • no supports for SmoothEdges option
  • hough
    • no RhoResolution option

Contributing[edit]

  • It'd help to group the missing functions above, as per [1] (similar to what was done in the signal package wiki page); please keep the original alphabetical list intact.

Open Bugs[edit]

bug bug title status
#38087 image package: graycomatrix incompatibilities with matlab None
#43218 image package: imshear causes more signal spread than expected and inconsistent vertical offset None
#44396 image package: bwmorph shrink does not preserve Euler number Confirmed
#44831 image package: imrotate - different dimensions of output matrix Confirmed
#45088 image package: rangefilt requires domain and image to have equal number of dimensions In Progress
#48529 image package: compilation warnings under Mac OSX None
#49452 [Octave forge] (image) missing MATLAB function corner and undistortImage Confirmed
#50151 image package: normxcorr2 is not compatible with Matlab None
#50188 image package: poly2mask does incompatible rounding None
#50257 image package: imtranslate is not Matlab compatible Confirmed
#50341 Missing Function imrect in image package None
#50429 image package: xyz2lab changed slightly in Matlab (and other color conversion functions) None
#50554 [octave forge] (image) cp2tform missing 'piecewise linear' and 'lwm' support None
#50656 image package: bwerode does not return right size when there's more dimensions on conn None
#50708 image package: add demosaic.m Patch Submitted
#50732 Image package: infinite error loop when assigning a strel (class) object to a vector Confirmed
#51420 [octave forge] (image) imrotate is less tolerant to missing argument than Matlab None
#51719 [octave forge] (image) watershed unit test failure None
#51884 [octave forge] (image) bwmorph(blackNwhiteMatrix, "thicken", 1) returns negated result (+ strange behavior at border) None
#51979 [octave forge] (image) Failing unit test for impyramid None
#51980 [octave forge] (image) Failing unit test for edge None
#52006 [octave forge] (image) 'makecform' feature request Confirmed
#52119 [octave forge] (image) Add 'reflect' padding option to imfilter None
#52715 [octave forge] (image) Add full data range option to ycbcrfunc conversions None
#52959 [octave forge] (image) histeq is not compatible with Matlab None
#55059 [octave forge] (image) Failing unit test for grayslice In Progress
#55438 [octave forge] (image) Binary input image for edge None
#55521 [octave forge] (image) Unit tests for bwpack and bwunpack fail on big endian architectures None
#56958 [Octave-Forge] (image) Implementation of insertText Confirmed
#57822 [octave forge] (image) test failures on macOS - imadjust, immse, mean2 In progress
#58684 [octave forge] (image) imtranslate produces nonsense for fractional shifts Confirmed
#59773 [octave forge] (image) iradon is not Matlab compatible when using filter None
#62099 [octave forge] (image) imresize - lanczos* is not implemented None
#62452 [octave forge] (image) bwmorph spur produces wrong result None

Patches[edit]

  • #8059: [new function for image package] ranktf.m
  • #8060: [image package new function] whitepoint.m
  • #8722: implement impixelinfo and impixelinfoval
  • #8813: image package: Extended image I/O for Analyze 7.5 format to handle big-endian images
  • #8571: image package: three deconvolution routines (Wiener, RL, RLTV)
  • #9509: Image package: simple implementation of roipoly function
  • #9593: [Octave Forge] (Image) New function demosaic.m from bug #50708
  • #9600: [Octave Forge] (Image) New functions: lin2rgb.m and lrgb2lin.m
  • #9602: [octave forge] (image) multithresh
  • #9603: [Octave Forge] (Image) New functions: xyz2double.m, xyz2single.m, xyz2uint16.m
  • #9729: [octave forge] (image) -- rgb2xyz conversion with adapted whitepoint
  • #9853: [octave forge] (image) implement niftiread, niftiwrite, niftiinfo
  • #9957: Nonlinear filter for image package (colfilt2)

Image Processing Functions[edit]

Info icon.svg
This section is still under construction so the list is incomplete.

This is a list of Image Processing functions by topic including: missing functions, related bugs and patches, and some alternatives.

Note:

Basic Read and Write Image Files[edit]

Function Octave Package Version Related Bugs and Patches Alternatives Notes
imfinfo function is in Octave core
imread function is in Octave core cv.imread from mexopencv

in case of color image, the color order of Octave is RGB/RGBA while OpenCV color order is BGR/BGRA

imwrite function is in Octave core cv.imwrite from mexopencv

in case of color image, the color order of Octave is RGB/RGBA while OpenCV color order is BGR/BGRA

Missing: dicomanon, dicomdisp, dicomuid, dpxinfo, dpxread, interfileinfo, interfileread, nitfinfo, nitfread

High Dynamic Range Images - Not implemented[edit]

Large Image Files - Not implemented[edit]

Type Conversion[edit]

Function Octave Package Version Related Bugs and Patches Alternatives Notes
adaptthresh - cv.adaptiveThreshold from mexopencv
demosaic - #50708 #9593 cv.demosaicing from mexopencv
gray2ind function is in Octave core
grayslice < 1.0.0
graythresh 1.0.0 Octave version has more methods
im2double 1.0.0
im2int16 2.0.0
im2java2d -
im2single 2.0.0
im2uint16 1.0.0
im2uint8 1.0.0
imbinarize - imbinarize (I) is equivalent to im2bw(I, graythresh(I)),

another option is cv.threshold from mexopencv

imcast 2.4.0 Octave Only
imquantize 2.6.0
ind2gray function is in Octave core
ind2rgb function is in Octave core
label2rgb 1.0.0
mat2gray < 1.0.0
multithresh - #9602
otsuthresh 2.10.0
rgb2gray function is in Octave core #53654 Octave version 4.4.0 and above
rgb2ind function is in Octave core

Color[edit]

Function Octave Package Version Related Bugs and Patches Alternatives Notes
colorangle 2.10.0
lab2double 2.6.0
lab2rgb 2.6.0
lab2uint16 2.6.0
lab2uint8 2.6.0
lab2xyz 2.6.0
lin2rgb - #9600
ntsc2rgb 2.8.0
rgb2lab 2.6.0
rgb2lin - #9600
rgb2ntsc 2.8.0
rgb2xyz 2.6.0
rgb2ycbcr < 1.0.0
whitepoint - #8060
xyz2double - #9603
xyz2lab 2.6.0
xyz2rgb 2.6.0
xyz2uint16 - #9603
ycbcr2rgb 2.2.0

Missing: applycform, chromadapt, colorcloud, iccfind, iccread, iccroot, iccwrite, illumgray, illumpca, illumwhite, imapprox, isicc, makecform

Synthetic Images[edit]

Function Octave Package Version Related Bugs and Patches Alternatives Notes
checkerboard 2.2.0
imnoise 2.2.2
phantom 2.6.2

Basic Display[edit]

Function Octave Package Version Related Bugs and Patches Alternatives Notes
imshow function is in Octave core
montage 2.2.0
imfuse 2.14.0
imshowpair 2.14.0

Missing: immovie, implay, iptgetpref, iptprefs, iptsetpref, warp

Geometric Transformations[edit]

Function Octave Package Version Related Bugs and Patches Alternatives Notes
affine2d 2.14.0
affine3d 2.14.0
cp2tform 2.2.0
imcrop 2.0.0
impyramid 2.6.0
imref2d 2.12.0
imref3d 2.12.0
imrotate <1.0.0
imtranslate <1.0.0 incompatible to Matlab's imtranslate
maketform 2.2.0
tformfwd 2.2.0
tforminv 2.2.0

Missing: imwarp

Image Filtering[edit]

Function Octave Package Version Related Bugs and Patches Alternatives Notes
bwareafilt 2.4.0
bwpropfilt 2.4.0
convmtx2 -
entropyfilt 1.0.9
fibermetric -
freqz2 -
fsamp2 -
fspecial 1.0.0
ftrans2 -
fwind1 -
fwind2 -
gabor -
imboxfilt -
imboxfilt3 -
imfilter 1.0.5
imgaborfilt -
imgaussfilt -
imgaussfilt3 -
imguidedfilter -
imsmooth 1.0.5 Octave only
integralBoxFilter -
integralBoxFilter3 -
integralImage 2.12.0
integralImage3 2.12.0
medfilt2 < 1.0.0
medfilt3 -
nlfilter < 1.0.0
normxcorr2 2.0.0 #50151
ordfilt2 1.0.9
padarray < 1.0.0
rangefilt 1.0.9 #45088
stdfilt 1.0.9
wiener2 2.8.0

Image Arithmetic[edit]

Function Octave Package Version Related Bugs and Patches Alternatives Notes
imabsdiff 2.0.0
imadd 2.0.0
imapplymatrix 2.14.0
imcomplement 1.0.6
imdivide 2.0.0
imlincomb 2.0.0
immultiply 2.0.0
imsubtract 2.0.0

Morphological Operations[edit]

Function Octave Package Version Related Bugs and Patches Alternatives Notes
applylut < 1.0.0
bwareaopen 2.2.0
bwhitmiss < 1.0.0
bwlookup --
bwmorph < 1.0.0 #51884
bwpack 2.10.0
bwunpack 2.10.0
bwulterode --
conndef < 1.0.0
imbothat 2.0.0
imclearborder 2.4.0
imclose < 1.0.0
imdilate < 1.0.0
imerode < 1.0.0
imextendedmax 2.8.0
imextendedmin 2.8.0
imfill 2.6.0
imhmax 2.8.0
imhmin 2.8.0
imimposemin 2.8.0
imopen < 1.0.0
imreconstruct 2.4.0
imregionalmax 2.4.0
imregionalmin 2.4.0
imtophat < 1.0.0
iptcheckconn 2.0.0
offsetstrel --
strel 2.2.0 #50732
watershed 2.6.0

Image Transforms[edit]

Function Octave Package Version Related Bugs and Patches Alternatives Notes
dct2 -
dctmtx -
fanbeam -
fan2para -
fftshift part of core Octave
fft2 part of core Octave
hough 2.8.0
houghlines 2.10.0
houghpeaks 2.10.0
idct2 -
ifftshift part of core Octave
ifft2 part of core Octave
iradon <1.0.0
para2fan -
radon <1.0.0

Graphical Interface Interaction[edit]

Function Octave Package Version Related Bugs and Patches Alternatives Notes
imellipse -
imfreehand -
imline -
immagbox -
imoverview -
imoverviewpanel -
impixelinfo - #8722
impixelinfoval - #8722
impixelregion -
impixelregionpanel -
implay -
impoint -
impoly -
imrect -
imscrollpanel -
iptgetpref -
iptprefs -
iptsetpref -
  • Obs: implay, iptgetpref, iptprefs, iptsetpref functions are on Basic Display section too...