DiskCachedCellImgOptions (ImgLib2 Javadocs 0-SNAPSHOT API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.scijava.optional.AbstractOptions<DiskCachedCellImgOptions>
- - net.imglib2.cache.img.DiskCachedCellImgOptions

All Implemented Interfaces:

AccessOptions<DiskCachedCellImgOptions>, CacheOptions<DiskCachedCellImgOptions>, CellDimensionsOptions<DiskCachedCellImgOptions>, DiskCacheOptions<DiskCachedCellImgOptions>, Options<DiskCachedCellImgOptions>
```
public class DiskCachedCellImgOptions
extends AbstractOptions<DiskCachedCellImgOptions>
implements AccessOptions<DiskCachedCellImgOptions>, CellDimensionsOptions<DiskCachedCellImgOptions>, CacheOptions<DiskCachedCellImgOptions>, DiskCacheOptions<DiskCachedCellImgOptions>
```
Optional parameters for constructing a DiskCachedCellImgFactory.

Author:

Tobias Pietzsch

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class DiskCachedCellImgOptions.Values
- Nested classes/interfaces inherited from class org.scijava.optional.AbstractOptions
  AbstractOptions.AbstractValues, AbstractOptions.ValuesToString
- Nested classes/interfaces inherited from interface net.imglib2.cache.img.optional.AccessOptions
  AccessOptions.Val
- Nested classes/interfaces inherited from interface net.imglib2.cache.img.optional.CellDimensionsOptions
  CellDimensionsOptions.Val
- Nested classes/interfaces inherited from interface net.imglib2.cache.img.optional.CacheOptions
  CacheOptions.CacheType, CacheOptions.Val
- Nested classes/interfaces inherited from interface net.imglib2.cache.img.optional.DiskCacheOptions
  DiskCacheOptions.Val

Field Summary

Fields
Modifier and Type Field and Description

DiskCachedCellImgOptions.Values values

Constructor Summary

Constructors
Constructor and Description

DiskCachedCellImgOptions()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected DiskCachedCellImgOptions`	`append(DiskCachedCellImgOptions additionalOptions)`
`protected DiskCachedCellImgOptions`	`copyOrThis()`
`DiskCachedCellImgOptions`	`dirtyAccesses(boolean dirty)` Specify whether the image should use `Dirty` accesses.
`static DiskCachedCellImgOptions`	`options()` Create default `DiskCachedCellImgOptions`.

Methods inherited from class org.scijava.optional.AbstractOptions
setValue, toString

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

Methods inherited from interface net.imglib2.cache.img.optional.AccessOptions
volatileAccesses

Methods inherited from interface net.imglib2.cache.img.optional.CellDimensionsOptions
cellDimensions

Methods inherited from interface net.imglib2.cache.img.optional.CacheOptions
cacheType, maxCacheSize

Methods inherited from interface net.imglib2.cache.img.optional.DiskCacheOptions
cacheDirectory, deleteCacheDirectoryOnExit, initializeCellsAsDirty, maxIoQueueSize, numIoThreads, tempDirectory, tempDirectoryPrefix

Methods inherited from interface org.scijava.optional.Options
setValue

- Field Detail
  - values
```
public final DiskCachedCellImgOptions.Values values
```
- Constructor Detail
  - DiskCachedCellImgOptions
```
public DiskCachedCellImgOptions()
```
- Method Detail
  - options
```
public static DiskCachedCellImgOptions options()
```
    Create default DiskCachedCellImgOptions.
    
    Returns:
    
    default DiskCachedCellImgOptions.
  - dirtyAccesses
```
public DiskCachedCellImgOptions dirtyAccesses(boolean dirty)
```
    Specify whether the image should use Dirty accesses. Dirty accesses track whether cells were written to. Only cells that were written to are (potentially) cached to disk.
    This is true by default.
    
    Specified by:
    
    dirtyAccesses in interface AccessOptions<DiskCachedCellImgOptions>
    
    Parameters:
    
    dirty - whether the image should use Dirty accesses.
  - append
```
protected DiskCachedCellImgOptions append(DiskCachedCellImgOptions additionalOptions)
```
    Overrides:
    
    append in class AbstractOptions<DiskCachedCellImgOptions>
  - copyOrThis
```
protected DiskCachedCellImgOptions copyOrThis()
```
    Overrides:
    
    copyOrThis in class AbstractOptions<DiskCachedCellImgOptions>

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015–2022 ImgLib2. All rights reserved.