core.rendering
Class Renderer

java.lang.Object
  core.rendering.Renderer

public class Renderer

extends java.lang.Object

The Renderer class handles all the code that draws and evolves the DLIC and the experiment. Built in are several handlers for adjusting all of the rendering parameters that might conceivably need adjusting (image size, kernel matrix, streamlength, color coding mode, etc.). The main() should create an instance of the desired experiment and pass it to an instance of this renderer, followed (if necessary) by a series of calls to the Renderer's configuration handlers, and concluded with a call to the renderer's StartRender() function. DLIC generation will then proceed as usual.

Version:

1.0s

Author:

Michael Danziger

Field Summary

static int	CM_COLOR_1 The image is a colored image generated using the first color coding algorithm
static int	CM_COLOR_2 The image is a colored image generated using the second color coding algorithm
static int	CM_COLOR_3 The image is a colored image generated using the third color coding algorithm
static int	CM_COLOR_4 The image is a colored image generated using the fourth color coding algorithm, which is regional coloring
static int	CM_GREYSCALE The image is greyscale
(package private) double	colorHue The HSV hue of the color used in the image.
(package private) int	colorMode The color mode of the image (that is, how the image is colored).
(package private) double	colorSaturation The HSV saturation S of the color used in the image for color mode 1.
(package private) double	colorStrength This essentially controls how bright the color will be, and how quickly it starts to fall off to black.
(package private) double	colorValue The HSV value V of the color used in the image for color mode 1.
(package private) int	doubleHeight double the height of the output image in pixels.
(package private) int	doubleWidth double the width of the output image in pixels.
(package private) double	dt Time step for evolution between frames
(package private) int	endFrame The end frame of the inteval where we will actually render an image.
(package private) BaseExperiment	experiment
(package private) double	fallOff rate at which color falls to black below the saturation value
(package private) int	filterRepeat The number of times the kernel is applied to the image (normally should be 1).
(package private) double	FluidFlowSpeed Flowspeed when we let have flow along E(B) varying with the magnitude of E(B)
(package private) java.lang.String	fname String which is the path for the sequence file name of the tiffs produced, including the full path to those files.
(package private) double	Fnorm Field normalization for the flowspeed when we let have flow along E(B) varying with the magnitude of E(B) The calculated speed is FluidFlowSpeed*(B(E)/Fnorm)^Fpower.
(package private) double	Fpower Field power for the flowspeed when we let have flow along E(B) varying with the magnitude of E(B)
(package private) int	frames number of frames of the animation to be produced.
(package private) int	halfHeight half of the height of the output image in pixels.
(package private) int	halfWidth half of the width of the output image in pixels.
(package private) int	height height of output image in pixels
(package private) double[]	ikernel kernel for the image (this controls the blending of the image).
(package private) boolean	OKToRun flag to make sure the renderer has all the required info before running
(package private) Vec3	origin The origin for the plot, non-zero and used only when there is no symmerty
(package private) RGBImage	outimage The rgb version of output which now has the full (width,height) dimensions, with the additional information (if any) computed from the assumed symmetry of the image.
(package private) AccumImage	output The image as actually computed, which depending on the symmetry can be either 1/4 or 1/2 or the full final image written to file and displayed in "window".
(package private) Vec	RegionColor RegionColor for when we use different colors in different regions of the image
(package private) Vec	RegionFlow RegionFlow for when we use different flow speeds in different regions of the image
(package private) RGBImage	rgbimage The rgb verzion of output with the same dimensions as output.
(package private) double	scale Overall scale factor for image
(package private) int	startFrame The beginning frame of the inteval where we will actually render an image.
(package private) int	streamlen length of convolution kernel in pixels
static int	SYM_BOTH The image is symmetric about both the vertical and the horizontal axis
static int	SYM_HORIZONTAL The image is symmetric about the horizontal axis
static int	SYM_NONE The image has no symmetry
static int	SYM_VERTICAL The image is symmetric about the vertical axis
(package private) int	symmetry Key to the symmetry of the image.
(package private) int	width width of output image in pixels
(package private) OutputWindow	window As the rendering proceeds, the program displays an output image on the screen frame by frame in "window".
(package private) Vec3	Xdir Unit axis for the X-direction of the image
(package private) Vec3	Ydir Unit axis for the Y-direction of the image

