{"id":1094,"date":"2014-07-11T13:50:40","date_gmt":"2014-07-11T17:50:40","guid":{"rendered":"https:\/\/blogs.mathworks.com\/steve\/?p=1094"},"modified":"2019-11-01T11:09:26","modified_gmt":"2019-11-01T15:09:26","slug":"under-the-hood-of-imread","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/steve\/2014\/07\/11\/under-the-hood-of-imread\/","title":{"rendered":"Under the hood of imread"},"content":{"rendered":"\r\n

I'm going to play a small trick on you today. Try reading in this JPEG file using imread<\/tt>:<\/p>

url = 'https:\/\/blogs.mathworks.com\/images\/steve\/2014\/peppers.jpg'<\/span>;\r\nrgb = imread(url);\r\nimshow(rgb)\r\n<\/pre>\"\" 
So what's the trick? Well, look more closely at this file using imfinfo<\/tt>:<\/p>
info = imfinfo(url)\r\n<\/pre>
\r\ninfo = \r\n\r\n                  Filename: 'https:\/\/blogs.mathworks.com\/images\/steve\/2014\/...'\r\n               FileModDate: '11-Jul-2014 14:46:33'\r\n                  FileSize: 287677\r\n                    Format: 'png'\r\n             FormatVersion: []\r\n                     Width: 512\r\n                    Height: 384\r\n                  BitDepth: 24\r\n                 ColorType: 'truecolor'\r\n           FormatSignature: [137 80 78 71 13 10 26 10]\r\n                  Colormap: []\r\n                 Histogram: []\r\n             InterlaceType: 'none'\r\n              Transparency: 'none'\r\n    SimpleTransparencyData: []\r\n           BackgroundColor: []\r\n           RenderingIntent: []\r\n            Chromaticities: []\r\n                     Gamma: []\r\n               XResolution: []\r\n               YResolution: []\r\n            ResolutionUnit: []\r\n                   XOffset: []\r\n                   YOffset: []\r\n                OffsetUnit: []\r\n           SignificantBits: []\r\n              ImageModTime: '16 Jul 2002 16:46:41 +0000'\r\n                     Title: []\r\n                    Author: []\r\n               Description: 'Zesty peppers'\r\n                 Copyright: 'Copyright The MathWorks, Inc.'\r\n              CreationTime: []\r\n                  Software: []\r\n                Disclaimer: []\r\n                   Warning: []\r\n                    Source: []\r\n                   Comment: []\r\n                 OtherText: []\r\n\r\n<\/pre>
See it yet? No?<\/p>
Look at the Format field:<\/p>
info.Format\r\n<\/pre>
\r\nans =\r\n\r\npng\r\n\r\n<\/pre>
The function imfinfo<\/tt> is claiming this this JPEG file is really a PNG file, which is a completely different image file format!<\/p>
So what's going on here? Is this a JPEG file or not?<\/p>
This trick question is really just an excuse to peek under the hood of imread<\/tt> to see how an interesting piece of it works. (Well, it's interesting to me, at least.)<\/p>
Before opening the hood, though, let's try reading one more file. And notice that this filename has an extension that has nothing to do with any particular image format.<\/p>
url2 = 'https:\/\/blogs.mathworks.com\/images\/steve\/2014\/peppers.fruit_study_2014_Jul_11'<\/span>;\r\n\r\nrgb2 = imread(url2);\r\nimshow(rgb2)\r\n<\/pre>\"\" 
OK, so imread<\/tt> can successfully read this image file even without an extension indicating its format.<\/p>
If you're curious, a lot of the imread<\/tt> code that makes all this work is available for you to look at in your installation of MATLAB. (If, on the other hand, you're not curious, then this would be a good time to go over and read Cleve's blog<\/a> instead.) For example, you can view the source code for imread<\/tt> in the MATLAB Editor by typing edit imread<\/tt>. (Please don't modify the code, though!)<\/p>
Here's a partial fragment of code near the top:<\/p>
if (isempty(fmt_s))\r\n    % The format was not specified explicitly.<\/pre>
    ... snip ...<\/pre>
    % Try to determine the file type.\r\n    [format, fmt_s] = imftype(filename);<\/pre>
Hmm, what's that function imftype<\/tt>?<\/p>
which imftype<\/span>\r\n<\/pre>
'imftype' not found.\r\n<\/pre>
It doesn't appear to exist!<\/p>
It does exist, but it happens to be a private function. The function which<\/tt> will find it if you tell which<\/tt> to look at little harder.<\/p>
which -all<\/span> imftype<\/span>\r\n<\/pre>
\/Applications\/MATLAB_R2014a.app\/toolbox\/matlab\/imagesci\/private\/imftype.m  % Private to imagesci\r\n<\/pre>
Even though you can't directly call this function (that's what private<\/i> means here), you can still look at it in the MATLAB Editor by typing edit private\/imftype<\/tt>.<\/p>
Here's some code from near the beginning of imftype<\/tt>.<\/p>
idx = find(filename == '.');\r\nif (~isempty(idx))\r\n    extension = lower(filename(idx(end)+1:end));\r\nelse\r\n    extension = '';\r\nend<\/pre>
% Try to get useful imformation from the extension.<\/pre>
if (~isempty(extension))<\/pre>
    % Look up the extension in the file format registry.\r\n    fmt_s = imformats(extension);<\/pre>
    if (~isempty(fmt_s))<\/pre>
        if (~isempty(fmt_s.isa))<\/pre>
            % Call the ISA function for this format.\r\n            tf = feval(fmt_s.isa, filename);<\/pre>
            if (tf)<\/pre>
                % The file is of that format.  Return the ext field.\r\n                format = fmt_s.ext{1};\r\n                return;<\/pre>
            end\r\n        end\r\n    end\r\nend<\/pre>
In English: If the filename has an extension on it, use the imformats<\/tt> function to get a function that can test to see whether the file really has that format.<\/p>
So what's that new function imformats<\/tt> in the middle there? Well, you can call this one directly. Try it.<\/p>
s = imformats\r\n<\/pre>
\r\ns = \r\n\r\n1x19 struct array with fields:\r\n\r\n    ext\r\n    isa\r\n    info\r\n    read\r\n    write\r\n    alpha\r\n    description\r\n\r\n<\/pre>
That output is not very readable. If we were designing this today, we'd probably make imformats<\/tt> return a table. Fortunately we've got an easy way to convert a struct array into table!<\/p>
t = struct2table(s)\r\n<\/pre>
\r\nt = \r\n\r\n       ext          isa         info          read         write      alpha\r\n    __________    _______    ___________    _________    _________    _____\r\n\r\n    {1x1 cell}    @isbmp     @imbmpinfo     @readbmp     @writebmp    0    \r\n    {1x1 cell}    @iscur     @imcurinfo     @readcur     ''           1    \r\n    {1x2 cell}    @isfits    @imfitsinfo    @readfits    ''           0    \r\n    {1x1 cell}    @isgif     @imgifinfo     @readgif     @writegif    0    \r\n    {1x1 cell}    @ishdf     @imhdfinfo     @readhdf     @writehdf    0    \r\n    {1x1 cell}    @isico     @imicoinfo     @readico     ''           1    \r\n    {1x2 cell}    @isjp2     @imjp2info     @readjp2     @writej2c    0    \r\n    {1x1 cell}    @isjp2     @imjp2info     @readjp2     @writejp2    0    \r\n    {1x2 cell}    @isjp2     @imjp2info     @readjp2     ''           0    \r\n    {1x2 cell}    @isjpg     @imjpginfo     @readjpg     @writejpg    0    \r\n    {1x1 cell}    @ispbm     @impnminfo     @readpnm     @writepnm    0    \r\n    {1x1 cell}    @ispcx     @impcxinfo     @readpcx     @writepcx    0    \r\n    {1x1 cell}    @ispgm     @impnminfo     @readpnm     @writepnm    0    \r\n    {1x1 cell}    @ispng     @impnginfo     @readpng     @writepng    1    \r\n    {1x1 cell}    @ispnm     @impnminfo     @readpnm     @writepnm    0    \r\n    {1x1 cell}    @isppm     @impnminfo     @readpnm     @writepnm    0    \r\n    {1x1 cell}    @isras     @imrasinfo     @readras     @writeras    1    \r\n    {1x2 cell}    @istif     @imtifinfo     @readtif     @writetif    0    \r\n    {1x1 cell}    @isxwd     @imxwdinfo     @readxwd     @writexwd    0    \r\n\r\n\r\n               description            \r\n    __________________________________\r\n\r\n    'Windows Bitmap'                  \r\n    'Windows Cursor resources'        \r\n    'Flexible Image Transport System' \r\n    'Graphics Interchange Format'     \r\n    'Hierarchical Data Format'        \r\n    'Windows Icon resources'          \r\n    'JPEG 2000 (raw codestream)'      \r\n    'JPEG 2000 (Part 1)'              \r\n    'JPEG 2000 (Part 2)'              \r\n    'Joint Photographic Experts Group'\r\n    'Portable Bitmap'                 \r\n    'Windows Paintbrush'              \r\n    'Portable Graymap'                \r\n    'Portable Network Graphics'       \r\n    'Portable Any Map'                \r\n    'Portable Pixmap'                 \r\n    'Sun Raster'                      \r\n    'Tagged Image File Format'        \r\n    'X Window Dump'                   \r\n\r\n<\/pre>
Now we've gotten to some interesting stuff! This table represents the guts of how imread<\/tt>, imfinfo<\/tt>, and imwrite<\/tt> knows how to deal with the many different image file formats supported.<\/p>
If you pass an extension to imformats<\/tt>, it looks through file formats it knows about to see if it matches a standard one.<\/p>
imformats('jpg'<\/span>)\r\n<\/pre>
\r\nans = \r\n\r\n            ext: {'jpg'  'jpeg'}\r\n            isa: @isjpg\r\n           info: @imjpginfo\r\n           read: @readjpg\r\n          write: @writejpg\r\n          alpha: 0\r\n    description: 'Joint Photographic Experts Group'\r\n\r\n<\/pre>
Let's go back to the original file peppers.jpg and consider what happens in the code we've seen so far.<\/p>
1. We did not specify the format explicitly (with a 2nd argument) when we called imread<\/tt>, so imread<\/tt> called imftype<\/tt> to determine the format type.<\/p>
2. The function imftype<\/tt> found an extension ('.jpg') at the end of the filename, so it asked the imformats<\/tt> function about the extension, and imformats<\/tt> returned a set of function handles useful for doing things with JPEG files. One of the function handles, @isjpg<\/tt>, tests to see whether a file is a JPEG file or not.<\/p>
To be completely truthful, @isjpg<\/tt> just does a quick check based only on the first few bytes of the file. Look at the code by typing edit private\/isjpg<\/tt>. Here are the key lines.<\/p>
fid = fopen(filename, 'r', 'ieee-le');\r\nassert(fid ~= -1, message('MATLAB:imagesci:validate:fileOpen', filename));\r\nsig = fread(fid, 2, 'uint8');\r\nfclose(fid);\r\ntf = isequal(sig, [255; 216]);<\/pre>
OK, I have now taught you enough so that you can thoroughly confuse imread<\/tt> if you really want to. But don't you already have enough hobbies?<\/i><\/p>
3. In this case, the file wasn't actually a JPEG file, so the function handle @isjpg<\/tt> returned 0 (false).<\/p>
That brings us to the rest of the excitement in imftype<\/tt>.<\/p>
% Get all formats from the registry.\r\nfmt_s = imformats;<\/pre>
% Look through each of the possible formats.\r\nfor p = 1:length(fmt_s)\r\n    % Call each ISA function until the format is found.\r\n    if (~isempty(fmt_s(p).isa))\r\n        tf = feval(fmt_s(p).isa, filename);\r\n        if (tf)\r\n            % The file is of that format.  Return the ext field.\r\n            format = fmt_s(p).ext{1};\r\n            fmt_s = fmt_s(p);\r\n            return\r\n        end\r\n    else\r\n        warning(message('MATLAB:imagesci:imftype:missingIsaFunction'));\r\n    end\r\nend<\/pre>
In English: For every image file format we know about, run the corresponding isa<\/tt> function handle on the file. If one of the isa<\/tt> functions returns true, then return the corresponding set of information from imformats<\/tt>.<\/p>
Back to the story for our misnamed image file peppers.jpg. The @isjpg<\/tt> function handle returned false for it. So imftype<\/tt> then tried the isa<\/tt> function handles for every image file format. One of them, @ispng<\/tt>, returned 1 (true). That information was passed back up to imread<\/tt>, which then read the file successfully as a PNG, which was the file's true format type.<\/p>
Finally, here's what happened for the image file peppers.2014_Jul_11. When imftype<\/tt> passed the extension '2014_Jul_11'<\/tt> to imformats<\/tt>, no such image format extension was found, so imformats<\/tt> returned empty. That caused imftype<\/tt> to go into the code that simply tried every image format it knew about, which again worked when it got to PNG.<\/p>
Phew! That's the story of the effort imread<\/tt> makes to read your images in correctly.<\/p>
For the three of you that are still reading along, I'll send a t-shirt to the first one to post a convincingly complete explanation of this line of code from above:<\/p>
extension = lower(filename(idx(end)+1:end));<\/pre>