Ignore:
Timestamp:
12/22/06 10:38:13 (13 years ago)
Author:
melissa
Message:

Include notes on recent API additions.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/loci/formats/getting-started.txt

    r1695 r1966  
    4040  is equal to the current file; if not, initFile(String) should be called  
    4141  (see below). 
     42 
     43String[] getUsedFiles(String) throws FormatException, IOException : 
     44  You only need to override this if your format uses multiple files in a single 
     45  dataset.  This method should return a list of all the files associated with 
     46  the given file name (i.e. every file needed to display the current dataset). 
     47  For an example of how this works, see loci.formats.in.PerkinElmerReader. 
    4248 
    4349byte[] openBytes(String, int) throws FormatException, IOException : 
     
    8389                       constant values in FormatReader for a list of valid 
    8490                       values 
    85  
    86   Note that each variable is intialized to 0 or null when 
     91    boolean orderCertain[0] : set to true if you are certain that the dimension 
     92                              order is correct 
     93 
     94  Note that each variable is initialized to 0 or null when 
    8795  super.initFile(String) is called. 
    8896  Also, super.initFile(String) constructs a Hashtable called "metadata" where 
     
    136144- Several common image compression types are supported in 
    137145  loci.formats.Compression.  These include LZW, LZO, Base64, ZIP and RLE. 
     146 
     147- Debugging statements can be added using FormatReader.debug(String). 
    138148 
    139149- If you wish to convert a file's metadata to OME-XML (strongly encouraged), 
     
    173183    -nocolors           Intepret indexed color images as grayscale. 
    174184    -omexml             Output the OME-XML for the file. 
     185    -normalize          Normalize floating point images. 
     186    -fast               Display RGB images as quickly as possible. 
     187    -debug              Turn on debugging output. 
    175188    -range              Specify a range of images to open. 
    176189    -series             Set the series number (for container file formats). 
     190    -map                Specify file on disk to which name should be mapped. 
    177191 
    178192- For more details, please look at the source code and javadocs.  Studying 
Note: See TracChangeset for help on using the changeset viewer.