Constructor Summary

Renderer()
The default constructor for the Renderer, which sets the default values for the various options and parameters.

Method Summary

(package private) boolean	CheckStatus() CheckStatus() is only used internally by Renderer.
double	GetColorHue() GetColorHue() returns the hue of the image as a normalized double.
int	GetColorMode() GetColorMode() returns the color mode of the image as an integer.
double	GetColorSaturation() GetColorSaturation() returns the HSV saturation of the image as a normalized double.
double	GetColorStrength() GetColorStrength() returns the color strength of the image.
double	GetColorValue() GetColorValue() returns the HSV value of the image as a normalized double.
BaseExperiment	GetExperiment() GetExperiment() returns the experiment that is currently set to render.
double	GetFallOff() GetFallOff() returns the fallOff of the image.
java.lang.String	GetFileName() GetFileName() returns the filename of the image (including path).
double	GetFluidFlowSpeed() GetFluidFlowSpeed() returns fluid flow speed in the equation FluidFlowSpeed*(B(E)/Fnorm)^Fpower.
double	GetFnorm() GetFnorm() returns Fnorm in FluidFlowSpeed*(B(E)/Fnorm)^Fpower.
double	GetFpower() GetFpower() returns Fpower in FluidFlowSpeed*(B(E)/Fnorm)^Fpower.
int	GetFrames() GetFrames() returns the number of frames to be rendered.
int	GetHeight() GetHeight() returns the height of the image.
double[]	GetIKernel() GetIKernel() returns the kernel for the image.
int	GetIKernelFilterRepeat() GetIKernelFilterRepeat() returns the number of times the kernel is applied to the image.
Vec3	GetOrigin() GetOrigin() returns the origin of the plot, non-zero only if there is no symmetry.
Vec	GetRegionColor() GetRegionColor() returns colors of the various color regions, if used.
Vec	GetRegionFlow() GetRegionFlow() returns flow speeds of the various flow regions, if used.
double	GetScale() GetScale() returns the "scale" of the image.
int	GetStreamLen() GetStreamLen() returns the streamlength of the image (streamlen).
int	GetSymmetry() GetSymmetry() returns the symmetry of the image as an integer.
double	GetTimeStep() GetTimeStep() returns the time step for the evolution of the experiment.
int	GetWidth() GetWidth() returns the width of the image.
Vec3	GetXdir() Get the X coordinate unit vector of the image.
Vec3	GetYdir() Get the Y coordinate unit vector of the image.
(package private) void	InitOutputWindow() InitOutputWindow() is only used internally by Renderer.
private static java.lang.String	PadZeros(int x, int len) A method to pad the names of the image files produced with beginning zeroes.
private static void	println(java.lang.String s) A local way to print a string
void	PrintRenderInfo() Prints out the characteristics of this renderer
void	SetColorHue(double myHue) SetColorHue() sets the HSV hue of the color used in the image.
void	SetColorMode(int myColorMode) SetColorMode() sets the color mode of the image (that is, how the image is colored).
void	SetColorSaturation(double myColorSaturation) SetColorSaturation() sets the HSV saturation used in the image.
void	SetColorStrength(double myStrength) SetColorStrength() sets the strength or intensity of the coloring.
void	SetColorValue(double myColorValue) SetColorValue() sets the HSV value used in the image.
void	SetEndFrame(int end) SetEndFrame() sets the frame at which DLIC rendering ends
void	SetExperiment(BaseExperiment myExperiment) SetExperiment() sets the experiment that the renderer will render.
void	SetFallOff(double myFallOff) SetFallOff() sets the fallOff of the coloring.
void	SetFileName(java.lang.String myName) SetFileName() sets the filename of the image (including path).
void	SetFluidFlowSpeed(double FluidFlowSpeed) SetFluidFlowSpeed() sets the flow speeds in FluidFlowSpeed*(B(E)/Fnorm)^Fpower.
void	SetFnorm(double Fnorm) SetFnorm() sets the Fnorm in FluidFlowSpeed*(B(E)/Fnorm)^Fpower.
void	SetFpower(double Fpower) SetFpower() sets the Fpower in FluidFlowSpeed*(B(E)/Fnorm)^Fpower.
void	SetFrames(int myFrames) SetFrames() sets the number of frames to be rendered.
void	SetHeight(int myHeight) SetHeight() sets the height of the image, WHICH MUST BE EVEN BECAUSE OF OUR SYMMETRIZATION PROCESSES.
void	SetIKernel(double[] myIKernel) SetIKernel() sets the kernel for the image (this controls the blending of the image).
void	SetIKernelFilterRepeat(int myRepeat) SetIKernelFilterRepeat() sets the number of times the kernel is applied to the image (should usually be 1).
void	SetOrigin(Vec3 Origin) SetOrigin() sets the origin of the plot, non-zero only if there is no symmetry.
void	SetRegionColor(Vec RegionColor) SetRegionColor() sets the colors of the various color regions, if used.
void	SetRegionFlow(Vec RegionFlow) SetRegionFlow() sets the flow speeds of the various flow regions, if used.
void	SetScale(double myScale) SetScale() sets the "scale" of the image.
void	SetStartFrame(int start) SetStartFrame() sets the frame at which DLIC rendering starts
void	SetStreamLen(int myStreamlen) SetStreamLen() sets the streamlength of the image (streamlen).
void	SetSymmetry(int mySymmetry) SetSymmetry() sets the symmetry of the image.
void	SetTimeStep(double myStep) SetTimeStep() sets the time step for the evolution of the experiment.
void	SetWidth(int myWidth) SetWidth() sets the width of the image, WHICH MUST BE EVEN BECAUSE OF OUR SYMMETRIZATION PROCESSES.
void	SetXdir(Vec3 myXdir) Set the X coordinate unit vector of the image.
void	SetYdir(Vec3 myYdir) Set the Y coordinate unit vector of the image.
void	StartRender() StartRender() starts the program rendering.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYM_NONE

