Documentation of 'jhplot.P3D' Java class.
P3D
Skip navigation links
jhplot

Class P3D

    • Constructor Detail

      • P3D

        public P3D()
        Construct an empty container

      • P3D

        public P3D(String title)
        Construct an empty container with a title
        Parameters:
        title - New title

      • P3D

        public P3D(String title,           String sfile)
        Construct a P3D from a file. Data should be separated by space in 6 columns: X,dX,Y,dY,Z,dZ
        Parameters:
        title - Title of the container
        sfile - File name with input

    • Method Detail

      • setTitle

        public void setTitle(String title)
        Set a new title
        Overrides:
        setTitle in class Plottable
        Parameters:
        title - New Title

      • getPenColor

        public Color getPenColor()
        Get the color attribute
        Returns:
        Color

      • setPenColor

        public void setPenColor(Color c)
        Sets the symbol color
        Parameters:
        c - Color

      • setPenWidth

        public void setPenWidth(int w)
        Set width of the lines
        Parameters:
        w - Width of the lines

      • getPenWidth

        public int getPenWidth()
        Get width of the lines
        Returns:
        Width of the lines

      • read

        public int read(String sfile)
        Read P3D from a file. The old content will be lost. The file should contain 6 columns: x,y,z, dx,dy,dz. Comment lines starting with "#" and "*" are ignored.
        Parameters:
        sfile - File name with input
        Returns:
        zero if success

      • writeSerialized

        public int writeSerialized(String name)
        Write a P0D object to a serialized file
        Parameters:
        name - serialized file name for output.
        Returns:
        zero if no errors

      • readSerialized

        public P3D readSerialized(String name)
        Read a P3D object from a serialized file
        Parameters:
        name - serialized file name for input.
        Returns:
        new P3D object

      • readGZip

        public int readGZip(String sfile)
        Read P3D from a GZipped file. The old content will be lost. The file should contain 6 columns: x,y,z, dx,dy,dz. Comment lines starting with "#" and "*" are ignored.
        Parameters:
        sfile - File name with input
        Returns:
        zero if success

      • readZip

        public int readZip(String sfile)
        Read P3D from a Zipped file. The old content will be lost. The file should contain 6 columns: x,y,z, dx,dy,dz. Comment lines starting with "#" and "*" are ignored.
        Parameters:
        sfile - File name with input
        Returns:
        zero if success

      • toFile

        public void toFile(String name)
        Write a P3D to an external file.
        Parameters:
        name - File name with output

      • print

        public void print()
        Print a P3D container on the screen

      • merge

        public P3D merge(P3D a)
        Merge two P3D containers
        Parameters:
        a - Container to be added
        Returns:
        New P3D container

      • setDataArray

        public void setDataArray(jplot.DataArray3D data)
        Set data in a form of DataArray
        Parameters:
        data - input data

      • getDataArray

        public jplot.DataArray3D getDataArray()
        Return a DataArray3D container.
        Returns:
        Container of type DataArray3D

      • add

        public void add(double x,                double dx,                double y,                double dy,                double z,                double dz)
        Adds values of a plot-point pair (X,dX,Y,dY,Z,dZ).
        Parameters:
        x - X-value of the plot-point
        dx - extent in X
        y - Y-value of the plot-point
        dy - extent in Y
        z - Z-value of the plot-point
        dz - extent in Z

      • set

        public void set(int i,                double x,                double dx,                double y,                double dy,                double z,                double dz)
        Sets the values of (x,dx,y,dy,z,dz).
        Parameters:
        i - index of the plot-point
        x - X-value of the plot-point
        dx - extent in X
        y - Y-value of the plot-point
        dy - extent in Y
        z - Z-value of the plot-point
        dz - extent in Z

      • size

        public int size()
        Return the length of the data vector.
        Returns:
        length of the PlotPoint vector

      • getCopy

        public P3D getCopy()
        get a copy of the current holder

      • getArrayX

        public double[] getArrayX()
        Get array representing X-values
        Returns:
        array with X values

      • getArrayY

        public double[] getArrayY()
        Get array representing Y-values
        Returns:
        array with Y values

      • getArrayZ

        public double[] getArrayZ()
        Get array representing Z-values
        Returns:
        array with Y values

      • getX

        public double getX(int i)
        Return a specific X-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
        Parameters:
        i - index of the array
        Returns:
        the value of x at index i

      • getDX

        public double getDX(int i)
        Return a specific dX-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
        Parameters:
        i - index of the array
        Returns:
        the value of dx at index i

      • getY

        public double getY(int i)
        Return a specific Y-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
        Parameters:
        i - index of the array
        Returns:
        the value of y at index i

      • getDY

        public double getDY(int i)
        Return a specific dY-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
        Parameters:
        i - index of the array
        Returns:
        the value of dy at index i

      • getZ

        public double getZ(int i)
        Return a specific Z-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
        Parameters:
        i - index of the array
        Returns:
        the value of z at index i

      • getDZ

        public double getDZ(int i)
        Return a specific dZ-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
        Parameters:
        i - index of the array
        Returns:
        the value of dz at index i

      • getMax

        public double getMax(int axis)
        Returns the maximum value in the range.
        Parameters:
        axis - defines to which axis this function applies. axis=0 - X, axis=1 - Y, axis=2 - Z,
        Returns:
        the maximum value.

      • getMin

        public double getMin(int axis)
        Returns the minimum value in the range. axis=0 - X, axis=1 - Y, axis=2 - Z.
        Parameters:
        axis - defines to which axis this function applies.
        Returns:
        the minimum value.

      • meanX

        public double meanX()
        Returns the mean value in X.
        Returns:
        Mean value in X

      • meanY

        public double meanY()
        Returns the mean value in Y.
        Returns:
        Mean value in Y

      • meanZ

        public double meanZ()
        Returns the mean value in Z.
        Returns:
        Mean value in Y

      • clear

        public void clear()
        Clear the container

      • toTable

        public void toTable()
        Print the P2D 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)

      • doc

        public void doc()
        Show online documentation.
Skip navigation links

DMelt 2.7 © DataMelt by jWork.ORG