FlowVis.Data.FlowChannel Class Reference

Contains the data stored in one channel of the flow data. Each channel contains one scalar per grid cell. More...

List of all members.

Public Member Functions

 FlowChannel (FlowGeometry geometry)
 Constructor. The channel contains no data, only the geometry which provides the grid is assigned. To change the data use the Data-field.
bool HasTransfer ()
 Checks if a transfer function has been assigned to this channel.
float GetInterpolatedValue (Math.Vector3f pos)
 Returns the interpolated data at the specified position. The geometry object of the flow data is used to retrieve the indices of the four neighbouring grid cell indices. The result is the linear interpolation of the according values stored in this channel. If the position is outside of the grid the value 0 is returned.
float GetNearestValue (Math.Vector3f pos)
 Returns the value of the nearest grid position. The nearest grid position is obtained by the geometry object. If the position is outside of the grid the value 0 is returned.
float GetValueAtNormalizedPosition (Math.Vector3f normalizedPosition)
 Returns the interpolated value at a specified normalized position which means the position is given in the range of 0 to 1 in each direction.
float NormalizeValue (float value)
 Normalized values are in the range from 0 to 1, where 0 corresponds to the minimum value of this channel and 1 to the maximum value of this channel. This method converts a denormalized value to a normalized one.
float DenormalizeValue (float value)
 Normalized values are in the range from 0 to 1, where 0 corresponds to the minimum value of this channel and 1 to the maximum value of this channel. Denormalized values store the real value. This method converts a normalized value to a denormalized one.

Properties

float[] Data [set]
 Gives access to the stored value. When the data is changed the minimum and maximum value are extracted. Throws an exception when new values are applied and the number of values doesn't fit to the geometry of this channel.
float Maximum [get]
 Get the maximum value stored in this channel.
float Minimum [get]
 Get the minimum value stored in this channel.
TransferFunction Transfer [get, set]
 Set or get the transfer function assigned to this channel.


Detailed Description

Contains the data stored in one channel of the flow data. Each channel contains one scalar per grid cell.


Constructor & Destructor Documentation

FlowVis.Data.FlowChannel.FlowChannel ( FlowGeometry  geometry  ) 

Constructor. The channel contains no data, only the geometry which provides the grid is assigned. To change the data use the Data-field.

Parameters:
geometry Geometry contains the grid for this flow data


Member Function Documentation

bool FlowVis.Data.FlowChannel.HasTransfer (  ) 

Checks if a transfer function has been assigned to this channel.

Returns:
true if a transfer function is assigned

float FlowVis.Data.FlowChannel.GetInterpolatedValue ( Math.Vector3f  pos  ) 

Returns the interpolated data at the specified position. The geometry object of the flow data is used to retrieve the indices of the four neighbouring grid cell indices. The result is the linear interpolation of the according values stored in this channel. If the position is outside of the grid the value 0 is returned.

Parameters:
pos Position from which the neighbouring grid cells are obtained
Returns:
Linear interpolated value

float FlowVis.Data.FlowChannel.GetNearestValue ( Math.Vector3f  pos  ) 

Returns the value of the nearest grid position. The nearest grid position is obtained by the geometry object. If the position is outside of the grid the value 0 is returned.

Parameters:
pos Position for which the nearest grid cell is obtained.
Returns:
value stored in this channel at the nearest grid cell

float FlowVis.Data.FlowChannel.GetValueAtNormalizedPosition ( Math.Vector3f  normalizedPosition  ) 

Returns the interpolated value at a specified normalized position which means the position is given in the range of 0 to 1 in each direction.

Parameters:
normalizedPosition normalizedPosition normalized position in the range of 0 to 1
Returns:
interpolated value calculated with the method GetInterpolatedValue

float FlowVis.Data.FlowChannel.NormalizeValue ( float  value  ) 

Normalized values are in the range from 0 to 1, where 0 corresponds to the minimum value of this channel and 1 to the maximum value of this channel. This method converts a denormalized value to a normalized one.

Parameters:
value denormalized value (which may have been retreived with one the GetValue-methods)
Returns:
normalized value in the range of 0 and 1

float FlowVis.Data.FlowChannel.DenormalizeValue ( float  value  ) 

Normalized values are in the range from 0 to 1, where 0 corresponds to the minimum value of this channel and 1 to the maximum value of this channel. Denormalized values store the real value. This method converts a normalized value to a denormalized one.

Parameters:
value normalized value in the range of 0 and 1
Returns:
normalized value in the range of the minimum and maximum value of this channel


Property Documentation

float [] FlowVis.Data.FlowChannel.Data [set]

Gives access to the stored value. When the data is changed the minimum and maximum value are extracted. Throws an exception when new values are applied and the number of values doesn't fit to the geometry of this channel.

float FlowVis.Data.FlowChannel.Maximum [get]

Get the maximum value stored in this channel.

float FlowVis.Data.FlowChannel.Minimum [get]

Get the minimum value stored in this channel.

TransferFunction FlowVis.Data.FlowChannel.Transfer [get, set]

Set or get the transfer function assigned to this channel.


The documentation for this class was generated from the following file:
Generated on Mon Jan 21 16:09:36 2008 for FlowVis by  doxygen 1.5.1-p1