Class

scalismo.statisticalmodel.asm

IOHandlers

Related Doc: package asm

Permalink

class IOHandlers[T <: HasIOMetadata, IO <: IOHandler[T]] extends AnyRef

An object representing a collection of IO handlers providing load/save capabilities for a given object type. If there are multiple implementations for the given type (e.g., multiple image preprocessor implementations, multiple feature extractor implementations), they are distinguished (and uniquely identified) by their IO Identifiers (see HasIOIdentifier).

For every supported IO Identifier, a corresponding IOHandler must be registered using the register() method. The identifiers/handlers that come built into scalismo are automatically registered and available, but manual registration is required for user-defined handlers.

T

the type of objects that can be loaded/saved

IO

the type of the corresponding IO handlers

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. IOHandlers
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IOHandlers()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def find(identifier: String): Try[IO]

    Permalink

    Find the handler corresponding to the given IO identifier.

    Find the handler corresponding to the given IO identifier.

    identifier

    an IO identifier.

    returns

    the corresponding IO handler, or a Failure if no handler was registered for the identifier.

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. def load(h5File: HDF5File, h5Group: Group): Try[T]

    Permalink

    Convenience method to load an object from an HDF5 group.

    Convenience method to load an object from an HDF5 group. This method loads the IO metadata from the file, then uses the list of registered handlers to automatically find the corresponding IO handler, and finally uses that handler to load the object.

    h5File

    the HDF5 file containing the group.

    h5Group

    the HDF5 group within the file to load the object from.

    returns

    the object corresponding to the information in the HDF5 group.

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. def register(handler: IO): Unit

    Permalink

    Register an IO handler to make it available for loading and saving object instances.

    Register an IO handler to make it available for loading and saving object instances.

    handler

    the IO Handler to register.

  18. def save(t: T, h5File: HDF5File, h5Group: Group): Try[Unit]

    Permalink

    Convenience method to store an object to an HDF5 group.

    Convenience method to store an object to an HDF5 group. This method uses the list of registered handlers to automatically find the correct IO handler, then saves the object's metadata and uses the IO handler to save the object.

    t

    the object to save.

    h5File

    the HDF5 file containing the group.

    h5Group

    the HDF5 group to save the object to.

    returns

    Success or Failure

  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped