ProfileProcessor (SNT Javadocs 0-SNAPSHOT API)

java.lang.Object
- sc.fiji.snt.analysis.ProfileProcessor<T>

All Implemented Interfaces:

Callable<double[]>
```
public class ProfileProcessor<T extends RealType<T>>
extends Object
implements Callable<double[]>
```
Profile intensities within local neighborhoods around Path PointInImages

Author:

Cameron Arshadi

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProfileProcessor.Metric

static class ProfileProcessor.Shape

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProfileProcessor.Metric`
`static class`	`ProfileProcessor.Shape`

Constructor Summary

Constructors
Constructor and Description

ProfileProcessor(RandomAccessibleInterval<T> rai, Path path)

Constructors
Constructor and Description
`ProfileProcessor(RandomAccessibleInterval<T> rai, Path path)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double[]`	`call()` Process and return the profile values.
`static ProfileProcessor.Metric[]`	`getMetrics()` Gets the array of available `ProfileProcessor.Metric`s
`static ProfileProcessor.Shape[]`	`getShapes()` Gets the array of available `ProfileProcessor.Shape`s
`double[]`	`getValues()` The profile values, or null if they have not been processed yet.
`static void`	`main(String[] args)`
`void`	`process()`
`static <T extends RealType<T>> double[]`	`profilePathNodes(RandomAccessible<T> rai, Path path, double[] values)` Get the intensities for the point coordinates of a Path
`void`	`setMetric(ProfileProcessor.Metric metric)` Sets the metric to be computed for each local neighborhood.
`void`	`setRadius(int radius)` Specify a fixed radius for each `ProfileProcessor.Shape` region around each `PointInImage`.
`void`	`setShape(ProfileProcessor.Shape shape)` Sets the shape to be iterated.

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

- Constructor Detail
  - ProfileProcessor
```
public ProfileProcessor(RandomAccessibleInterval<T> rai,
                        Path path)
```
- Method Detail
  - getMetrics
```
public static ProfileProcessor.Metric[] getMetrics()
```
    Gets the array of available ProfileProcessor.Metrics
    
    Returns:
    
    the Metric array
  - getShapes
```
public static ProfileProcessor.Shape[] getShapes()
```
    Gets the array of available ProfileProcessor.Shapes
    
    Returns:
    
    the Shape array
  - setMetric
```
public void setMetric(ProfileProcessor.Metric metric)
```
    Sets the metric to be computed for each local neighborhood. This setting is ignored if using ProfileProcessor.Shape.CENTERLINE.
    
    Parameters:
    
    metric -
  - setShape
```
public void setShape(ProfileProcessor.Shape shape)
```
    Sets the shape to be iterated.
    
    Parameters:
    
    shape -
  - setRadius
```
public void setRadius(int radius)
```
    Specify a fixed radius for each ProfileProcessor.Shape region around each PointInImage. Set to <= 0 to use the actual PointInImage radii.
    
    Parameters:
    
    radius -
  - getValues
```
public double[] getValues()
```
    The profile values, or null if they have not been processed yet.
    
    Returns:
    
    the values
  - process
```
public void process()
```
  - call
```
public double[] call()
```
    Process and return the profile values.
    
    Specified by:
    
    call in interface Callable<double[]>
    
    Returns:
    
    the values.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if using CENTERLINE shape and any Path nodes are outside the bounds of the image
  - profilePathNodes
```
public static <T extends RealType<T>> double[] profilePathNodes(RandomAccessible<T> rai,
                                                                Path path,
                                                                double[] values)
```
    Get the intensities for the point coordinates of a Path
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    rai - the image
    
    path - the Path to profile
    
    values - the array to store the values
    
    Returns:
    
    the value array
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if the Path contains any points outside the image bounds
  - main
```
public static void main(String[] args)
```

Class ProfileProcessor<T extends RealType<T>>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProfileProcessor

Method Detail

getMetrics

getShapes

setMetric

setShape

setRadius

getValues

process

call

profilePathNodes

main