Changeset 3956


Ignore:
Timestamp:
04/18/08 15:22:16 (12 years ago)
Author:
curtis
Message:

Align documentation text better.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/loci/plugins/LociFunctions.java

    r3955 r3956  
    278278      IJ.write("Ext.isMetadataComplete(complete)"); 
    279279      IJ.write("-- True if Bio-Formats completely parses the current"); 
    280       IJ.write("  dataset's file format. If this function returns false,"); 
    281       IJ.write("  there are known limitations or missing features in how"); 
    282       IJ.write("  Bio-Formats handles this file format."); 
     280      IJ.write("-- dataset's file format. If this function returns false,"); 
     281      IJ.write("-- there are known limitations or missing features in how"); 
     282      IJ.write("-- Bio-Formats handles this file format."); 
    283283      IJ.write("Ext.fileGroupOption(id, fileGroupOption)"); 
    284284      IJ.write("-- Returns a code indicating the file grouping policy for"); 
    285       IJ.write("  for the current dataset. Possible values are:"); 
    286       IJ.write("     must, can, cannot, unknown"); 
     285      IJ.write("-- for the current dataset. Possible values are:"); 
     286      IJ.write("--   must, can, cannot, unknown"); 
    287287      IJ.write(""); 
    288288      IJ.write("-= Usable before initializing a file =-"); 
     
    298298      IJ.write("Ext.setOriginalMetadataPopulated(populate)"); 
    299299      IJ.write("-- Sets whether Bio-Formats should save proprietary metadata"); 
    300       IJ.write("  to the OME metadata store as custom attributes."); 
     300      IJ.write("-- to the OME metadata store as custom attributes."); 
    301301      IJ.write("Ext.isOriginalMetadataPopulated(populate)"); 
    302302      IJ.write("-- Sets whether Bio-Formats is saving proprietary metadata"); 
    303       IJ.write("  to the OME metadata store as custom attributes."); 
     303      IJ.write("-- to the OME metadata store as custom attributes."); 
    304304      IJ.write("Ext.setGroupFiles(group)"); 
    305305      IJ.write("-- For multi-file formats, sets whether to force grouping."); 
     
    308308      IJ.write("Ext.setMetadataFiltered(filter)"); 
    309309      IJ.write("-- Sets whether to filter out ugly metadata from the table"); 
    310       IJ.write("  (i.e., entries with unprintable characters, and extremely"); 
    311       IJ.write("  long values)."); 
     310      IJ.write("-- (i.e., entries with unprintable characters, and extremely"); 
     311      IJ.write("-- long values)."); 
    312312      IJ.write("Ext.isMetadataFiltered(filter)"); 
    313313      IJ.write("-- Gets whether ugly metadata is being filtered out."); 
     
    331331      IJ.write("Ext.openImage(title, no, x, y, width, height)"); 
    332332      IJ.write("-- Opens a subset of the no'th plane in a new window"); 
    333       IJ.write("  named 'title'."); 
     333      IJ.write("-- named 'title'."); 
    334334      IJ.write("Ext.close()"); 
    335335      IJ.write("-- Closes the active dataset."); 
     
    351351      IJ.write("Ext.getPixelType(pixelType)"); 
    352352      IJ.write("-- Gets a code representing the pixel type of the image."); 
    353       IJ.write("  Possible values include:"); 
    354       IJ.write("     int8, uint8, int16, uint16, int32, uint32, float, double"); 
     353      IJ.write("-- Possible values include:"); 
     354      IJ.write("--   int8, uint8, int16, uint16, int32, uint32, float, double"); 
    355355      IJ.write("Ext.getEffectiveSizeC(effectiveSizeC)"); 
    356356      IJ.write("-- Gets the 'effective' number of channels, such that:"); 
    357       IJ.write("  effectiveSizeC * sizeZ * sizeT == imageCount"); 
     357      IJ.write("-- effectiveSizeC * sizeZ * sizeT == imageCount"); 
    358358      IJ.write("Ext.getRGBChannelCount(rgbChannelCount)"); 
    359359      IJ.write("-- Gets the number of channels per composite image plane:"); 
    360       IJ.write("  sizeC / rgbChannelCount == effectiveSizeC"); 
     360      IJ.write("-- sizeC / rgbChannelCount == effectiveSizeC"); 
    361361      IJ.write("Ext.isIndexed(indexed)"); 
    362362      IJ.write("-- Gets whether the image planes are stored as indexed color"); 
    363       IJ.write("  (i.e., whether they have embedded LUTs)."); 
     363      IJ.write("-- (i.e., whether they have embedded LUTs)."); 
    364364      IJ.write("Ext.getChannelDimCount(channelDimCount)"); 
    365365      IJ.write("-- For highly multidimensional image data, the C dimension"); 
    366       IJ.write("  may consist of multiple embedded 'sub' dimensions."); 
    367       IJ.write("  This function returns the number of such dimensions."); 
     366      IJ.write("-- may consist of multiple embedded 'sub' dimensions."); 
     367      IJ.write("-- This function returns the number of such dimensions."); 
    368368      IJ.write("Ext.getChannelDimLength(i, channelDimLength)"); 
    369369      IJ.write("-- Gets the length of the i'th embedded 'sub' dimension."); 
     
    374374      IJ.write("Ext.getDimensionOrder(dimOrder)"); 
    375375      IJ.write("-- Gets a five-character string representing the dimensional"); 
    376       IJ.write("  rasterization order within the dataset. Valid orders are:"); 
    377       IJ.write("     XYCTZ, XYCZT, XYTCZ, XYTZC, XYZCT, XYZTC"); 
    378       IJ.write("  In cases where the channels are interleaved (e.g., CXYTZ),"); 
    379       IJ.write("  C will be the first dimension after X and Y (e.g., XYCTZ)"); 
    380       IJ.write("  and the isInterleaved function will return true."); 
     376      IJ.write("-- rasterization order within the dataset. Valid orders are:"); 
     377      IJ.write("--   XYCTZ, XYCZT, XYTCZ, XYTZC, XYZCT, XYZTC"); 
     378      IJ.write("-- In cases where the channels are interleaved (e.g., CXYTZ),"); 
     379      IJ.write("-- C will be the first dimension after X and Y (e.g., XYCTZ)"); 
     380      IJ.write("-- and the isInterleaved function will return true."); 
    381381      IJ.write("Ext.isOrderCertain(orderCertain)"); 
    382382      IJ.write("-- Gets whether the dimension order and sizes are known,"); 
    383       IJ.write("  or merely guesses."); 
     383      IJ.write("-- or merely guesses."); 
    384384      IJ.write("Ext.isInterleaved(interleaved)"); 
    385385      IJ.write("-- Gets whether or not the channels are interleaved."); 
    386       IJ.write("  This function exists because X and Y must appear first"); 
    387       IJ.write("  in the dimension order. For interleaved data, XYCTZ or"); 
    388       IJ.write("  XYCZT is used, and this method returns true."); 
     386      IJ.write("-- This function exists because X and Y must appear first"); 
     387      IJ.write("-- in the dimension order. For interleaved data, XYCTZ or"); 
     388      IJ.write("-- XYCZT is used, and this method returns true."); 
    389389      IJ.write("Ext.isInterleavedSubC(subC, interleaved)"); 
    390390      IJ.write("-- Gets whether the given 'sub' channel is interleaved."); 
    391       IJ.write("  This method exists because some data with multiple"); 
    392       IJ.write("  rasterized sub-dimensions within C have one sub-dimension"); 
    393       IJ.write("  interleaved, and the other not -- e.g., the SDT reader"); 
    394       IJ.write("  handles spectral-lifetime data with interleaved lifetime"); 
    395       IJ.write("  bins and non-interleaved spectral channels."); 
     391      IJ.write("-- This method exists because some data with multiple"); 
     392      IJ.write("-- rasterized sub-dimensions within C have one sub-dimension"); 
     393      IJ.write("-- interleaved, and the other not -- e.g., the SDT reader"); 
     394      IJ.write("-- handles spectral-lifetime data with interleaved lifetime"); 
     395      IJ.write("-- bins and non-interleaved spectral channels."); 
    396396      IJ.write("Ext.getIndex(z, c, t, index)"); 
    397397      IJ.write("-- Gets the rasterized index corresponding to the given"); 
    398       IJ.write("  Z, C and T coordinates, according to the dataset's"); 
    399       IJ.write("  dimension order."); 
     398      IJ.write("-- Z, C and T coordinates, according to the dataset's"); 
     399      IJ.write("-- dimension order."); 
    400400      IJ.write("Ext.getZCTCoords(index, z, c, t)"); 
    401401      IJ.write("-- Gets the Z, C and T coordinates corresponding to the given"); 
    402       IJ.write("  rasterized index value, according to the dataset's"); 
    403       IJ.write("  dimension order."); 
     402      IJ.write("-- rasterized index value, according to the dataset's"); 
     403      IJ.write("-- dimension order."); 
    404404      IJ.write("Ext.getMetadataValue(field, value)"); 
    405405      IJ.write("-- Obtains the specified metadata field's value."); 
Note: See TracChangeset for help on using the changeset viewer.