Package adams.flow.transformer

Class ImageFileReader

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class ImageFileReader
extends AbstractTransformer
    Reads any file format that the specified image reader supports.
    If meta-data is associated with the image, then this can be loaded as well.

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
    - generates:
       adams.data.image.AbstractImageContainer


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ImageReader
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -reader <adams.data.io.input.AbstractImageReader> (property: reader)
    The image reader to use.
    default: adams.data.io.input.JAIImageReader
 
    -load-meta-data <boolean> (property: loadMetaData)
    If enabled, loading of meta-data is attempted.
    default: false
 
    -meta-data-location <SAME_NAME|STARTING_WITH> (property: metaDataLocation)
    The location of the meta-data.
    default: SAME_NAME
 
    -meta-data-reader <adams.data.io.input.AbstractReportReader> (property: metaDataReader)
    The reader to use for the meta-data.
    default: adams.data.io.input.DefaultSimpleReportReader
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Reader

        protected ImageReader m_Reader
        the image reader to use.

      • m_LoadMetaData

        protected boolean m_LoadMetaData
        whether to load the meta-data as well (if present).

    • Constructor Detail

      • ImageFileReader

        public ImageFileReader()

    • Method Detail

      • setReader

        public void setReader​(ImageReader value)
        Sets the reader to use.
        Parameters:
        value - the reader

      • getReader

        public ImageReader getReader()
        Returns the reader to use.
        Returns:
        the reader

      • readerTipText

        public String readerTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setLoadMetaData

        public void setLoadMetaData​(boolean value)
        Sets whether to load available meta-data.
        Parameters:
        value - true if to load meta-data

      • getLoadMetaData

        public boolean getLoadMetaData()
        Returns whether to load available meta-data.
        Returns:
        true if to load meta-data

      • loadMetaDataTipText

        public String loadMetaDataTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • metaDataLocationTipText

        public String metaDataLocationTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setMetaDataReader

        public void setMetaDataReader​(AbstractReportReader value)
        Sets the reader to use for the meta-data.
        Parameters:
        value - the reader

      • getMetaDataReader

        public AbstractReportReader getMetaDataReader()
        Returns the reader to use for the meta-data.
        Returns:
        the reader

      • metaDataReaderTipText

        public String metaDataReaderTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        adams.data.image.AbstractImageContainer.class

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message