Package adams.data.io.output

Class BoofCVImageWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractImageWriter<BoofCVImageContainer>

adams.data.io.output.BoofCVImageWriter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ImageWriter<BoofCVImageContainer>, Serializable

public class BoofCVImageWriter
extends AbstractImageWriter<BoofCVImageContainer>

BoofCV image writer for: bmp, gif, jpeg, jpg, pgm, png, ppm, wbmp
For more information see:
http://boofcv.org/

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	m_FormatExtensions	the format extensions.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
BoofCVImageWriter()

Method Summary

Modifier and Type	Method	Description
protected String	doWrite(PlaceholderFile file, BoofCVImageContainer cont)	Performs the actual writing of the image file.
ImageReader	getCorrespondingReader()	Returns, if available, the corresponding reader.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.

Methods inherited from class adams.data.io.output.AbstractImageWriter

check, getDefaultFormatExtension, getWriters, isAvailable, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Field Detail

m_FormatExtensions

protected String[] m_FormatExtensions

the format extensions.

Constructor Detail

BoofCVImageWriter

public BoofCVImageWriter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface FileFormatHandler

Specified by:

getFormatDescription in class AbstractImageWriter<BoofCVImageContainer>

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in interface FileFormatHandler

Specified by:

getFormatExtensions in class AbstractImageWriter<BoofCVImageContainer>

Returns:

the extension(s) (without the dot!)

getCorrespondingReader

public ImageReader getCorrespondingReader()

Returns, if available, the corresponding reader.

Specified by:

getCorrespondingReader in interface ImageWriter<BoofCVImageContainer>

Specified by:

getCorrespondingReader in class AbstractImageWriter<BoofCVImageContainer>

Returns:

the reader, null if none available

doWrite

protected String doWrite(PlaceholderFile file,
                         BoofCVImageContainer cont)

Performs the actual writing of the image file.

Specified by:

doWrite in class AbstractImageWriter<BoofCVImageContainer>

Parameters:

file - the file to write to

cont - the image container to write

Returns:

always null