Object

scalismo.io

ImageIO

Related Doc: package io

Permalink

object ImageIO

Implements methods for reading and writing D-dimensional images

WARNING! WE ARE USING an LPS WORLD COORDINATE SYSTEM

VTK file format does not indicate the orientation of the image. Therefore, when reading from VTK, we assume that it is in RAI orientation. Hence, no magic is done, the same information (coordinates) present in the VTK file header are directly mapped to our coordinate system.

This is also the case when writing VTK. Our image domain information (origin, spacing ..) is mapped directly into the written VTK file header.

This is however not the case for Nifti files! Nifti file headers contain an affine transform from the ijk image coordinates to an RAS World Coordinate System (therefore supporting different image orientations). In order to read Nifti files coherently, we need to adapt the obtained RAS coordinates to our LPS system :

This is done by mirroring the first two dimensions of each point after applying the affine transform

The same mirroring is done again when writing an image to the Nifti format.

Important for oblique images : The Nifti standard supports oblique images, that is images with a bounding box rotated compared to the world dimensions. Scalismo does not support such images. For such images, we offer the user a possibility to resample the image to a domain aligned with the world dimensions and with an RAI orientation. The integrity of the oblique image will be contained in the resampled one. This functionality can be activated by setting a flag appropriately in the scalismo.io.ImageIO.read3DScalarImage method.

Note on Nifti's qform and sform :

As mentioned above, the Nifti header contains a transform from the unit ijk grid to the RAS world coordinates of the grid. This transform can be encoded in 2 entries of the Nifti header, the qform and the sform. In some files, these 2 entries can both be present, and in some cases could even indicate different transforms. In Scalismo, when such a case happens, we favour the sform entry by default. If you wish instead to favour the qform transform, you can do so by setting a flag appropriately in the scalismo.io.ImageIO.read3DScalarImage method.

Documentation on orientation :

http://www.grahamwideman.com/gw/brain/orientation/orientterms.htm

http://www.slicer.org/slicerWiki/index.php/Coordinate_systems

http://brainder.org/2012/09/23/the-nifti-file-format/

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

Type Members

  1. trait WriteNifti[D <: Dim] extends AnyRef

    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. implicit object DiscreteScalarImage3DNifti extends WriteNifti[_3D]

    Permalink
  5. object ScalarType extends Enumeration

    Permalink

    An enumeration comprising all the data types that we can read and write, in VTK and Nifti formats.

  6. final def asInstanceOf[T0]: T0

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  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 read2DScalarImage[S](file: File)(implicit arg0: Scalar[S], arg1: ClassTag[S], arg2: scala.reflect.api.JavaUniverse.TypeTag[S]): Try[DiscreteScalarImage[_2D, S]]

    Permalink
  18. def read3DScalarImage[S](file: File, resampleOblique: Boolean = false, favourQform: Boolean = false)(implicit arg0: Scalar[S], arg1: scala.reflect.api.JavaUniverse.TypeTag[S], arg2: ClassTag[S]): Try[DiscreteScalarImage[_3D, S]]

    Permalink

    Read a 3D Scalar Image

    Read a 3D Scalar Image

    S

    Voxel type of the image

    file

    image file to be read

    resampleOblique

    flag to resample oblique images. This is only required when reading Nifti files containing an oblique image. See documentation above ImageIO.

    favourQform

    flag to favour the qform Nifti header entry over the sform one (which is by default favoured). See documentation above ImageIO.

  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( ... )
  24. def writeNifti[S](img: DiscreteScalarImage[_3D, S], file: File)(implicit arg0: Scalar[S], arg1: scala.reflect.api.JavaUniverse.TypeTag[S], arg2: ClassTag[S]): Try[Unit]

    Permalink
  25. def writeVTK[D <: Dim, S](img: DiscreteScalarImage[D, S], file: File)(implicit arg0: NDSpace[D], arg1: CanConvertToVtk[D], arg2: Scalar[S], arg3: scala.reflect.api.JavaUniverse.TypeTag[S], arg4: ClassTag[S]): Try[Unit]

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped