NiftiTextureContent (Artisynth API documentation)

java.lang.Object
- maspack.util.ReferenceCountedBase
- - maspack.image.nifti.NiftiTextureContent

All Implemented Interfaces:: TextureContent, ReferenceCounted

public class NiftiTextureContent
extends ReferenceCountedBase
implements TextureContent

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NiftiTextureContent.ImagePanel
Simple class to help debug storage
- Nested classes/interfaces inherited from interface maspack.render.TextureContent
  TextureContent.ContentFormat

Nested Classes
Modifier and Type	Class and Description
`static class`	`NiftiTextureContent.ImagePanel` Simple class to help debug storage

Field Summary

Fields
Modifier and Type Field and Description

static int COL_ROW_PLANE

static int COL_SLICE_PLANE

static int ROW_SLICE_PLANE

Fields
Modifier and Type	Field and Description
`static int`	`COL_ROW_PLANE`
`static int`	`COL_SLICE_PLANE`
`static int`	`ROW_SLICE_PLANE`

Constructor Summary

Constructors
Constructor and Description

NiftiTextureContent(NiftiImage image, NiftiPixelGenerator voxelator)

Constructors
Constructor and Description
`NiftiTextureContent(NiftiImage image, NiftiPixelGenerator voxelator)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NiftiTextureContent`	`acquire()` Signal the resource that something is holding a reference to it.
`java.awt.image.BufferedImage`	`createImage()`
`void`	`dispose()`
`int`	`getColumn()`
`void`	`getData(java.nio.ByteBuffer out)` Get raw byte data of content, rasterized in row-major form, with (0,0) in the bottom-left corner.
`void`	`getData(Rectangle rect, java.nio.ByteBuffer out)` Get raw byte data for a region, rasterized in row-major form with (0,0) in the bottom-left corner.
`Rectangle`	`getDirty()` The portion of the texture that has been modified (marked "dirty")
`TextureContent.ContentFormat`	`getFormat()` Format of data returned by `TextureContent.getData(java.nio.ByteBuffer)`
`int`	`getHeight()` Number of pixels across height in content
`java.lang.Object`	`getKey()` A key for referring to this texture.
`NiftiPixelGenerator`	`getPixelGenerator()`
`int`	`getPixelSize()` Size of pixels in bytes
`int`	`getRow()`
`int`	`getSlice()`
`double`	`getT()` Normalized time to use
`Point2d[]`	`getTextureCoordinates(int plane)` Texture coordinates for a given plane (`COL_ROW_PLANE`, `ROW_SLICE_PLANE`, or `COL_SLICE_PLANE`), starting with the bottom-left corner and working around clockwise.
`int`	`getTime()`
`int`	`getWidth()` Number of pixels across width in content
`double`	`getX()` Normalized row-slice plane position within volume
`double`	`getY()` Normalized col-slice plane position within volume
`double`	`getZ()` Normalized col-row plane position within volume
`boolean`	`isDirty()` All or part of the texture has been marked as "dirty" (i.e.
`void`	`markClean()` Mark the entire texture as being clean
`void`	`prerender()` Prepares texture content for rendering
`void`	`setColumn(int c)` column to use for the row-slice plane
`void`	`setPixelGenerator(NiftiPixelGenerator voxelator)`
`void`	`setRow(int r)` Row to use for the column-slice plane
`void`	`setSlice(int s)` Slice to use on col-row plane
`void`	`setT(double t)` Normalized time to use
`void`	`setTime(int t)` For 4D DICOM images, sets the time index for all slices
`void`	`setX(double x)` Normalized row-slice plane position within volume
`void`	`setY(double y)` Normalized col-slice plane position within volume
`void`	`setZ(double z)` Normalized col-row plane position within volume
`void`	`showTexture()`

Methods inherited from class maspack.util.ReferenceCountedBase
acquireAndCount, getReferenceCount, release, releaseAndCount

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

Methods inherited from interface maspack.util.ReferenceCounted
acquireAndCount, getReferenceCount, release, releaseAndCount

- Field Detail
  - COL_ROW_PLANE
```
public static final int COL_ROW_PLANE
```
    See Also:
    
    Constant Field Values
  - COL_SLICE_PLANE
```
public static final int COL_SLICE_PLANE
```
    See Also:
    
    Constant Field Values
  - ROW_SLICE_PLANE
```
public static final int ROW_SLICE_PLANE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NiftiTextureContent
```
public NiftiTextureContent(NiftiImage image,
                           NiftiPixelGenerator voxelator)
```
- Method Detail
  - setColumn
```
public void setColumn(int c)
```
    column to use for the row-slice plane
    
    Parameters:
    
    c - column index
  - getColumn
```
public int getColumn()
```
    Returns:
    
    column for the row-slice plane
  - setRow
```
public void setRow(int r)
```
    Row to use for the column-slice plane
    
    Parameters:
    
    r - row index
  - getRow
```
public int getRow()
```
    Returns:
    
    column used on row-slice plane
  - setSlice
```
public void setSlice(int s)
```
    Slice to use on col-row plane
    
    Parameters:
    
    s - slice index
  - getSlice
```
public int getSlice()
```
    Returns:
    
    slice to use on the col-row plane
  - setTime
```
public void setTime(int t)
```
    For 4D DICOM images, sets the time index for all slices
    
    Parameters:
    
    t - time index
  - getTime
```
public int getTime()
```
    Returns:
    
    time index for slices
  - setX
```
public void setX(double x)
```
    Normalized row-slice plane position within volume
    
    Parameters:
    
    x - normalized column [0,1]
  - getX
```
public double getX()
```
    Normalized row-slice plane position within volume
    
    Returns:
    
    normalized column [0,1]
  - setY
```
public void setY(double y)
```
    Normalized col-slice plane position within volume
    
    Parameters:
    
    y - normalized row [0,1]
  - getY
```
public double getY()
```
    Normalized col-slice plane position within volume
    
    Returns:
    
    normalized row [0,1]
  - setZ
```
public void setZ(double z)
```
    Normalized col-row plane position within volume
    
    Parameters:
    
    z - normalized slice [0,1]
  - getZ
```
public double getZ()
```
    Normalized col-row plane position within volume
    
    Returns:
    
    normalized slice [0,1]
  - setT
```
public void setT(double t)
```
    Normalized time to use
    
    Parameters:
    
    t - normalized time [0,1]
  - getT
```
public double getT()
```
    Normalized time to use
    
    Returns:
    
    normalized time [0,1]
  - getWidth
```
public int getWidth()
```
    Description copied from interface: TextureContent
    
    Number of pixels across width in content
    
    Specified by:
    
    getWidth in interface TextureContent
    
    Returns:
    
    number of pixels
  - getHeight
```
public int getHeight()
```
    Description copied from interface: TextureContent
    
    Number of pixels across height in content
    
    Specified by:
    
    getHeight in interface TextureContent
    
    Returns:
    
    number of pixels
  - getTextureCoordinates
```
public Point2d[] getTextureCoordinates(int plane)
```
    Texture coordinates for a given plane (COL_ROW_PLANE, ROW_SLICE_PLANE, or COL_SLICE_PLANE), starting with the bottom-left corner and working around clockwise.
    
    Parameters:
    
    plane - plane index to compute coordinates of
    
    Returns:
    
    texture coordinates
  - getPixelSize
```
public int getPixelSize()
```
    Description copied from interface: TextureContent
    
    Size of pixels in bytes
    
    Specified by:
    
    getPixelSize in interface TextureContent
    
    Returns:
    
    size
  - setPixelGenerator
```
public void setPixelGenerator(NiftiPixelGenerator voxelator)
```
  - getPixelGenerator
```
public NiftiPixelGenerator getPixelGenerator()
```
  - prerender
```
public void prerender()
```
    Prepares texture content for rendering
  - getData
```
public void getData(java.nio.ByteBuffer out)
```
    Description copied from interface: TextureContent
    
    Get raw byte data of content, rasterized in row-major form, with (0,0) in the bottom-left corner.
    
    Specified by:
    
    getData in interface TextureContent
  - getData
```
public void getData(Rectangle rect,
                    java.nio.ByteBuffer out)
```
    Description copied from interface: TextureContent
    
    Get raw byte data for a region, rasterized in row-major form with (0,0) in the bottom-left corner.
    
    Specified by:
    
    getData in interface TextureContent
    
    Parameters:
    
    rect - rectangular region to acquire data for
    
    out - buffer to fill
  - showTexture
```
public void showTexture()
```
  - createImage
```
public java.awt.image.BufferedImage createImage()
```
  - isDirty
```
public boolean isDirty()
```
    Description copied from interface: TextureContent
    
    All or part of the texture has been marked as "dirty" (i.e. updated)
    
    Specified by:
    
    isDirty in interface TextureContent
  - getDirty
```
public Rectangle getDirty()
```
    Description copied from interface: TextureContent
    
    The portion of the texture that has been modified (marked "dirty")
    
    Specified by:
    
    getDirty in interface TextureContent
    
    Returns:
    
    bounding region of dirty area, null if nothing marked as dirty
  - markClean
```
public void markClean()
```
    Description copied from interface: TextureContent
    
    Mark the entire texture as being clean
    
    Specified by:
    
    markClean in interface TextureContent
  - getFormat
```
public TextureContent.ContentFormat getFormat()
```
    Description copied from interface: TextureContent
    
    Format of data returned by TextureContent.getData(java.nio.ByteBuffer)
    
    Specified by:
    
    getFormat in interface TextureContent
    
    Returns:
    
    format of data in buffer
    
    See Also:
    
    TextureContent.getData(java.nio.ByteBuffer)
  - getKey
```
public java.lang.Object getKey()
```
    Description copied from interface: TextureContent
    
    A key for referring to this texture. If two contents have the same key, then it is assumed they have the same underlying data (e.g. a filename, if loaded directly from a file). The key should be immutable (at least from a hashcode/equals perspective)
    
    Specified by:
    
    getKey in interface TextureContent
    
    Returns:
    
    uniquely identifying key
  - acquire
```
public NiftiTextureContent acquire()
```
    Description copied from interface: ReferenceCounted
    
    Signal the resource that something is holding a reference to it.
    
    Specified by:
    
    acquire in interface TextureContent
    
    Specified by:
    
    acquire in interface ReferenceCounted
    
    Overrides:
    
    acquire in class ReferenceCountedBase
    
    Returns:
    
    a reference to the acquired object for convenience.
  - dispose
```
public void dispose()
```

Class NiftiTextureContent

Nested Class Summary

Nested classes/interfaces inherited from interface maspack.render.TextureContent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class maspack.util.ReferenceCountedBase

Methods inherited from class java.lang.Object

Methods inherited from interface maspack.util.ReferenceCounted

Field Detail

COL_ROW_PLANE

COL_SLICE_PLANE

ROW_SLICE_PLANE

Constructor Detail

NiftiTextureContent

Method Detail

setColumn

getColumn

setRow

getRow

setSlice

getSlice

setTime

getTime

setX

getX

setY

getY

setZ

getZ

setT

getT

getWidth

getHeight

getTextureCoordinates

getPixelSize

setPixelGenerator

getPixelGenerator

prerender

getData

getData

showTexture

createImage

isDirty

getDirty

markClean

getFormat

getKey

acquire

dispose