public static final int SYM_NONE

The image has no symmetry

See Also:

Constant Field Values

SYM_VERTICAL

public static final int SYM_VERTICAL

The image is symmetric about the vertical axis

See Also:

Constant Field Values

SYM_HORIZONTAL

public static final int SYM_HORIZONTAL

The image is symmetric about the horizontal axis

See Also:

Constant Field Values

SYM_BOTH

public static final int SYM_BOTH

The image is symmetric about both the vertical and the horizontal axis

See Also:

Constant Field Values

CM_GREYSCALE

public static final int CM_GREYSCALE

The image is greyscale

See Also:

Constant Field Values

CM_COLOR_1

public static final int CM_COLOR_1

The image is a colored image generated using the first color coding algorithm

See Also:

Constant Field Values

CM_COLOR_2

public static final int CM_COLOR_2

The image is a colored image generated using the second color coding algorithm

See Also:

Constant Field Values

CM_COLOR_3

public static final int CM_COLOR_3

The image is a colored image generated using the third color coding algorithm

See Also:

Constant Field Values

CM_COLOR_4

public static final int CM_COLOR_4

The image is a colored image generated using the fourth color coding algorithm, which is regional coloring

See Also:

Constant Field Values

window

OutputWindow window

As the rendering proceeds, the program displays an output image on the screen frame by frame in "window".

output

AccumImage output

The image as actually computed, which depending on the symmetry can be either 1/4 or 1/2 or the full final image written to file and displayed in "window". That is, it may have dimensions
(width/2,height/2)---SYM_BOTH--------symmetric about vertical and horizontal,
(width/2,height)-----SYM_VERTICAL----symmetric about vertical axis,
(width,height/2)-----SYM_HORIZONTAL--symmetric about horizontal axis,
(width,height)-------SYM_NONE--------no symmetry

rgbimage

RGBImage rgbimage

The rgb verzion of output with the same dimensions as output.

outimage

RGBImage outimage

The rgb version of output which now has the full (width,height) dimensions, with the additional information (if any) computed from the assumed symmetry of the image.

width

int width

width of output image in pixels

halfWidth

int halfWidth

half of the width of the output image in pixels. This is used in situations with symmetry.

doubleWidth

int doubleWidth

double the width of the output image in pixels. This is used in situations with symmetry.

height

int height

height of output image in pixels

halfHeight

int halfHeight

half of the height of the output image in pixels. This is used in situations with symmetry.

doubleHeight

