Ignore:
Timestamp:
04/16/07 15:25:38 (13 years ago)
Author:
melissa
Message:

Updated to reflect recent API modifications.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/loci/formats/reader-guide.txt

    r2588 r2626  
    1414  the first byte of the file.  Return true if the file can be read; false if 
    1515  not (or if there is no way of checking). 
    16  
    17 int getImageCount() throws FormatException, IOException : 
    18   Return the number of image planes in the file.   
    19  
    20 boolean isRGB() throws FormatException, IOException : 
    21   This should only return true if the file's image planes are stored as RGB 
    22   or indexed color.  All other cases return false.  
    23  
    24 boolean isLittleEndian() throws FormatException, IOException : 
    25   Return the byte ordering of the pixel data.  Note that in some cases, this 
    26   is different from the file's native ordering.  If the pixel data is 
    27   guaranteed to have 8 bits per pixel, then isLittleEndian can return 
    28   anything. 
    29  
    30 boolean isInterleaved() throws FormatException, IOException : 
    31   This is only relevant if the file's image planes are stored as RGB or 
    32   indexed color; however, it should always be implemented.  If the image 
    33   planes are RGB, and the pixel data is stored as "RRR...GGG...BBB", then 
    34   return false.  Otherwise, if the pixel data is stored as "RGBRGBRGB..." 
    35   return true. 
    3616 
    3717String[] getUsedFiles() throws FormatException, IOException : 
     
    5838  isLittleEndian). 
    5939 
    60 void close() throws FormatException, IOException : 
    61   Close the stream used to read the file, and set the stream and file name to 
    62   null.  It is also very important to free any resources initialized elsewhere 
    63   in the reader.  After calling close on a reader, any additional calls to 
    64   that reader should result in a call to initFile(String). 
    65  
    66 void close(boolean) throws FormatException, IOException : 
    67   If the flag is set, just close the stream used to read the file (the reader 
    68   should remain initialized).  Otherwise, should be equivalent to calling 
    69   close(). 
    70  
    7140protected void initFile(String) throws FormatException, IOException : 
    7241  The majority of the file parsing logic should be placed in this method.  The 
     
    8857usually sufficient to override initFile(String) and isThisType(byte[]). 
    8958 
     59Every reader also has an instance of loci.formats.CoreMetadata.  All readers 
     60should populate the fields in CoreMetadata, which are essential to reading 
     61image planes. 
    9062 
    9163If you read from a file using something other than RandomAccessStream or 
Note: See TracChangeset for help on using the changeset viewer.