Java BF

Java BF is a Bio-Format API. In Java, BF is a final class that belongs to the loci.plugins.BF package. It extends the Objects class. Hence, all the methods of the Object class inherited in Java BF class. In this section, we section discuss about the Java BF (Bio Format) class.

Java BF API

A collection of plugins for ImageJ, including the Bio-Formats Importer, Bio-Formats Exporter, Bio-Formats Macro Extensions, Data Browser and Stack Slicer.

Java BF Class Constructor

There is only a construct of the class.

Java BF Class Methods

All the methods of the BF class are static. The methods openImagePlus() and openThumbImagePlus() throws FormatExcetion and IOException. The methods of the Java BF class are as follows:

Methods of the Java BF Class
debug(java.lang.String msg)
openImagePlus(ImporterOptions options)
openImagePlus(java.lang.String path)
openThumbImagePlus(ImporterOptions options)
openThumbImagePlus(java.lang.String path)
progress(boolean quiet, int value, int max)
status(boolean quiet, java.lang.String msg)
warn(boolean quiet, java.lang.String msg)

Let's see how to implement and use the above methods in a Java programs.

Java BF.debug() Method

protected void append(ILoggingEvent event) 
{
if (event.getLevel().isGreaterOrEqual(Level.INFO)) 
{
BF.status(false, event.getMessage().toString());
}
else 
{
BF.debug(event.getMessage().toString());
}
}

Java BF.openImagePlus() Method

public static ImagePlus[] openImagePlus(String path)
throws FormatException, IOException
{
ImporterOptions options = new ImporterOptions();
options.setId(path);
return openImagePlus(options);
}

Java BF.warn() Method

public static void loadThumb(BufferedImageReader thumbReader, int series, Panel panel, boolean quiet)
BF.status(quiet, "Reading thumbnail for series #" + (series + 1));
catch (IOException e) 
{ 
exc = e; 
}
if (exc != null) 
{
BF.warn(quiet, "Error loading thumbnail for series #" + (series + 1));
BF.debug(DebugTools.getStackTrace(exc));

Java BF.openThumbImagePlus() Method

public static ImagePlus[] openThumbImagePlus(String path)
throws FormatException, IOException
{
ImporterOptions options = new ImporterOptions();
options.setId(path);
return openThumbImagePlus(options);
}

Java BF.progress() Method

@Override
public void statusUpdated(StatusEvent e) {
 String msg = e.getStatusMessage();
 if (msg != null) BF.status(options.isQuiet(), msg);
 int value = e.getProgressValue();
 int max = e.getProgressMaximum();
 if (value >= 0 && max >= 0) BF.progress(options.isQuiet(), value, max);
}

Java BF.status() Method

public void stop() 
{
if (loader == null) return;
stop = true;
BF.status(false, "Canceling thumbnail generation");
try 
{
loader.join();
loader = null;
}
catch (InterruptedException exc) 
{
exc.printStackTrace();
}
BF.status(false, "");

Next TopicJava Logo

← prev next →