Package gov.nih.mipav.plugins

Interface PlugInFile

  • All Superinterfaces:
    PlugIn
    public interface PlugInFile
extends PlugIn
    An interface for a plugin which reads/writes images.
    Author:
    mccreedy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String[] CATEGORY  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean canReadImages()
      Returns whether this plugin supports reading of images in its format.
      boolean canWriteImages()
      Returns whether this plugin supports writing of images in its format.
      boolean isExtensionSupported​(java.lang.String ext)
      Checks whether a particular file extension is supported by this plugin.
      void readImage()
      Read an image of the type handled by this plugin.
      void writeImage​(ModelImage image)
      Write an image out to the file type handled by this plugin.

    • Field Detail

      • CATEGORY

        static final java.lang.String[] CATEGORY

    • Method Detail

      • canReadImages

        boolean canReadImages()
        Returns whether this plugin supports reading of images in its format.
        Returns:
        whether this plugin supports reading of images

      • canWriteImages

        boolean canWriteImages()
        Returns whether this plugin supports writing of images in its format.
        Returns:
        whether this plugin supports writing of images

      • isExtensionSupported

        boolean isExtensionSupported​(java.lang.String ext)
        Checks whether a particular file extension is supported by this plugin.
        Parameters:
        ext - the file extension to check
        Returns:
        whether the extension is supported

      • readImage

        void readImage()
        Read an image of the type handled by this plugin. The plugin should get the path to the file from the user.

      • writeImage

        void writeImage​(ModelImage image)
        Write an image out to the file type handled by this plugin. The plugin should get the path to write to from the user.
        Parameters:
        image - the image to write out