Package adams.data.io.input

Class OpenCVImageReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractImageReader<OpenCVImageContainer>

adams.data.io.input.OpenCVImageReader

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ImageReader<OpenCVImageContainer>, Serializable

public class OpenCVImageReader
extends AbstractImageReader<OpenCVImageContainer>

Reads images using OpenCV.

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

-mode <IMREAD_UNCHANGED|IMREAD_GRAYSCALE|IMREAD_COLOR|IMREAD_ANYDEPTH|IMREAD_ANYCOLOR|IMREAD_LOAD_GDAL|IMREAD_REDUCED_GRAYSCALE_2|IMREAD_REDUCED_COLOR_2|IMREAD_REDUCED_GRAYSCALE_4|IMREAD_REDUCED_COLOR_4|IMREAD_REDUCED_GRAYSCALE_8|IMREAD_REDUCED_COLOR_8|IMREAD_IGNORE_ORIENTATION> (property: mode)
    How to read the image.
    default: IMREAD_UNCHANGED
 

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.
protected ImreadMode	m_Mode	the mode.

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
OpenCVImageReader()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected OpenCVImageContainer	doRead(PlaceholderFile file)	Performs the actual reading of the image file.
ImageWriter	getCorrespondingWriter()	Returns, if available, the corresponding writer.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
ImreadMode	getMode()	Returns the read mode.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
String	modeTipText()	Returns the tip text for this property.
void	setMode(ImreadMode value)	Sets the read mode.

Methods inherited from class adams.data.io.input.AbstractImageReader

check, getDefaultFormatExtension, getReaders, isAvailable, postProcess, read

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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, getOptionManager, toCommandLine

Field Detail

m_FormatExtensions

protected String[] m_FormatExtensions

the format extensions.

m_Mode

protected ImreadMode m_Mode

the mode.

Constructor Detail

OpenCVImageReader

public OpenCVImageReader()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

setMode

public void setMode(ImreadMode value)

Sets the read mode.

Parameters:

value - the mode

getMode

public ImreadMode getMode()

Returns the read mode.

Returns:

the mode

modeTipText

public String modeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

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 AbstractImageReader<OpenCVImageContainer>

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 AbstractImageReader<OpenCVImageContainer>

Returns:

the extension (without the dot!)

getCorrespondingWriter

public ImageWriter getCorrespondingWriter()

Returns, if available, the corresponding writer.

Specified by:

getCorrespondingWriter in interface ImageReader<OpenCVImageContainer>

Specified by:

getCorrespondingWriter in class AbstractImageReader<OpenCVImageContainer>

Returns:

the writer, null if none available

doRead

protected OpenCVImageContainer doRead(PlaceholderFile file)

Performs the actual reading of the image file.

Specified by:

doRead in class AbstractImageReader<OpenCVImageContainer>

Parameters:

file - the file to read

Returns:

the image container, null if failed to read