MetadataUtil (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.ops.MetadataUtil

```
public class MetadataUtil
extends Object
```
Utility class that allows to copy Metadata. It is the responsibility of the user to ensure that the source and target spaces have the correct dimensionality.

Author:

Christian Dietz (University of Konstanz), Michael Zinsmaier (University of Konstanz), Martin Horn (University of Konstanz)

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ImgPlusMetadata`	`copyAndCleanImgPlusMetadata(Interval inInterval, ImgPlusMetadata in, ImgPlusMetadata out)` copies all `ImgPlusMetadata` from in to out.
`static <C extends CalibratedAxis> CalibratedSpace<C>`	`copyAndCleanTypedSpace(Interval inInterval, CalibratedSpace<C> in, CalibratedSpace<C> out)` copies the CalibratedAxis attributes from in to out.
`static ImageMetadata`	`copyImageMetadata(ImageMetadata in, ImageMetadata out)` copies the ImageMetadata from in to out
`static ImgPlusMetadata`	`copyImgPlusMetadata(ImgPlusMetadata in, ImgPlusMetadata out)` copies all ImgPlus metadata `ImgPlusMetadata` from in to out.
`static Named`	`copyName(Named in, Named out)` copies the name from in to out
`static Sourced`	`copySource(Sourced in, Sourced out)` copies the source attribute from in to out
`static <C extends CalibratedAxis> CalibratedSpace<C>`	`copyTypedSpace(CalibratedSpace<C> in, CalibratedSpace<C> out)` copies the CalibratedSpace attributes from in to out.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

copySource

public static Sourced copySource(Sourced in,
                                 Sourced out)

copies the source attribute from in to out

Parameters:: in -; out -
Returns:: returns out

copyName

public static Named copyName(Named in,
                             Named out)

copies the name from in to out

Parameters:: in -; out -
Returns:: returns out

copyImageMetadata

public static ImageMetadata copyImageMetadata(ImageMetadata in,
                                              ImageMetadata out)

copies the ImageMetadata from in to out

Parameters:: in -; out -
Returns:: returns out

copyTypedSpace

public static <C extends CalibratedAxis> CalibratedSpace<C> copyTypedSpace(CalibratedSpace<C> in,
                                                                           CalibratedSpace<C> out)

copies the CalibratedSpace attributes from in to out. Both spaces must have the same dimensionality.

Parameters:: in -; out -
Returns:: returns out

copyImgPlusMetadata

public static ImgPlusMetadata copyImgPlusMetadata(ImgPlusMetadata in,
                                                  ImgPlusMetadata out)

copies all ImgPlus metadata ImgPlusMetadata from in to out. The CalibratedSpace of in and out must have the same dimensionality.

Parameters:: in -; out -
Returns:: returns out

copyAndCleanTypedSpace

public static <C extends CalibratedAxis> CalibratedSpace<C> copyAndCleanTypedSpace(Interval inInterval,
                                                                                   CalibratedSpace<C> in,
                                                                                   CalibratedSpace<C> out)

copies the CalibratedAxis attributes from in to out. Attributes for dimensions of size 1 are removed during copying. The dimensionality of the out space must be dimensionality(inSpace) - #removed dims

Parameters:: inInterval - provides dimensionality information for the in space; in -; out -
Returns:: returns out

copyAndCleanImgPlusMetadata

public static ImgPlusMetadata copyAndCleanImgPlusMetadata(Interval inInterval,
                                                          ImgPlusMetadata in,
                                                          ImgPlusMetadata out)

copies all ImgPlusMetadata from in to out. CalibratedSpace attributes for dimensions of size 1 are removed during copying. The dimensionality of the out space must be dimensionality(inSpace) - #removed dims

Parameters:: inInterval - provides dimensionality information for the in space; in -; out -
Returns:: returns out

Class MetadataUtil