/*
* #%L
* Fork of JAI Image I/O Tools.
* %%
* Copyright (C) 2008 - 2014 Open Microscopy Environment:
* - Board of Regents of the University of Wisconsin-Madison
* - Glencoe Software, Inc.
* - University of Dundee
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of any organization.
* #L%
*/
/*
* $RCSfile: CBlkWTData.java,v $
* $Revision: 1.1 $
* $Date: 2005/02/11 05:02:30 $
* $State: Exp $
*
* Class: CBlkWTData
*
* Description: Storage for code-blocks of WT data.
*
*
*
* COPYRIGHT:
*
* This software module was originally developed by Raphaël Grosbois and
* Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel
* Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David
* Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research
* Centre France S.A) in the course of development of the JPEG2000
* standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This
* software module is an implementation of a part of the JPEG 2000
* Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio
* Systems AB and Canon Research Centre France S.A (collectively JJ2000
* Partners) agree not to assert against ISO/IEC and users of the JPEG
* 2000 Standard (Users) any of their rights under the copyright, not
* including other intellectual property rights, for this software module
* with respect to the usage by ISO/IEC and Users of this software module
* or modifications thereof for use in hardware or software products
* claiming conformance to the JPEG 2000 Standard. Those intending to use
* this software module in hardware or software products are advised that
* their use may infringe existing patents. The original developers of
* this software module, JJ2000 Partners and ISO/IEC assume no liability
* for use of this software module or modifications thereof. No license
* or right to this software module is granted for non JPEG 2000 Standard
* conforming products. JJ2000 Partners have full right to use this
* software module for his/her own purpose, assign or donate this
* software module to any third party and to inhibit third parties from
* using this software module for non JPEG 2000 Standard conforming
* products. This copyright notice must be included in all copies or
* derivative works of this software module.
*
* Copyright (c) 1999/2000 JJ2000 Partners.
* */
package jj2000.j2k.wavelet.analysis;
import jj2000.j2k.image.*;
/**
* This is a generic abstract class to store a code-block of wavelet data, be
* it quantized or not. This class does not have the notion of
* components. Therefore, it should be used for data from a single
* component. Subclasses should implement the different types of storage
* (<tt>int</tt>, <tt>float</tt>, etc.).
*
* <P>The data is always stored in one array, of the type matching the data
* type (i.e. for 'int' it's an 'int[]'). The data should be stored in the
* array in standard scan-line order. That is the samples go from the top-left
* corner of the code-block to the lower-right corner by line and then column.
*
* <P>The member variable 'offset' gives the index in the array of the first
* data element (i.e. the top-left coefficient). The member variable 'scanw'
* gives the width of the scan that is used to store the data, that can be
* different from the width of the block. Element '(x,y)' of the code-block
* (i.e. '(0,0)' is the top-left coefficient), will appear at position
* 'offset+y*scanw+x' in the array of data.
*
* <P>The classes <tt>CBlkWTDataInt</tt> and <tt>CBlkWTDataFloat</tt>
* provide implementations for <tt>int</tt> and <tt>float</tt> types
* respectively.
*
* <P>The types of data are the same as those defined by the 'DataBlk' class.
*
* @see CBlkWTDataSrc
*
* @see jj2000.j2k.quantization.quantizer.CBlkQuantDataSrcEnc
*
* @see DataBlk
*
* @see CBlkWTDataInt
*
* @see CBlkWTDataFloat
* */
public abstract class CBlkWTData {
/** The horizontal coordinate of the upper-left corner of the code-block */
public int ulx;
/** The vertical coordinate of the upper left corner of the code-block */
public int uly;
/** The horizontal index of the code-block, within the subband */
public int n;
/** The vertical index of the code-block, within the subband */
public int m;
/** The subband in which this code-block is found */
public SubbandAn sb;
/** The width of the code-block */
public int w;
/** The height of the code-block */
public int h;
/** The offset in the array of the top-left coefficient */
public int offset;
/** The width of the scanlines used to store the data in the array */
public int scanw;
/** The number of magnitude bits in the integer representation. This is
* only used for quantized wavelet data. */
public int magbits;
/** The WMSE scaling factor (multiplicative) to apply to the distortion
* measures of the data of this code-block. By default it is 1.*/
public float wmseScaling = 1f;
/** The value by which the absolute value of the data has to be divided in
* order to get the real absolute value. This value is useful to obtain
* the complement of 2 representation of a coefficient that is currently
* using the sign-magnitude representation. */
public double convertFactor = 1.0;
/**
* The quantization step size of the code-block. The value is updated by
* the quantizer module
* */
public double stepSize = 1.0;
/**
* Number of ROI coefficients in the code-block
* */
public int nROIcoeff = 0;
/** Number of ROI magnitude bit-planes */
public int nROIbp = 0;
/**
* Returns the data type of the <tt>CBlkWTData</tt> object, as
* defined in the DataBlk class.
*
* @return The data type of the object, as defined in the DataBlk class.
*
* @see DataBlk
* */
public abstract int getDataType();
/**
* Returns the array containing the data, or null if there is no data. The
* returned array is of the type returned by <tt>getDataType()</tt> (e.g.,
* for <tt>TYPE_INT</tt>, it is a <tt>int[]</tt>).
*
* <P>Each implementing class should provide a type specific equivalent
* method (e.g., <tt>getDataInt()</tt> in <tt>DataBlkInt</tt>) which
* returns an array of the correct type explicitely and not through an
* <tt>Object</tt>.
*
* @return The array containing the data, or <tt>null</tt> if there is no
* data.
*
* @see #getDataType
* */
public abstract Object getData();
/**
* Sets the data array to the specified one. The type of the specified
* data array must match the one returned by <tt>getDataType()</tt> (e.g.,
* for <tt>TYPE_INT</tt>, it should be a <tt>int[]</tt>). If the wrong
* type of array is given a <tt>ClassCastException</tt> will be thrown.
*
* <P>The size of the array is not necessarily checked for consistency
* with <tt>w</tt> and <tt>h</tt> or any other fields.
*
* <P>Each implementing class should provide a type specific equivalent
* method (e.g., <tt>setDataInt()</tt> in <tt>DataBlkInt</tt>) which takes
* an array of the correct type explicetely and not through an
* <tt>Object</tt>.
*
* @param arr The new data array to use
*
* @see #getDataType
* */
public abstract void setData(Object arr);
/**
* Returns a string of informations about the DataBlk
*
* @return Block dimensions and progressiveness in a string
* */
public String toString(){
String typeString = "";
switch(getDataType()){
case DataBlk.TYPE_BYTE:
typeString = "Unsigned Byte";
break;
case DataBlk.TYPE_SHORT:
typeString = "Short";
break;
case DataBlk.TYPE_INT:
typeString = "Integer";
break;
case DataBlk.TYPE_FLOAT:
typeString = "Float";
break;
}
return
"CBlkWTData: "+
"ulx= " + ulx + ", uly= " + uly +
", code-block("+m+","+n+"), width= "+w+
", height= "+h+", offset= "+offset+", scan-width="+scanw+
", type= "+typeString + ", sb= "+sb+", num. ROI coeff="+
nROIcoeff+", num. ROI bit-planes="+nROIbp;
}
}