AbstractImgLoader (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- spim.fiji.spimdata.imgloaders.AbstractImgLoader

All Implemented Interfaces:

LegacyBasicImgLoader<UnsignedShortType>, LegacyImgLoader<UnsignedShortType>

Direct Known Subclasses:

AbstractImgFactoryImgLoader, LegacyDHMImgLoader, LegacyMicroManagerImgLoader
```
public abstract class AbstractImgLoader
extends Object
implements LegacyImgLoader<UnsignedShortType>
```

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractImgLoader()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractImgLoader()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Dimensions`	`getImageSize(ViewId view)` Get the size of an image.
`UnsignedShortType`	`getImageType()`
`VoxelDimensions`	`getVoxelSize(ViewId view)` Get the voxel size of an image.
`protected abstract void`	`loadMetaData(ViewId view)` Loads only the metadata from the image, should call updateMetaDataCache( ...
`protected static void`	`normalize(Img<FloatType> img)`
`protected void`	`updateMetaDataCache(ViewId viewId, int w, int h, int d, double calX, double calY, double calZ)` Updates the cached imageMetaData
`void`	`updateXMLMetaData(List<? extends ViewSetup> setups, boolean forceUpdate)` Updates a list of ViewSetups using the imageMetaDataCache
`void`	`updateXMLMetaData(SpimData data, boolean forceUpdate)` Updates the ViewSetups using the imageMetaDataCache
`boolean`	`updateXMLMetaData(ViewSetup setup, boolean forceUpdate)` Updates one specific ViewSetup using the imageMetaDataCache

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

Methods inherited from interface mpicbg.spim.data.legacy.LegacyImgLoader
getFloatImage

Methods inherited from interface mpicbg.spim.data.legacy.LegacyBasicImgLoader
getImage

- Constructor Detail
  - AbstractImgLoader
```
protected AbstractImgLoader()
```
- Method Detail
  - updateMetaDataCache
```
protected void updateMetaDataCache(ViewId viewId,
                                   int w,
                                   int h,
                                   int d,
                                   double calX,
                                   double calY,
                                   double calZ)
```
    Updates the cached imageMetaData
  - loadMetaData
```
protected abstract void loadMetaData(ViewId view)
```
    Loads only the metadata from the image, should call updateMetaDataCache( ... )
    
    Parameters:
    
    view -
  - getImageSize
```
public Dimensions getImageSize(ViewId view)
```
    Description copied from interface: LegacyImgLoader
    
    Get the size of an image. If possible, load only the meta-data for the specified view. Note, that this should not get the meta-data from the SequenceDescription but pull it from the image file.
    
    Specified by:
    
    getImageSize in interface LegacyImgLoader<UnsignedShortType>
    
    Parameters:
    
    view - timepoint and setup for which to retrieve the image size.
    
    Returns:
    
    the image size, or null if it could not be determined.
  - getVoxelSize
```
public VoxelDimensions getVoxelSize(ViewId view)
```
    Description copied from interface: LegacyImgLoader
    
    Get the voxel size of an image. If possible, load only the meta-data for the specified view. Note, that this should not get the meta-data from the SequenceDescription but pull it from the image file.
    
    Specified by:
    
    getVoxelSize in interface LegacyImgLoader<UnsignedShortType>
    
    Parameters:
    
    view - timepoint and setup for which to retrieve the voxel size.
    
    Returns:
    
    the voxel size, or null if it could not be determined.
  - getImageType
```
public UnsignedShortType getImageType()
```
    Specified by:
    
    getImageType in interface LegacyBasicImgLoader<UnsignedShortType>
  - updateXMLMetaData
```
public void updateXMLMetaData(SpimData data,
                              boolean forceUpdate)
```
    Updates the ViewSetups using the imageMetaDataCache
    
    Parameters:
    
    data - - the SpimData object that contains all ViewSetups can could be potentially updated
    
    forceUpdate - - overwrite the data if it is already present
  - updateXMLMetaData
```
public void updateXMLMetaData(List<? extends ViewSetup> setups,
                              boolean forceUpdate)
```
    Updates a list of ViewSetups using the imageMetaDataCache
    
    Parameters:
    
    setups - - a list of ViewSetups can could be potentially updated
    
    forceUpdate - - overwrite the data if it is already present
  - updateXMLMetaData
```
public boolean updateXMLMetaData(ViewSetup setup,
                                 boolean forceUpdate)
```
    Updates one specific ViewSetup using the imageMetaDataCache
    
    Parameters:
    
    setup - - ViewSetups that can potentially be updated if it is in the cache
    
    forceUpdate - - overwrite the data if it is already present
    
    Returns:
    
    true if something was updated, false if it was not in the cache or if could have been updated but was already there
  - normalize
```
protected static final void normalize(Img<FloatType> img)
```

Class AbstractImgLoader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface mpicbg.spim.data.legacy.LegacyImgLoader

Methods inherited from interface mpicbg.spim.data.legacy.LegacyBasicImgLoader

Constructor Detail

AbstractImgLoader

Method Detail

updateMetaDataCache

loadMetaData

getImageSize

getVoxelSize

getImageType

updateXMLMetaData

updateXMLMetaData

updateXMLMetaData

normalize