001/*
002 * $RCSfile: CBlkWTDataFloat.java,v $
003 * $Revision: 1.1 $
004 * $Date: 2005/02/11 05:02:30 $
005 * $State: Exp $
006 *
007 * Class:                   CBlkWTDataFloat
008 *
009 * Description:             Implementation of CBlkWTData for 'float' data
010 *
011 *
012 *
013 * COPYRIGHT:
014 *
015 * This software module was originally developed by Raphaël Grosbois and
016 * Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel
017 * Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David
018 * Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research
019 * Centre France S.A) in the course of development of the JPEG2000
020 * standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This
021 * software module is an implementation of a part of the JPEG 2000
022 * Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio
023 * Systems AB and Canon Research Centre France S.A (collectively JJ2000
024 * Partners) agree not to assert against ISO/IEC and users of the JPEG
025 * 2000 Standard (Users) any of their rights under the copyright, not
026 * including other intellectual property rights, for this software module
027 * with respect to the usage by ISO/IEC and Users of this software module
028 * or modifications thereof for use in hardware or software products
029 * claiming conformance to the JPEG 2000 Standard. Those intending to use
030 * this software module in hardware or software products are advised that
031 * their use may infringe existing patents. The original developers of
032 * this software module, JJ2000 Partners and ISO/IEC assume no liability
033 * for use of this software module or modifications thereof. No license
034 * or right to this software module is granted for non JPEG 2000 Standard
035 * conforming products. JJ2000 Partners have full right to use this
036 * software module for his/her own purpose, assign or donate this
037 * software module to any third party and to inhibit third parties from
038 * using this software module for non JPEG 2000 Standard conforming
039 * products. This copyright notice must be included in all copies or
040 * derivative works of this software module.
041 *
042 * Copyright (c) 1999/2000 JJ2000 Partners.
043 *
044 *
045 *
046 */
047
048
049package jj2000.j2k.wavelet.analysis;
050
051import jj2000.j2k.image.*;
052
053/**
054 * This is an implementation of the 'CBlkWTData' abstract class for 32 bit
055 * floating point data (float).
056 *
057 * <P>The methods in this class are declared final, so that they can
058 * be inlined by inlining compilers.
059 *
060 * @see CBlkWTData
061 * */
062public class CBlkWTDataFloat extends CBlkWTData {
063    /** The array where the data is stored */
064    public float[] data;
065
066    /**
067     * Returns the identifier of this data type, <tt>TYPE_FLOAT</tt>,
068     * as defined in <tt>DataBlk</tt>.
069     *
070     * @return The type of data stored. Always <tt>DataBlk.TYPE_FLOAT</tt>
071     *
072     * @see DataBlk#TYPE_FLOAT
073     *
074     *
075     * */
076    public final int getDataType() {
077        return DataBlk.TYPE_FLOAT;
078    }
079
080    /**
081     * Returns the array containing the data, or null if there is no
082     * data array. The returned array is a float array.
083     *
084     * @return The array of data (a float[]) or null if there is no
085     * data.
086     *
087     *
088     * */
089    public final Object getData() {
090        return data;
091    }
092
093    /**
094     * Returns the array containing the data, or null if there is no
095     * data array.
096     *
097     * @return The array of data or null if there is no data.
098     *
099     *
100     * */
101    public final float[] getDataFloat() {
102        return data;
103    }
104
105    /**
106     * Sets the data array to the specified one. The provided array
107     * must be a float array, otherwise a ClassCastException is
108     * thrown. The size of the array is not checked for consistency
109     * with the code-block dimensions.
110     *
111     * @param arr The data array to use. Must be a float array.
112     *
113     *
114     * */
115    public final void setData(Object arr) {
116        data = (float[]) arr;
117    }
118
119    /**
120     * Sets the data array to the specified one. The size of the array
121     * is not checked for consistency with the code-block dimensions. This
122     * method is more efficient than 'setData()'.
123     *
124     * @param arr The data array to use.
125     *
126     *
127     * */
128    public final void setDataFloat(float[] arr) {
129        data = arr;
130    }
131}