de.unihalle.informatik.MiToBo.core.datatypes.neurites
Class MTBNeurite2DProfile

java.lang.Object
  extended by de.unihalle.informatik.MiToBo.core.datatypes.neurites.MTBNeurite2DProfile

public class MTBNeurite2DProfile
extends java.lang.Object

Container class for storing neurite profile data and associated additional information for a single neurite region.

Objects of this type are usually generated by applying methods from class NeuriteMolProfExtractor2D to neuron images. An object of this class is empty per default (apart from the associated neurite region), so all data has to calculated externally and then be passed to the object using its set-routines.

Author:
moeller, Danny Misiak

Field Summary
private  MTBNeurite2D neurite
           
private  double[] profile
          Profile data along longest skeleton path.
private  java.util.Vector<java.util.Vector<java.awt.geom.Point2D.Double>> profilePoints
          Points of the profile (neurite region) belonging to the longest path.
private  MTBImageRGB voronoiImg
          Image filled with voronoi tesselation data during profile calculation if non-null.
 
Constructor Summary
MTBNeurite2DProfile()
           
MTBNeurite2DProfile(MTBNeurite2D _neurite, double[] _profile, java.util.Vector<java.util.Vector<java.awt.geom.Point2D.Double>> _profilePoints, MTBImageRGB _voronoiImg)
          Constructor to create a new MTBNeuriteProfile object from the given MTBRegion2D.
 
Method Summary
 MTBNeurite2D getNeurite()
           
 double[] getProfile()
          Get profile data of the neurite region.
 java.util.Vector<java.util.Vector<java.awt.geom.Point2D.Double>> getProfilePoints()
           
 int getProfileSize()
           
 MTBImageRGB getVoronoiImg()
          Get voronoi tesselation image.
 void setNeurite(MTBNeurite2D neurite)
           
 void setProfile(double[] profileData)
          Pass profile data to the profile.
 void setProfilePoints(java.util.Vector<java.util.Vector<java.awt.geom.Point2D.Double>> profPoints)
          Set the points of the neurite region where the profiles are calculated from.
 void setVoronoiImg(MTBImageRGB voronoiImg)
          Specify an image to be filled with voronoi data.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

neurite

private MTBNeurite2D neurite

profile

private double[] profile
Profile data along longest skeleton path.


profilePoints

private java.util.Vector<java.util.Vector<java.awt.geom.Point2D.Double>> profilePoints
Points of the profile (neurite region) belonging to the longest path.


voronoiImg

private MTBImageRGB voronoiImg
Image filled with voronoi tesselation data during profile calculation if non-null.

Note: Memory needs to be allocated externally, please use the setVoronoiImg()-routine for passing a suitable image to the object.

Constructor Detail

MTBNeurite2DProfile

public MTBNeurite2DProfile()

MTBNeurite2DProfile

public MTBNeurite2DProfile(MTBNeurite2D _neurite,
                           double[] _profile,
                           java.util.Vector<java.util.Vector<java.awt.geom.Point2D.Double>> _profilePoints,
                           MTBImageRGB _voronoiImg)
Constructor to create a new MTBNeuriteProfile object from the given MTBRegion2D.

Parameters:
region - Neurite region the profile is calculated for.
Method Detail

getNeurite

public MTBNeurite2D getNeurite()

getProfile

public double[] getProfile()
Get profile data of the neurite region.

Attention: May be null!

Returns:
Profile data of neurite.

getProfilePoints

public java.util.Vector<java.util.Vector<java.awt.geom.Point2D.Double>> getProfilePoints()

getProfileSize

public int getProfileSize()

getVoronoiImg

public MTBImageRGB getVoronoiImg()
Get voronoi tesselation image.

Attention: May be null!

Returns:
Voronoi tesselation image.

setNeurite

public void setNeurite(MTBNeurite2D neurite)

setProfile

public void setProfile(double[] profileData)
Pass profile data to the profile.

Parameters:
profileData - Data of the profile as calculated by profile extractor.

setProfilePoints

public void setProfilePoints(java.util.Vector<java.util.Vector<java.awt.geom.Point2D.Double>> profPoints)
Set the points of the neurite region where the profiles are calculated from.

Parameters:
profPoints - points in the neurite region for profile calculating

setVoronoiImg

public void setVoronoiImg(MTBImageRGB voronoiImg)
Specify an image to be filled with voronoi data.

Attention: Correct size is mandatory!

Parameters:
voronoiImg - Allocated image to be filled with voronoi data.