Ignore:
Timestamp:
04/27/07 11:43:54 (13 years ago)
Author:
melissa
Message:

Moved assertId implementation to FormatTools and added assertId calls to appropriate methods.

File:
1 edited

Legend:

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

    r2655 r2695  
    2020  the given file name (i.e. every file needed to display the current dataset). 
    2121  For an example of how this works, see loci.formats.in.PerkinElmerReader. 
     22  It is recommended that the first line of this method be 
     23  "FormatTools.assertId(currentId, true, 1)" - this ensures that the file name 
     24  is non-null. 
    2225 
    2326byte[] openBytes(int) throws FormatException, IOException : 
     
    2831  isLittleEndian() and isInterleaved().  Also, the length of the 
    2932  byte array should be [image width * image height * bytes per pixel].  Extra 
    30   bytes will generally be truncated. 
     33  bytes will generally be truncated. It is recommended that the first line of  
     34  this method be "FormatTools.asserId(currentId, true, 1)" - this ensures that  
     35  the file name is non-null. 
    3136 
    3237BufferedImage openImage(int) throws FormatException, IOException : 
     
    3641  loci.formats.ImageTools.makeImage(byte[], int width, int height, int 
    3742  numberOfChannels, boolean isInterleaved, int bytesPerPixel, boolean 
    38   isLittleEndian). 
     43  isLittleEndian). It is recommended that the first line of this method be 
     44  "FormatTools.assertId(currentId, true, 1)" - this ensures that the file name 
     45  is non-null. 
    3946 
    4047protected void initFile(String) throws FormatException, IOException : 
Note: See TracChangeset for help on using the changeset viewer.