int doubleHeight

double the height of the output image in pixels. This is used in situations with symmetry.

streamlen

int streamlen

length of convolution kernel in pixels

frames

int frames

number of frames of the animation to be produced. The sequence numbers of the frames produced will run from 0000 to (frames-1)

fname

java.lang.String fname

String which is the path for the sequence file name of the tiffs produced, including the full path to those files. Example: "C:\\DLIC\\UniformField\\ch". This string will result in the production a series of tiff files in the folder UniformField named ch0000.tiff up to choNNN.tiff, where NNN = (frames -1).

startFrame

int startFrame

The beginning frame of the inteval where we will actually render an image. We evolve the experiment through 0 to frames -1, but we only compute images from startFrame to endFrame.

endFrame

int endFrame

The end frame of the inteval where we will actually render an image. We evolve the experiment through 0 to frames -1, but we only compute images from startFrame to endFrame.

dt

double dt

Time step for evolution between frames

scale

double scale

Overall scale factor for image

ikernel

double[] ikernel

kernel for the image (this controls the blending of the image). To blend the image, we perform a convolution on 'this' with a 3x3 kernel and scalar offset. ikernel is of type double[10], and the convolution computed is of the form: out(i,j) = c0 + c1*out(i-1,j-1) + c2*out( i ,j-1) + c3*out(i+1,j-1) + c4*out(i-1, j ) + c5*out( i , j ) + c6*out(i+1, j ) + c7*out(i-1,j+1) + c8*out( i ,j+1) + c9*out(i+1,j+1) where ci = kernel[i]

filterRepeat

int filterRepeat

The number of times the kernel is applied to the image (normally should be 1).

symmetry

int symmetry

Key to the symmetry of the image. If the image is symmetric about its horizontal axis, vertical axis, or both, we save time by only calculating one half (or one quarter) of the image, and "folding" that part over the axis (axes) of symmetry. The values this integer can have are "Renderer.SYM_NONE" = 0 for no symmetry (entire image is calculated) "Renderer.SYM_VERTICAL" = 1 for vertical symmetry (left side of the image is flipped to the right side) "Renderer.SYM_HORIZONTAL" = 2 for horizontal symmetry (top half of the image is flipped to the bottom half) "Renderer.SYM_BOTH" = 3 for symmetry in both directions (upper left quadrant is flipped to the other three).

Xdir

Vec3 Xdir

Unit axis for the X-direction of the image

Ydir

Vec3 Ydir

Unit axis for the Y-direction of the image

colorMode

int colorMode

The color mode of the image (that is, how the image is colored). The values are: "Renderer.CM_GREYSCALE" = 0 generates a black and white image "Renderer.CM_COLOR_1" = 1 generates a "flat" colored image using colorHue, colorSaturation and colorValue "Renderer.CM_COLOR_2" = 2 generates a colored image using the first color coding algorithm, based on the magnitude of the field. "Renderer.CM_COLOR_3" = 3 generates a colored image using the second color coding algorithm, based on the magnitude of the field.

colorHue

double colorHue

The HSV hue of the color used in the image. The hue value should be a normalized value between 0 and 1.0. Any value above or below that is clamped to 1.0 or 0.

colorSaturation

double colorSaturation

The HSV saturation S of the color used in the image for color mode 1. The value should be a normalized value between 0 and 1.0. Any value above or below that is clamped to 1.0 or 0.

colorValue

double colorValue

The HSV value V of the color used in the image for color mode 1. The value should be a normalized value between 0 and 1.0. Any value above or below that is clamped to 1.0 or 0.

colorStrength

double colorStrength

This essentially controls how bright the color will be, and how quickly it starts to fall off to black. This value will most likely be different for each image.

fallOff

double fallOff

rate at which color falls to black below the saturation value

RegionColor

Vec RegionColor

RegionColor for when we use different colors in different regions of the image

RegionFlow

Vec RegionFlow

RegionFlow for when we use different flow speeds in different regions of the image

FluidFlowSpeed

double FluidFlowSpeed

Flowspeed when we let have flow along E(B) varying with the magnitude of E(B)

Fnorm

double Fnorm

Field normalization for the flowspeed when we let have flow along E(B) varying with the magnitude of E(B) The calculated speed is FluidFlowSpeed*(B(E)/Fnorm)^Fpower.

