jhplot
Class PNI
- java.lang.Object
-
- jhplot.PNI
-
- All Implemented Interfaces:
- java.io.Serializable
public class PNI extends java.lang.Object implements java.io.Serializable
Data holder in 2D for integer number. It is similar to matrix in 2D. It has columns and rows. The number of columns may not be the same. For example, data can be presented as:1 2 3 4 5 12 3 4 1 3 4 555 5 66 77 1 2 2 33 434 4
All numbers are expected to be integers..
It extends ArrayList and adds many new features for data manipulation. The class does not have graphical option (use H1D to show the data or methods of this class which transform P0D to a H1D histogram).
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description PNI()
Construct an empty container with no titlePNI(java.lang.String title)
Construct an empty container with a titlePNI(java.lang.String title, boolean shallow, PNI pni)
Construct a copy from a PNI.PNI(java.lang.String title, java.lang.String file)
Construct a container with a title from external file (see the method toFile() how to write such ASCII file)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description void
add(int[] values)
Adds (appends) the specified element to the end of this list.void
add(P0I values)
Adds (appends) P0D to the end of this list.void
clear()
Clear the containerPNI
copy(java.lang.String newtitle)
Create an exact copy of the current P0D.void
doc()
Show online documentation.int[]
get(int row)
Return a specific row as arrayint
get(int row, int column)
Return a specific value.int[][]
getArray()
Get a double array with values.java.util.ArrayList<int[]>
getArrayList()
Get data in form of ArrayListint[]
getColumn(int column)
Return a specific column as an arrayint
getDimension()
Get last dimension of the data (or number of columns).int[]
getDimensions()
Get the numbers of columns.H1D
getH1D(int bins)
Create histogram.H1D
getH1D(int bins, double min, double max)
Return H1D histogram with PND content.H1D
getH1D(int bins, double min, double max, int column)
Make a histogram from a column of PND.IDataPointSet
getIDataPointSet()
Get the data point set for JAIDAdouble
getMax()
Get min valuedouble
getMin()
Get max valueP0I
getP0I(int column)
Return a specific column as an arrayP1D
getP1D(int c1, int c2)
Return 2 columns as P1D to show as a X-Y plotP2D
getP2D(int c1, int c2, int c3)
Return 3 columns as P2D to show as a X-Y-Z plotP0D
getRow(int row)
Return a specific row as arrayP0I
getRowP0D(int row)
Return a specific row as P0DPNI
getRows(java.lang.String newtitle, int indexMin, int indexMax)
Get rows : min is inxluded, max is not;java.lang.String
getTitle()
Get a new titlestatic void
main(java.lang.String[] args)
TestPNI
oper(PNI PNI, java.lang.String what)
Operations on PNI containers: add, subtract, multiply, divide.PNI
oper(PNI PNI, java.lang.String title, java.lang.String what)
Operations on PNI containers: add, subtract, multiply, divide.void
operScale(double scale)
Scale each element of datavoid
print()
Print PNI to System.out.int
read(java.io.BufferedReader br)
Read the data from external file.int
read(java.io.File sfile)
Read PNI from a file.int
read(java.lang.String sfile)
Read PNI from a file.int
read(java.net.URL url)
Read data from URL.int
readGZip(java.io.File sfile)
Read PNI from a GZiped file.int
readGZip(java.lang.String sfile)
Read PNI from a GZiped file.PNI
readSerialized(java.lang.String name)
Read a PNI object from a serialized fileint
readZip(java.lang.String sfile)
Read the data from ZIPed external file.PNI
remove(int index)
Remove a rowvoid
set(int index, int[] values)
Sets (replace) the specified row.void
set(int index, P0I values)
Sets (replace) the specified element with P0D.PNI
setArray(int[][] values)
Set values from double array Old content will be lost.void
setArrayList(java.util.ArrayList<int[]> array)
Set the data in form of ArrayListvoid
setTitle(java.lang.String title)
Set a new titleint
size()
Data size (number of rows)void
toFile(java.lang.String name)
Write a PNI to an external file.java.lang.String
toString()
Get a string representing PNIvoid
toTable()
Show container to a Table in a separate Frame.void
write(java.lang.String name)
Write a PNI to an external file.int
writeSerialized(java.lang.String name)
Write a P0D object to a serialized file
-
-
-
Constructor Detail
-
PNI
public PNI(java.lang.String title)
Construct an empty container with a title- Parameters:
title
- A title
-
PNI
public PNI(java.lang.String title, boolean shallow, PNI pni)
Construct a copy from a PNI. If the last argument is true, a shallow copy of a collection. In this case a new collection contains references to same objects as the source collection. Data are not cloned- Parameters:
title
- new titleshallow
- if true, a shallow copy of a collection.PNI
- inpit data
-
PNI
public PNI(java.lang.String title, java.lang.String file)
Construct a container with a title from external file (see the method toFile() how to write such ASCII file)- Parameters:
title
- A titlefile
- input file name. It can be either a file on a file system or URL location (must start from http or ftp)
-
PNI
public PNI()
Construct an empty container with no title
-
-
Method Detail
-
setTitle
public void setTitle(java.lang.String title)
Set a new title- Parameters:
title
- New Title
-
getTitle
public java.lang.String getTitle()
Get a new title- Returns:
- Title
-
clear
public void clear()
Clear the container
-
get
public int[] get(int row)
Return a specific row as array- Parameters:
row
- index of the row- Returns:
- array of values
-
getRowP0D
public P0I getRowP0D(int row)
Return a specific row as P0D- Parameters:
row
- index of the row- Returns:
- array of values
-
get
public int get(int row, int column)
Return a specific value.- Parameters:
row
- row indexcolumn
- column index- Returns:
- value
-
toString
public java.lang.String toString()
Get a string representing PNI- Overrides:
toString
in classjava.lang.Object
- Returns:
- String with all values
-
print
public void print()
Print PNI to System.out.
-
getColumn
public int[] getColumn(int column)
Return a specific column as an array- Parameters:
column
- index of the column- Returns:
- array with values.
-
getP1D
public P1D getP1D(int c1, int c2)
Return 2 columns as P1D to show as a X-Y plot- Parameters:
c1
- index of the first columnc2
- index of the second column- Returns:
- P1D array with X-Y values.
-
getP0I
public P0I getP0I(int column)
Return a specific column as an array- Parameters:
column
- index of the column- Returns:
- P0D array with values.
-
getP2D
public P2D getP2D(int c1, int c2, int c3)
Return 3 columns as P2D to show as a X-Y-Z plot- Parameters:
c1
- index of the first columnc2
- index of the second columnc3
- index of the third column- Returns:
- P3D array with X-Y-Z values.
-
getRow
public P0D getRow(int row)
Return a specific row as array- Parameters:
row
- index of the row- Returns:
- array of values
-
getArrayList
public java.util.ArrayList<int[]> getArrayList()
Get data in form of ArrayList- Returns:
- data in form of ArrayList
-
getIDataPointSet
public IDataPointSet getIDataPointSet()
Get the data point set for JAIDA- Returns:
-
add
public void add(int[] values)
Adds (appends) the specified element to the end of this list.- Parameters:
values
- array of values to be added.
-
add
public void add(P0I values)
Adds (appends) P0D to the end of this list.- Parameters:
values
- array of values to be added.
-
set
public void set(int index, int[] values)
Sets (replace) the specified row.- Parameters:
index
- position indexvalues
- array of values to be added.
-
set
public void set(int index, P0I values)
Sets (replace) the specified element with P0D.- Parameters:
index
- position indexvalues
- array of values to be added.
-
read
public int read(java.io.BufferedReader br)
Read the data from external file. Old data will be lost. Use "#" or "*" for comments.- Parameters:
sfile
- File name with input- Returns:
- zero if success.
-
readZip
public int readZip(java.lang.String sfile)
Read the data from ZIPed external file. Old data will be lost. Use "#" or "*" for comments.- Parameters:
sfile
- File name with the input (extension .zip)- Returns:
- zero if success.
-
read
public int read(java.io.File sfile)
Read PNI from a file. The old content will be lost. Use a space to separate values in columns and tab to put new row. Comment lines starting with "#" and "*" are ignored.- Parameters:
sfile
- input file- Returns:
- zero if success
-
read
public int read(java.net.URL url)
Read data from URL. Use a space to separate values in columns and tab to put new row.- Parameters:
url
- URL location of input file
-
readGZip
public int readGZip(java.lang.String sfile)
Read PNI from a GZiped file. It can read URL if the string starts from http or ftp, otherwise a file on the file system is assumed.Use a space to separate values in columns and tab to put new row.
- Parameters:
sfile
- File name with input (extension .gz)- Returns:
- zero if success
-
read
public int read(java.lang.String sfile)
Read PNI from a file. It can read URL if the string starts from http or ftp, otherwise a file on the file system is assumed.The old content will be lost. Use a space to separate values in columns and tab to put new row. Comment lines starting with "#" and "*" are ignored.
- Parameters:
sfile
- File name with input- Returns:
- zero if success
-
readGZip
public int readGZip(java.io.File sfile)
Read PNI from a GZiped file. The old content will be lost. Use a space to separate values in columns and tab to put new row. Comment lines start from "#" and "*" are ignored.- Parameters:
sfile
- File name with input (extension .gz)- Returns:
- zero if success
-
write
public void write(java.lang.String name)
Write a PNI to an external file. Same method as toFile()- Parameters:
name
- File name with output
-
writeSerialized
public int writeSerialized(java.lang.String name)
Write a P0D object to a serialized file- Parameters:
name
- serialized file name for output.- Returns:
- zero if no errors
-
readSerialized
public PNI readSerialized(java.lang.String name)
Read a PNI object from a serialized file- Parameters:
name
- serialized file name for input.- Returns:
- new PNI object
-
toFile
public void toFile(java.lang.String name)
Write a PNI to an external file.- Parameters:
name
- File name with output
-
remove
public PNI remove(int index)
Remove a row- Parameters:
index
- row index to be removed
-
oper
public PNI oper(PNI PNI, java.lang.String what)
Operations on PNI containers: add, subtract, multiply, divide. Keep the same graphical attributes and title.- Parameters:
PNI
- Input PNI container for operationwhat
- String representing the operation: "+" add a P0D container to the original; "-" subtract a P0D from the original; "*" multiply; "/" divide by P0D- Returns:
- original PNI after the operation.
-
oper
public PNI oper(PNI PNI, java.lang.String title, java.lang.String what)
Operations on PNI containers: add, subtract, multiply, divide. Keep the same graphical attributes- Parameters:
PNI
- Input PNI container for operationtitle
- New titlewhat
- String representing the operation: "+" add a P0D container to the original; "-" subtract a P0D from the original; "*" multiply; "/" divide by P0D- Returns:
- original PNI after the operation.
-
toTable
public void toTable()
Show container to a Table in a separate Frame. The numbers are formatted to scientific format. One can sort and search the data in this table (but not modify)
-
getDimension
public int getDimension()
Get last dimension of the data (or number of columns). The stored dimention is the one set after the last call "add", or if it set manually.- Returns:
- dimension (number of elements in a row)
-
getDimensions
public int[] getDimensions()
Get the numbers of columns. The stored dimention is the one set after the last call "add", or if it set manually.- Returns:
- dimension (number of elements in a row)
-
operScale
public void operScale(double scale)
Scale each element of data- Parameters:
scale
- Scale factor
-
size
public int size()
Data size (number of rows)- Returns:
- number of rows
-
copy
public PNI copy(java.lang.String newtitle)
Create an exact copy of the current P0D. New object is created.- Parameters:
newtitle
- new title
-
getRows
public PNI getRows(java.lang.String newtitle, int indexMin, int indexMax)
Get rows : min is inxluded, max is not;- Parameters:
title
- New titleindexMin
- min index of rowindexMax
- max index of row- Returns:
- new PNI with rows indexMin-indexMax
-
setArrayList
public void setArrayList(java.util.ArrayList<int[]> array)
Set the data in form of ArrayList- Parameters:
array
- ArrayList to be set.
-
getArray
public int[][] getArray()
Get a double array with values.- Returns:
- double array with values
-
setArray
public PNI setArray(int[][] values)
Set values from double array Old content will be lost.- Parameters:
values
- array to be set: [ROWS][dimension];- Returns:
- PNI with new values
-
main
public static void main(java.lang.String[] args)
Test- Parameters:
args
-
-
getH1D
public H1D getH1D(int bins, double min, double max)
Return H1D histogram with PND content. All values are added. Histogram range is defined by Min and Max values.- Parameters:
bins
- Number of bins for the histogram.min
- Min value of histogrammax
- Max value of histogram- Returns:
- H2D histogram filled with P0D.
-
getH1D
public H1D getH1D(int bins)
Create histogram. Min and Max are determined authomatically.- Parameters:
bins
- Number of bins- Returns:
-
getH1D
public H1D getH1D(int bins, double min, double max, int column)
Make a histogram from a column of PND.- Parameters:
bins
- Number of binsmin
- Min valuemax
- Max valuecolumn
- column of PND (- Returns:
- histogram
-
getMax
public double getMax()
Get min value- Returns:
- minimum value
-
getMin
public double getMin()
Get max value- Returns:
-
doc
public void doc()
Show online documentation.
-
-
DMelt 3.0 © DataMelt by jWork.ORG