jhplot
Class F3D

java.lang.Object
  extended by jhplot.DrawOptions
      extended by jhplot.F3D
All Implemented Interfaces:
Serializable

public class F3D
extends DrawOptions
implements Serializable

Create 3D function.

See Also:
Serialized Form

Constructor Summary
F3D(hep.aida.IFunction iname, double Xmin, double Xmax, double Ymin, double Ymax, double Zmin, double Zmax)
          Create a function in 3D from a AIDA IFunction.
F3D(String name)
          Create a function in 3D for evaluation.
F3D(String name, double Xmin, double Xmax, double Ymin, double Ymax, double Zmin, double Zmax)
          Build a 3D function.
F3D(String name, hep.aida.IFunction iname, double Xmin, double Xmax, double Ymin, double Ymax, double Zmin, double Zmax)
           
F3D(String title, String name, double Xmin, double Xmax, double Ymin, double Ymax, double Zmin, double Zmax)
          Create a function in 3D.
F3D(String title, String name, hep.aida.IFunction iname, double Xmin, double Xmax, double Ymin, double Ymax, double Zmin, double Zmax)
          Create a function in 3D from a AIDA IFunction.
 
Method Summary
 void doc()
          Show online documentation.
 double eval(double x, double y, double z)
          Evaluate a function at a specific point in (x,y,z)
 double getMaxX()
          Get Max value in X
 double getMaxY()
          Get Max value in Y
 double getMaxZ()
          Set Max value in Z
 double getMinX()
          Get Min value in X
 double getMinY()
          Get Min value in Y
 double getMinZ()
          Get Min value in Z
 String getName()
          Get the name of the function used for evaluation
 graph.ParseFunction getParse()
          Return parsed function.
 int getPoints()
          Get the number of points for evaluation of a function
 String getTitle()
          Get the title
 void setMaxX(double max)
          Set Max value in X
 void setMaxY(double max)
          Set Max value in Y
 void setMaxZ(double max)
          Set Max value in Z
 void setMinX(double min)
          Set Min in X
 void setMinY(double min)
          Set Min value in Y
 void setMinZ(double min)
          Set Min value in Z
 void setName(String name)
          Sets a name of the function, i.e.
 void setPoints(int bins)
          Get the number of points
 void setTitle(String title)
          Set a title
 
Methods inherited from class jhplot.DrawOptions
copyLinePars, getBinWidth, getColor, getDrawOption, getDrawOptions, getLegend, getLineParm, getNameX, getNameY, getNameZ, getSymbol, getType, isBars, printDrawOptions, printDrawOptions, setBars, setBinWidth, setColor, setDrawLine, setDrawLineKey, setDrawOption, setDrawSymbol, setErr, setErrAll, setErrColor, setErrColor, setErrColorX, setErrColorY, setErrFill, setErrFillColor, setErrFillColor, setErrSys, setErrSysFill, setErrSysFillColor, setErrSysFillColor, setErrSysX, setErrSysY, setErrTicSize, setErrX, setErrY, setFill, setFillColor, setFillColorTransparency, setGraphStyle, setLegend, setNameX, setNameY, setNameZ, setPenDash, setPenDash, setPenWidth, setPenWidthErr, setPenWidthErrSys, setStyle, setSymbol, setSymbolSize, setType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

F3D

public F3D(String name)
Create a function in 3D for evaluation. The function may have up to 3 independent variables: x,y,z.

If the answer is wrong then use the parenthesis to force the order of evaluation. The most likely place this will be needed is in the use of the power command. The exponent is not evaluated correctly if it begins with a unary operator.

List of commands

Parameters:
name - String representing the function

F3D

public F3D(String title,
           String name,
           double Xmin,
           double Xmax,
           double Ymin,
           double Ymax,
           double Zmin,
           double Zmax)
Create a function in 3D. Uses 500 points between min and max value for evaluation. The function may have up to 3 independent variables in it (x,y,z).

If the answer is wrong then use the parenthesis to force the order of evaluation. The most likely place this will be needed is in the use of the power command. The exponent is not evaluated correctly if it begins with a unary operator.