Fpower

double Fpower

Field power for the flowspeed when we let have flow along E(B) varying with the magnitude of E(B)

origin

Vec3 origin

The origin for the plot, non-zero and used only when there is no symmerty

experiment

BaseExperiment experiment

OKToRun

boolean OKToRun

flag to make sure the renderer has all the required info before running

Constructor Detail

Renderer

public Renderer()

The default constructor for the Renderer, which sets the default values for the various options and parameters.

Method Detail

SetExperiment

public void SetExperiment(BaseExperiment myExperiment)

SetExperiment() sets the experiment that the renderer will render. When running an experiment file, you should first create an instance of that experiment, and then pass it to the renderer with this function. The renderer will NOT RUN without an experiment set (an error message in the console will tell you if you forgot to set it).

GetExperiment

public BaseExperiment GetExperiment()

GetExperiment() returns the experiment that is currently set to render.

SetWidth

public void SetWidth(int myWidth)

SetWidth() sets the width of the image, WHICH MUST BE EVEN BECAUSE OF OUR SYMMETRIZATION PROCESSES.

GetWidth

public int GetWidth()

GetWidth() returns the width of the image.

SetHeight

public void SetHeight(int myHeight)

SetHeight() sets the height of the image, WHICH MUST BE EVEN BECAUSE OF OUR SYMMETRIZATION PROCESSES.

GetHeight

public int GetHeight()

GetHeight() returns the height of the image.

SetStreamLen

public void SetStreamLen(int myStreamlen)

SetStreamLen() sets the streamlength of the image (streamlen).

GetStreamLen

public int GetStreamLen()

GetStreamLen() returns the streamlength of the image (streamlen).

SetFileName

public void SetFileName(java.lang.String myName)

SetFileName() sets the filename of the image (including path). Example: "C:\\DLIC\\UniformField\\ch".

GetFileName

public java.lang.String GetFileName()

GetFileName() returns the filename of the image (including path).

SetFrames

public void SetFrames(int myFrames)

SetFrames() sets the number of frames to be rendered.

SetStartFrame

public void SetStartFrame(int start)

SetStartFrame() sets the frame at which DLIC rendering starts

SetEndFrame

public void SetEndFrame(int end)

SetEndFrame() sets the frame at which DLIC rendering ends

GetFrames

public int GetFrames()

GetFrames() returns the number of frames to be rendered.

SetTimeStep

public void SetTimeStep(double myStep)

SetTimeStep() sets the time step for the evolution of the experiment.

GetTimeStep

public double GetTimeStep()

GetTimeStep() returns the time step for the evolution of the experiment.

SetScale

public void SetScale(double myScale)

SetScale() sets the "scale" of the image. This should usually be 1.0.

GetScale

public double GetScale()

GetScale() returns the "scale" of the image.

SetIKernel

public void SetIKernel(double[] myIKernel)

SetIKernel() sets the kernel for the image (this controls the blending of the image).

GetIKernel

public double[] GetIKernel()

GetIKernel() returns the kernel for the image.

SetIKernelFilterRepeat

public void SetIKernelFilterRepeat(int myRepeat)

SetIKernelFilterRepeat() sets the number of times the kernel is applied to the image (should usually be 1).

GetIKernelFilterRepeat

public int GetIKernelFilterRepeat()

GetIKernelFilterRepeat() returns the number of times the kernel is applied to the image.

SetSymmetry

public void SetSymmetry(int mySymmetry)

SetSymmetry() sets the symmetry of the image.

GetSymmetry

public int GetSymmetry()

GetSymmetry() returns the symmetry of the image as an integer.

SetColorMode

public void SetColorMode(int myColorMode)

SetColorMode() sets the color mode of the image (that is, how the image is colored).

GetColorMode

public int GetColorMode()

GetColorMode() returns the color mode of the image as an integer.

SetColorHue

public void SetColorHue(double myHue)

SetColorHue() sets the HSV hue of the color used in the image. If using CM_GREYSCALE, this value does nothing. The "myHue" value should be a normalized hue value between 0 and 1.0. Any value above or below that is clamped to 1.0 or 0.

GetColorHue

public double GetColorHue()

