Trait/Object

scalismo.statisticalmodel.asm

Hdf5IOHandler

Related Docs: object Hdf5IOHandler | package asm

Permalink

trait Hdf5IOHandler[T <: HasIOMetadata] extends AnyRef

Trait providing methods for serializing/deserializing objects of type T to/from HDF5 files.

T

the type of objects which can be constructed from the information present in HDF5 files, and saved into such files.

Linear Supertypes
AnyRef, Any
Known Subclasses
FeatureExtractorIOHandler, GaussianGradientImagePreprocessorIOHandler, IOHandler, IdentityImagePreprocessorIOHandler, ImagePreprocessorIOHandler, NormalDirectionFeatureExtractorIOHandler
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hdf5IOHandler
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def load(meta: IOMetadata, h5File: HDF5File, h5Group: Group): Try[T]

    Permalink

    Load (instantiate) an object of type T from the information in an HDF5 file.

    Load (instantiate) an object of type T from the information in an HDF5 file. The IO metadata present in the file, as well as the file and group with the file, are provided as arguments, so that implementations can read additional data that might be required for correct object instantiation.

    meta

    IO Metadata about the concrete implementation, as present in the HDF5 file.

    h5File

    the HDF5 file containing the information about the object to be constructed.

    h5Group

    the HDF5 group containing the information about the object to be constructed.

    returns

    an object of type T corresponding to the provided IO metadata and initialized according to the information present in the file (wrapped in a Success]), or a Failure indicating the cause of the failure

Concrete 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. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink

    Save all required information about an object to an HDF5 file, so that the object can later be reconstructed using the Hdf5IOHandler.load method.

    Save all required information about an object to an HDF5 file, so that the object can later be reconstructed using the Hdf5IOHandler.load method. Note that implementations do not need to care about saving the object's IO metadata, as this is taken care of by the framework. Thus, if the object to be stored does not require any further parameterization, this method does not need to be overridden (there is a default no-op implementation). Otherwise, it is strongly advised to follow these rules in the implementation:

    - Do not write data anywhere except in the provided group (or subgroups thereof). In other words, do not store data in parent of sibling groups of h5Group. - Do not store attributes directly attached to h5Group, as they might clash with the attributes used internally by the framework. - There are no further limitations, i.e., you are free to create values and subgroups, or anything else, in h5Grouph5Group itself.

    t

    the object about which information is to be stored.

    h5File

    the HDF5 file to save the information to.

    h5Group

    the group under which to save the information in the HDF5 file.

    returns

    Success or Failure

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

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

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

  19. final def wait(arg0: Long, arg1: Int): Unit

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

  20. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped