ImageReader (adams-pom 24.12.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, FileFormatHandler, OptionHandler

All Known Subinterfaces:

InputStreamImageReader<T>

All Known Implementing Classes:

AbstractImageReader, ApacheCommonsImageReader, BoofCVImageReader, JAIImageReader, OpenCVImageReader, PNGImageReader
```
public interface ImageReader<T extends AbstractImageContainer>
extends OptionHandler, FileFormatHandler
```
Interface for image readers.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ImageWriter`	`getCorrespondingWriter()`	Returns, if available, the corresponding writer.
`boolean`	`isAvailable()`	Returns whether the reader is actually available.
`T`	`read(PlaceholderFile file)`	Reads the image file.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.io.FileFormatHandler
getDefaultFormatExtension, getFormatDescription, getFormatExtensions

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

- Method Detail
  - getCorrespondingWriter
```
ImageWriter getCorrespondingWriter()
```
    Returns, if available, the corresponding writer.
    
    Returns:
    
    the writer, null if none available
  - isAvailable
```
boolean isAvailable()
```
    Returns whether the reader is actually available.
    
    Returns:
    
    true if available and ready to use
  - read
```
T read(PlaceholderFile file)
```
    Reads the image file.
    
    Parameters:
    
    file - the file to read
    
    Returns:
    
    the image container, null if failed to read