GetColorHue() returns the hue of the image as a normalized double.

SetColorSaturation

public void SetColorSaturation(double myColorSaturation)

SetColorSaturation() sets the HSV saturation used in the image. The "myColorSaturation" value should be a normalized hue value between 0 and 1.0. Any value above or below that is clamped to 1.0 or 0.

GetColorSaturation

public double GetColorSaturation()

GetColorSaturation() returns the HSV saturation of the image as a normalized double.

SetColorValue

public void SetColorValue(double myColorValue)

SetColorValue() sets the HSV value used in the image. The "myColorValue" value should be a normalized hue value between 0 and 1.0. Any value above or below that is clamped to 1.0 or 0.

GetColorValue

public double GetColorValue()

GetColorValue() returns the HSV value of the image as a normalized double.

SetColorStrength

public void SetColorStrength(double myStrength)

SetColorStrength() sets the strength or intensity of the coloring.

GetColorStrength

public double GetColorStrength()

GetColorStrength() returns the color strength of the image.

SetFallOff

public void SetFallOff(double myFallOff)

SetFallOff() sets the fallOff of the coloring.

GetFallOff

public double GetFallOff()

GetFallOff() returns the fallOff of the image.

SetRegionColor

public void SetRegionColor(Vec RegionColor)

SetRegionColor() sets the colors of the various color regions, if used.

GetRegionColor

public Vec GetRegionColor()

GetRegionColor() returns colors of the various color regions, if used.

SetRegionFlow

public void SetRegionFlow(Vec RegionFlow)

SetRegionFlow() sets the flow speeds of the various flow regions, if used.

GetRegionFlow

public Vec GetRegionFlow()

GetRegionFlow() returns flow speeds of the various flow regions, if used.

GetFluidFlowSpeed

public double GetFluidFlowSpeed()

GetFluidFlowSpeed() returns fluid flow speed in the equation FluidFlowSpeed*(B(E)/Fnorm)^Fpower.

SetFluidFlowSpeed

public void SetFluidFlowSpeed(double FluidFlowSpeed)

SetFluidFlowSpeed() sets the flow speeds in FluidFlowSpeed*(B(E)/Fnorm)^Fpower.

GetFnorm

public double GetFnorm()

GetFnorm() returns Fnorm in FluidFlowSpeed*(B(E)/Fnorm)^Fpower.

SetFnorm

public void SetFnorm(double Fnorm)

SetFnorm() sets the Fnorm in FluidFlowSpeed*(B(E)/Fnorm)^Fpower.

GetFpower

public double GetFpower()

GetFpower() returns Fpower in FluidFlowSpeed*(B(E)/Fnorm)^Fpower.

SetFpower

public void SetFpower(double Fpower)

SetFpower() sets the Fpower in FluidFlowSpeed*(B(E)/Fnorm)^Fpower.

GetOrigin

public Vec3 GetOrigin()

GetOrigin() returns the origin of the plot, non-zero only if there is no symmetry.

SetOrigin

public void SetOrigin(Vec3 Origin)

SetOrigin() sets the origin of the plot, non-zero only if there is no symmetry.

PrintRenderInfo

public void PrintRenderInfo()

Prints out the characteristics of this renderer

SetXdir

public void SetXdir(Vec3 myXdir)

Set the X coordinate unit vector of the image.

GetXdir

public Vec3 GetXdir()

Get the X coordinate unit vector of the image.

SetYdir

public void SetYdir(Vec3 myYdir)

Set the Y coordinate unit vector of the image.

GetYdir

public Vec3 GetYdir()

Get the Y coordinate unit vector of the image.

CheckStatus

boolean CheckStatus()

CheckStatus() is only used internally by Renderer.

InitOutputWindow

void InitOutputWindow()

InitOutputWindow() is only used internally by Renderer.

StartRender

public void StartRender()

StartRender() starts the program rendering. If for whatever reason the renderer doesn't have sufficient information to start the rendering process, it will tell you with a message in the console.

PadZeros

private static java.lang.String PadZeros(int x,
                                         int len)

A method to pad the names of the image files produced with beginning zeroes. The string representation of N is padded up to a length 'len'. For example: (N,len) = (12,4) => returns "0012"

println

private static void println(java.lang.String s)

A local way to print a string