List of commands

Parameters:
name - String representing the function.
Xmin - Min value in X
Xmax - Max value in X
Ymin - Min value in Y
Ymax - Max value in Y
Zmin - Min value in Z
Zmax - Max value in Y

F3D

public F3D(String name,
           double Xmin,
           double Xmax,
           double Ymin,
           double Ymax,
           double Zmin,
           double Zmax)
Build a 3D function. Title set to its name.

Parameters:
name -
Xmin -
Xmax -
Ymin -
Ymax -
Zmin -
Zmax -

F3D

public F3D(String title,
           String name,
           hep.aida.IFunction iname,
           double Xmin,
           double Xmax,
           double Ymin,
           double Ymax,
           double Zmin,
           double Zmax)
Create a function in 3D from a AIDA IFunction.

Parameters:
title - title
name - String representing the function.
iname - input AIDA function
Xmin - Min value in X
Xmax - Max value in X
Ymin - Min value in Y
Ymax - Max value in Y
Zmin - Min value in Z
Zmax - Max value in Y

F3D

public F3D(String name,
           hep.aida.IFunction iname,
           double Xmin,
           double Xmax,
           double Ymin,
           double Ymax,
           double Zmin,
           double Zmax)

F3D

public F3D(hep.aida.IFunction iname,
           double Xmin,
           double Xmax,
           double Ymin,
           double Ymax,
           double Zmin,
           double Zmax)
Create a function in 3D from a AIDA IFunction.

Parameters:
iname - input AIDA function
Xmin - Min value in X
Xmax - Max value in X
Ymin - Min value in Y
Ymax - Max value in Y
Zmin - Min value in Z
Zmax - Max value in Y
Method Detail

eval

public double eval(double x,
                   double y,
                   double z)
Evaluate a function at a specific point in (x,y,z)

Parameters:
x - value in x for evaluation
y - value in y for evaluation
z - value in z for evaluation
Returns:
function value at (x,y,z)

setTitle

public void setTitle(String title)
Set a title

Overrides:
setTitle in class DrawOptions
Parameters:
title - Title

getTitle

public String getTitle()
Get the title

Overrides:
getTitle in class DrawOptions
Returns:
Title

setMinX

public void setMinX(double min)
Set Min in X

Parameters:
min - Min value

getMinX

public double getMinX()
Get Min value in X

Returns:
Min value in X

setMinY

public void setMinY(double min)
Set Min value in Y

Parameters:
min - Min value in Y

setMinZ

public void setMinZ(double min)
Set Min value in Z

Parameters:
min - Min value in Z

getMinY

public double getMinY()
Get Min value in Y

Returns:
Min value in Y

getMinZ

public double getMinZ()
Get Min value in Z

Parameters:
Min - value in Z

setMaxX

public void setMaxX(double max)
Set Max value in X

Parameters:
max - Max value in X

doc

public void doc()
Show online documentation.


setMaxZ

public void setMaxZ(double max)
Set Max value in Z

Parameters:
max - Max value in Z

setName

public void setName(String name)
Sets a name of the function, i.e. what will be used for evaluation

Parameters:
name - Name

getName

public String getName()
Get the name of the function used for evaluation

Returns:
Name

getMaxX

public double getMaxX()
Get Max value in X

Returns:
Max value in X

getMaxZ

public double getMaxZ()
Set Max value in Z

Returns:
max Max value in Z

setMaxY

public void setMaxY(double max)
Set Max value in Y

Parameters:
max - Max value in Y

getMaxY

public double getMaxY()
Get Max value in Y

Returns:
Max value in Y

setPoints

public void setPoints(int bins)
Get the number of points

Parameters:
bins - Number of points

getPoints

public int getPoints()
Get the number of points for evaluation of a function

Returns:
Number of points

getParse

public graph.ParseFunction getParse()
Return parsed function. One can evaluate it as: value=function.getResult(x,y,z), where function is what returned by this method.

Returns:
function


jHepWork 3.1 ©