|
FreeHEP API Version 3.2.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Basic user-level interface class for holding and managing a single set of "data points".
| Method Summary | |
IDataPoint |
addPoint()
Add a new empty IDataPoint at the end of the set. |
void |
addPoint(IDataPoint point)
Add a copy of an IDataPoint at the end of the set. |
IAnnotation |
annotation()
Get the IAnnotation of the IDataPointSet. |
void |
clear()
Remove all the IDataPoints in the set. |
int |
dimension()
Get the dimension of the IDataPoints that can be stored in the set. |
double |
lowerExtent(int coord)
Get the lower value for a give axis. |
IDataPoint |
point(int index)
Get the IDataPoint at a give index in the set. |
void |
removePoint(int index)
Remove the IDataPoint at a given index. |
void |
scale(double scaleFactor)
Scales the values and the errors of all the measurements of each point by a given factor. |
void |
scaleErrors(double scaleFactor)
Scales the errors of all the measurements of each point by a given factor. |
void |
scaleValues(double scaleFactor)
Scales the values of all the measurements of each point by a given factor. |
void |
setCoordinate(int coord,
double[] val,
double[] err)
Set the values and errors of a given coordinate all at once. |
void |
setCoordinate(int coord,
double[] val,
double[] errp,
double[] errm)
Set the values and errors of a given coordinate all at once. |
void |
setTitle(String title)
Set the title of the IDataPointSet. |
int |
size()
Get the current size of the IDataPointSet, i.e. the number of IDataPoints contained in the set. |
String |
title()
Get the title of the IDataPointSet. |
double |
upperExtent(int coord)
Get the upper value for a give axis. |
| Method Detail |
public IAnnotation annotation()
public String title()
public void setTitle(String title)
throws IllegalArgumentException
title - The new title.
IllegalArgumentException - If the title cannot be set.public int dimension()
public void clear()
public int size()
public IDataPoint point(int index)
index - The IDataPoint index.
public void setCoordinate(int coord,
double[] val,
double[] err)
throws IllegalArgumentException
coord - The coordinate's indexval - The array of the values for the given coordinateerr - The array with the symmetric errors.
IllegalArgumentException - if an illegal coordinate is provided or if
there is a mismatch between the size of the array and the size of the IDataPointSet.
public void setCoordinate(int coord,
double[] val,
double[] errp,
double[] errm)
throws IllegalArgumentException
coord - The coordinate's indexval - The array of the values for the given coordinateerrp - The array with the plus errors.errm - The array with the minus errors.
IllegalArgumentException - if an illegal coordinate is provided or if
there is a mismatch between the size of the array and the size of the IDataPointSet.
public IDataPoint addPoint()
throws RuntimeException
RuntimeException - If a new IDataPoint cannot be added to the set.
public void addPoint(IDataPoint point)
throws IllegalArgumentException
point - The IDataPoint to be added.
IllegalArgumentException - If the point has the wrong dimension or
if the point cannot be added.
public void removePoint(int index)
throws IllegalArgumentException
index - The index of the IDataPoint to be removed.
IllegalArgumentException - If the index is < 0 or >= size().
public double lowerExtent(int coord)
throws IllegalArgumentException
coord - The coordinate of the axis.
IllegalArgumentException - if coord < 0 or coord >= dimension() or if the set is empty.
public double upperExtent(int coord)
throws IllegalArgumentException
coord - The coordinate of the axis.
IllegalArgumentException - if coord < 0 or coord >= dimension() or if the set is empty.
public void scale(double scaleFactor)
throws IllegalArgumentException
scaleFactor - The scale factor.
IllegalArgumentException - If an illegal scaleFactor is provided.
public void scaleValues(double scaleFactor)
throws IllegalArgumentException
scaleFactor - The scale factor.
IllegalArgumentException - If an illegal scaleFactor is provided.
public void scaleErrors(double scaleFactor)
throws IllegalArgumentException
scaleFactor - The scale factor.
IllegalArgumentException - If an illegal scaleFactor is provided.
|
FreeHEP API Version 3.2.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||