NativeBoolType (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.type.numeric.complex.AbstractComplexType<T>
- - net.imglib2.type.numeric.real.AbstractRealType<T>
  - - net.imglib2.type.numeric.integer.AbstractIntegerType<NativeBoolType>
    - - net.imglib2.type.logic.NativeBoolType

All Implemented Interfaces:

Comparable<NativeBoolType>, BooleanType<NativeBoolType>, NativeType<NativeBoolType>, ComplexType<NativeBoolType>, IntegerType<NativeBoolType>, NumericType<NativeBoolType>, RealType<NativeBoolType>, Add<NativeBoolType>, Div<NativeBoolType>, Mul<NativeBoolType>, MulFloatingPoint, Pow<NativeBoolType>, PowFloatingPoint, SetOne, SetZero, Sub<NativeBoolType>, ValueEquals<NativeBoolType>, Type<NativeBoolType>
```
public class NativeBoolType
extends AbstractIntegerType<NativeBoolType>
implements BooleanType<NativeBoolType>, NativeType<NativeBoolType>
```
NativeType backed by boolean.

Author:

Curtis Rueden

Field Summary

Fields
Modifier and Type Field and Description

protected BooleanAccess dataAccess

protected NativeImg<?,? extends BooleanAccess> img

Fields
Modifier and Type	Field and Description
`protected BooleanAccess`	`dataAccess`
`protected NativeImg<?,? extends BooleanAccess>`	`img`

Constructor Summary

Constructors
Constructor and Description
`NativeBoolType()`
`NativeBoolType(boolean value)`
`NativeBoolType(BooleanAccess access)`
`NativeBoolType(NativeImg<?,? extends BooleanAccess> boolStorage)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(NativeBoolType c)`
`void`	`and(NativeBoolType c)`
`int`	`compareTo(NativeBoolType c)`
`NativeBoolType`	`copy()` Creates a new `Type` variable that has the value of this `Type`
`NativeBoolType`	`createVariable()` Creates a new `Type` variable which can only store one value.
`void`	`dec()`
`void`	`div(NativeBoolType c)`
`NativeBoolType`	`duplicateTypeOnSameNativeImg()` Creates a new `NativeType` which stores in the same physical array.
`boolean`	`equals(Object obj)`
`boolean`	`get()` Returns the primitive boolean value that is used to store this type.
`BigInteger`	`getBigInteger()`
`int`	`getBitsPerPixel()`
`Fraction`	`getEntitiesPerPixel()` Get the number of entities in the storage array required to store one pixel value.
`int`	`getInteger()`
`long`	`getIntegerLong()`
`double`	`getMaxValue()`
`double`	`getMinValue()`
`NativeTypeFactory<NativeBoolType,BooleanAccess>`	`getNativeTypeFactory()`
`int`	`hashCode()`
`void`	`inc()`
`Index`	`index()` Get the (modifiable) index into the current data array.
`void`	`mul(double c)`
`void`	`mul(float c)`
`void`	`mul(NativeBoolType c)`
`void`	`not()`
`void`	`or(NativeBoolType c)`
`void`	`set(boolean f)` Sets the primitive boolean value that is used to store this type.
`void`	`set(NativeBoolType c)` Sets the value of another `Type`.
`void`	`setBigInteger(BigInteger b)`
`void`	`setInteger(int f)`
`void`	`setInteger(long f)`
`void`	`setOne()`
`void`	`setZero()`
`void`	`sub(NativeBoolType c)`
`String`	`toString()`
`void`	`updateContainer(Object c)` This method is used by an accessor (e.g., a `Cursor`) to request an update of the current data array.
`boolean`	`valueEquals(NativeBoolType t)`
`void`	`xor(NativeBoolType c)`

Methods inherited from class net.imglib2.type.numeric.integer.AbstractIntegerType
getMinIncrement, getRealDouble, getRealFloat, setReal, setReal

Methods inherited from class net.imglib2.type.numeric.real.AbstractRealType
getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, pow, pow, setImaginary, setImaginary

Methods inherited from class net.imglib2.type.numeric.complex.AbstractComplexType
complexConjugate, setComplexNumber, setComplexNumber

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

Methods inherited from interface net.imglib2.type.numeric.RealType
getMinIncrement

Methods inherited from interface net.imglib2.type.numeric.ComplexType
complexConjugate, getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, getRealDouble, getRealFloat, setComplexNumber, setComplexNumber, setImaginary, setImaginary, setReal, setReal

Methods inherited from interface net.imglib2.type.operators.Pow
pow

Methods inherited from interface net.imglib2.type.operators.PowFloatingPoint
pow

Methods inherited from interface net.imglib2.type.NativeType
decIndex, decIndex, getIndex, incIndex, incIndex, updateIndex

- Field Detail
  - img
```
protected final NativeImg<?,? extends BooleanAccess> img
```
  - dataAccess
```
protected BooleanAccess dataAccess
```
- Constructor Detail
  - NativeBoolType
```
public NativeBoolType(NativeImg<?,? extends BooleanAccess> boolStorage)
```
  - NativeBoolType
```
public NativeBoolType(boolean value)
```
  - NativeBoolType
```
public NativeBoolType(BooleanAccess access)
```
  - NativeBoolType
```
public NativeBoolType()
```
- Method Detail
  - getNativeTypeFactory
```
public NativeTypeFactory<NativeBoolType,BooleanAccess> getNativeTypeFactory()
```
    Specified by:
    
    getNativeTypeFactory in interface NativeType<NativeBoolType>
  - duplicateTypeOnSameNativeImg
```
public NativeBoolType duplicateTypeOnSameNativeImg()
```
    Description copied from interface: NativeType
    
    Creates a new NativeType which stores in the same physical array. This is only used internally.
    
    Specified by:
    
    duplicateTypeOnSameNativeImg in interface NativeType<NativeBoolType>
    
    Returns:
    
    a new NativeType instance working on the same NativeImg
  - getEntitiesPerPixel
```
public Fraction getEntitiesPerPixel()
```
    Description copied from interface: NativeType
    
    Get the number of entities in the storage array required to store one pixel value. A pixel value may be spread over several or less than one entity. For example, a complex number may require 2 entries of a float[] array to store one pixel. Or a 12-bit type might need 12/64th entries of a long[] array.
    
    Specified by:
    
    getEntitiesPerPixel in interface NativeType<NativeBoolType>
    
    Returns:
    
    the number of storage type entities required to store one pixel value.
  - updateContainer
```
public void updateContainer(Object c)
```
    Description copied from interface: NativeType
    
    This method is used by an accessor (e.g., a Cursor) to request an update of the current data array.
    As an example consider a CellCursor moving on a CellImg. The cursor maintains a NativeType which provides access to the image data. When the cursor moves from one cell to the next, the underlying data array of the NativeType must be switched to the data array of the new cell.
    
    To achieve this, the CellCursor calls updateContainer() with itself as the argument. updateContainer() in turn will call NativeImg.update(Object) on it's container, passing along the reference to the cursor. In this example, the container would be a CellImg. While the NativeType does not know about the type of the cursor, the container does. CellImg knows that it is passed a CellCursor instance, which can be used to figure out the current cell and the underlying data array, which is then returned to the NativeType.
    
    The idea behind this concept is maybe not obvious. The NativeType knows which basic type is used (float, int, byte, ...). However, it does not know how the data is stored (ArrayImg, CellImg, ...). This prevents the need for multiple implementations of NativeType .
    
    Specified by:
    
    updateContainer in interface NativeType<NativeBoolType>
    
    Parameters:
    
    c - reference to an accessor which can be passed on to the container (which will know what to do with it).
  - index
```
public Index index()
```
    Description copied from interface: NativeType
    
    Get the (modifiable) index into the current data array. The returned instance will always be the same for the same Type.
    
    Specified by:
    
    index in interface NativeType<NativeBoolType>
  - get
```
public boolean get()
```
    Returns the primitive boolean value that is used to store this type.
    
    Specified by:
    
    get in interface BooleanType<NativeBoolType>
    
    Returns:
    
    primitive boolean value
  - set
```
public void set(boolean f)
```
    Sets the primitive boolean value that is used to store this type.
    
    Specified by:
    
    set in interface BooleanType<NativeBoolType>
  - set
```
public void set(NativeBoolType c)
```
    Description copied from interface: Type
    
    Sets the value of another Type.
    
    Specified by:
    
    set in interface Type<NativeBoolType>
    
    Overrides:
    
    set in class AbstractRealType<NativeBoolType>
    
    Parameters:
    
    c - the new value
  - and
```
public void and(NativeBoolType c)
```
    Specified by:
    
    and in interface BooleanType<NativeBoolType>
  - or
```
public void or(NativeBoolType c)
```
    Specified by:
    
    or in interface BooleanType<NativeBoolType>
  - xor
```
public void xor(NativeBoolType c)
```
    Specified by:
    
    xor in interface BooleanType<NativeBoolType>
  - not
```
public void not()
```
    Specified by:
    
    not in interface BooleanType<NativeBoolType>
  - add
```
public void add(NativeBoolType c)
```
    Specified by:
    
    add in interface Add<NativeBoolType>
    
    Overrides:
    
    add in class AbstractRealType<NativeBoolType>
  - div
```
public void div(NativeBoolType c)
```
    Specified by:
    
    div in interface Div<NativeBoolType>
    
    Overrides:
    
    div in class AbstractRealType<NativeBoolType>
  - mul
```
public void mul(NativeBoolType c)
```
    Specified by:
    
    mul in interface Mul<NativeBoolType>
    
    Overrides:
    
    mul in class AbstractRealType<NativeBoolType>
  - sub
```
public void sub(NativeBoolType c)
```
    Specified by:
    
    sub in interface Sub<NativeBoolType>
    
    Overrides:
    
    sub in class AbstractRealType<NativeBoolType>
  - mul
```
public void mul(float c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
    
    Overrides:
    
    mul in class AbstractRealType<NativeBoolType>
  - mul
```
public void mul(double c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
    
    Overrides:
    
    mul in class AbstractRealType<NativeBoolType>
  - setOne
```
public void setOne()
```
    Specified by:
    
    setOne in interface SetOne
    
    Overrides:
    
    setOne in class AbstractIntegerType<NativeBoolType>
  - setZero
```
public void setZero()
```
    Specified by:
    
    setZero in interface SetZero
    
    Overrides:
    
    setZero in class AbstractIntegerType<NativeBoolType>
  - inc
```
public void inc()
```
    Specified by:
    
    inc in interface RealType<NativeBoolType>
    
    Overrides:
    
    inc in class AbstractIntegerType<NativeBoolType>
  - dec
```
public void dec()
```
    Specified by:
    
    dec in interface RealType<NativeBoolType>
    
    Overrides:
    
    dec in class AbstractIntegerType<NativeBoolType>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractIntegerType<NativeBoolType>
  - getBitsPerPixel
```
public int getBitsPerPixel()
```
    Specified by:
    
    getBitsPerPixel in interface RealType<NativeBoolType>
  - valueEquals
```
public boolean valueEquals(NativeBoolType t)
```
    Specified by:
    
    valueEquals in interface ValueEquals<NativeBoolType>
    
    Overrides:
    
    valueEquals in class AbstractIntegerType<NativeBoolType>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AbstractIntegerType<NativeBoolType>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractIntegerType<NativeBoolType>
  - compareTo
```
public int compareTo(NativeBoolType c)
```
    Specified by:
    
    compareTo in interface Comparable<NativeBoolType>
    
    Overrides:
    
    compareTo in class AbstractIntegerType<NativeBoolType>
  - createVariable
```
public NativeBoolType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type variable which can only store one value.
    
    Specified by:
    
    createVariable in interface Type<NativeBoolType>
    
    Returns:
    
    a new Type variable
  - copy
```
public NativeBoolType copy()
```
    Description copied from interface: Type
    
    Creates a new Type variable that has the value of this Type
    
    Specified by:
    
    copy in interface Type<NativeBoolType>
    
    Returns:
    
    a new Type variable
  - getMaxValue
```
public double getMaxValue()
```
    Specified by:
    
    getMaxValue in interface RealType<NativeBoolType>
  - getMinValue
```
public double getMinValue()
```
    Specified by:
    
    getMinValue in interface RealType<NativeBoolType>
  - getInteger
```
public int getInteger()
```
    Specified by:
    
    getInteger in interface IntegerType<NativeBoolType>
  - getIntegerLong
```
public long getIntegerLong()
```
    Specified by:
    
    getIntegerLong in interface IntegerType<NativeBoolType>
  - getBigInteger
```
public BigInteger getBigInteger()
```
    Specified by:
    
    getBigInteger in interface IntegerType<NativeBoolType>
  - setInteger
```
public void setInteger(int f)
```
    Specified by:
    
    setInteger in interface IntegerType<NativeBoolType>
  - setInteger
```
public void setInteger(long f)
```
    Specified by:
    
    setInteger in interface IntegerType<NativeBoolType>
  - setBigInteger
```
public void setBigInteger(BigInteger b)
```
    Specified by:
    
    setBigInteger in interface IntegerType<NativeBoolType>

Class NativeBoolType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.type.numeric.integer.AbstractIntegerType

Methods inherited from class net.imglib2.type.numeric.real.AbstractRealType

Methods inherited from class net.imglib2.type.numeric.complex.AbstractComplexType

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.type.numeric.RealType

Methods inherited from interface net.imglib2.type.numeric.ComplexType

Methods inherited from interface net.imglib2.type.operators.Pow

Methods inherited from interface net.imglib2.type.operators.PowFloatingPoint

Methods inherited from interface net.imglib2.type.NativeType

Field Detail

img

dataAccess

Constructor Detail

NativeBoolType

NativeBoolType

NativeBoolType

NativeBoolType

Method Detail

getNativeTypeFactory

duplicateTypeOnSameNativeImg

getEntitiesPerPixel

updateContainer

index

get

set

set

and

or

xor

not

add

div

mul

sub

mul

mul

setOne

setZero

inc

dec

toString

getBitsPerPixel

valueEquals

equals

hashCode

compareTo

createVariable

copy

getMaxValue

getMinValue

getInteger

getIntegerLong

getBigInteger

setInteger

setInteger

setBigInteger